Add strkey support for liquidity pools and claimable balances (#799)

Author: Shaptic

src/strkey.js

@@ -10,7 +10,9 @@ const versionBytes = {
   preAuthTx: 19 << 3, // T
   sha256Hash: 23 << 3, // X
   signedPayload: 15 << 3, // P
-  contract: 2 << 3 // C
+  contract: 2 << 3, // C
+  liquidityPool: 11 << 3, // L
+  claimableBalance: 1 << 3 // B
 };
 
 const strkeyTypes = {
@@ -20,7 +22,9 @@ const strkeyTypes = {
   T: 'preAuthTx',
   X: 'sha256Hash',
   P: 'signedPayload',
-  C: 'contract'
+  C: 'contract',
+  L: 'liquidityPool',
+  B: 'claimableBalance'
 };
 
 /**
@@ -205,6 +209,60 @@ export class StrKey {
     return isValid('contract', address);
   }
 
+  /**
+   * Encodes raw data to strkey claimable balance (B...).
+   * @param   {Buffer} data  data to encode
+   * @returns {string}
+   */
+  static encodeClaimableBalance(data) {
+    return encodeCheck('claimableBalance', data);
+  }
+
+  /**
+   * Decodes strkey contract (B...) to raw data.
+   * @param   {string} address  balance to decode
+   * @returns {Buffer}
+   */
+  static decodeClaimableBalance(address) {
+    return decodeCheck('claimableBalance', address);
+  }
+
+  /**
+   * Checks validity of alleged claimable balance (B...) strkey address.
+   * @param   {string} address  balance to check
+   * @returns {boolean}
+   */
+  static isValidClaimableBalance(address) {
+    return isValid('claimableBalance', address);
+  }
+
+  /**
+   * Encodes raw data to strkey liquidity pool (L...).
+   * @param   {Buffer} data  data to encode
+   * @returns {string}
+   */
+  static encodeLiquidityPool(data) {
+    return encodeCheck('liquidityPool', data);
+  }
+
+  /**
+   * Decodes strkey liquidity pool (L...) to raw data.
+   * @param   {string} address  address to decode
+   * @returns {Buffer}
+   */
+  static decodeLiquidityPool(address) {
+    return decodeCheck('liquidityPool', address);
+  }
+
+  /**
+   * Checks validity of alleged liquidity pool (L...) strkey address.
+   * @param   {string} address  pool to check
+   * @returns {boolean}
+   */
+  static isValidLiquidityPool(address) {
+    return isValid('liquidityPool', address);
+  }
+
   static getVersionByteForPrefix(address) {
     return strkeyTypes[address[0]];
   }
@@ -234,12 +292,19 @@ function isValid(versionByteName, encoded) {
     case 'ed25519SecretSeed': // falls through
     case 'preAuthTx': // falls through
     case 'sha256Hash': // falls through
-    case 'contract':
+    case 'contract': // falls through
+    case 'liquidityPool':
       if (encoded.length !== 56) {
         return false;
       }
       break;
 
+    case 'claimableBalance':
+      if (encoded.length !== 58) {
+        return false;
+      }
+      break;
+
     case 'med25519PublicKey':
       if (encoded.length !== 69) {
         return false;
@@ -270,8 +335,12 @@ function isValid(versionByteName, encoded) {
     case 'preAuthTx': // falls through
     case 'sha256Hash': // falls through
     case 'contract':
+    case 'liquidityPool':
       return decoded.length === 32;
 
+    case 'claimableBalance':
+      return decoded.length === 32 + 1; // +1 byte for discriminant
+
     case 'med25519PublicKey':
       return decoded.length === 40; // +8 bytes for the ID
 

test/unit/strkey_test.js

@@ -413,6 +413,37 @@ describe('StrKey', function () {
     });
   });
 
+  describe('#liquidityPools', function () {
+    it('valid w/ 32-byte hash', function () {
+      const strkey = 'LA7QYNF7SOWQ3GLR2BGMZEHXAVIRZA4KVWLTJJFC7MGXUA74P7UJUPJN';
+      const asHex =
+        '3f0c34bf93ad0d9971d04ccc90f705511c838aad9734a4a2fb0d7a03fc7fe89a';
+      expect(StellarBase.StrKey.isValidLiquidityPool(strkey)).to.be.true;
+      expect(
+        StellarBase.StrKey.decodeLiquidityPool(strkey).toString('hex')
+      ).to.equal(asHex);
+      expect(
+        StellarBase.StrKey.encodeLiquidityPool(Buffer.from(asHex, 'hex'))
+      ).to.equal(strkey);
+    });
+  });
+
+  describe('#claimableBalances', function () {
+    it('valid w/ 33-byte strkey', function () {
+      const strkey =
+        'BAAD6DBUX6J22DMZOHIEZTEQ64CVCHEDRKWZONFEUL5Q26QD7R76RGR4TU';
+      const asHex =
+        '003f0c34bf93ad0d9971d04ccc90f705511c838aad9734a4a2fb0d7a03fc7fe89a';
+      expect(StellarBase.StrKey.isValidClaimableBalance(strkey)).to.be.true;
+      expect(
+        StellarBase.StrKey.decodeClaimableBalance(strkey).toString('hex')
+      ).to.equal(asHex);
+      expect(
+        StellarBase.StrKey.encodeClaimableBalance(Buffer.from(asHex, 'hex'))
+      ).to.equal(strkey);
+    });
+  });
+
   describe('#invalidStrKeys', function () {
     // From https://stellar.org/protocol/sep-23#invalid-test-cases
     const BAD_STRKEYS = [
@@ -430,7 +461,11 @@ describe('StrKey', function () {
       // Padding bytes are not allowed
       'MA7QYNF7SOWQ3GLR2BGMZEHXAVIRZA4KVWLTJJFC7MGXUA74P7UJUAAAAAAAAAAAACJUK===',
       // Invalid checksum
-      'MA7QYNF7SOWQ3GLR2BGMZEHXAVIRZA4KVWLTJJFC7MGXUA74P7UJUAAAAAAAAAAAACJUO'
+      'MA7QYNF7SOWQ3GLR2BGMZEHXAVIRZA4KVWLTJJFC7MGXUA74P7UJUAAAAAAAAAAAACJUO',
+      // Trailing bits should be zeroes
+      'BAAD6DBUX6J22DMZOHIEZTEQ64CVCHEDRKWZONFEUL5Q26QD7R76RGR4TV',
+      // Invalid claimable balance type
+      'BAAT6DBUX6J22DMZOHIEZTEQ64CVCHEDRKWZONFEUL5Q26QD7R76RGXACA'
 
       //
       // FIXME: The following test cases don't pass (i.e. don't throw).

types/index.d.ts

@@ -989,6 +989,14 @@ export namespace StrKey {
   function encodeContract(data: Buffer): string;
   function decodeContract(address: string): Buffer;
   function isValidContract(address: string): boolean;
+
+  function encodeClaimableBalance(data: Buffer): string;
+  function decodeClaimableBalance(address: string): Buffer;
+  function isValidClaimableBalance(address: string): boolean;
+
+  function encodeLiquidityPool(data: Buffer): string;
+  function decodeLiquidityPool(address: string): Buffer;
+  function isValidLiquidityPool(address: string): boolean;
 }
 
 export namespace SignerKey {