icrc1-account-converter.mo

import Array "mo:base/Array";
import Blob "mo:base/Blob";
import Char "mo:base/Char";
import Iter "mo:base/Iter";
import Nat32 "mo:base/Nat32";
import Nat8 "mo:base/Nat8";
import Option "mo:base/Option";
import Principal "mo:base/Principal";
import Result "mo:base/Result";
import Text "mo:base/Text";

/** https://github.com/dfinity/ICRC-1/blob/main/ref/Account.mo */
module Account2TextConverter {

  public type Account = { owner : Principal; subaccount : ?Blob };
  public type ParseError = {
    #malformed : Text;
    #not_canonical;
    #bad_checksum;
  };

  /// Converts an account to text.
  public func toText({ owner; subaccount } : Account) : Text {
    let ownerText = Principal.toText(owner);
    switch (subaccount) {
      case (null) { ownerText };
      case (?subaccount) {
        assert (subaccount.size() == 32);
        if (iterAll(subaccount.vals(), func(b : Nat8) : Bool { b == 0 })) {
          ownerText;
        } else {
          ownerText # "-" # checkSum(owner, subaccount) # "." # displaySubaccount(subaccount);
        };
      };
    };
  };

  /// Parses account from its textual representation.
  public func fromText(text : Text) : Result.Result<Account, ParseError> {
    let n = text.size();

    if (n == 0) {
      return #err(#malformed("empty"));
    };

    let charsIter = text.chars();
    let chars = Array.tabulate(n, func(_ : Nat) : Char { Option.get(charsIter.next(), ' ') });

    var lastDash = n;
    var dot = n;

    // Find the last dash and the dot.
    label l for (i in Iter.range(0, n - 1)) {
      if (chars[i] == '-') { lastDash := i };
      if (chars[i] == '.') { dot := i; break l };
    };

    if (lastDash == n) {
      return #err(#malformed("expected at least one dash ('-') character"));
    };

    if (dot == n) {
      // No subaccount separator: the principal case.
      return #ok({ owner = Principal.fromText(text); subaccount = null });
    };

    let numSubaccountDigits = (n - dot - 1) : Nat;

    if (numSubaccountDigits > 64) {
      return #err(#malformed("the subaccount is too long (expected at most 64 characters)"));
    };

    if (dot < lastDash) {
      return #err(#malformed("the subaccount separator does not follow the checksum separator"));
    };

    if (dot - lastDash - 1 : Nat != 7) {
      return #err(#bad_checksum);
    };

    // The encoding ends with a dot, the subaccount is empty.
    if (dot == (n - 1 : Nat)) {
      return #err(#not_canonical);
    };

    // The first digit after the dot must not be a zero.
    if (chars[dot + 1] == '0') {
      return #err(#not_canonical);
    };

    let principalText = Text.fromIter(iterSlice(chars, 0, lastDash - 1 : Nat));
    let owner = Principal.fromText(principalText);

    var subaccountMut = Array.init<Nat8>(32, 0);

    let subaccountDigits = iterChain(
      iterReplicate('0', 64 - numSubaccountDigits : Nat),
      iterSlice(chars, dot + 1, n - 1 : Nat),
    );

    // Decode hex backwards into the subaccount array.
    for ((i, c) in iterEnumerate(subaccountDigits)) {
      let value = switch (decodeHexDigit(c)) {
        case (?v) { v };
        case (null) {
          return #err(#malformed("invalid hex char: '" # Text.fromChar(c) # "'"));
        };
      };
      subaccountMut[i / 2] += value << (4 * Nat8.fromNat(1 - i % 2));
    };

    // Check that the subaccount is not the default.
    if (iterAll<Nat8>(subaccountMut.vals(), func(x : Nat8) : Bool { x == 0 })) {
      return #err(#not_canonical);
    };

    let subaccount = Blob.fromArrayMut(subaccountMut);

    if (not iterEqual<Char>(checkSum(owner, subaccount).chars(), iterSlice(chars, lastDash + 1, dot - 1 : Nat), Char.equal)) {
      return #err(#bad_checksum);
    };

    #ok({ owner = owner; subaccount = ?subaccount });
  };

  // prettier-ignore
    let hexDigits = ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'];

  func hexDigit(n : Nat8) : Char {
    hexDigits[Nat8.toNat(n)];
  };

  func decodeHexDigit(c : Char) : ?Nat8 {
    switch (c) {
      case ('0') { ?0 };
      case ('1') { ?1 };
      case ('2') { ?2 };
      case ('3') { ?3 };
      case ('4') { ?4 };
      case ('5') { ?5 };
      case ('6') { ?6 };
      case ('7') { ?7 };
      case ('8') { ?8 };
      case ('9') { ?9 };
      case ('a') { ?10 };
      case ('b') { ?11 };
      case ('c') { ?12 };
      case ('d') { ?13 };
      case ('e') { ?14 };
      case ('f') { ?15 };
      case _ { null };
    };
  };

