fix: canton raw prepared transaction parsing

Ticket: COIN-6482

Author: ravibitgo

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

@@ -150,7 +150,7 @@ export class Transaction extends BaseTransaction {
     // TODO: extract other required data (utxo used, request time, execute before etc)
     let parsedInfo: PreparedTxnParsedInfo;
     try {
-      parsedInfo = utils.parseRawCantonTransactionData(this._prepareCommand.preparedTransaction);
+      parsedInfo = utils.parseRawCantonTransactionData(this._prepareCommand.preparedTransaction, this.type);
     } catch (e) {
       throw new InvalidTransactionError(`Failed to parse transaction hash: ${e instanceof Error ? e.message : e}`);
     }

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

@@ -1,7 +1,7 @@
 import BigNumber from 'bignumber.js';
 import crypto from 'crypto';
 
-import { BaseUtils, isValidEd25519PublicKey } from '@bitgo/sdk-core';
+import { BaseUtils, isValidEd25519PublicKey, TransactionType } from '@bitgo/sdk-core';
 
 import { computePreparedTransaction } from '../../resources/hash/hash.js';
 import { PreparedTransaction } from '../../resources/proto/preparedTransaction.js';
@@ -79,66 +79,102 @@ export class Utils implements BaseUtils {
   /**
    * Method to parse raw canton transaction & get required data
    * @param {String} rawData base64 encoded string
+   * @param {TransactionType} txType the transaction type
    * @returns {PreparedTxnParsedInfo}
    */
-  parseRawCantonTransactionData(rawData: string): PreparedTxnParsedInfo {
+  parseRawCantonTransactionData(rawData: string, txType: TransactionType): PreparedTxnParsedInfo {
     const decodedData = this.decodePreparedTransaction(rawData);
     let sender = '';
     let receiver = '';
     let amount = '';
-    decodedData.transaction?.nodes?.forEach((node) => {
+    let preApprovalNode: RecordField[] = [];
+    let transferNode: RecordField[] = [];
+    let transferAcceptRejectNode: RecordField[] = [];
+    const nodes = decodedData.transaction?.nodes;
+
+    nodes?.forEach((node) => {
       const versionedNode = node.versionedNode;
       if (!versionedNode || versionedNode.oneofKind !== 'v1') return;
-
       const v1Node = versionedNode.v1;
       const nodeType = v1Node.nodeType;
-
       if (nodeType.oneofKind !== 'create') return;
-
       const createNode = nodeType.create;
-
-      const getField = (fields: RecordField[], label: string) => fields.find((f) => f.label === label)?.value?.sum;
-
-      // Check if it's the correct template
       const template = createNode.templateId;
       const argSum = createNode.argument?.sum;
       if (!argSum || argSum.oneofKind !== 'record') return;
       const fields = argSum.record?.fields;
       if (!fields) return;
-      if (template?.entityName === 'AmuletTransferInstruction') {
-        const transferField = fields.find((f) => f.label === 'transfer');
-        const transferSum = transferField?.value?.sum;
-        if (!transferSum || transferSum.oneofKind !== 'record') return;
+      if (
+        template?.entityName === 'TransferPreapprovalProposal' &&
+        !preApprovalNode.length &&
+        txType === TransactionType.OneStepPreApproval
+      ) {
+        preApprovalNode = fields;
+      }
+      if (
+        template?.entityName === 'Amulet' &&
+        node?.nodeId === '9' &&
+        !transferAcceptRejectNode.length &&
+        txType === TransactionType.TransferAccept
+      ) {
+        transferAcceptRejectNode = fields;
+      }
+      if (
+        template?.entityName === 'Amulet' &&
+        node?.nodeId === '4' &&
+        !transferAcceptRejectNode.length &&
+        txType === TransactionType.TransferReject
+      ) {
+        transferAcceptRejectNode = fields;
+      }
+      if (
+        template?.entityName === 'AmuletTransferInstruction' &&
+        node?.nodeId === '14' &&
+        !transferNode.length &&
+        txType === TransactionType.Send
+      ) {
+        transferNode = fields;
+      }
+    });
+
+    const getField = (fields: RecordField[], label: string) => fields.find((f) => f.label === label)?.value?.sum;
+
+    if (preApprovalNode.length) {
+      const receiverData = getField(preApprovalNode, 'receiver');
+      if (receiverData?.oneofKind === 'party') receiver = receiverData.party ?? '';
+      const providerData = getField(preApprovalNode, 'provider');
+      if (providerData?.oneofKind === 'party') sender = providerData.party ?? '';
+      amount = '0';
+    } else if (transferNode.length) {
+      const transferField = transferNode.find((f) => f.label === 'transfer');
+      const transferSum = transferField?.value?.sum;
+      if (transferSum && transferSum.oneofKind === 'record') {
         const transferRecord = transferSum.record?.fields;
-        if (!transferRecord) return;
-        const senderData = getField(transferRecord, 'sender');
-        if (senderData?.oneofKind === 'party') sender = senderData.party ?? '';
-
-        const receiverData = getField(transferRecord, 'receiver');
-        if (receiverData?.oneofKind === 'party') receiver = receiverData.party ?? '';
-
-        const amountData = getField(transferRecord, 'amount');
-        if (amountData?.oneofKind === 'numeric') amount = amountData.numeric ?? '';
-      } else if (template?.entityName === 'Amulet') {
-        const dsoData = getField(fields, 'dso');
-        if (dsoData?.oneofKind === 'party') sender = dsoData.party ?? '';
-        const ownerData = getField(fields, 'owner');
-        if (ownerData?.oneofKind === 'party') receiver = ownerData.party ?? '';
-        const amountField = getField(fields, 'amount');
-        if (!amountField || amountField.oneofKind !== 'record') return;
+        if (transferRecord?.length) {
+          const senderData = getField(transferRecord, 'sender');
+          if (senderData?.oneofKind === 'party') sender = senderData.party ?? '';
 
+          const receiverData = getField(transferRecord, 'receiver');
+          if (receiverData?.oneofKind === 'party') receiver = receiverData.party ?? '';
+
+          const amountData = getField(transferRecord, 'amount');
+          if (amountData?.oneofKind === 'numeric') amount = amountData.numeric ?? '';
+        }
+      }
+    } else if (transferAcceptRejectNode.length) {
+      const dsoData = getField(transferAcceptRejectNode, 'dso');
+      if (dsoData?.oneofKind === 'party') sender = dsoData.party ?? '';
+      const ownerData = getField(transferAcceptRejectNode, 'owner');
+      if (ownerData?.oneofKind === 'party') receiver = ownerData.party ?? '';
+      const amountField = getField(transferAcceptRejectNode, 'amount');
+      if (amountField && amountField.oneofKind === 'record') {
         const amountRecord = amountField.record?.fields;
-        if (!amountRecord) return;
-        const initialAmountData = getField(amountRecord, 'initialAmount');
-        if (initialAmountData?.oneofKind === 'numeric') amount = initialAmountData.numeric ?? '';
-      } else if (template?.entityName === 'TransferPreapprovalProposal') {
-        const receiverData = getField(fields, 'receiver');
-        if (receiverData?.oneofKind === 'party') receiver = receiverData.party ?? '';
-        const providerData = getField(fields, 'provider');
-        if (providerData?.oneofKind === 'party') sender = providerData.party ?? '';
-        amount = '0';
+        if (amountRecord?.length) {
+          const initialAmountData = getField(amountRecord, 'initialAmount');
+          if (initialAmountData?.oneofKind === 'numeric') amount = initialAmountData.numeric ?? '';
+        }
       }
-    });
+    }
     if (!sender || !receiver || !amount) {
       const missingFields: string[] = [];
       if (!sender) missingFields.push('sender');

modules/sdk-coin-canton/test/unit/utils.ts

@@ -1,5 +1,8 @@
 import assert from 'assert';
 import should from 'should';
+
+import { TransactionType } from '@bitgo/sdk-core';
+
 import utils from '../../src/lib/utils';
 import {
   CANTON_ADDRESSES,
@@ -9,20 +12,24 @@ import {
   PreparedTransactionRawData,
   PrepareSubmissionResponse,
   TransferAcceptancePrepareResponse,
+  TransferRejectionPrepareResponse,
 } from '../resources';
 
 describe('Canton Util', function () {
   describe('Raw transaction parser', function () {
     it('should parse the prepared transaction', () => {
-      const parsedData = utils.parseRawCantonTransactionData(PreparedTransactionRawData);
+      const parsedData = utils.parseRawCantonTransactionData(PreparedTransactionRawData, TransactionType.Send);
       should.exist(parsedData);
       assert.equal(parsedData.sender, 'abc-1::12200c1ee226fbdf9fba3461c2c0c73331b69d3c6fd8cfce28cdf864141141cc656d');
       assert.equal(parsedData.receiver, 'abc-2::12207e96ada18a845adf4dc01410265633d5266dca9bb280c98e35c3692db87d3e35');
       assert.equal(parsedData.amount, '200000000000');
     });
 
     it('should parse the acceptance prepared transaction', () => {
-      const parsedData = utils.parseRawCantonTransactionData(TransferAcceptancePrepareResponse.preparedTransaction);
+      const parsedData = utils.parseRawCantonTransactionData(
+        TransferAcceptancePrepareResponse.preparedTransaction,
+        TransactionType.TransferAccept
+      );
       should.exist(parsedData);
       assert.equal(parsedData.sender, 'DSO::1220be58c29e65de40bf273be1dc2b266d43a9a002ea5b18955aeef7aac881bb471a');
       assert.equal(
@@ -32,8 +39,22 @@ describe('Canton Util', function () {
       assert.equal(parsedData.amount, '50000000000');
     });
 
+    it('should parse the rejection prepared transaction', () => {
+      const parsedData = utils.parseRawCantonTransactionData(
+        TransferRejectionPrepareResponse.preparedTransaction,
+        TransactionType.TransferReject
+      );
+      should.exist(parsedData);
+      assert.equal(parsedData.sender, 'DSO::1220be58c29e65de40bf273be1dc2b266d43a9a002ea5b18955aeef7aac881bb471a');
+      assert.equal(parsedData.receiver, '12201::122038402cf1650876d2920d6047b11a4aaf0de7b428e9916009cba2a22b1ae22c1a');
+      assert.equal(parsedData.amount, '50000000000');
+    });
+
     it('should parse the one-step preapproval prepared transaction', () => {
-      const parsedData = utils.parseRawCantonTransactionData(OneStepPreApprovalPrepareResponse.preparedTransaction);
+      const parsedData = utils.parseRawCantonTransactionData(
+        OneStepPreApprovalPrepareResponse.preparedTransaction,
+        TransactionType.OneStepPreApproval
+      );
       should.exist(parsedData);
       assert.equal(
         parsedData.sender,