Merge pull request #5872 from BitGo/COIN-3609

fix(sdk-coin-stx): handling noneCV for sip10

Author: ravibitgo

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

@@ -11,7 +11,7 @@ import {
   VerifyTransactionOptions,
 } from '@bitgo/sdk-core';
 import { BaseCoin as StaticsBaseCoin, CoinFamily, coins } from '@bitgo/statics';
-import { cvToString, cvToValue } from '@stacks/transactions';
+import { ClarityType, cvToString, cvToValue } from '@stacks/transactions';
 
 import { ExplainTransactionOptions, StxSignTransactionOptions, StxTransactionExplanation } from './types';
 import { StxLib } from '.';
@@ -214,7 +214,10 @@ export class Stx extends BaseCoin {
           amount: outputAmount,
           tokenName: findTokenNameByContract(txJson.payload.contractAddress, txJson.payload.contractName),
         };
-        if (txJson.payload.functionArgs.length === 4) {
+        if (
+          txJson.payload.functionArgs.length === 4 &&
+          txJson.payload.functionArgs[3].type === ClarityType.OptionalSome
+        ) {
           memo = Buffer.from(txJson.payload.functionArgs[3].value.buffer).toString();
           transactionRecipient['memo'] = memo;
         }

modules/sdk-coin-stx/test/fixtures.ts

@@ -38,10 +38,10 @@ export const txForExplainFungibleTokenTransfer =
 export const txForExplainFungibleTokenTransferWithMemoId10 =
   '808000000004012fe507c09dbb23c3b7e5d166c81fc4b87692510b000000000000000000000000000000b400000003020130831ab5d8fc925e088931b2eb86efcd054612293aa8a0156dfa50f44b54b6776683d2463783a10ee358d565ac74e4004c9cd0a96674cb5726ac1fc848e6f00c0201a76e30fa14ca3528ebb3a3aa92cc2e202592747c2b7028d4a3791663c3361f6d2d6fd44617a0775f58076ad119f923b27d1ca3ef63273910e7a8f91d59b5ee0900038e3c4529395611be9abf6fa3b6987e81d402385e3d605a073f42f407565a4a3d00020302000000010102152fe507c09dbb23c3b7e5d166c81fc4b87692510b1a1500a1c42f0c11bfe3893f479af18904677685be0d747369703664702d746f6b656e0d747369703664702d746f6b656e010000000000002710021a1500a1c42f0c11bfe3893f479af18904677685be0d747369703664702d746f6b656e087472616e73666572000000040100000000000000000000000000002710051a1500a1c42f0c11bfe3893f479af18904677685be0515ab50cac953ac55edc14e2b236854b1ead863fece0a02000000023130';
 export const txForExplainFungibleTokenTransferWithoutMemo =
-  '808000000004012fe507c09dbb23c3b7e5d166c81fc4b87692510b000000000000000000000000000000b4000000030200125aadf265dc67bae4e08cffd42795a05745d9ad345ab582a0ad4ceedec79e1c26111d6a5058bb9aac355a007bad9b81c2f90026864fa1f2dbe13a29fbcea60f02013d603fedc49e7040607c6e091e81557a31b1832eef3ca7a6ab10105e95e226fd5fe2c7c97b7ca0dabc17af6ca0dcb7133dac7d24951b4b410ff9092f566a5ca000038e3c4529395611be9abf6fa3b6987e81d402385e3d605a073f42f407565a4a3d00020302000000010102152fe507c09dbb23c3b7e5d166c81fc4b87692510b1a1500a1c42f0c11bfe3893f479af18904677685be0d747369703664702d746f6b656e0d747369703664702d746f6b656e010000000000002710021a1500a1c42f0c11bfe3893f479af18904677685be0d747369703664702d746f6b656e087472616e73666572000000030100000000000000000000000000002710051a1500a1c42f0c11bfe3893f479af18904677685be0515ab50cac953ac55edc14e2b236854b1ead863fece';
+  '808000000004012fe507c09dbb23c3b7e5d166c81fc4b87692510b000000000000000000000000000000b4000000030200d12a80f67cdac72ad116075e86846986a015a60bf541855ea17ddc79620b679b0d75e523cbc7638969addeb047e73ed11b398a894b2fd4459623afb2fc10461b02007e01f28f9ac5b9bc32f3de826f69aabcc6b357faa50d98087ff12714eb3d351e515482aff784b54ab572ce6f86c1f40c71b21fd197e846fb388718f55f17d4d300038e3c4529395611be9abf6fa3b6987e81d402385e3d605a073f42f407565a4a3d00020302000000010102152fe507c09dbb23c3b7e5d166c81fc4b87692510b1a1500a1c42f0c11bfe3893f479af18904677685be0d747369703664702d746f6b656e0d747369703664702d746f6b656e010000000000002710021a1500a1c42f0c11bfe3893f479af18904677685be0d747369703664702d746f6b656e087472616e73666572000000040100000000000000000000000000002710051a1500a1c42f0c11bfe3893f479af18904677685be0515ab50cac953ac55edc14e2b236854b1ead863fece09';
 export const txForExplainFungibleTokenTransferWithMemoZero =
   '808000000004012fe507c09dbb23c3b7e5d166c81fc4b87692510b000000000000000000000000000000b4000000030200ce306873b8a41b66676f0dcf8cc933eedc15b52fb24e41495d43edecfa2e9e3e291a898724a997c223178910405939ffcd57264bdc0d08de6bfc402385a57edc02010e0fd2bae5af96bbbb49de41bf965cd47e2f9d93018189cc7e5642536c309a527c701d0e5f5ae44cd30c411323b09112f6f23f372a0c5d1d7713922c2a275a7500038e3c4529395611be9abf6fa3b6987e81d402385e3d605a073f42f407565a4a3d00020302000000010102152fe507c09dbb23c3b7e5d166c81fc4b87692510b1a1500a1c42f0c11bfe3893f479af18904677685be0d747369703664702d746f6b656e0d747369703664702d746f6b656e010000000000002710021a1500a1c42f0c11bfe3893f479af18904677685be0d747369703664702d746f6b656e087472616e73666572000000040100000000000000000000000000002710051a1500a1c42f0c11bfe3893f479af18904677685be0515ab50cac953ac55edc14e2b236854b1ead863fece0a020000000130';
-
+export const hexWithoutMemoTransferId = '463377e1bff7fb4124108d160a4e42fe0ed57e69842b1c02fa6181ba345c49c6';
 export const fungibleTokenTransferTx = {
   id: '2bf5277ac7cd57741163d85b78905c97e55f05887369e3908450e4050aa4cf01',
   fee: '180',

modules/sdk-coin-stx/test/unit/resources.ts

@@ -189,4 +189,6 @@ export const FUNGIBLE_TOKEN_TRANSFER_CONSTANTS = {
     '80800000000400164247d6f2b425ac5771423ae6c80c754f7172b0000000000000000000000000000000b4000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000030200000001010215164247d6f2b425ac5771423ae6c80c754f7172b01a1500a1c42f0c11bfe3893f479af18904677685be0d747369703664702d746f6b656e0d747369703664702d746f6b656e010000000000002710021a1500a1c42f0c11bfe3893f479af18904677685be0d747369703664702d746f6b656e087472616e73666572000000030100000000000000000000000000002710051a1500a1c42f0c11bfe3893f479af18904677685be0515ab50cac953ac55edc14e2b236854b1ead863fece',
   SIGNED_MULTI_SIG_TX:
     '808000000004012fe507c09dbb23c3b7e5d166c81fc4b87692510b000000000000000000000000000000b4000000030201e4c98d7687eab5f11d03febc96951301eede336088b06c5a676cc6093f70e16b3f3533ccd8e6f92390a17dcc917f4e828657f17605574a5fcbb3da59f25483dc02019095c2f5217e0f168f27b605b47e9eac2da3c5ea309c42a2677addfb67c1fd471ef20187ce6b85b5b541d4b4f00d2f8ea8f7d42be84327968cb9411730b5217a00038e3c4529395611be9abf6fa3b6987e81d402385e3d605a073f42f407565a4a3d00020302000000010102152fe507c09dbb23c3b7e5d166c81fc4b87692510b1a1500a1c42f0c11bfe3893f479af18904677685be0d747369703664702d746f6b656e0d747369703664702d746f6b656e010000000000002710021a1500a1c42f0c11bfe3893f479af18904677685be0d747369703664702d746f6b656e087472616e73666572000000040100000000000000000000000000002710051a1500a1c42f0c11bfe3893f479af18904677685be0515ab50cac953ac55edc14e2b236854b1ead863fece0a020000000131',
+  SIGNED_MULTI_SIG_TX_WITHOUT_MEMO:
+    '808000000004012fe507c09dbb23c3b7e5d166c81fc4b87692510b000000000000000000000000000000b4000000030200d12a80f67cdac72ad116075e86846986a015a60bf541855ea17ddc79620b679b0d75e523cbc7638969addeb047e73ed11b398a894b2fd4459623afb2fc10461b02007e01f28f9ac5b9bc32f3de826f69aabcc6b357faa50d98087ff12714eb3d351e515482aff784b54ab572ce6f86c1f40c71b21fd197e846fb388718f55f17d4d300038e3c4529395611be9abf6fa3b6987e81d402385e3d605a073f42f407565a4a3d00020302000000010102152fe507c09dbb23c3b7e5d166c81fc4b87692510b1a1500a1c42f0c11bfe3893f479af18904677685be0d747369703664702d746f6b656e0d747369703664702d746f6b656e010000000000002710021a1500a1c42f0c11bfe3893f479af18904677685be0d747369703664702d746f6b656e087472616e73666572000000040100000000000000000000000000002710051a1500a1c42f0c11bfe3893f479af18904677685be0515ab50cac953ac55edc14e2b236854b1ead863fece09',
 };

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

@@ -193,7 +193,7 @@ 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 () {
+  it('should explain a fungible token transfer transaction with memo', async function () {
     const explain = await basecoin.explainTransaction({
       txHex: testData.txForExplainFungibleTokenTransfer,
       feeInfo: { fee: '' },
@@ -208,6 +208,21 @@ describe('STX:', function () {
     explain.outputs[0].tokenName.should.equal(testData.fungibleTokenTransferTx.tokenName);
   });
 
+  it('should explain a fungible token transfer transaction without memo', async function () {
+    const explain = await basecoin.explainTransaction({
+      txHex: testData.txForExplainFungibleTokenTransferWithoutMemo,
+      feeInfo: { fee: '' },
+    });
+    explain.id.should.equal(testData.hexWithoutMemoTransferId);
+    explain.fee.should.equal(testData.fungibleTokenTransferTx.fee);
+    assert.deepEqual(explain.memo, undefined, 'memo should be undefined');
+    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]));
+    assert.deepEqual(explain.outputs[0].memo, undefined, 'memo should be undefined');
+    explain.outputs[0].tokenName.should.equal(testData.fungibleTokenTransferTx.tokenName);
+  });
+
   describe('Keypairs:', () => {
     it('should generate a keypair from random seed', function () {
       const keyPair = basecoin.generateKeyPair();

modules/sdk-coin-stx/test/unit/transactionBuilder/fungibleTokenTransferBuilder.ts

@@ -1,7 +1,7 @@
 import { TestBitGo, TestBitGoAPI } from '@bitgo/sdk-test';
 import { BitGoAPI } from '@bitgo/sdk-api';
 import { coins } from '@bitgo/statics';
-import { bufferCVFromString, someCV, standardPrincipalCV, uintCV } from '@stacks/transactions';
+import { bufferCVFromString, noneCV, someCV, standardPrincipalCV, uintCV } from '@stacks/transactions';
 import should from 'should';
 import { StacksMainnet, StacksTestnet } from '@stacks/network';
 import { TransactionType } from '@bitgo/sdk-core';
@@ -115,7 +115,7 @@ describe('Stacks: Fungible Token Transfer Builder', () => {
         tx.inputs[0].value.should.equal('10000');
       });
 
-      it('a multisig fungible token transfer transaction', async () => {
+      it('a multisig fungible token transfer transaction with memo', async () => {
         const builder = initTxBuilder();
         builder.functionArgs([
           uintCV('10000'),
@@ -132,6 +132,27 @@ describe('Stacks: Fungible Token Transfer Builder', () => {
         JSON.stringify(tx.toJson());
         should.deepEqual(tx.toBroadcastFormat(), testData.FUNGIBLE_TOKEN_TRANSFER_CONSTANTS.SIGNED_MULTI_SIG_TX);
       });
+
+      it('a multisig fungible token transfer transaction without memo', async () => {
+        const builder = initTxBuilder();
+        builder.functionArgs([
+          uintCV('10000'),
+          standardPrincipalCV(testData.FUNGIBLE_TOKEN_TRANSFER_CONSTANTS.SENDER_ADDRESS),
+          standardPrincipalCV(testData.FUNGIBLE_TOKEN_TRANSFER_CONSTANTS.RECEIVER_ADDRESS),
+          noneCV(),
+        ]);
+
+        builder.sign({ key: testData.prv1 });
+        builder.sign({ key: testData.prv2 });
+        builder.fromPubKey([testData.pub1, testData.pub2, testData.pub3]);
+        builder.numberSignatures(2);
+        const tx = await builder.build();
+        JSON.stringify(tx.toJson());
+        should.deepEqual(
+          tx.toBroadcastFormat(),
+          testData.FUNGIBLE_TOKEN_TRANSFER_CONSTANTS.SIGNED_MULTI_SIG_TX_WITHOUT_MEMO
+        );
+      });
     });
 
     describe('should fail', () => {