feat(sdk-coin-xrp): add wrw support cold wallet xrpl token

nvrakesh06 · nvrakesh06 · commit 08c0c4a5b448 · 2024-11-17T21:06:29.000+05:30
TICKET: WIN-3813
diff --git a/modules/bitgo/test/v2/unit/recovery.ts b/modules/bitgo/test/v2/unit/recovery.ts
@@ -8,6 +8,7 @@ import { EcdsaRangeProof, EcdsaTypes } from '@bitgo/sdk-lib-mpc';
 import { TransactionFactory } from '@ethereumjs/tx';
 import * as sinon from 'sinon';
 import { ethLikeDKLSKeycard, ethLikeGG18Keycard } from '../fixtures/tss/recoveryFixtures';
+import { Utils } from '@bitgo/sdk-coin-xrp';
 
 const recoveryNocks = require('../lib/recovery-nocks');
 
@@ -54,12 +55,12 @@ describe('Recovery:', function () {
         })
         .then(function (recovery) {
           recovery.txHex.should.equal(
-            '120000228000000024000000042E00003039201B0015519161400000024F37EDC068400000000000001E7300811439CA010E0E0198150F8DDD5768CCD2B095701D8C8314201276ADC469C4F10D1369E0F5C5A7DEF37B2267F3E0107321026C91974146427889C801BD26CE31CE0E10307A69DFE4139DE45E5E35933A6B03744630440220692763F79B6C61D50BE57C613C589EF33FC7A5063169F7E21ABDBF9BFB84A26C022062DC329F27F678AAE51C85896298C54D9D1174E891D52199DED13898F94ECA1A8114ABB5B7C843F3AA8D8EFACC3C5A7D9B0484C17442E1E010732102F4E376133012F5404990C7E1DF83A9F943B30D55F0D856632C8E8378FCEB70D27446304402203F8DAA9F0B26D902A20BBDE426B80941E2E75784EE40290203607BAEEFF080E802207C651C9DE5DB949A3231A70F199939624FB92B36BDA23D2A5858643CA0C288EC8114ACEF9F0A2FCEC44A9A213444A9E6C57E2D02856AE1F1'
+            '12000022800000002400000004201B0015519161400000024F37EDC068400000000000001E7300811439CA010E0E0198150F8DDD5768CCD2B095701D8C8314201276ADC469C4F10D1369E0F5C5A7DEF37B2267F3E0107321026C91974146427889C801BD26CE31CE0E10307A69DFE4139DE45E5E35933A6B03744630440220263C30D0CBB59076D0541E1D8919B0D467FDC9CFC63D2FB43E22A26924FB174E02204EFFD8F2269D1F701FF3D816A215884226BCB6668222B962FD124A9F8264E98D8114ABB5B7C843F3AA8D8EFACC3C5A7D9B0484C17442E1E010732102F4E376133012F5404990C7E1DF83A9F943B30D55F0D856632C8E8378FCEB70D274473045022100D3D94038EE6D5A2E4E9C2B79ED176066C7FE8019B2ACD1F028FD3212A7BA4E6F02205E39C9734873441D8018D2A72C42F31D1863B65215AFC9674820A8A3135E81248114ACEF9F0A2FCEC44A9A213444A9E6C57E2D02856AE1F1'
           );
-          recovery.id.should.equal('0123383D6E12E9F7B3A13727CCE4D15895014FB3957D29610D308E300EA742C1');
+          recovery.id.should.equal('25B104FD0B9649AB38950202741356C75DBEEAD3E9F1F43097C8A649D3FE8E94');
           recovery.outputAmount.should.equal('9919000000');
           recovery.outputs.length.should.equal(1);
-          recovery.outputs[0].address.should.equal('rsv2kremJSSFbbaLqrf8fWxxN5QnsynNm2?dt=12345');
+          recovery.outputs[0].address.should.equal('rsv2kremJSSFbbaLqrf8fWxxN5QnsynNm2');
           recovery.outputs[0].amount.should.equal('9919000000');
           recovery.fee.fee.should.equal('30');
         });
