feat(sdk-coin-canton): added transaction class

Ticket: COIN-5871

Author: ravibitgo

modules/sdk-coin-canton/package.json

@@ -42,7 +42,7 @@
   "dependencies": {
     "@bitgo/sdk-core": "^36.10.1",
     "@bitgo/statics": "^58.2.0",
-    "@canton-network/wallet-sdk": "^0.9.0",
+    "@canton-network/wallet-sdk": "^0.10.0",
     "bignumber.js": "^9.1.1"
   },
   "devDependencies": {

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

@@ -1,6 +1,38 @@
+import { TransactionType } from '@bitgo/sdk-core';
+import { PartyId } from '@canton-network/core-types';
+
 /**
  * The transaction data returned from the toJson() function of a transaction
  */
 export interface TxData {
   id: string;
+  type: TransactionType;
+  sender: string;
+  receiver: string;
+}
+
+export interface PreparedTrxParsedInfo {
+  sender: string;
+  receiver: string;
+  amount: string;
+}
+
+export interface WalletInitializationDataTxData {
+  id: string;
+  type: TransactionType;
+}
+
+export interface CantonPrepareCommandResponse {
+  preparedTransaction?: string;
+  preparedTransactionHash: string;
+  hashingSchemeVersion: string;
+  hashingDetails?: string;
+}
+
+export interface PreparedParty {
+  partyTransactions: Uint8Array<ArrayBufferLike>[];
+  combinedHash: string;
+  txHashes: Buffer<ArrayBuffer>[];
+  namespace: string;
+  partyId: PartyId;
 }

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

@@ -1,16 +1,49 @@
-import { BaseKey, BaseTransaction } from '@bitgo/sdk-core';
-import { TxData } from './iface';
+import { BaseKey, BaseTransaction, InvalidTransactionError, TransactionType } from '@bitgo/sdk-core';
+import { BaseCoin as CoinConfig } from '@bitgo/statics';
+import { CantonPrepareCommandResponse, TxData } from './iface';
+import utils from './utils';
 
 export class Transaction extends BaseTransaction {
+  private _transaction: CantonPrepareCommandResponse;
+
+  constructor(coinConfig: Readonly<CoinConfig>) {
+    super(coinConfig);
+  }
+
+  get transaction(): CantonPrepareCommandResponse {
+    return this._transaction;
+  }
+
+  set transaction(transaction: CantonPrepareCommandResponse) {
+    this._transaction = transaction;
+    this._id = transaction.preparedTransactionHash;
+  }
+
   canSign(key: BaseKey): boolean {
     return false;
   }
 
   toBroadcastFormat(): string {
-    throw new Error('Method not implemented.');
+    if (!this._transaction) {
+      throw new InvalidTransactionError('Empty transaction data');
+    }
+    return this._transaction.preparedTransactionHash;
   }
 
   toJson(): TxData {
-    throw new Error('Method not implemented.');
+    if (!this._transaction || !this._transaction.preparedTransaction) {
+      throw new InvalidTransactionError('Empty transaction data');
+    }
+    const result: TxData = {
+      id: this.id,
+      type: this._type as TransactionType,
+      sender: '',
+      receiver: '',
+    };
+    // TODO: extract other required data (utxo used, request time, execute before etc)
+    const parsedInfo = utils.parseRawCantonTransactionData(this._transaction.preparedTransaction);
+    result.sender = parsedInfo.sender;
+    result.receiver = parsedInfo.receiver;
+    return result;
   }
 }

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

@@ -1,5 +1,7 @@
 import { BaseUtils, isValidEd25519PublicKey } from '@bitgo/sdk-core';
-import { TopologyController } from '@canton-network/wallet-sdk';
+import { RecordField } from '@canton-network/core-ledger-proto';
+import { decodePreparedTransaction, TopologyController } from '@canton-network/wallet-sdk';
+import { PreparedTrxParsedInfo } from './iface';
 
 export class Utils implements BaseUtils {
   /** @inheritdoc */
@@ -40,6 +42,82 @@ export class Utils implements BaseUtils {
   getAddressFromPublicKey(publicKey: string): string {
     return TopologyController.createFingerprintFromPublicKey(publicKey);
   }
+
+  /**
+   * Method to parse raw canton transaction & get required data
+   * @param {String} rawData base64 encoded string
+   * @returns {PreparedTrxParsedInfo}
+   */
+  parseRawCantonTransactionData(rawData: string): PreparedTrxParsedInfo {
+    const decodedData = decodePreparedTransaction(rawData);
+    let sender = '';
+    let receiver = '';
+    let amount = '';
+    decodedData.transaction?.nodes?.map((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;
+
+      // Check if it's the correct template
+      const template = createNode.templateId;
+      if (template?.entityName !== 'AmuletTransferInstruction') return;
+
+      // Now parse the 'create' argument
+      if (createNode.argument?.sum?.oneofKind !== 'record') return;
+      const fields = createNode.argument?.sum?.record?.fields;
+      if (!fields) return;
+
+      // Find the 'transfer' field
+      const transferField = fields.find((f) => f.label === 'transfer');
+      if (transferField?.value?.sum?.oneofKind !== 'record') return;
+      const transferRecord = transferField?.value?.sum?.record?.fields;
+      if (!transferRecord) return;
+
+      const getField = (fields: RecordField[], label: string) => fields.find((f) => f.label === label)?.value?.sum;
+
+      const senderData = getField(transferRecord, 'sender');
+      if (!senderData || senderData.oneofKind !== 'party') return;
+      sender = senderData.party;
+      const receiverData = getField(transferRecord, 'receiver');
+      if (!receiverData || receiverData.oneofKind !== 'party') return;
+      receiver = receiverData.party;
+      const amountData = getField(transferRecord, 'amount');
+      if (!amountData || amountData.oneofKind !== 'numeric') return;
+      amount = amountData.numeric;
+    });
+    if (!sender || !receiver || !amount) {
+      throw new Error('invalid transaction data');
+    }
+    return {
+      sender,
+      receiver,
+      amount,
+    };
+  }
+
+  /**
+   * Method to compute the prepared transaction hash offline
+   * @param {String} preparedTransaction base64 encoded prepared transaction
+   * @returns {Promise<string>} the computed hash
+   */
+  async computeHashFromPreparedTransaction(preparedTransaction: string): Promise<string> {
+    return await TopologyController.createTransactionHash(preparedTransaction);
+  }
+
+  /**
+   * Method to compute the topology transactions hash offline
+   * @param {Uint8Array<ArrayBufferLike>[]} preparedTransactions the prepared topology transactions
+   * @returns {Promise<String>} the computed hash
+   */
+  async computeHashFromTopologyTransaction(preparedTransactions: Uint8Array<ArrayBufferLike>[]): Promise<string> {
+    return await TopologyController.computeTopologyTxHash(preparedTransactions);
+  }
 }
 
 const utils = new Utils();

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

@@ -0,0 +1,43 @@
+import { BaseKey, BaseTransaction, InvalidTransactionError, TransactionType } from '@bitgo/sdk-core';
+import { BaseCoin as CoinConfig } from '@bitgo/statics';
+import { PreparedParty, WalletInitializationDataTxData } from '../iface';
+
+export class Transaction extends BaseTransaction {
+  private _transaction: PreparedParty;
+
+  constructor(coinConfig: Readonly<CoinConfig>) {
+    super(coinConfig);
+  }
+
+  get transaction(): PreparedParty {
+    return this._transaction;
+  }
+
+  set transaction(transaction: PreparedParty) {
+    this._transaction = transaction;
+    this._id = transaction.combinedHash;
+  }
+
+  canSign(key: BaseKey): boolean {
+    return false;
+  }
+
+  toBroadcastFormat(): string {
+    if (!this._transaction) {
+      throw new InvalidTransactionError('Empty transaction data');
+    }
+    return this._transaction.combinedHash;
+  }
+
+  toJson(): WalletInitializationDataTxData {
+    if (!this._transaction) {
+      throw new InvalidTransactionError('Empty transaction data');
+    }
+    const result: WalletInitializationDataTxData = {
+      id: this.id,
+      type: this._type as TransactionType,
+    };
+    // Add logic to parse the preparedTransaction & extract sender, receiver
+    return result;
+  }
+}