Merge pull request #6096 from BitGo/WIN-5377

feat(sdk-coin-icp): support setting ingressEnd

Author: hitansh-madan

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

@@ -108,7 +108,7 @@ export class Transaction extends BaseTransaction {
             fee: parsedTx.operations[2].amount.value,
             senderPublicKeyHex: senderPublicKeyHex,
             transactionType: transactionType,
-            expiryTime: Number(parsedTx.metadata.created_at_time + (MAX_INGRESS_TTL - PERMITTED_DRIFT)),
+            expiryTime: Number(parsedTx.metadata.ingress_end ?? parsedTx.metadata.created_at_time + MAX_INGRESS_TTL),
             memo: parsedTx.metadata.memo,
           };
 
@@ -225,6 +225,7 @@ export class Transaction extends BaseTransaction {
     ) as CborUnsignedTransaction;
     const update = unsignedTransaction.updates[0];
     const httpCanisterUpdate = (update as unknown as [string, HttpCanisterUpdate])[1];
+    httpCanisterUpdate.ingress_expiry = BigInt(unsignedTransaction.ingress_expiries[0]);
     return await this.getParsedTransactionFromUpdate(httpCanisterUpdate, false);
   }
 
@@ -284,6 +285,7 @@ export class Transaction extends BaseTransaction {
       metadata: {
         created_at_time: args.createdAtTime.timestampNanos,
         memo: Number(args.memo.memo),
+        ingress_end: Number(httpCanisterUpdate.ingress_expiry) + PERMITTED_DRIFT,
       },
       account_identifier_signers: accountIdentifierSigners,
     };
@@ -294,6 +296,7 @@ export class Transaction extends BaseTransaction {
   async parseSignedTransaction(rawTransaction: string): Promise<ParsedTransaction> {
     const signedTransaction = this._utils.cborDecode(this._utils.blobFromHex(rawTransaction));
     const httpCanisterUpdate = (signedTransaction as UpdateEnvelope).content as HttpCanisterUpdate;
+    httpCanisterUpdate.ingress_expiry = BigInt((signedTransaction as UpdateEnvelope).content.ingress_expiry);
     return await this.getParsedTransactionFromUpdate(httpCanisterUpdate, true);
   }
 

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

@@ -11,6 +11,7 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
   protected _sender: string;
   protected _publicKey: string;
   protected _memo: number | BigInt;
+  protected _ingressEnd: number | BigInt;
   protected _receiverId: string;
   protected _amount: string;
 
@@ -64,6 +65,19 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
     return this;
   }
 
+  /**
+   * Set the ingressEnd timestamp
+   * @param {number} ingressEnd - timestamp in nanoseconds
+   * @returns {TransactionBuilder} This transaction builder
+   */
+  public ingressEnd(ingressEnd: number | BigInt): this {
+    if (BigInt(ingressEnd.toString()) < 0n) {
+      throw new BuildTransactionError(`Invalid timestamp: ${ingressEnd}`);
+    }
+    this._ingressEnd = ingressEnd;
+    return this;
+  }
+
   /**
    * Sets the account Id of the receiver of this transaction.
    *
@@ -138,6 +152,7 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
     this._publicKey = icpTransactionData.senderPublicKeyHex;
     this._amount = icpTransactionData.amount;
     this._memo = icpTransactionData.memo ?? DEFAULT_MEMO;
+    this._ingressEnd = Number(icpTransactionData.expiryTime);
   }
 
   validateAddress(address: BaseAddress): void {

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

@@ -95,7 +95,7 @@ export class TransferBuilder extends TransactionBuilder {
     };
 
     const createdTimestamp = this._transaction.createdTimestamp;
-    const { metaData, ingressEndTime } = this._utils.getMetaData(this._memo, createdTimestamp);
+    const { metaData, ingressEndTime } = this._utils.getMetaData(this._memo, createdTimestamp, this._ingressEnd);
 
     const icpTransaction: IcpTransaction = {
       public_keys: [publicKey],

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

@@ -21,6 +21,7 @@ import {
   CurveType,
   AccountIdentifierHash,
   CborUnsignedTransaction,
+  MAX_INGRESS_TTL,
 } from './iface';
 import { KeyPair as IcpKeyPair } from './keyPair';
 const messageCompiled = require('../../resources/messageCompiled');
@@ -581,14 +582,21 @@ export class Utils implements BaseUtils {
 
   getMetaData(
     memo: number | BigInt,
-    timestamp: number | bigint | undefined
+    timestamp: number | bigint | undefined,
+    ingressEnd: number | BigInt | undefined
   ): { 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
+    let ingressStartTime: number, ingressEndTime: number;
+    if (ingressEnd) {
+      ingressEndTime = Number(ingressEnd);
+      ingressStartTime = ingressEndTime - MAX_INGRESS_TTL; // 5 mins in nanoseconds
+    } else {
+      ingressStartTime = currentTime;
+      ingressEndTime = ingressStartTime + MAX_INGRESS_TTL; // 5 mins in nanoseconds
+    }
     const metaData: MetaData = {
       created_at_time: currentTime,
       ingress_start: ingressStartTime,

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

@@ -306,6 +306,7 @@ export const ParsedUnsignedTransaction = {
   metadata: {
     created_at_time: 1743689749455000000,
     memo: 1234,
+    ingress_end: 1743690049455000000,
   },
 };
 
@@ -355,6 +356,7 @@ export const ParsedSignedTransaction = {
   metadata: {
     created_at_time: 1743689749455000000,
     memo: 1234,
+    ingress_end: 1743690049455000000,
   },
 };
 

modules/sdk-coin-icp/test/unit/transactionBuilder/transactionBuilder.ts

@@ -3,7 +3,7 @@ import { getBuilderFactory } from '../getBuilderFactory';
 import { BaseKey } from '@bitgo/sdk-core';
 import * as testData from '../../resources/icp';
 import sinon from 'sinon';
-import { DEFAULT_MEMO } from '../../../src/lib/iface';
+import { DEFAULT_MEMO, MAX_INGRESS_TTL } from '../../../src/lib/iface';
 
 describe('ICP Transaction Builder', async () => {
   const factory = getBuilderFactory('ticp');
@@ -122,7 +122,7 @@ describe('ICP Transaction Builder', async () => {
     txBuilder.receiverId(testData.Accounts.account2.address);
     txBuilder.amount('10');
     txBuilder.memo(testData.MetaDataWithMemo.memo);
-
+    txBuilder.ingressEnd(1904384564000000000n);
     await txBuilder.build();
     txn = txBuilder.transaction;
     const unsignedTxn = txBuilder.transaction.unsignedTransaction;
@@ -139,6 +139,9 @@ describe('ICP Transaction Builder', async () => {
     txBuilder.combine();
     const signedTxn = txBuilder.transaction.signedTransaction;
     signedTxn.should.be.a.String();
+    txBuilder.transaction.icpTransaction.metadata.ingress_start.should.equal(
+      Number(1904384564000000000n) - MAX_INGRESS_TTL
+    );
   });
 });