feat(sdk-coin-apt): addition of test case for apt transaction builder

Ticket: COIN-2258

Author: baltiyal

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

@@ -11,9 +11,15 @@ 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';
+
+export interface AptParseTransactionOptions extends ParseTransactionOptions {
+  txHex: string;
+}
 
 export class Apt extends BaseCoin {
   protected readonly _staticsCoin: Readonly<StaticsBaseCoin>;
@@ -64,7 +70,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, // TODO: check this
+          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 +115,26 @@ 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 coinConfig = coins.get(this.getChain());
+    const factory = new TransactionBuilderFactory(coinConfig);
+    const transactionBuilder = factory.from(params.txHex);
+    const rebuiltTransaction = await transactionBuilder.build();
+    const parsedTransaction = rebuiltTransaction.toJson();
+    return {
+      inputs: [
+        {
+          address: parsedTransaction.sender,
+          value: parsedTransaction.recipient.amount,
+        },
+      ],
+      outputs: [
+        {
+          address: parsedTransaction.recipient.address,
+          value: parsedTransaction.recipient.amount,
+        },
+      ],
+    };
   }
 
   generateKeyPair(seed?: Buffer): KeyPair {

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

@@ -1,5 +1,9 @@
 import { ITransactionExplanation, TransactionFee } from '@bitgo/sdk-core';
 
+export enum AptTransactionType {
+  Transfer = 'Transfer',
+  TokenTransfer = 'TokenTransfer',
+}
 export type TransactionExplanation = ITransactionExplanation<TransactionFee>;
 
 /**

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

@@ -26,6 +26,7 @@ import utils from '../utils';
 export abstract class Transaction extends BaseTransaction {
   protected _rawTransaction: RawTransaction;
   protected _signature: Signature;
+  public txRecipient: TransactionRecipient; //TODO: check and fix - layering, and usage.
 
   static DEFAULT_PUBLIC_KEY = Buffer.alloc(32);
   static DEFAULT_SIGNATURE = Buffer.alloc(64);
@@ -119,18 +120,18 @@ export abstract class Transaction extends BaseTransaction {
   }
 
   loadInputsAndOutputs(): void {
-    const txRecipient = this.recipient;
+    this.txRecipient = this.recipient;
     this._inputs = [
       {
         address: this.sender,
-        value: txRecipient.amount as string,
+        value: this.txRecipient.amount as string,
         coin: this._coinConfig.name,
       },
     ];
     this._outputs = [
       {
-        address: txRecipient.address,
-        value: txRecipient.amount as string,
+        address: this.txRecipient.address,
+        value: this.txRecipient.amount as string,
         coin: this._coinConfig.name,
       },
     ];
@@ -155,6 +156,7 @@ export abstract class Transaction extends BaseTransaction {
 
   /** @inheritDoc */
   explainTransaction(): TransactionExplanation {
+    //TODO: explain transaction to take input as params then take build txn and return the explanation
     const displayOrder = ['id', 'outputs', 'outputAmount', 'changeOutputs', 'changeAmount', 'fee', 'withdrawAmount'];
 
     const outputs: TransactionRecipient[] = [this.recipient];

modules/sdk-coin-apt/src/lib/transaction/transferTransaction.ts

@@ -3,6 +3,9 @@ import { TxData } from '../iface';
 import { TransactionPayloadEntryFunction } from '@aptos-labs/ts-sdk';
 
 export class TransferTransaction extends Transaction {
+  constructor(coinConfig) {
+    super(coinConfig);
+  }
   toJson(): TxData {
     const rawTxn = this._rawTransaction;
     const payload = this._rawTransaction.payload as TransactionPayloadEntryFunction;

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

@@ -1,17 +1,23 @@
 import { TransactionBuilder } from './transactionBuilder';
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
-import { TransactionType } from '@bitgo/sdk-core';
+import { Recipient, TransactionType } from '@bitgo/sdk-core';
 import { TransferTransaction } from './transaction/transferTransaction';
 
 export class TransferBuilder extends TransactionBuilder {
   constructor(_coinConfig: Readonly<CoinConfig>) {
     super(_coinConfig);
+    this.transaction = new TransferTransaction(_coinConfig);
   }
 
   protected get transactionType(): TransactionType {
     return TransactionType.Send;
   }
 
+  send(txRecipient: Recipient): this {
+    this.transaction.txRecipient = txRecipient;
+    return this;
+  }
+
   /**
    * Initialize the transaction builder fields using the decoded transaction data
    *

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

@@ -0,0 +1,31 @@
+import { Recipient } from '@bitgo/sdk-core';
+
+export const AMOUNT = 100000000;
+
+export const addresses = {
+  validAddresses: [
+    '0xf7405c28a02cf5bab4ea4498240bb3579db45951794eb1c843bef0534c093ad9',
+    '0x1aed808916ab9b1b30b07abb53561afd46847285ce28651221d406173a372449',
+  ],
+  invalidAddresses: [
+    'randomString',
+    '0xc4173a804406a365e69dfb297ddfgsdcvf',
+    '5ne7phA48Jrvpn39AtupB8ZkCCAy8gLTfpGihZPuDqen',
+  ],
+};
+
+export const sender = {
+  address: '0x1aed808916ab9b1b30b07abb53561afd46847285ce28651221d406173a372449',
+  privateKey: '0x54e1a88eb2b881fe6c222985d0fabc9ba3aca35743dd1d19db18a9a355acbaaa',
+  publicKey: '0xf73836f42257240e43d439552471fc9dbcc3f1af5bd0b4ed83f44b5f66146442',
+};
+
+export const recipients: Recipient[] = [
+  {
+    address: addresses.validAddresses[0],
+    amount: AMOUNT.toString(),
+  },
+];
+
+export const TRANSFER =
+  '0xc8f02d25aa698b3e9fbd8a08e8da4c8ee261832a25a4cde8731b5ec356537d09170000000000000002000000000000000000000000000000000000000000000000000000000000000104636f696e087472616e73666572010700000000000000000000000000000000000000000000000000000000000000010a6170746f735f636f696e094170746f73436f696e000220f7405c28a02cf5bab4ea4498240bb3579db45951794eb1c843bef0534c093ad908e803000000000000400d0300000000006400000000000000207c7667000000000200202121dcd098069ae535697dd019cfd8677ca7aba0adac1d1959cbce6dc54b12594010f340ec153b724c4dc1c9a435d0fafed1775d851c1e8d965925a7879550c69a4677925d9198334a72ae7ce8998226ff0a83743c7ba8a2831136c072bf21c404';