@@ -82,12 +83,12 @@ describe('Recovery:', function () {
         })
         .then(function (recovery) {
           recovery.txHex.should.equal(
-            '120000228000000024000000042E00003039201B0015519161400000024F37EDC068400000000000001E7300811439CA010E0E0198150F8DDD5768CCD2B095701D8C8314201276ADC469C4F10D1369E0F5C5A7DEF37B2267F3E010732102F4E376133012F5404990C7E1DF83A9F943B30D55F0D856632C8E8378FCEB70D27446304402203F8DAA9F0B26D902A20BBDE426B80941E2E75784EE40290203607BAEEFF080E802207C651C9DE5DB949A3231A70F199939624FB92B36BDA23D2A5858643CA0C288EC8114ACEF9F0A2FCEC44A9A213444A9E6C57E2D02856AE1F1'
+            '12000022800000002400000004201B0015519161400000024F37EDC068400000000000001E7300811439CA010E0E0198150F8DDD5768CCD2B095701D8C8314201276ADC469C4F10D1369E0F5C5A7DEF37B2267F3E010732102F4E376133012F5404990C7E1DF83A9F943B30D55F0D856632C8E8378FCEB70D274473045022100D3D94038EE6D5A2E4E9C2B79ED176066C7FE8019B2ACD1F028FD3212A7BA4E6F02205E39C9734873441D8018D2A72C42F31D1863B65215AFC9674820A8A3135E81248114ACEF9F0A2FCEC44A9A213444A9E6C57E2D02856AE1F1'
           );
-          recovery.id.should.equal('397C13D060B4BE43E7F2EEAE5B35E27DA306A7F6766A38C4F0570E359E71D090');
+          recovery.id.should.equal('11D09331E7AC76D4817F08D359F8CEB06A10DFCBE4B7ABAE45C7A1131443C6F1');
           recovery.outputAmount.should.equal('9919000000');
           recovery.outputs.length.should.equal(1);
-          recovery.outputs[0].address.should.equal('rsv2kremJSSFbbaLqrf8fWxxN5QnsynNm2?dt=12345');
+          recovery.outputs[0].address.should.equal('rsv2kremJSSFbbaLqrf8fWxxN5QnsynNm2');
           recovery.outputs[0].amount.should.equal('9919000000');
           recovery.fee.fee.should.equal('30');
         });
@@ -109,16 +110,18 @@ describe('Recovery:', function () {
           recoveryDestination: 'rsv2kremJSSFbbaLqrf8fWxxN5QnsynNm2?dt=12345',
         })
         .then(function (recovery) {
-          const json = JSON.parse(recovery.txHex);
-          json.TransactionType.should.equal('Payment');
-          json.Account.should.equal('raGZWRkRBUWdQJsKYEzwXJNbCZMTqX56aA');
-          json.Destination.should.equal('rsv2kremJSSFbbaLqrf8fWxxN5QnsynNm2');
-          json.DestinationTag.should.equal(12345);
-          json.Amount.should.equal('9919000000');
-          json.Flags.should.equal(2147483648);
-          json.LastLedgerSequence.should.equal(1397137);
-          json.Fee.should.equal('30');
-          json.Sequence.should.equal(4);
+          recovery.txHex.should.equal(
+            '12000022800000002400000004201B0015519161400000024F37EDC068400000000000001E811439CA010E0E0198150F8DDD5768CCD2B095701D8C8314201276ADC469C4F10D1369E0F5C5A7DEF37B2267'
+          );
+          const tx: any = Utils.decodeTransaction(recovery.txHex);
+          tx.TransactionType.should.equal('Payment');
+          tx.Account.should.equal('raGZWRkRBUWdQJsKYEzwXJNbCZMTqX56aA');
+          tx.Destination.should.equal('rsv2kremJSSFbbaLqrf8fWxxN5QnsynNm2');
+          tx.Amount.should.equal('9919000000');
+          tx.Flags.should.equal(2147483648);
+          tx.LastLedgerSequence.should.equal(1397137);
+          tx.Fee.should.equal('30');
+          tx.Sequence.should.equal(4);
         });
     });
   });