  // prettier-ignore
    let crc32Table : [Nat32] =
    [ 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f
    , 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988
    , 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91, 0x1db71064, 0x6ab020f2
    , 0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7
    , 0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9
    , 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172
    , 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, 0x35b5a8fa, 0x42b2986c
    , 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59
    , 0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423
    , 0xcfba9599, 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924
    , 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, 0x01db7106
    , 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433
    , 0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d
    , 0x91646c97, 0xe6635c01, 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e
    , 0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950
    , 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65
    , 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7
    , 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0
    , 0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa
    , 0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f
    , 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, 0x2eb40d81
    , 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a
    , 0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683, 0xe3630b12, 0x94643b84
    , 0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1
    , 0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb
    , 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc
    , 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, 0xd6d6a3e8, 0xa1d1937e
    , 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b
    , 0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55
    , 0x316e8eef, 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236
    , 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, 0xb2bd0b28
    , 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d
    , 0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 0x9c0906a9, 0xeb0e363f
    , 0x72076785, 0x05005713, 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38
    , 0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242
    , 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777
    , 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69
    , 0x616bffd3, 0x166ccf45, 0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2
    , 0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc
    , 0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9
    , 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693
    , 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94
    , 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d
    ];

  let crc32Seed : Nat32 = 0xffffffff;

  // prettier-ignore
    let base32Alphabet = ["a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z", "2", "3", "4", "5", "6", "7"];

  func updateCrc(crc : Nat32, byte : Nat8) : Nat32 {
    crc32Table[Nat32.toNat(crc ^ Nat32.fromNat(Nat8.toNat(byte)) & 0xff)] ^ (crc >> 8);
  };

  public func checkSum(owner : Principal, subaccount : Blob) : Text {
    let crc = crc32Seed ^ iterFold(iterChain(Principal.toBlob(owner).vals(), subaccount.vals()), updateCrc, crc32Seed);

    let d = func(shift : Nat) : Text {
      base32Alphabet[Nat32.toNat((crc >> Nat32.fromNat(shift)) & 0x1f)];
    };

    d(27) # d(22) # d(17) # d(12) # d(7) # d(2) # base32Alphabet[Nat32.toNat((crc & 0x03) << 3)];
  };

  // Hex-encodes a subaccount, skipping the leading zeros.
  func displaySubaccount(subaccount : Blob) : Text {
    func nibbles(b : Nat8) : Iter.Iter<Nat8> {
      iterChain(iterOnce(b / 16), iterOnce(b % 16));
    };

    Text.fromIter(
      Iter.map(
        iterSkipWhile(
          iterFlatMap(subaccount.vals(), nibbles),
          func(b : Nat8) : Bool { b == 0 },
        ),
        hexDigit,
      )
    );
  };

  // Helper functions to deal with iterators

  func iterSlice<T>(a : [T], from : Nat, to : Nat) : Iter.Iter<T> {
    Iter.map(Iter.range(from, to), func(i : Nat) : T { a[i] });
  };

  func iterEqual<T>(xs : Iter.Iter<T>, ys : Iter.Iter<T>, eq : (T, T) -> Bool) : Bool {
    loop {
      switch ((xs.next(), ys.next())) {
        case ((null, null)) { return true };
        case ((null, _)) { return false };
        case ((_, null)) { return false };
        case ((?x, ?y)) { if (not eq(x, y)) { return false } };
      };
    };
  };

  func iterAll<T>(xs : Iter.Iter<T>, predicate : (T) -> Bool) : Bool {
    loop {
      switch (xs.next()) {
        case (null) { return true };
        case (?x) { if (not predicate(x)) { return false } };
      };
    };
  };

  func iterSkipWhile<T>(xs : Iter.Iter<T>, predicate : (T) -> Bool) : Iter.Iter<T> {
    loop {
      switch (xs.next()) {
        case (null) { return xs };
        case (?x) {
          if (not predicate(x)) {
            return iterChain(iterOnce(x), xs);
          };
        };
      };
    };
  };

  func iterEnumerate<T>(xs : Iter.Iter<T>) : Iter.Iter<(Nat, T)> = object {
    var counter = 0;

    public func next() : ?(Nat, T) {
      switch (xs.next()) {
        case (?x) {
          let count = counter;
          counter += 1;
          ?(count, x);
        };
        case (null) { null };
      };
    };
  };

  func iterFlatMap<T, S>(xs : Iter.Iter<T>, f : (T) -> Iter.Iter<S>) : Iter.Iter<S> = object {
    var it = iterEmpty<S>();

    public func next() : ?S {
      loop {
        switch (it.next()) {
          case (?s) { return ?s };
          case (null) {
            switch (xs.next()) {
              case (null) { return null };
              case (?x) { it := f(x) };
            };
          };
        };
      };
    };
  };

  func iterReplicate<T>(x : T, times : Nat) : Iter.Iter<T> = object {
    var left = times;

    public func next() : ?T {
      if (left == 0) { null } else { left -= 1; ?x };
    };
  };

  func iterEmpty<T>() : Iter.Iter<T> = object {
    public func next() : ?T = null;
  };

  func iterOnce<T>(x : T) : Iter.Iter<T> = object {
    var value = ?x;

    public func next() : ?T {
      let old_value = value;
      value := null;
      old_value;
    };
  };

  func iterChain<T>(xs : Iter.Iter<T>, ys : Iter.Iter<T>) : Iter.Iter<T> = object {
    public func next() : ?T {
      switch (xs.next()) {
        case (null) { ys.next() };
        case (?x) { ?x };
      };
    };
  };

  func iterFold<T, A>(xs : Iter.Iter<T>, f : (A, T) -> A, seed : A) : A {
    var acc = seed;
    loop {
      switch (xs.next()) {
        case (null) { return acc };
        case (?x) { acc := f(acc, x) };
      };
    };
  };
};