feat(sdk-coin-stx): modified explain transaction to accomodate token transfer transactions

ravibitgo · ravibitgo · commit ea9014db643a · 2025-03-13T11:21:31.000+05:30
Ticket: COIN-3291
diff --git a/modules/sdk-coin-stx/src/lib/transaction.ts b/modules/sdk-coin-stx/src/lib/transaction.ts
@@ -1,9 +1,12 @@
 import {
   addressToString,
   BufferReader,
+  ContractCallPayload,
   createStacksPrivateKey,
   createStacksPublicKey,
   createTransactionAuthField,
+  cvToString,
+  cvToValue,
   deserializeTransaction,
   isSingleSig,
   MultiSigSpendingCondition,
@@ -13,7 +16,9 @@ import {
   StacksTransaction,
   TransactionSigner,
 } from '@stacks/transactions';
+
 import { BaseCoin as CoinConfig, StacksNetwork } from '@bitgo/statics';
+
 import {
   BaseKey,
   BaseTransaction,
@@ -23,11 +28,13 @@ import {
   SigningError,
   TransactionType,
 } from '@bitgo/sdk-core';
+
+import BigNum from 'bn.js';
+
 import { SignatureData, StacksContractPayload, StacksTransactionPayload, TxData } from './iface';
 import { functionArgsToSendParams, getTxSenderAddress, removeHexPrefix, stringifyCv, unpadMemo } from './utils';
 import { KeyPair } from './keyPair';
-import { ContractCallPayload } from '@stacks/transactions/dist/payload';
-import BigNum from 'bn.js';
+import { FUNCTION_NAME_TRANSFER } from './constants';
 
 export class Transaction extends BaseTransaction {
   private _stxTransaction: StacksTransaction;
@@ -237,6 +244,21 @@ export class Transaction extends BaseTransaction {
         const sum: BigNum = sendParams.reduce((current, next) => current.add(new BigNum(next.amount)), new BigNum(0));
         this._outputs = sendParams.map((sendParam) => ({ address: sendParam.address, value: sendParam.amount, coin }));
         this._inputs = [{ address: txJson.from, value: sum.toString(), coin }];
+      } else if (txJson.payload.functionName === FUNCTION_NAME_TRANSFER && txJson.payload.functionArgs.length >= 3) {
+        this._outputs = [
+          {
+            address: cvToString(txJson.payload.functionArgs[1]),
+            value: cvToValue(txJson.payload.functionArgs[2]).toString(),
+            coin: this._coinConfig.name,
+          },
+        ];
+        this._inputs = [
+          {
+            address: cvToString(txJson.payload.functionArgs[0]),
+            value: cvToValue(txJson.payload.functionArgs[2]).toString(),
+            coin: this._coinConfig.name,
+          },
+        ];
       } else {
         this._outputs = [
           {
diff --git a/modules/sdk-coin-stx/src/stx.ts b/modules/sdk-coin-stx/src/stx.ts
@@ -9,6 +9,7 @@ import {
   VerifyTransactionOptions,
 } from '@bitgo/sdk-core';
 import { BaseCoin as StaticsBaseCoin, CoinFamily, coins } from '@bitgo/statics';
+import { cvToString, cvToValue } from '@stacks/transactions';
 import { ExplainTransactionOptions, StxSignTransactionOptions, StxTransactionExplanation } from './types';
 import { StxLib } from '.';
 
@@ -182,24 +183,41 @@ export class Stx extends BaseCoin {
     const txJson = tx.toJson();
 
     if (tx.type === TransactionType.Send) {
-      const outputs: TransactionRecipient[] = [
-        {
+      // check if it is a token transaction or native coin transaction
+      let transactionRecipient: TransactionRecipient;
+      let outputAmount: string;
+      let memo: string | undefined;
+      if (txJson.payload.contractAddress && txJson.payload.functionArgs.length >= 3) {
+        outputAmount = cvToValue(txJson.payload.functionArgs[2]).toString();
+        transactionRecipient = {
+          address: cvToString(txJson.payload.functionArgs[1]),
+          amount: outputAmount,
+        };
+        if (txJson.payload.functionArgs.length === 4) {
+          memo = txJson.payload.functionArgs[3].buffer.toString('ascii');
+          transactionRecipient['memo'] = memo;
+        }
+      } else {
+        outputAmount = txJson.payload.amount;
+        memo = txJson.payload.memo;
+        transactionRecipient = {
           address: txJson.payload.to,
-          amount: txJson.payload.amount,
-          memo: txJson.payload.memo,
-        },
-      ];
+          amount: outputAmount,
+          memo: memo,
+        };
+      }
+      const outputs: TransactionRecipient[] = [transactionRecipient];
 
       const displayOrder = ['id', 'outputAmount', 'changeAmount', 'outputs', 'changeOutputs', 'fee', 'memo', 'type'];
       return {
         displayOrder,
         id: txJson.id,
-        outputAmount: txJson.payload.amount.toString(),
+        outputAmount: outputAmount.toString(),
         changeAmount: '0',
         outputs,
         changeOutputs: [],
         fee: txJson.fee,
-        memo: txJson.payload.memo,
+        memo: memo,
         type: tx.type,
       };
     }
diff --git a/modules/sdk-coin-stx/test/fixtures.ts b/modules/sdk-coin-stx/test/fixtures.ts
@@ -30,3 +30,34 @@ export const unsignedTxExplainedTransfer = {
   recipient: 'STDE7Y8HV3RX8VBM2TZVWJTS7ZA1XB0SSC3NEVH0',
   sender: 'STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6',
 };
+
+export const txForExplainFungibleTokenTransfer =
+  '808000000004012fe507c09dbb23c3b7e5d166c81fc4b87692510b000000000000000000000000000000b4000000030200ffa41419c088011baffa87d0113257dbf2033e19ffd5098e9c3e1d8bc606f5e97519688630d57154fcad34967ea04246fe5127203c9971e0b1426cdbd6c132d502004fed6b5699e3211629ad182bf53392374a72e692eb4afe770ffa1fd715661c5706ec16854d14028c49d54806b34b89f108f76d39f2a7675589a94a179bba0ed100038e3c4529395611be9abf6fa3b6987e81d402385e3d605a073f42f407565a4a3d0002030200000000021a1500a1c42f0c11bfe3893f479af18904677685be0d747369703664702d746f6b656e087472616e7366657200000004051a1500a1c42f0c11bfe3893f479af18904677685be0515ab50cac953ac55edc14e2b236854b1ead863fece0100000000000000000000000000002710020000000131';
+
+export const fungibleTokenTransferTx = {
+  id: 'f2ea2261c3d66b87ffe67dedbf36e8ab00762bd6fa8d8fafdf6299c56deb1ebf',
+  fee: '180',
+  contractAddress: 'STAG18E45W613FZ3H4ZMF6QHH426EXM5QTSAVWYH',
+  contractName: 'tsip6dp-token',
+  functionName: 'transfer',
+  functionArgs: [
+    {
+      type: 5,
+      address: {
+        type: 0,
+        version: 26,
+        hash160: '1500a1c42f0c11bfe3893f479af18904677685be',
+      },
+    },
+    {
+      type: 5,
+      address: {
+        type: 0,
+        version: 21,
+        hash160: 'ab50cac953ac55edc14e2b236854b1ead863fece',
+      },
+    },
+    { type: 1, value: '10000' },
+    { type: 2 },
+  ],
+};
diff --git a/modules/sdk-coin-stx/test/unit/stx.ts b/modules/sdk-coin-stx/test/unit/stx.ts
@@ -1,10 +1,13 @@
-import { TestBitGo, TestBitGoAPI } from '@bitgo/sdk-test';
+import assert from 'assert';
+
 import { BitGoAPI } from '@bitgo/sdk-api';
+import { Wallet } from '@bitgo/sdk-core';
+import { TestBitGo, TestBitGoAPI } from '@bitgo/sdk-test';
 import { coins } from '@bitgo/statics';
+import { cvToString } from '@stacks/transactions';
+
 import * as testData from '../fixtures';
 import { Stx, Tstx, StxLib } from '../../src';
-import assert from 'assert';
-import { Wallet } from '@bitgo/sdk-core';
 
 const { KeyPair } = StxLib;
 
@@ -190,6 +193,20 @@ describe('STX:', function () {
     explain.contractFunctionArgs[0].value.toString().should.equal(testData.txExplainedContract.functionArgs[0].value);
   });
 
+  it('should explain a fungible token transfer transaction', async function () {
+    const explain = await basecoin.explainTransaction({
+      txHex: testData.txForExplainFungibleTokenTransfer,
+      feeInfo: { fee: '' },
+    });
+    explain.id.should.equal(testData.fungibleTokenTransferTx.id);
+    explain.fee.should.equal(testData.fungibleTokenTransferTx.fee);
+    explain.memo.should.equal('1');
+    explain.outputAmount.should.equal(testData.fungibleTokenTransferTx.functionArgs[2].value);
+    explain.outputs[0].amount.should.equal(testData.fungibleTokenTransferTx.functionArgs[2].value);
+    explain.outputs[0].address.should.equal(cvToString(testData.fungibleTokenTransferTx.functionArgs[1]));
+    explain.outputs[0].memo.should.equal('1');
+  });
+
   describe('Keypairs:', () => {
     it('should generate a keypair from random seed', function () {
       const keyPair = basecoin.generateKeyPair();
diff --git a/modules/sdk-coin-stx/test/unit/transactionBuilder/fungibleTokenTransferBuilder.ts b/modules/sdk-coin-stx/test/unit/transactionBuilder/fungibleTokenTransferBuilder.ts
@@ -74,11 +74,11 @@ describe('Stacks: Fungible Token Transfer Builder', () => {
 
         tx.type.should.equal(TransactionType.Send);
         tx.outputs.length.should.equal(1);
-        tx.outputs[0].address.should.equal(testData.FUNGIBLE_TOKEN_TRANSFER_CONSTANTS.CONTRACT_ADDRESS);
-        tx.outputs[0].value.should.equal('0');
+        tx.outputs[0].address.should.equal(testData.FUNGIBLE_TOKEN_TRANSFER_CONSTANTS.RECEIVER_ADDRESS);
+        tx.outputs[0].value.should.equal('10000');
         tx.inputs.length.should.equal(1);
-        tx.inputs[0].address.should.equal(testData.TX_SENDER.address);
-        tx.inputs[0].value.should.equal('0');
+        tx.inputs[0].address.should.equal(testData.FUNGIBLE_TOKEN_TRANSFER_CONSTANTS.SENDER_ADDRESS);
+        tx.inputs[0].value.should.equal('10000');
       });
 
       it('an unsigned fungible token transfer transaction without memo', async () => {
@@ -105,11 +105,11 @@ describe('Stacks: Fungible Token Transfer Builder', () => {
 
         tx.type.should.equal(TransactionType.Send);
         tx.outputs.length.should.equal(1);
-        tx.outputs[0].address.should.equal(testData.FUNGIBLE_TOKEN_TRANSFER_CONSTANTS.CONTRACT_ADDRESS);
-        tx.outputs[0].value.should.equal('0');
+        tx.outputs[0].address.should.equal(testData.FUNGIBLE_TOKEN_TRANSFER_CONSTANTS.RECEIVER_ADDRESS);
+        tx.outputs[0].value.should.equal('10000');
         tx.inputs.length.should.equal(1);
-        tx.inputs[0].address.should.equal(testData.TX_SENDER.address);
-        tx.inputs[0].value.should.equal('0');
+        tx.inputs[0].address.should.equal(testData.FUNGIBLE_TOKEN_TRANSFER_CONSTANTS.SENDER_ADDRESS);
+        tx.inputs[0].value.should.equal('10000');
       });
 
       it('a multisig fungible token transfer transaction', async () => {