diff --git a/modules/sdk-coin-xrp/src/lib/tokenTransferBuilder.ts b/modules/sdk-coin-xrp/src/lib/tokenTransferBuilder.ts
@@ -49,7 +49,7 @@ export class TokenTransferBuilder extends TransactionBuilder {
    * @param {string} address - the address with optional destination tag
    * @returns {TransactionBuilder} This transaction builder
    */
-  to(address: string): TransactionBuilder {
+  to(address: string): TokenTransferBuilder {
     const { address: xrpAddress, destinationTag } = utils.getAddressDetails(address);
     this._destination = xrpAddress;
     this._destinationTag = destinationTag;
diff --git a/modules/sdk-coin-xrp/src/lib/transferBuilder.ts b/modules/sdk-coin-xrp/src/lib/transferBuilder.ts
@@ -46,7 +46,7 @@ export class TransferBuilder extends TransactionBuilder {
    * @param {string} address - the address with optional destination tag
    * @returns {TransactionBuilder} This transaction builder
    */
-  to(address: string): TransactionBuilder {
+  to(address: string): TransferBuilder {
     const { address: xrpAddress, destinationTag } = utils.getAddressDetails(address);
     this._destination = xrpAddress;
     this._destinationTag = destinationTag;
diff --git a/modules/sdk-coin-xrp/src/lib/utils.ts b/modules/sdk-coin-xrp/src/lib/utils.ts
@@ -249,6 +249,24 @@ class Utils implements BaseUtils {
       issuer: token.issuerAddress,
     };
   }
+
+  /**
+   * Decodes a serialized XRPL transaction.
+   *
+   * @param {string} txHex - The serialized transaction in hex.
+   * @returns {Object} - Decoded transaction object.
+   * @throws {Error} - If decoding fails or input is invalid.
+   */
+  public decodeTransaction(txHex: string) {
+    if (typeof txHex !== 'string' || txHex.trim() === '') {
+      throw new Error('Invalid transaction hex. Expected a non-empty string.');
+    }
+    try {
+      return xrpl.decode(txHex);
+    } catch (error) {
+      throw new Error(`Failed to decode transaction: ${error.message}`);
+    }
+  }
 }
 
 const utils = new Utils();
diff --git a/modules/sdk-coin-xrp/src/xrp.ts b/modules/sdk-coin-xrp/src/xrp.ts
@@ -40,6 +40,7 @@ import {
 import { KeyPair as XrpKeyPair } from './lib/keyPair';
 import utils from './lib/utils';
 import ripple from './ripple';
+import { TokenTransferBuilder, TransactionBuilderFactory, TransferBuilder } from './lib';
 
 export class Xrp extends BaseCoin {
   protected _staticsCoin: Readonly<StaticsBaseCoin>;
@@ -541,29 +542,31 @@ export class Xrp extends BaseCoin {
         accountLines,
         keys,
         isKrsRecovery,
+        isUnsignedSweep,
         userAddress,
         backupAddress,
       };
 
       return this.recoverXrpToken(params, tokenName, tokenParams);
     }
 
-    const transaction = {
-      TransactionType: 'Payment',
-      Account: params.rootAddress, // source address
-      Destination: destinationAddress,
-      DestinationTag: destinationTag,
-      Amount: recoverableBalance.toFixed(0),
-      Flags: 2147483648,
-      LastLedgerSequence: currentLedger + 1000000, // give it 1 million ledgers' time (~1 month, suitable for KRS)
-      Fee: openLedgerFee.times(3).toFixed(0), // the factor three is for the multisigning
-      Sequence: sequenceId,
-    };
-    const txJSON: string = JSON.stringify(transaction);
+    const factory = new TransactionBuilderFactory(coins.get(this.getChain()));
+    const txBuilder = factory.getTransferBuilder() as TransferBuilder;
+    txBuilder
+      .to(destinationAddress as string)
+      .amount(recoverableBalance.toFixed(0))
+      .sender(params.rootAddress)
+      .flags(2147483648)
+      .lastLedgerSequence(currentLedger + 1000000) // give it 1 million ledgers' time (~1 month, suitable for KRS)
+      .fee(openLedgerFee.times(3).toFixed(0)) // the factor three is for the multisigning
+      .sequence(sequenceId);
+
+    const tx = await txBuilder.build();
+    const serializedTx = tx.toBroadcastFormat();
 
     if (isUnsignedSweep) {
       return {
-        txHex: txJSON,
+        txHex: serializedTx,
         coin: this.getChain(),
       };
     }
@@ -572,7 +575,7 @@ export class Xrp extends BaseCoin {
       throw new Error(`userKey is not a private key`);
     }
     const userKey = keys[0].privateKey.toString('hex');
-    const userSignature = ripple.signWithPrivateKey(txJSON, userKey, { signAs: userAddress });
+    const userSignature = ripple.signWithPrivateKey(serializedTx, userKey, { signAs: userAddress });
 
     let signedTransaction: string;
 
@@ -583,7 +586,7 @@ export class Xrp extends BaseCoin {
         throw new Error(`backupKey is not a private key`);
       }
       const backupKey = keys[1].privateKey.toString('hex');
-      const backupSignature = ripple.signWithPrivateKey(txJSON, backupKey, { signAs: backupAddress });
+      const backupSignature = ripple.signWithPrivateKey(serializedTx, backupKey, { signAs: backupAddress });
       signedTransaction = ripple.multisign([userSignature.signedTransaction, backupSignature.signedTransaction]);
     }
 
@@ -603,8 +606,6 @@ export class Xrp extends BaseCoin {
   public async recoverXrpToken(params, tokenName, tokenParams) {
     const { currency, issuer } = utils.getXrpCurrencyFromTokenName(tokenName);
 
-    // const accountLines = JSON.parse(tokenParams.accountLines);
-    // const lines = accountLines.body.result.lines;
     const lines = tokenParams.accountLines.body.result.lines;
 
     let amount;
@@ -622,33 +623,40 @@ export class Xrp extends BaseCoin {
       throw new Error(`Does not have funds to recover`);
     }
 
+    const decimalPlaces = coins.get(tokenName).decimalPlaces;
+    amount = new BigNumber(amount).shiftedBy(decimalPlaces).toFixed();
+
     const FLAG_VALUE = 2147483648;
 
-    const transaction = {
-      TransactionType: 'Payment',
-      Amount: {
-        value: amount,
-        currency,
-        issuer,
-      }, // source address
-      Destination: tokenParams.destinationAddress,
-      DestinationTag: tokenParams.destinationTag,
-      Account: params.rootAddress,
-      Flags: FLAG_VALUE,
-      LastLedgerSequence: tokenParams.currentLedger + 1000000, // give it 1 million ledgers' time (~1 month, suitable for KRS)
-      Fee: tokenParams.openLedgerFee.times(3).toFixed(0), // the factor three is for the multisigning
-      Sequence: tokenParams.sequenceId,
-    };
-    const txJSON: string = JSON.stringify(transaction);
+    const factory = new TransactionBuilderFactory(coins.get(tokenName));
+    const txBuilder = factory.getTokenTransferBuilder() as TokenTransferBuilder;
+    txBuilder
+      .to(tokenParams.destinationAddress)
+      .amount(amount)
+      .sender(params.rootAddress)
+      .flags(FLAG_VALUE)
+      .lastLedgerSequence(tokenParams.currentLedger + 1000000) // give it 1 million ledgers' time (~1 month, suitable for KRS)
+      .fee(tokenParams.openLedgerFee.times(3).toFixed(0)) // the factor three is for the multisigning
+      .sequence(tokenParams.sequenceId);
+
+    const tx = await txBuilder.build();
+    const serializedTx = tx.toBroadcastFormat();
+
+    const { keys, isKrsRecovery, isUnsignedSweep, userAddress, backupAddress } = tokenParams;
 
-    const { keys, isKrsRecovery, userAddress, backupAddress } = tokenParams;
+    if (isUnsignedSweep) {
+      return {
+        txHex: serializedTx,
+        coin: this.getChain(),
+      };
+    }
 
     if (!keys[0].privateKey) {
       throw new Error(`userKey is not a private key`);
     }
 
     const userKey = keys[0].privateKey.toString('hex');
-    const userSignature = ripple.signWithPrivateKey(txJSON, userKey, { signAs: userAddress });
+    const userSignature = ripple.signWithPrivateKey(serializedTx, userKey, { signAs: userAddress });
 
     let signedTransaction: string;
 
@@ -659,7 +667,7 @@ export class Xrp extends BaseCoin {
         throw new Error(`backupKey is not a private key`);
       }
       const backupKey = keys[1].privateKey.toString('hex');
-      const backupSignature = ripple.signWithPrivateKey(txJSON, backupKey, { signAs: backupAddress });
+      const backupSignature = ripple.signWithPrivateKey(serializedTx, backupKey, { signAs: backupAddress });
       signedTransaction = ripple.multisign([userSignature.signedTransaction, backupSignature.signedTransaction]);
     }
 
diff --git a/modules/sdk-coin-xrp/test/resources/xrp.ts b/modules/sdk-coin-xrp/test/resources/xrp.ts
@@ -195,6 +195,105 @@ export const accountlinesResponse = {
   },
 };
 
+export const accountInfoResponseUnsigned = {
+  body: {
+    result: {
+      account_data: {
+        Account: 'raGZWRkRBUWdQJsKYEzwXJNbCZMTqX56aA',
+        Balance: '99997952',
+        Flags: 1179648,
+        LedgerEntryType: 'AccountRoot',
+        OwnerCount: 2,
+        PreviousTxnID: '1216237378659EC1849D45D210B45C96B7B091B4134BA3A00509B8F9DCBA59C4',
+        PreviousTxnLgrSeq: 1851142,
+        Sequence: 807096,
+        index: 'BDD920F6F4C21E2EDF8E604257AB2D3EFF3CD8374330B98989A58E9AB27FDC9D',
+        signer_lists: [
+          {
+            Flags: 65536,
+            LedgerEntryType: 'SignerList',
+            OwnerNode: '0',
+            PreviousTxnID: '1216237378659EC1849D45D210B45C96B7B091B4134BA3A00509B8F9DCBA59C4',
+            PreviousTxnLgrSeq: 1851142,
+            SignerEntries: [
+              {
+                SignerEntry: {
+                  Account: 'rGmQHwvb5SZRbyhp4JBHdpRzSmgqADxPbE',
+                  SignerWeight: 1,
+                },
+              },
+              {
+                SignerEntry: {
+                  Account: 'rGevN87RpWBbdLxKCF4FAqWgRoSyMJA81f',
+                  SignerWeight: 1,
+                },
+              },
+              {
+                SignerEntry: {
+                  Account: 'r3mykfPQZt4eJZKLUGMNVB49eDSJiE9zh3',
+                  SignerWeight: 1,
+                },
+              },
+            ],
+            SignerListID: 0,
+            SignerQuorum: 2,
+            index: '00B47042E37B5F11E6325D7BECAA08D165C6681DB4F6528AF7D1CA6ED50075B7',
+          },
+        ],
+      },
+      account_flags: {
+        allowTrustLineClawback: false,
+        defaultRipple: false,
+        depositAuth: false,
+        disableMasterKey: false,
+        disallowIncomingCheck: false,
+        disallowIncomingNFTokenOffer: false,
+        disallowIncomingPayChan: false,
+        disallowIncomingTrustline: false,
+        disallowIncomingXRP: false,
+        globalFreeze: false,
+        noFreeze: false,
+        passwordSpent: false,
+        requireAuthorization: false,
+        requireDestinationTag: false,
+      },
+      ledger_current_index: 1851200,
+      queue_data: {
+        txn_count: 0,
+      },
+      validated: false,
+    },
+    status: 'success',
+    type: 'response',
+  },
+};
+
+export const accountlinesResponseUnsigned = {
+  body: {
+    result: {
+      account: 'raGZWRkRBUWdQJsKYEzwXJNbCZMTqX56aA',
+      ledger_hash: 'E6F38D1D7B94153BF7FFC8D8CC1DF57D57151D26FC2EB7647B5631786B955EFF',
+      ledger_index: 1848964,
+      lines: [
+        {
+          account: 'rQhWct2fv4Vc4KRjRgMrxa8xPN9Zx9iLKV',
+          balance: '4',
+          currency: '524C555344000000000000000000000000000000',
+          limit: '1000000000',
+          limit_peer: '0',
+          no_ripple: false,
+          no_ripple_peer: false,
+          quality_in: 0,
+          quality_out: 0,
+        },
+      ],
+      validated: true,
+    },
+    status: 'success',
+    type: 'response',
+  },
+};
+
 export const feeResponse = {
   body: {
     id: 'fee_websocket_example',
diff --git a/modules/sdk-coin-xrp/test/unit/xrp.ts b/modules/sdk-coin-xrp/test/unit/xrp.ts
