Merge pull request #5318 from BitGo/coin-2258-apt-tx-builder-1

feat(sdk-coin-apt): transaction builder

Author: bhavidhingra

modules/sdk-coin-apt/package.json

@@ -43,10 +43,12 @@
     "@aptos-labs/ts-sdk": "^1.32.0",
     "@bitgo/sdk-core": "^28.19.0",
     "@bitgo/statics": "^50.18.0",
-    "bignumber.js": "^9.1.2"
+    "bignumber.js": "^9.1.2",
+    "lodash": "^4.17.21"
   },
   "devDependencies": {
     "@bitgo/sdk-api": "^1.58.0",
-    "@bitgo/sdk-test": "^8.0.63"
+    "@bitgo/sdk-test": "^8.0.63",
+    "@bitgo/sdk-lib-mpc": "^10.1.0"
   }
 }

modules/sdk-coin-apt/src/apt.ts

@@ -1,5 +1,6 @@
 import {
   BaseCoin,
+  BaseTransaction,
   BitGoBase,
   InvalidAddressError,
   KeyPair,
@@ -11,9 +12,17 @@ import {
   VerifyAddressOptions,
   VerifyTransactionOptions,
 } from '@bitgo/sdk-core';
-import { BaseCoin as StaticsBaseCoin } from '@bitgo/statics';
-import { KeyPair as AptKeyPair } from './lib';
+import { BaseCoin as StaticsBaseCoin, coins } from '@bitgo/statics';
+import { KeyPair as AptKeyPair, TransactionBuilderFactory, TransferTransaction } from './lib';
 import utils from './lib/utils';
+import * as _ from 'lodash';
+import BigNumber from 'bignumber.js';
+import { ExplainTransactionOptions } from './lib/types';
+import { AptTransactionExplanation } from './lib/iface';
+
+export interface AptParseTransactionOptions extends ParseTransactionOptions {
+  txHex: string;
+}
 
 export class Apt extends BaseCoin {
   protected readonly _staticsCoin: Readonly<StaticsBaseCoin>;
@@ -64,7 +73,40 @@ export class Apt extends BaseCoin {
   }
 
   async verifyTransaction(params: VerifyTransactionOptions): Promise<boolean> {
-    throw new Error('Method not implemented.');
+    const coinConfig = coins.get(this.getChain());
+    const { txPrebuild: txPrebuild, txParams: txParams } = params;
+    const transaction = new TransferTransaction(coinConfig);
+    const rawTx = txPrebuild.txHex;
+    if (!rawTx) {
+      throw new Error('missing required tx prebuild property txHex');
+    }
+    transaction.fromRawTransaction(rawTx);
+    const explainedTx = transaction.explainTransaction();
+    if (txParams.recipients !== undefined) {
+      const filteredRecipients = txParams.recipients?.map((recipient) => {
+        return {
+          address: recipient.address,
+          amount: BigInt(recipient.amount),
+        };
+      });
+      const filteredOutputs = explainedTx.outputs.map((output) => {
+        return {
+          address: output.address,
+          amount: BigInt(output.amount),
+        };
+      });
+      if (!_.isEqual(filteredOutputs, filteredRecipients)) {
+        throw new Error('Tx outputs does not match with expected txParams recipients');
+      }
+      let totalAmount = new BigNumber(0);
+      for (const recipients of txParams.recipients) {
+        totalAmount = totalAmount.plus(recipients.amount);
+      }
+      if (!totalAmount.isEqualTo(explainedTx.outputAmount)) {
+        throw new Error('Tx total amount does not match with expected total amount field');
+      }
+    }
+    return true;
   }
 
   async isWalletAddress(params: VerifyAddressOptions): Promise<boolean> {
@@ -76,8 +118,41 @@ export class Apt extends BaseCoin {
     return true;
   }
 
-  parseTransaction(params: ParseTransactionOptions): Promise<ParsedTransaction> {
-    throw new Error('Method not implemented.');
+  async parseTransaction(params: AptParseTransactionOptions): Promise<ParsedTransaction> {
+    const transactionExplanation = await this.explainTransaction({ txHex: params.txHex });
+    if (!transactionExplanation) {
+      throw new Error('Invalid transaction');
+    }
+    return {
+      inputs: [
+        {
+          address: transactionExplanation.sender,
+          amount: transactionExplanation.outputAmount,
+        },
+      ],
+      outputs: [
+        {
+          address: transactionExplanation.outputs[0].address,
+          amount: transactionExplanation.outputs[0].amount,
+        },
+      ],
+    };
+  }
+
+  /**
+   * Explain a Apt transaction
+   * @param params
+   */
+  async explainTransaction(params: ExplainTransactionOptions): Promise<AptTransactionExplanation | undefined> {
+    const factory = this.getBuilder();
+    let rebuiltTransaction: BaseTransaction;
+    try {
+      const transactionBuilder = factory.from(params.txHex);
+      rebuiltTransaction = await transactionBuilder.build();
+    } catch {
+      return undefined;
+    }
+    return rebuiltTransaction.explainTransaction();
   }
 
   generateKeyPair(seed?: Buffer): KeyPair {
@@ -103,4 +178,8 @@ export class Apt extends BaseCoin {
   signTransaction(params: SignTransactionOptions): Promise<SignedTransaction> {
     throw new Error('Method not implemented.');
   }
+
+  private getBuilder(): TransactionBuilderFactory {
+    return new TransactionBuilderFactory(coins.get(this.getChain()));
+  }
 }

modules/sdk-coin-apt/src/lib/constants.ts

@@ -2,3 +2,6 @@ export const APT_ADDRESS_LENGTH = 64;
 export const APT_TRANSACTION_ID_LENGTH = 64;
 export const APT_BLOCK_ID_LENGTH = 64;
 export const APT_SIGNATURE_LENGTH = 128;
+export const UNAVAILABLE_TEXT = 'UNAVAILABLE';
+export const DEFAULT_GAS_UNIT_PRICE = 100;
+export const SECONDS_PER_WEEK = 7 * 24 * 60 * 60; // Days * Hours * Minutes * Seconds

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

@@ -1,6 +1,23 @@
+import {
+  TransactionExplanation as BaseTransactionExplanation,
+  TransactionRecipient,
+  TransactionType as BitGoTransactionType,
+} from '@bitgo/sdk-core';
+
+export interface AptTransactionExplanation extends BaseTransactionExplanation {
+  sender?: string;
+  type?: BitGoTransactionType;
+}
+
 /**
  * The transaction data returned from the toJson() function of a transaction
  */
-export interface TxData {
+export interface TransferTxData {
   id: string;
+  sender: string;
+  recipient: TransactionRecipient;
+  sequenceNumber: number;
+  maxGasAmount: number;
+  gasUnitPrice: number;
+  expirationTime: number;
 }

modules/sdk-coin-apt/src/lib/index.ts

@@ -2,7 +2,8 @@ import * as Utils from './utils';
 import * as Interface from './iface';
 
 export { KeyPair } from './keyPair';
-export { Transaction } from './transaction';
+export { Transaction } from './transaction/transaction';
+export { TransferTransaction } from './transaction/transferTransaction';
 export { TransactionBuilder } from './transactionBuilder';
 export { TransferBuilder } from './transferBuilder';
 export { TransactionBuilderFactory } from './transactionBuilderFactory';