Merge pull request #6021 from BitGo/WIN-5232-2

feat(sdk-coin-icp): implemented default memo as 0 and related changes

Author: mohd-kashif

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

@@ -9,6 +9,7 @@ export const LEDGER_CANISTER_ID = new Uint8Array([0, 0, 0, 0, 0, 0, 0, 2, 1, 1])
 export const ROOT_PATH = 'm/0';
 export const ACCOUNT_BALANCE_ENDPOINT = '/account/balance';
 export const PUBLIC_NODE_REQUEST_ENDPOINT = '/api/v3/canister/';
+export const DEFAULT_MEMO = 0; // default memo value is 0
 
 export enum RequestType {
   CALL = 'call',
@@ -41,7 +42,7 @@ export interface IcpTransactionData {
   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;
 }
@@ -71,38 +72,31 @@ export interface IcpOperation {
   amount: IcpAmount;
 }
 
-export interface IcpTransactionParseMetadata {
+export interface MetaData {
   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
 }
 
-export interface IcpTransactionBuildMetadata {
-  created_at_time: number;
-  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
-}
-
 export interface IcpTransaction {
   public_keys: IcpPublicKey[];
   operations: IcpOperation[];
-  metadata: IcpTransactionBuildMetadata;
+  metadata: MetaData;
 }
 
 export interface ParsedTransaction {
   operations: IcpOperation[];
   account_identifier_signers: IcpAccount[];
-  metadata: IcpTransactionParseMetadata;
+  metadata: MetaData;
 }
 
 export interface IcpAccountIdentifier {
   address: string;
 }
 
 export interface SendArgs {
-  memo?: { memo: number | BigInt };
+  memo: { memo: number | BigInt };
   payment: { receiverGets: { e8s: number } };
   maxFee: { e8s: number };
   to: { hash: Buffer };

modules/sdk-coin-icp/src/lib/staticProtoDefinition.json

@@ -109,10 +109,9 @@ export class Transaction extends BaseTransaction {
             senderPublicKeyHex: senderPublicKeyHex,
             transactionType: transactionType,
             expiryTime: Number(parsedTx.metadata.created_at_time + (MAX_INGRESS_TTL - PERMITTED_DRIFT)),
+            memo: parsedTx.metadata.memo,
           };
-          if (parsedTx.metadata.memo !== undefined) {
-            this._icpTransactionData.memo = parsedTx.metadata.memo;
-          }
+
           this._utils.validateRawTransaction(this._icpTransactionData);
           this._id = this.generateTransactionId();
           break;
@@ -284,12 +283,10 @@ 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/transaction.ts

@@ -3,7 +3,7 @@ import BigNumber from 'bignumber.js';
 import { BaseTransactionBuilder, BuildTransactionError, BaseAddress, SigningError, BaseKey } from '@bitgo/sdk-core';
 import { Transaction } from './transaction';
 import utils from './utils';
-import { IcpTransaction, IcpTransactionData, PayloadsData, Signatures } from './iface';
+import { DEFAULT_MEMO, IcpTransaction, IcpTransactionData, PayloadsData, Signatures } from './iface';
 import { SignedTransactionBuilder } from './signedTransactionBuilder';
 
 export abstract class TransactionBuilder extends BaseTransactionBuilder {
@@ -137,9 +137,7 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
     this._receiverId = icpTransactionData.receiverAddress;
     this._publicKey = icpTransactionData.senderPublicKeyHex;
     this._amount = icpTransactionData.amount;
-    if (icpTransactionData.memo !== undefined) {
-      this._memo = icpTransactionData.memo;
-    }
+    this._memo = icpTransactionData.memo ?? DEFAULT_MEMO;
   }
 
   validateAddress(address: BaseAddress): void {

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

@@ -6,12 +6,12 @@ import { Transaction } from './transaction';
 import { UnsignedTransactionBuilder } from './unsignedTransactionBuilder';
 import {
   CurveType,
-  IcpTransactionBuildMetadata,
   IcpOperation,
   IcpPublicKey,
   IcpTransaction,
   IcpTransactionData,
   OperationType,
+  DEFAULT_MEMO,
 } from './iface';
 import assert from 'assert';
 
@@ -34,6 +34,11 @@ export class TransferBuilder extends TransactionBuilder {
 
   /** @inheritdoc */
   protected async buildImplementation(): Promise<Transaction> {
+    // The ICP chain sets a memo field with a default value of 0. This ensures compatibility
+    // by setting the memo to 0 if it's not explicitly provided.
+    if (!this._memo || this._memo === undefined || this._memo === null) {
+      this._memo = DEFAULT_MEMO;
+    }
     this.validateTransaction(this._transaction);
     this.buildIcpTransactionData();
     const unsignedTransactionBuilder = new UnsignedTransactionBuilder(this._transaction.icpTransaction);
@@ -90,8 +95,7 @@ export class TransferBuilder extends TransactionBuilder {
     };
 
     const createdTimestamp = this._transaction.createdTimestamp;
-    const { metaData, ingressEndTime }: { metaData: IcpTransactionBuildMetadata; ingressEndTime: number | BigInt } =
-      this._utils.getMetaData(this._memo, createdTimestamp);
+    const { metaData, ingressEndTime } = this._utils.getMetaData(this._memo, createdTimestamp);
 
     const icpTransaction: IcpTransaction = {
       public_keys: [publicKey],
@@ -106,10 +110,9 @@ export class TransferBuilder extends TransactionBuilder {
       senderPublicKeyHex: this._publicKey,
       transactionType: OperationType.TRANSACTION,
       expiryTime: ingressEndTime,
+      memo: this._memo,
     };
-    if (this._memo !== undefined) {
-      icpTransactionData.memo = this._memo;
-    }
+
     this._transaction.icpTransactionData = icpTransactionData;
     this._transaction.icpTransaction = icpTransaction;
   }

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

@@ -25,12 +25,12 @@ export class UnsignedTransactionBuilder {
       Number(this._icpTransactionPayload.metadata.ingress_end) -
       Number(this._icpTransactionPayload.metadata.ingress_start); // 300s in nanoseconds
     const ingressExpiries = this.getIngressExpiries(
-      this._icpTransactionPayload.metadata.ingress_start,
-      this._icpTransactionPayload.metadata.ingress_end,
+      this._icpTransactionPayload.metadata.ingress_start!,
+      this._icpTransactionPayload.metadata.ingress_end!,
       interval
     );
     const sendArgs = this.getSendArgs(
-      this._icpTransactionPayload.metadata.memo!,
+      this._icpTransactionPayload.metadata.memo,
       this._icpTransactionPayload.metadata.created_at_time,
       this._icpTransactionPayload.operations[1].amount.value,
       this._icpTransactionPayload.operations[2].amount.value,
@@ -89,22 +89,15 @@ export class UnsignedTransactionBuilder {
     return ingressExpiries;
   }
 
-  getSendArgs(
-    memo: number | BigInt | undefined,
-    created_at_time: number,
-    amount: string,
-    fee: string,
-    receiver: string
-  ): SendArgs {
+  getSendArgs(memo: number | BigInt, created_at_time: number, amount: string, fee: string, receiver: string): SendArgs {
     const sendArgs: SendArgs = {
       payment: { receiverGets: { e8s: Number(amount) } },
       maxFee: { e8s: -Number(fee) },
       to: { hash: Buffer.from(receiver, 'hex') },
       createdAtTime: { timestampNanos: Number(created_at_time) },
+      memo: { memo: memo },
     };
-    if (memo !== undefined) {
-      sendArgs.memo = { memo: memo };
-    }
+
     return sendArgs;
   }
 

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

@@ -15,7 +15,7 @@ import {
   IcpTransactionData,
   RequestType,
   Signatures,
-  IcpTransactionBuildMetadata,
+  MetaData,
   SendArgs,
   PayloadsData,
   CurveType,
@@ -367,9 +367,7 @@ export class Utils implements BaseUtils {
     }
     this.validateFee(transactionData.fee);
     this.validateValue(new BigNumber(transactionData.amount));
-    if (transactionData.memo !== undefined) {
-      this.validateMemo(transactionData.memo);
-    }
+    this.validateMemo(transactionData.memo);
     this.validateExpireTime(transactionData.expiryTime);
   }
 
@@ -584,21 +582,20 @@ export class Utils implements BaseUtils {
   getMetaData(
     memo: number | BigInt,
     timestamp: number | bigint | undefined
-  ): { metaData: IcpTransactionBuildMetadata; ingressEndTime: number | BigInt } {
+  ): { metaData: MetaData; ingressEndTime: number | BigInt } {
     let currentTime = Date.now() * 1000000;
     if (timestamp) {
       currentTime = Number(timestamp);
     }
     const ingressStartTime = currentTime;
     const ingressEndTime = ingressStartTime + 5 * 60 * 1000000000; // 5 mins in nanoseconds
-    const metaData: IcpTransactionBuildMetadata = {
+    const metaData: MetaData = {
       created_at_time: currentTime,
       ingress_start: ingressStartTime,
       ingress_end: ingressEndTime,
+      memo: memo,
     };
-    if (memo !== undefined || !isNaN(memo)) {
-      metaData.memo = memo;
-    }
+
     return { metaData, ingressEndTime };
   }
 
@@ -620,10 +617,8 @@ export class Utils implements BaseUtils {
       maxFee: { e8s: Number(args.maxFee.e8s) },
       to: { hash: Buffer.from(args.to.hash) },
       createdAtTime: { timestampNanos: BigNumber(args.createdAtTime.timestampNanos.toString()).toNumber() },
+      memo: { memo: Number(args.memo.memo.toString()) },
     };
-    if (args.memo !== undefined && args.memo !== null) {
-      transformedArgs.memo = { memo: Number(args.memo?.memo?.toString()) };
-    }
     return transformedArgs;
   }
 
@@ -724,7 +719,7 @@ export class Utils implements BaseUtils {
     const operationMap = new Map([[2, transferFields]]);
     const txnFields = new Map<any, any>([
       [0, operationMap],
-      [1, this.safeBigInt(sendArgs.memo?.memo || 0)], // TODO: remove 0 value as memo will always be set, WIN-5232
+      [1, this.safeBigInt(sendArgs.memo.memo)],
       [2, new Map([[0, BigInt(sendArgs.createdAtTime.timestampNanos)]])],
     ]);