Skip to content

fix: canton raw prepared transaction parsing #7479

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 11, 2025
+129 −46
Merged

fix: canton raw prepared transaction parsing #7479

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modules/sdk-coin-canton/src/lib/transaction/transaction.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}`);
}
Expand Down
115 changes: 75 additions & 40 deletions modules/sdk-coin-canton/src/lib/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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';
Expand Down Expand Up @@ -79,66 +79,101 @@ 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' &&
!transferAcceptRejectNode.length &&
(txType === TransactionType.TransferAccept || txType === TransactionType.TransferReject)
) {
transferAcceptRejectNode = fields;
}
});

nodes?.forEach((node) => {
const versionedNode = node.versionedNode;
if (!versionedNode || versionedNode.oneofKind !== 'v1') return;
const v1Node = versionedNode.v1;
const nodeType = v1Node.nodeType;
if (nodeType.oneofKind !== 'exercise') return;
const exerciseNode = nodeType.exercise;
const choiceId = exerciseNode.choiceId;
if (!choiceId || choiceId !== 'TransferFactory_Transfer') return;
const argSum = exerciseNode.chosenValue?.sum;
if (!argSum || argSum.oneofKind !== 'record') return;
const fields = argSum.record?.fields;
if (!fields) return;
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');
Expand Down
6 changes: 6 additions & 0 deletions modules/sdk-coin-canton/test/resources.ts
View file
Open in desktop

Large diffs are not rendered by default.

52 changes: 47 additions & 5 deletions modules/sdk-coin-canton/test/unit/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,39 +1,81 @@
import assert from 'assert';
import should from 'should';

import { TransactionType } from '@bitgo/sdk-core';

import utils from '../../src/lib/utils';
import {
CANTON_ADDRESSES,
CANTON_BLOCK_HEIGHT,
GenerateTopologyResponse,
OneStepPreApprovalPrepareResponse,
PreparedTransactionRawData,
PreparedTxn1StepReceiver,
PreparedTxn2StepReceiver,
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);
it('should parse correctly when receiver is on 2-step', () => {
const parsedData = utils.parseRawCantonTransactionData(PreparedTxn2StepReceiver, TransactionType.Send);
should.exist(parsedData);
assert.equal(parsedData.sender, 'DSO::1220be58c29e65de40bf273be1dc2b266d43a9a002ea5b18955aeef7aac881bb471a');
assert.equal(parsedData.sender, '1220a::1220ade60300cf7d0b18ffaa2ffe4f492ad1ad601cfc162b20f77ec99d16c2c2f158');
assert.equal(
parsedData.receiver,
'ravi-test-party-1::122092e7d33ac10c0f3d55976342f37555df05da5b742956d56a62ae2367769079d2'
);
assert.equal(parsedData.amount, '20000000000');
});

it('should parse correctly 1', () => {
const parsedData = utils.parseRawCantonTransactionData(PreparedTxn1StepReceiver, TransactionType.Send);
should.exist(parsedData);
assert.equal(parsedData.sender, '1220a::1220ade60300cf7d0b18ffaa2ffe4f492ad1ad601cfc162b20f77ec99d16c2c2f158');
assert.equal(
parsedData.receiver,
'ravi-demo-party-txn-01-tapper::1220ea7ab5a723f8a6b2078e617e6c58cb7e78e49947ddc239e1a941aa56e6ba08b4'
);
assert.equal(parsedData.amount, '20000000000');
});

it('should parse the acceptance prepared transaction', () => {
const parsedData = utils.parseRawCantonTransactionData(
TransferAcceptancePrepareResponse.preparedTransaction,
TransactionType.TransferAccept
);
should.exist(parsedData);
assert.equal(parsedData.sender, 'DSO::1220be58c29e65de40bf273be1dc2b266d43a9a002ea5b18955aeef7aac881bb471a');
assert.equal(parsedData.receiver, 'abcde::12205b4e3537a95126d90604592344d8ad3c3ddccda4f79901954280ee19c576714d');
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,
Expand Down