feat(sdk-coin-icp): make memo field optional in transaction interfaces and builders

TICKET: WIN-5112

Author: mohd-kashif

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

@@ -35,14 +35,13 @@ export enum Network {
   ID = '00000000000000020101', // ICP does not have different network IDs for mainnet and testnet
 }
 
-//TODO make memo optional in the interface
 export interface IcpTransactionData {
   senderAddress: string;
   receiverAddress: string;
   amount: string;
   fee: string;
   senderPublicKeyHex: string;
-  memo: number | BigInt; // memo in string is not accepted by ICP chain.
+  memo?: number | BigInt; // memo in string is not accepted by ICP chain.
   transactionType: OperationType;
   expiryTime: number | BigInt;
 }
@@ -72,10 +71,9 @@ export interface IcpOperation {
   amount: IcpAmount;
 }
 
-//TODO check for optional memo in the interface
 export interface IcpTransactionParseMetadata {
   created_at_time: number;
-  memo: number | BigInt; // memo in string is not accepted by ICP chain.
+  memo?: number | BigInt; // memo in string is not accepted by ICP chain.
   ingress_start?: number | BigInt; // it should be nano seconds
   ingress_end?: number | BigInt; // it should be nano seconds
 }
@@ -104,7 +102,7 @@ export interface IcpAccountIdentifier {
 }
 
 export interface SendArgs {
-  memo: { memo: number | BigInt };
+  memo?: { memo: number | BigInt };
   payment: { receiverGets: { e8s: number } };
   maxFee: { e8s: number };
   to: { hash: Buffer };
@@ -163,7 +161,7 @@ export interface TxData {
   sender: string;
   senderPublicKey: string;
   recipient: string;
-  memo: number | BigInt;
+  memo?: number | BigInt;
   feeAmount: string;
   expirationTime: number | BigInt;
   type?: BitGoTransactionType;

modules/sdk-coin-icp/src/lib/transaction.ts

@@ -97,17 +97,18 @@ export class Transaction extends BaseTransaction {
       const transactionType = parsedTx.operations[0].type;
       switch (transactionType) {
         case OperationType.TRANSACTION:
-          //TODO memo is optional here too, check proto def as well
           this._icpTransactionData = {
             senderAddress: parsedTx.operations[0].account.address,
             receiverAddress: parsedTx.operations[1].account.address,
             amount: parsedTx.operations[1].amount.value,
             fee: parsedTx.operations[2].amount.value,
             senderPublicKeyHex: senderPublicKeyHex,
-            memo: parsedTx.metadata.memo,
             transactionType: transactionType,
             expiryTime: Number(parsedTx.metadata.created_at_time + (MAX_INGRESS_TTL - PERMITTED_DRIFT)),
           };
+          if (parsedTx.metadata.memo !== undefined) {
+            this._icpTransactionData.memo = parsedTx.metadata.memo;
+          }
           this._utils.validateRawTransaction(this._icpTransactionData);
           break;
         default:
@@ -135,7 +136,7 @@ export class Transaction extends BaseTransaction {
     }
     switch (this._icpTransactionData.transactionType) {
       case OperationType.TRANSACTION:
-        return {
+        const txData: TxData = {
           id: this._id,
           sender: this._icpTransactionData.senderAddress,
           senderPublicKey: this._icpTransactionData.senderPublicKeyHex,
@@ -145,6 +146,10 @@ export class Transaction extends BaseTransaction {
           expirationTime: this._icpTransactionData.expiryTime,
           type: BitGoTransactionType.Send,
         };
+        if (this._icpTransactionData.memo !== undefined) {
+          txData.memo = this._icpTransactionData.memo;
+        }
+        return txData;
       default:
         throw new Error(`Unsupported transaction type: ${this._icpTransactionData.transactionType}`);
     }
@@ -271,10 +276,12 @@ export class Transaction extends BaseTransaction {
       operations: [senderOperation, receiverOperation, feeOperation],
       metadata: {
         created_at_time: args.createdAtTime.timestampNanos,
-        memo: Number(args.memo.memo),
       },
       account_identifier_signers: accountIdentifierSigners,
     };
+    if (args.memo !== undefined) {
+      parsedTxn.metadata.memo = Number(args.memo.memo);
+    }
     this.createdTimestamp = args.createdAtTime.timestampNanos;
     return parsedTxn;
   }

modules/sdk-coin-icp/src/lib/transactionBuilder.ts

@@ -132,10 +132,12 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
     this._transaction = tx;
     const icpTransactionData = tx.icpTransactionData;
     this._sender = icpTransactionData.senderAddress;
-    this._memo = icpTransactionData.memo;
     this._receiverId = icpTransactionData.receiverAddress;
     this._publicKey = icpTransactionData.senderPublicKeyHex;
     this._amount = icpTransactionData.amount;
+    if (icpTransactionData.memo !== undefined) {
+      this._memo = icpTransactionData.memo;
+    }
   }
 
   validateAddress(address: BaseAddress): void {

modules/sdk-coin-icp/src/lib/transferBuilder.ts

@@ -104,10 +104,12 @@ export class TransferBuilder extends TransactionBuilder {
       amount: this._amount,
       fee: this._utils.feeData(),
       senderPublicKeyHex: this._publicKey,
-      memo: this._memo,
       transactionType: OperationType.TRANSACTION,
       expiryTime: ingressEndTime,
     };
+    if (this._memo !== undefined) {
+      icpTransactionData.memo = this._memo;
+    }
     this._transaction.icpTransactionData = icpTransactionData;
     this._transaction.icpTransaction = icpTransaction;
   }

modules/sdk-coin-icp/src/lib/unsignedTransactionBuilder.ts

@@ -89,14 +89,22 @@ export class UnsignedTransactionBuilder {
     return ingressExpiries;
   }
 
-  getSendArgs(memo: number | BigInt, created_at_time: number, amount: string, fee: string, receiver: string): SendArgs {
+  getSendArgs(
+    memo: number | BigInt | undefined,
+    created_at_time: number,
+    amount: string,
+    fee: string,
+    receiver: string
+  ): SendArgs {
     const sendArgs: SendArgs = {
-      memo: { memo: memo },
       payment: { receiverGets: { e8s: Number(amount) } },
       maxFee: { e8s: -Number(fee) },
       to: { hash: Buffer.from(receiver, 'hex') },
       createdAtTime: { timestampNanos: Number(created_at_time) },
     };
+    if (memo !== undefined) {
+      sendArgs.memo = { memo: memo };
+    }
     return sendArgs;
   }
 

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

@@ -358,8 +358,9 @@ export class Utils implements BaseUtils {
     }
     this.validateFee(transactionData.fee);
     this.validateValue(new BigNumber(transactionData.amount));
-    //TODO check for optional memo
-    this.validateMemo(transactionData.memo);
+    if (transactionData.memo !== undefined) {
+      this.validateMemo(transactionData.memo);
+    }
     this.validateExpireTime(transactionData.expiryTime);
   }
 
@@ -607,12 +608,14 @@ export class Utils implements BaseUtils {
     const SendRequestMessage = root.lookupType('SendRequest');
     const args = SendRequestMessage.decode(arg) as unknown as SendArgs;
     const transformedArgs: SendArgs = {
-      memo: { memo: BigInt(args.memo.memo.toString()) },
       payment: { receiverGets: { e8s: args.payment.receiverGets.e8s } },
       maxFee: { e8s: args.maxFee.e8s },
       to: { hash: Buffer.from(args.to.hash) },
       createdAtTime: { timestampNanos: BigNumber(args.createdAtTime.timestampNanos.toString()).toNumber() },
     };
+    if (args.memo !== undefined && args.memo !== null) {
+      transformedArgs.memo = { memo: BigInt(args.memo?.memo?.toString()) };
+    }
     return transformedArgs;
   }
 

modules/sdk-coin-icp/test/resources/icp.ts

@@ -195,7 +195,21 @@ export const payloadsData = {
     'b90002677570646174657381826b5452414e53414354494f4eb900056b63616e69737465725f69644a000000000000000201016b6d6574686f645f6e616d656773656e645f70626361726758400a0308d20912040a02080a1a0308904e2a220a20c3d30f404955975adaba89f2e1ebc75c1f44a6a204578afce8f3780d64fe252e3a0a0880a48596eb92b599186673656e646572581dd5fc1dc4d74d4aa35d81cf345533d20548113412d32fffdcece2f68a026e696e67726573735f6578706972791b000000000000000070696e67726573735f6578706972696573811b1832d4ce93deb200',
 };
 
-export const signatures = [
+export const payloadsDataWithoutMemo = {
+  payloads: [
+    {
+      hex_bytes: '0a69632d726571756573743112e4b82e09b05badc6978a3bb9eb2773cf467c7c62f573b6b4df5d304a6487',
+      account_identifier: {
+        address: '0af815da8259ba8bb3d34fbfb2ac730f07a1adc81438d40d667d91b408b25f2f',
+      },
+      signature_type: 'ecdsa',
+    },
+  ],
+  unsigned_transaction:
+    'b90002677570646174657381826b5452414e53414354494f4eb900056b63616e69737465725f69644a000000000000000201016b6d6574686f645f6e616d656773656e645f706263617267583b12040a02080a1a0308904e2a220a20c3d30f404955975adaba89f2e1ebc75c1f44a6a204578afce8f3780d64fe252e3a0a0880a48596eb92b599186673656e646572581dd5fc1dc4d74d4aa35d81cf345533d20548113412d32fffdcece2f68a026e696e67726573735f6578706972791b000000000000000070696e67726573735f6578706972696573811b1832d4ce93deb200',
+};
+
+export const Signatures = [
   {
     signing_payload: {
       account_identifier: { address: '0af815da8259ba8bb3d34fbfb2ac730f07a1adc81438d40d667d91b408b25f2f' },
@@ -213,9 +227,30 @@ export const signatures = [
   },
 ];
 
-export const signedTransaction =
+export const SignaturesWithoutMemo = [
+  {
+    signing_payload: {
+      account_identifier: { address: '0af815da8259ba8bb3d34fbfb2ac730f07a1adc81438d40d667d91b408b25f2f' },
+      hex_bytes: '0a69632d726571756573743112e4b82e09b05badc6978a3bb9eb2773cf467c7c62f573b6b4df5d304a6487',
+      signature_type: 'ecdsa',
+    },
+    signature_type: 'ecdsa',
+    public_key: {
+      hex_bytes:
+        '042ab77b959e28c4fa47fa8fb9e57cec3d66df5684d076ac2e4c5f28fd69a23dd31a59f908c8add51eab3530b4ac5d015166eaf2198c52fa9a8df7cfaeb8fdb7d4',
+      curve_type: 'secp256k1',
+    },
+    hex_bytes:
+      '5a954e35fa40b0aec27f83a8d6124b5c2f68622c5f4799bc66ff4ff994ffcad14b22dbf5a0a1438d3b812375aab16637659207e745f705f436a599a3ee2bfaac',
+  },
+];
+
+export const SignedTransaction =
   'b9000367636f6e74656e74b900066c726571756573745f747970656463616c6c6b63616e69737465725f69644a000000000000000201016b6d6574686f645f6e616d656773656e645f70626361726758400a0308d20912040a02080a1a0308904e2a220a20c3d30f404955975adaba89f2e1ebc75c1f44a6a204578afce8f3780d64fe252e3a0a0880a48596eb92b599186673656e646572581dd5fc1dc4d74d4aa35d81cf345533d20548113412d32fffdcece2f68a026e696e67726573735f6578706972791b1832d4ce93deb2006d73656e6465725f7075626b6579d84058583056301006072a8648ce3d020106052b8104000a034200042ab77b959e28c4fa47fa8fb9e57cec3d66df5684d076ac2e4c5f28fd69a23dd31a59f908c8add51eab3530b4ac5d015166eaf2198c52fa9a8df7cfaeb8fdb7d46a73656e6465725f7369675840dee0c728fc06d2140ad84e2be5f983626114d49f51216d4070bfccbfba79041d77648bad917428a8adb9908828458488562f0d159571382b1ac50fb81d5165c9';
 
+export const SignedTransactionWithoutMemo =
+  'b9000367636f6e74656e74b900066c726571756573745f747970656463616c6c6b63616e69737465725f69644a000000000000000201016b6d6574686f645f6e616d656773656e645f706263617267583b12040a02080a1a0308904e2a220a20c3d30f404955975adaba89f2e1ebc75c1f44a6a204578afce8f3780d64fe252e3a0a0880a48596eb92b599186673656e646572581dd5fc1dc4d74d4aa35d81cf345533d20548113412d32fffdcece2f68a026e696e67726573735f6578706972791b1832d4ce93deb2006d73656e6465725f7075626b6579d84058583056301006072a8648ce3d020106052b8104000a034200042ab77b959e28c4fa47fa8fb9e57cec3d66df5684d076ac2e4c5f28fd69a23dd31a59f908c8add51eab3530b4ac5d015166eaf2198c52fa9a8df7cfaeb8fdb7d46a73656e6465725f73696758405a954e35fa40b0aec27f83a8d6124b5c2f68622c5f4799bc66ff4ff994ffcad14b22dbf5a0a1438d3b812375aab16637659207e745f705f436a599a3ee2bfaac';
+
 export const ParsedUnsignedTransaction = {
   operations: [
     {
@@ -347,19 +382,17 @@ export const TxnId = '4c10cf22a768a20e7eebc86e49c031d0e22895a39c6355b5f7455b2aca
 export const PublicNodeApiBroadcastResponse =
   'd9d9f7a266737461747573677265706c6965646b6365727469666963617465590317d9d9f7a2647472656583018301820458200548bee8d4a0ada144f09841a1814e0c7b06a9c525e19d07990c27a8d5dfebe983018204582059964f7dcd455bb5333f0424188250c1bafdfee505b6d4bffce6b93d84b02fbc83024e726571756573745f7374617475738301820458208ec4679d2b1049ab4154b9113c88a7bacc1772831a799d0337e650fe093339648302582086ab628166c7c823c4fac064f42bcb6c6939aec9a63ce88a2eef553475fd55958301830183024a6572726f725f636f646582034649433035303383024b72656a6563745f636f646582034105830183024e72656a6563745f6d65737361676582035901984572726f722066726f6d2043616e69737465722072796a6c332d74796161612d61616161612d61616162612d6361693a2043616e69737465722063616c6c656420606963302e74726170602077697468206d6573736167653a20746865206465626974206163636f756e7420646f65736e2774206861766520656e6f7567682066756e647320746f20636f6d706c65746520746865207472616e73616374696f6e2c2063757272656e742062616c616e63653a20302e303030303030303020546f6b656e2e0a436f6e736964657220677261636566756c6c792068616e646c696e67206661696c757265732066726f6d20746869732063616e6973746572206f7220616c746572696e67207468652063616e697374657220746f2068616e646c6520657863657074696f6e732e2053656520646f63756d656e746174696f6e3a20687474703a2f2f696e7465726e6574636f6d70757465722e6f72672f646f63732f63757272656e742f7265666572656e6365732f657865637574696f6e2d6572726f727323747261707065642d6578706c696369746c7983024673746174757382034872656a6563746564830182045820535b0b886d8f16a1d4909618e38af89fa407ef6f606c1e667ab31015f35db57f83024474696d658203498ad7d790e682f69918697369676e61747572655830a26f5ae0c1396f6005487223031062886416c7d4ea37a1b2a7b64a287b376a5f4495cffd99a69bf4f4fd95e53794f415';
 
-export const SignedTransactionWithoutMemo =
-  'b9000367636f6e74656e74b900066c726571756573745f747970656463616c6c6b63616e69737465725f69644a000000000000000201016b6d6574686f645f6e616d656773656e645f70626361726758410a0012080a0608f0c5eadc031a0308904e2a220a20c3d30f404955975adaba89f2e1ebc75c1f44a6a204578afce8f3780d64fe252e3a0a0880a48596eb92b599186673656e646572581db32b534dcc87771406ce0d93595733ca9c635f0f2f3e29559e8806a1026e696e67726573735f6578706972791b1832d4ce93deb2006d73656e6465725f7075626b6579d84058583056301006072a8648ce3d020106052b8104000a0342000482ef63ee315d6323c616970c93267ca92ee81a691027f9c856ccd23f414f32c5209b7b6f64f42e66c9c5adf064cf0f372ae1b27c9a0fcbc4dcaa8fb5cd5ba0e66a73656e6465725f7369675840d5fa414e9308da3d900520cd48349cdb5bcdb9ec87060ad48aedc9f36356fd897c12822ee2434917e76248ae4a827a723c9ca616488e01037245df67c11e1f1d';
+export const RecoverySignedTransactionWithoutMemo =
+  'b9000367636f6e74656e74b900066c726571756573745f747970656463616c6c6b63616e69737465725f69644a000000000000000201016b6d6574686f645f6e616d656773656e645f706263617267583f12080a0608f0c5eadc031a0308904e2a220a20c3d30f404955975adaba89f2e1ebc75c1f44a6a204578afce8f3780d64fe252e3a0a0880a48596eb92b599186673656e646572581db32b534dcc87771406ce0d93595733ca9c635f0f2f3e29559e8806a1026e696e67726573735f6578706972791b1832d4ce93deb2006d73656e6465725f7075626b6579d84058583056301006072a8648ce3d020106052b8104000a0342000482ef63ee315d6323c616970c93267ca92ee81a691027f9c856ccd23f414f32c5209b7b6f64f42e66c9c5adf064cf0f372ae1b27c9a0fcbc4dcaa8fb5cd5ba0e66a73656e6465725f7369675840c9b8a7bb6d304a684423e108b0fc510d78c4e4b0aa37d66366d32f24bab48a3a1da9eeff92c77ee0aa288bea1369d6696b7d975af5e0f0f6f8b8809a4b0143db';
 
-export const SignedTransactionWithMemo =
+export const RecoverySignedTransactionWithMemo =
   'b9000367636f6e74656e74b900066c726571756573745f747970656463616c6c6b63616e69737465725f69644a000000000000000201016b6d6574686f645f6e616d656773656e645f70626361726758440a0308d20912080a0608f0c5eadc031a0308904e2a220a20c3d30f404955975adaba89f2e1ebc75c1f44a6a204578afce8f3780d64fe252e3a0a0880a48596eb92b599186673656e646572581db32b534dcc87771406ce0d93595733ca9c635f0f2f3e29559e8806a1026e696e67726573735f6578706972791b1832d4ce93deb2006d73656e6465725f7075626b6579d84058583056301006072a8648ce3d020106052b8104000a0342000482ef63ee315d6323c616970c93267ca92ee81a691027f9c856ccd23f414f32c5209b7b6f64f42e66c9c5adf064cf0f372ae1b27c9a0fcbc4dcaa8fb5cd5ba0e66a73656e6465725f7369675840819eeac2eeb59a283ab7c52a48a25a7abde85a8af02632245a3a89ace413cd2043c5bb662cf736a66c77bd61b606e581948843592f4ab8132925aff3826ba87c';
 
 export const RecoverTransactionSignatureWithoutMemo = [
   {
     signing_payload: {
-      hex_bytes: '0a69632d726571756573744638d4e2c21864b52d8edbabac4eca2b0b53ea132f5527226692aa2af17e9ed4',
-      account_identifier: {
-        address: '4623c8c75bf76b1275460328de94a6f1b9f9000d173941694cb93a8bd26b77ca',
-      },
+      hex_bytes: '0a69632d7265717565737406b1635ce592ff5a70c21936bec1148f17e40b08155d29f1e7eeb73a50b3b2b5',
+      account_identifier: { address: '4623c8c75bf76b1275460328de94a6f1b9f9000d173941694cb93a8bd26b77ca' },
       signature_type: 'ecdsa',
     },
     signature_type: 'ecdsa',
@@ -368,7 +401,7 @@ export const RecoverTransactionSignatureWithoutMemo = [
       curve_type: 'secp256k1',
     },
     hex_bytes:
-      'd5fa414e9308da3d900520cd48349cdb5bcdb9ec87060ad48aedc9f36356fd897c12822ee2434917e76248ae4a827a723c9ca616488e01037245df67c11e1f1d',
+      'c9b8a7bb6d304a684423e108b0fc510d78c4e4b0aa37d66366d32f24bab48a3a1da9eeff92c77ee0aa288bea1369d6696b7d975af5e0f0f6f8b8809a4b0143db',
   },
 ];