Merge pull request #5900 from BitGo/COIN-3733-fungible-bug

fix(sdk-coin-apt): fungible fix verify transaction flow

Author: baltiyal

modules/sdk-coin-apt/src/apt.ts

@@ -15,7 +15,7 @@ import {
   VerifyTransactionOptions,
 } from '@bitgo/sdk-core';
 import { BaseCoin as StaticsBaseCoin, coins } from '@bitgo/statics';
-import { KeyPair as AptKeyPair, Transaction, TransactionBuilderFactory, TransferTransaction } from './lib';
+import { KeyPair as AptKeyPair, TransactionBuilderFactory } from './lib';
 import utils from './lib/utils';
 import * as _ from 'lodash';
 import BigNumber from 'bignumber.js';
@@ -79,20 +79,16 @@ export class Apt extends BaseCoin {
     return true;
   }
 
-  getTransaction(coinConfig: Readonly<StaticsBaseCoin>): Transaction {
-    return new TransferTransaction(coinConfig);
-  }
-
   async verifyTransaction(params: VerifyTransactionOptions): Promise<boolean> {
-    const coinConfig = coins.get(this.getChain());
     const { txPrebuild: txPrebuild, txParams: txParams } = params;
-    const transaction = this.getTransaction(coinConfig);
-    const rawTx = txPrebuild.txHex;
-    if (!rawTx) {
+    const txHex = txPrebuild.txHex;
+    if (!txHex) {
       throw new Error('missing required tx prebuild property txHex');
     }
-    transaction.fromRawTransaction(rawTx);
-    const explainedTx = transaction.explainTransaction();
+    const explainedTx = await this.explainTransaction({ txHex });
+    if (!explainedTx) {
+      throw new Error('failed to explain transaction');
+    }
     if (txParams.recipients !== undefined) {
       const filteredRecipients = txParams.recipients?.map((recipient) => {
         return {
@@ -155,11 +151,9 @@ export class Apt extends BaseCoin {
    * @param params
    */
   async explainTransaction(params: ExplainTransactionOptions): Promise<AptTransactionExplanation | undefined> {
-    const factory = this.getBuilder();
     let rebuiltTransaction: BaseTransaction;
     try {
-      const transactionBuilder = factory.from(params.txHex);
-      rebuiltTransaction = await transactionBuilder.build();
+      rebuiltTransaction = await this.rebuildTransaction(params.txHex);
     } catch {
       return undefined;
     }
@@ -190,7 +184,17 @@ export class Apt extends BaseCoin {
     throw new Error('Method not implemented.');
   }
 
-  private getBuilder(): TransactionBuilderFactory {
+  protected getTxBuilderFactory(): TransactionBuilderFactory {
     return new TransactionBuilderFactory(coins.get(this.getChain()));
   }
+
+  protected async rebuildTransaction(txHex: string): Promise<BaseTransaction> {
+    const txBuilderFactory = this.getTxBuilderFactory();
+    try {
+      const txBuilder = txBuilderFactory.from(txHex);
+      return await txBuilder.build();
+    } catch {
+      throw new Error('Failed to rebuild transaction');
+    }
+  }
 }

modules/sdk-coin-apt/src/aptToken.ts

@@ -1,7 +1,6 @@
 import { Apt } from './apt';
 import { BitGoBase, CoinConstructor, NamedCoinConstructor } from '@bitgo/sdk-core';
-import { AptTokenConfig, BaseCoin as StaticsBaseCoin, coins, tokens } from '@bitgo/statics';
-import { FungibleAssetTransfer, Transaction } from './lib';
+import { AptTokenConfig, coins, tokens } from '@bitgo/statics';
 
 export class AptToken extends Apt {
   public readonly tokenConfig: AptTokenConfig;
@@ -46,10 +45,6 @@ export class AptToken extends Apt {
     return this.tokenConfig.decimalPlaces;
   }
 
-  getTransaction(coinConfig: Readonly<StaticsBaseCoin>): Transaction {
-    return new FungibleAssetTransfer(coinConfig);
-  }
-
   getChain(): string {
     return this.tokenConfig.type;
   }

modules/sdk-coin-apt/src/lib/transactionBuilderFactory.ts

@@ -19,7 +19,7 @@ export class TransactionBuilderFactory extends BaseTransactionBuilderFactory {
   /** @inheritdoc */
   from(signedRawTxn: string): TransactionBuilder {
     try {
-      const signedTxn = this.parseTransaction(signedRawTxn);
+      const signedTxn = Transaction.deserializeSignedTransaction(signedRawTxn);
       const txnType = this.getTransactionTypeFromSignedTxn(signedTxn);
       switch (txnType) {
         case TransactionType.Send:
@@ -80,13 +80,4 @@ export class TransactionBuilderFactory extends BaseTransactionBuilderFactory {
     }
     return builder;
   }
-
-  /** Parse the transaction from a signed txn hex string
-   *
-   * @param {string} signedRawTransaction - the signed txn hex
-   * @returns {SignedTransaction} parsedtransaction
-   */
-  private parseTransaction(signedRawTransaction: string): SignedTransaction {
-    return Transaction.deserializeSignedTransaction(signedRawTransaction);
-  }
 }

modules/sdk-coin-apt/test/unit/apt.ts

@@ -35,6 +35,16 @@ describe('APT:', function () {
     recipients: testData.recipients,
   };
 
+  const batchFungibleTxPrebuild = {
+    txHex: testData.FUNGIBLE_BATCH_RAW_TX_HEX,
+    txInfo: {},
+  };
+
+  const batchFungibleTxParams = {
+    recipients: testData.batchFungibleRecipients,
+    type: 'transfer',
+  };
+
   before(function () {
     bitgo = TestBitGo.decorate(BitGoAPI, { env: 'mock' });
     bitgo.safeRegister('apt', Apt.createInstance);
@@ -96,6 +106,16 @@ describe('APT:', function () {
       isTransactionVerified.should.equal(true);
     });
 
+    it('should succeed to verify fungible transaction', async function () {
+      const verification = {};
+      const isTransactionVerified = await basecoin.verifyTransaction({
+        txPrebuild: batchFungibleTxPrebuild,
+        txParams: batchFungibleTxParams,
+        verification,
+      });
+      isTransactionVerified.should.equal(true);
+    });
+
     it('should succeed to verify transaction when recipients amount are numbers', async function () {
       const txPrebuild = newTxPrebuild();
       const txParamsWithNumberAmounts = newTxParams();