Merge pull request #6721 from BitGo/WIN-6761

fix(sdk-coin-tao): fix toJson & explainTransaction for token transfers

Author: hitansh-madan

modules/sdk-coin-tao/src/lib/iface.ts

@@ -0,0 +1,9 @@
+import { Interface } from '@bitgo/abstract-substrate';
+
+export interface TransferStakeTxData extends Interface.TxData {
+  destinationColdkey: string;
+  hotkey: string;
+  originNetuid: string;
+  destinationNetuid: string;
+  alphaAmount: string;
+}

modules/sdk-coin-tao/src/lib/tokenTransferBuilder.ts

@@ -1,8 +1,9 @@
+import { Interface, Schema, Transaction, TransactionBuilder } from '@bitgo/abstract-substrate';
+import { InvalidTransactionError, TransactionType } from '@bitgo/sdk-core';
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
-import { defineMethod, UnsignedTransaction, DecodedSignedTx, DecodedSigningPayload } from '@substrate/txwrapper-core';
+import { DecodedSignedTx, DecodedSigningPayload, defineMethod, UnsignedTransaction } from '@substrate/txwrapper-core';
 import BigNumber from 'bignumber.js';
-import { InvalidTransactionError, TransactionType } from '@bitgo/sdk-core';
-import { TransactionBuilder, Interface, Schema, Transaction } from '@bitgo/abstract-substrate';
+import { TokenTransferTransaction } from './tokenTransferTransaction';
 
 export class TokenTransferBuilder extends TransactionBuilder {
   protected _destinationColdkey: string;
@@ -13,6 +14,7 @@ export class TokenTransferBuilder extends TransactionBuilder {
 
   constructor(_coinConfig: Readonly<CoinConfig>) {
     super(_coinConfig);
+    this._transaction = new TokenTransferTransaction(_coinConfig);
   }
 
   /**

modules/sdk-coin-tao/src/lib/tokenTransferTransaction.ts

@@ -0,0 +1,80 @@
+import { Interface as SubstrateInterface, Transaction as SubstrateTransaction } from '@bitgo/abstract-substrate';
+import { InvalidTransactionError, TransactionRecipient } from '@bitgo/sdk-core';
+import { decode } from '@substrate/txwrapper-polkadot';
+import { TransferStakeTxData } from './iface';
+import utils from './utils';
+
+export class TokenTransferTransaction extends SubstrateTransaction {
+  /** @inheritdoc */
+  toJson(): SubstrateInterface.TxData {
+    if (!this._substrateTransaction) {
+      throw new InvalidTransactionError('Empty transaction');
+    }
+
+    const decodedTx = decode(this._substrateTransaction, {
+      metadataRpc: this._substrateTransaction.metadataRpc,
+      registry: this._registry,
+      isImmortalEra: utils.isZeroHex(this._substrateTransaction.era),
+    }) as unknown as SubstrateInterface.DecodedTx;
+    const txMethod = decodedTx.method.args as SubstrateInterface.TransferStakeArgs;
+
+    const result = super.toJson() as TransferStakeTxData;
+    result.destinationColdkey = txMethod.destinationColdkey;
+    result.hotkey = txMethod.hotkey;
+    result.originNetuid = txMethod.originNetuid;
+    result.destinationNetuid = txMethod.destinationNetuid;
+    result.alphaAmount = txMethod.alphaAmount;
+
+    return result;
+  }
+
+  /** @inheritdoc */
+  loadInputsAndOutputs(): void {
+    super.loadInputsAndOutputs();
+
+    const decodedTx = decode(this._substrateTransaction, {
+      metadataRpc: this._substrateTransaction.metadataRpc,
+      registry: this._registry,
+      isImmortalEra: utils.isZeroHex(this._substrateTransaction.era),
+    }) as unknown as SubstrateInterface.DecodedTx;
+    const txMethod = decodedTx.method.args as SubstrateInterface.TransferStakeArgs;
+
+    this._inputs.push({
+      address: this._sender,
+      value: txMethod.alphaAmount,
+      coin: utils.getTaoTokenBySubnetId(txMethod.originNetuid).name,
+    });
+
+    this._outputs.push({
+      address: txMethod.destinationColdkey,
+      value: txMethod.alphaAmount,
+      coin: utils.getTaoTokenBySubnetId(txMethod.destinationNetuid).name,
+    });
+  }
+
+  /** @inheritdoc */
+  explainTransaction(): SubstrateInterface.TransactionExplanation {
+    const result = this.toJson();
+    const outputs: TransactionRecipient[] = this._outputs.map((output) => {
+      return {
+        address: output.address,
+        amount: output.value,
+        tokenName: output.coin,
+      };
+    });
+
+    const explanationResult: SubstrateInterface.TransactionExplanation = {
+      id: result.id,
+      outputAmount: result.amount?.toString() || '0',
+      changeAmount: '0',
+      changeOutputs: [],
+      outputs,
+      fee: {
+        fee: result.tip?.toString() || '',
+        type: 'tip',
+      },
+      type: this.type,
+    };
+    return explanationResult;
+  }
+}

modules/sdk-coin-tao/src/lib/utils.ts

@@ -1,11 +1,20 @@
-import { Utils as SubstrateUtils, Interface } from '@bitgo/abstract-substrate';
-import { NetworkType } from '@bitgo/statics';
+import { Interface, Utils as SubstrateUtils } from '@bitgo/abstract-substrate';
+import { BaseCoin as CoinConfig, coins, NetworkType, TaoCoin } from '@bitgo/statics';
+import assert from 'assert';
 import { mainnetMaterial, testnetMaterial } from '../resources';
 
 export class Utils extends SubstrateUtils {
   getMaterial(networkType: NetworkType): Interface.Material {
     return (networkType === NetworkType.MAINNET ? mainnetMaterial : testnetMaterial) as unknown as Interface.Material;
   }
+
+  getTaoTokenBySubnetId(subnetId: string): Readonly<CoinConfig> {
+    const tokens = coins.filter((coin) => coin instanceof TaoCoin && coin.subnetId === subnetId).map((coin) => coin);
+
+    assert(tokens.length > 0, `No Tao token found for subnetId: ${subnetId}`);
+    assert(tokens.length === 1, `Multiple Tao tokens found for subnetId: ${subnetId}`);
+    return tokens[0];
+  }
 }
 
 const utils = new Utils();

modules/sdk-coin-tao/test/resources/index.ts

@@ -176,8 +176,8 @@ export const rawTx = {
       '0x9806129f7b0675db59d19b4bd9c8c72eaabba75a9863d02b30115b8b3c3ca5c20f025422130000d501210300c823000009000000e143f23803ac50e8f6f8e62695d1ce9e4e1d68aa36c1cd2cfd15340213f3423e149799bc9602cb5cf201f3425fb8d253b2d4e61fc119dcab3249f307f594754d',
   },
   transferStake: {
-    unsigned:
-      '0xdd02840061b18c6dc02ddcabdeac56cb4f21a971cc41cc97640f6f85b073480008c53a0d00aadae7fa1f53e7a5c900b330ff71bee6782cf3c29a2c6f9599162381cd021ad581c74ded89f49ec79adefed64af8ff16649553523dda9cb4f017cbf15681e50ed5012103000007569f7b0675db59d19b4bd9c8c72eaabba75a9863d02b30115b8b3c3ca5c20f02548a90be061598f4b592afbd546bcb6beadb3c02f5c129df2e11b698f9543dbd41010002000300000000002000',
+    signed:
+      '0xdd02840061b18c6dc02ddcabdeac56cb4f21a971cc41cc97640f6f85b073480008c53a0d00aadae7fa1f53e7a5c900b330ff71bee6782cf3c29a2c6f9599162381cd021ad581c74ded89f49ec79adefed64af8ff16649553523dda9cb4f017cbf15681e50ed5012103000007569f7b0675db59d19b4bd9c8c72eaabba75a9863d02b30115b8b3c3ca5c20f02548a90be061598f4b592afbd546bcb6beadb3c02f5c129df2e11b698f9543dbd41010001000300000000002000',
   },
 };
 

