Merge pull request #8078 from BitGo/COIN-7533

feat: added token in oneStepPreApproval builder

Author: ravibitgo

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

@@ -132,6 +132,7 @@ export interface TransactionBroadcastData {
 
 export interface CantonOneStepEnablementRequest extends CantonPrepareCommandRequest {
   receiverId: string;
+  token?: string;
 }
 
 export interface CantonTransferAcceptRejectRequest extends CantonPrepareCommandRequest {

modules/sdk-coin-canton/src/lib/oneStepPreApprovalBuilder.ts

@@ -8,6 +8,7 @@ import utils from './utils';
 export class OneStepPreApprovalBuilder extends TransactionBuilder {
   private _commandId: string;
   private _receiverPartyId: string;
+  private _token: string;
   constructor(_coinConfig: Readonly<CoinConfig>) {
     super(_coinConfig);
   }
@@ -73,6 +74,20 @@ export class OneStepPreApprovalBuilder extends TransactionBuilder {
     return this;
   }
 
+  /**
+   * Sets the optional token field if present, used for canton token preApproval setup
+   * @param name - the bitgo name of the token
+   * @returns The current builder for chaining
+   * @throws Error if name is invalid
+   */
+  token(name: string): this {
+    if (!name || !name.trim()) {
+      throw new Error('token name must be a non-empty string');
+    }
+    this._token = name.trim();
+    return this;
+  }
+
   /**
    * Builds and returns the CantonOneStepEnablementRequest object from the builder's internal state.
    *
@@ -91,6 +106,7 @@ export class OneStepPreApprovalBuilder extends TransactionBuilder {
       verboseHashing: false,
       actAs: [this._receiverPartyId],
       readAs: [],
+      token: this._token,
     };
   }
 

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

@@ -244,7 +244,14 @@ export class Transaction extends BaseTransaction {
       case TransactionType.TransferAccept:
       case TransactionType.TransferReject: {
         const txData = this.toJson();
-        inputs.push({ address: txData.sender, amount: txData.amount });
+        const input: ITransactionRecipient = {
+          address: txData.sender,
+          amount: txData.amount,
+        };
+        if (txData.token) {
+          input.tokenName = txData.token;
+        }
+        inputs.push(input);
         inputAmount = txData.amount;
         break;
       }

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

@@ -98,6 +98,7 @@ export class Utils implements BaseUtils {
     let instrumentAdmin: string | undefined;
     let token: string | undefined;
     let preApprovalNode: RecordField[] = [];
+    let tokenPreApprovalNode: RecordField[] = [];
     let transferNode: RecordField[] = [];
     let transferAcceptRejectNode: RecordField[] = [];
     let tokenTransferAcceptRejectNode: RecordField[] = [];
@@ -124,6 +125,13 @@ export class Utils implements BaseUtils {
       ) {
         preApprovalNode = fields;
       }
+      if (
+        template?.entityName === 'TransferPreapproval' &&
+        !tokenPreApprovalNode.length &&
+        txType === TransactionType.OneStepPreApproval
+      ) {
+        tokenPreApprovalNode = fields;
+      }
       if (
         template?.entityName === 'Amulet' &&
         !transferAcceptRejectNode.length &&
@@ -182,6 +190,27 @@ export class Utils implements BaseUtils {
       const providerData = getField(preApprovalNode, 'provider');
       if (providerData?.oneofKind === 'party') sender = providerData.party ?? '';
       amount = '0';
+    } else if (tokenPreApprovalNode.length) {
+      const receiverData = getField(tokenPreApprovalNode, 'receiver');
+      if (receiverData?.oneofKind === 'party') receiver = receiverData.party ?? '';
+      const operatorData = getField(tokenPreApprovalNode, 'operator');
+      if (operatorData?.oneofKind === 'party') sender = operatorData.party ?? '';
+      amount = '0';
+      const instrumentAdminData = getField(tokenPreApprovalNode, 'instrumentAdmin');
+      if (instrumentAdminData?.oneofKind === 'party') instrumentAdmin = instrumentAdminData.party ?? '';
+      const allowancesData = getField(tokenPreApprovalNode, 'instrumentAllowances');
+      if (allowancesData?.oneofKind === 'list') {
+        // for the same instrument admin, if multiple tokens are supported then we can enable all of them,
+        // but we won't be doing that for now
+        const firstAllowance = allowancesData.list?.elements?.[0]?.sum;
+        if (firstAllowance?.oneofKind === 'record') {
+          const allowanceFields = firstAllowance.record?.fields ?? [];
+          const idData = getField(allowanceFields, 'id');
+          if (idData?.oneofKind === 'text') {
+            instrumentId = idData.text ?? '';
+          }
+        }
+      }
     } else if (transferNode.length) {
       const transferField = transferNode.find((f) => f.label === 'transfer');
       const transferSum = transferField?.value?.sum;

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

@@ -93,6 +93,20 @@ export const InvalidOneStepPreApprovalPrepareResponse = {
   hashingDetails: null,
 };
 
+export const CantonTokenPreApprovalPrepareResponse = {
+  preparedTransaction:
+    'CoYKCgMyLjESATAa1wkKATDCPtAJCs0JCgMyLjESQjAwYWNhMzZkYzZiMGUxMmI1MDI1YWY3ZjY5YmJlYmE5YjY0MzMzMDVlZTE2ZjhkM2Q3OGU4NTkxMTlkZmQyNmUyOBoXdXRpbGl0eS1yZWdpc3RyeS1hcHAtdjAiigEKQDY2MTE1MTc2OGQ2OTE0MWRmZDZiNzU3YmRjMzQ4MDEyYjJhNjRiMmM5NTZhZDU4Njc4MmY5N2QwNzQwOGYyNjQSMVV0aWxpdHkuUmVnaXN0cnkuQXBwLlYwLk1vZGVsLlRyYW5zZmVyUHJlYXBwcm92YWwaE1RyYW5zZmVyUHJlYXBwcm92YWwqtwVytAUKigEKQDY2MTE1MTc2OGQ2OTE0MWRmZDZiNzU3YmRjMzQ4MDEyYjJhNjRiMmM5NTZhZDU4Njc4MmY5N2QwNzQwOGYyNjQSMVV0aWxpdHkuUmVnaXN0cnkuQXBwLlYwLk1vZGVsLlRyYW5zZmVyUHJlYXBwcm92YWwaE1RyYW5zZmVyUHJlYXBwcm92YWwSdgoIb3BlcmF0b3ISajpoYXV0aDBfMDA3YzY1Zjg1N2YxYzNkNTk5Y2I2ZGY3Mzc3NTo6MTIyMGQyZDczMmQwNDJjMjgxY2VlODBmNDgzYWI4MGYzY2JhYTQ3ODI4NjBlZDVmNGRjMjI4YWIwM2RlZGQyZWU4ZjkSaQoIcmVjZWl2ZXISXTpbcmF2aS0yLXN0ZXAtcGFydHktbmV3OjoxMjIwOTJlN2QzM2FjMTBjMGYzZDU1OTc2MzQyZjM3NTU1ZGYwNWRhNWI3NDI5NTZkNTZhNjJhZTIzNjc3NjkwNzlkMhJ9Cg9pbnN0cnVtZW50QWRtaW4SajpoYXV0aDBfMDA3YzY1Zjg1N2YxYzNkNTk5Y2I2ZGY3Mzc3NTo6MTIyMGQyZDczMmQwNDJjMjgxY2VlODBmNDgzYWI4MGYzY2JhYTQ3ODI4NjBlZDVmNGRjMjI4YWIwM2RlZGQyZWU4ZjkSwgEKFGluc3RydW1lbnRBbGxvd2FuY2VzEqkBWqYBCqMBcqABCooBCkA2NjExNTE3NjhkNjkxNDFkZmQ2Yjc1N2JkYzM0ODAxMmIyYTY0YjJjOTU2YWQ1ODY3ODJmOTdkMDc0MDhmMjY0EjFVdGlsaXR5LlJlZ2lzdHJ5LkFwcC5WMC5Nb2RlbC5UcmFuc2ZlclByZWFwcHJvdmFsGhNJbnN0cnVtZW50QWxsb3dhbmNlEhEKAmlkEgtCCVRlc3RDb2luMTJbcmF2aS0yLXN0ZXAtcGFydHktbmV3OjoxMjIwOTJlN2QzM2FjMTBjMGYzZDU1OTc2MzQyZjM3NTU1ZGYwNWRhNWI3NDI5NTZkNTZhNjJhZTIzNjc3NjkwNzlkMjpoYXV0aDBfMDA3YzY1Zjg1N2YxYzNkNTk5Y2I2ZGY3Mzc3NTo6MTIyMGQyZDczMmQwNDJjMjgxY2VlODBmNDgzYWI4MGYzY2JhYTQ3ODI4NjBlZDVmNGRjMjI4YWIwM2RlZGQyZWU4Zjk6W3JhdmktMi1zdGVwLXBhcnR5LW5ldzo6MTIyMDkyZTdkMzNhYzEwYzBmM2Q1NTk3NjM0MmYzNzU1NWRmMDVkYTViNzQyOTU2ZDU2YTYyYWUyMzY3NzY5MDc5ZDIiIhIgonlu8JNr2xJ7NdQe9F9z/79FyBc67vEKrGmbd+r0wtsSigISgwEKW3JhdmktMi1zdGVwLXBhcnR5LW5ldzo6MTIyMDkyZTdkMzNhYzEwYzBmM2Q1NTk3NjM0MmYzNzU1NWRmMDVkYTViNzQyOTU2ZDU2YTYyYWUyMzY3NzY5MDc5ZDISJDdkOTk3ODlkLTJmMjItNDllMS04NWNiLTc5ZDJjZTVhNjljMRpTZ2xvYmFsLWRvbWFpbjo6MTIyMGJlNThjMjllNjVkZTQwYmYyNzNiZTFkYzJiMjY2ZDQzYTlhMDAyZWE1YjE4OTU1YWVlZjdhYWM4ODFiYjQ3MWEqJDQ3NzA1ZTk4LWM3NTUtNGM4Ny1hYmI3LTBiOWMyNGM5Mzk3ZjDf4Zy2rMSSAw==',
+  preparedTransactionHash: 'zl1kTTr96UWEpR0h9MzvLBZItsttVbwBI0JVJOgJZUg=',
+  hashingSchemeVersion: 'HASHING_SCHEME_VERSION_V2',
+  hashingDetails: null,
+  costEstimation: {
+    estimationTimestamp: '2026-02-06T07:26:30.017983Z',
+    confirmationRequestTrafficCostEstimation: 3697,
+    confirmationResponseTrafficCostEstimation: 452,
+    totalTrafficCostEstimation: 4149,
+  },
+};
+
 export const CANTON_ADDRESSES = {
   VALID_ADDRESS: '1220a::1220a43d89dc7d8f85316116aac093667f769fce55411aef6846ccb933b2e1a3b598',
   // party hint should be present

modules/sdk-coin-canton/test/unit/builder/oneStepEnablement/oneStepEnablementBuilder.ts

@@ -7,6 +7,7 @@ import { OneStepPreApprovalBuilder, Transaction } from '../../../../src';
 import { CantonOneStepEnablementRequest } from '../../../../src/lib/iface';
 
 import {
+  CantonTokenPreApprovalPrepareResponse,
   InvalidOneStepPreApprovalPrepareResponse,
   OneStepEnablement,
   OneStepPreApprovalPrepareResponse,
@@ -29,6 +30,25 @@ describe('Wallet Pre-approval Enablement Builder', () => {
     assert.equal(actAs, partyId);
   });
 
+  it('should get the one step enablement request object for token', function () {
+    const txBuilder = new OneStepPreApprovalBuilder(coins.get('tcanton'));
+    const oneStepEnablementTx = new Transaction(coins.get('tcanton'));
+    txBuilder.initBuilder(oneStepEnablementTx);
+    txBuilder.setTransaction(CantonTokenPreApprovalPrepareResponse);
+    const commandId = '7d99789d-2f22-49e1-85cb-79d2ce5a69c1';
+    const partyId = 'ravi-2-step-party-new::122092e7d33ac10c0f3d55976342f37555df05da5b742956d56a62ae2367769079d2';
+    const token = 'tcanton:testcoin1';
+    txBuilder.commandId(commandId).receiverPartyId(partyId).token(token);
+    const requestObj: CantonOneStepEnablementRequest = txBuilder.toRequestObject();
+    should.exist(requestObj);
+    assert.equal(requestObj.commandId, commandId);
+    assert.equal(requestObj.receiverId, partyId);
+    assert.equal(requestObj.token, token);
+    assert.equal(requestObj.actAs.length, 1);
+    const actAs = requestObj.actAs[0];
+    assert.equal(actAs, partyId);
+  });
+
   it('should validate raw transaction', function () {
     const txBuilder = new OneStepPreApprovalBuilder(coins.get('tcanton'));
     const oneStepEnablementTx = new Transaction(coins.get('tcanton'));