modules/sdk-coin-tao/test/unit/transactionBuilder/tokenTransferBuilder.ts

@@ -1,10 +1,10 @@
 import assert from 'assert';
 import should from 'should';
-import { spy, assert as SinonAssert } from 'sinon';
+import { assert as SinonAssert, spy } from 'sinon';
+import { TokenTransferBuilder } from '../../../src/lib/tokenTransferBuilder';
+import utils from '../../../src/lib/utils';
 import { accounts, mockTssSignature, rawTx } from '../../resources';
 import { buildTestConfig } from './base';
-import utils from '../../../src/lib/utils';
-import { TokenTransferBuilder } from '../../../src/lib/tokenTransferBuilder';
 
 describe('Tao Token Transfer Builder', function () {
   const referenceBlock = '0x149799bc9602cb5cf201f3425fb8d253b2d4e61fc119dcab3249f307f594754d';
@@ -52,7 +52,7 @@ describe('Tao Token Transfer Builder', function () {
         .destinationColdkey('5Ffp1wJCPu4hzVDTo7XaMLqZSvSadyUQmxWPDw74CBjECSoq')
         .hotkey('5FCPTnjevGqAuTttetBy4a24Ej3pH9fiQ8fmvP1ZkrVsLUoT')
         .originNetuid('1')
-        .destinationNetuid('2')
+        .destinationNetuid('1')
         .sender({ address: sender.address })
         .validity({ firstValid: 3933, maxDuration: 64 })
         .referenceBlock(referenceBlock)
@@ -62,15 +62,43 @@ describe('Tao Token Transfer Builder', function () {
 
       const tx = await builder.build();
       const serializedTx = tx.toBroadcastFormat();
-      serializedTx.should.equal(rawTx.transferStake.unsigned);
+
+      serializedTx.should.equal(rawTx.transferStake.signed);
+      tx.toJson().should.deepEqual({
+        id: '0xe5ce9ff1bbdf54d1dbd5adee8648027aa7efa99d319b041afb4b57be2042fc11',
+        sender: '5EGoFA95omzemRssELLDjVenNZ68aXyUeqtKQScXSEBvVJkr',
+        referenceBlock: '0x149799bc9602cb5cf201f3425fb8d253b2d4e61fc119dcab3249f307f594754d',
+        blockNumber: 3933,
+        genesisHash: '0x8f9cf856bf558a14440e75569c9e58594757048d7b3a84b5d25f6bd978263105',
+        nonce: 200,
+        specVersion: 224,
+        transactionVersion: 1,
+        eraPeriod: 64,
+        chainName: 'Bittensor',
+        tip: 0,
+        destinationColdkey: '5Ffp1wJCPu4hzVDTo7XaMLqZSvSadyUQmxWPDw74CBjECSoq',
+        hotkey: '5FCPTnjevGqAuTttetBy4a24Ej3pH9fiQ8fmvP1ZkrVsLUoT',
+        originNetuid: '1',
+        destinationNetuid: '1',
+        alphaAmount: '9007199254740995',
+      });
+      tx.explainTransaction().should.containDeep({
+        outputs: [
+          {
+            address: '5Ffp1wJCPu4hzVDTo7XaMLqZSvSadyUQmxWPDw74CBjECSoq',
+            amount: '9007199254740995',
+            tokenName: 'ttao:apex',
+          },
+        ],
+      });
     });
 
     it('should re-build from raw signed tx', async function () {
-      builder.from(rawTx.transferStake.unsigned);
+      builder.from(rawTx.transferStake.signed);
       builder.validity({ firstValid: 3933, maxDuration: 64 }).referenceBlock(referenceBlock);
       const tx = await builder.build();
       const serializedTx = tx.toBroadcastFormat();
-      serializedTx.should.equal(rawTx.transferStake.unsigned);
+      serializedTx.should.equal(rawTx.transferStake.signed);
     });
   });
 });