feat(sdk-coin-apt): sendMany multiple recipients native aptos

baltiyal · baltiyal · commit 6efbd37a4f2f · 2025-03-27T20:46:15.000+05:30
TICKET: COIN-3558
diff --git a/modules/sdk-coin-apt/src/lib/constants.ts b/modules/sdk-coin-apt/src/lib/constants.ts
@@ -5,11 +5,14 @@ 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
+export const ADDRESS_BYTES_LENGTH = 32;
+export const AMOUNT_BYTES_LENGTH = 8;
 
 export const DIGITAL_ASSET_TRANSFER_AMOUNT = '1';
 
 export const FUNGIBLE_ASSET_TRANSFER_FUNCTION = '0x1::primary_fungible_store::transfer';
 export const COIN_TRANSFER_FUNCTION = '0x1::aptos_account::transfer_coins';
+export const COIN_BATCH_TRANSFER_FUNCTION = '0x1::aptos_account::batch_transfer_coins';
 export const DIGITAL_ASSET_TRANSFER_FUNCTION = '0x1::object::transfer';
 
 export const APTOS_COIN = '0x1::aptos_coin::AptosCoin';
diff --git a/modules/sdk-coin-apt/src/lib/iface.ts b/modules/sdk-coin-apt/src/lib/iface.ts
@@ -26,3 +26,11 @@ export interface TxData {
   feePayer: string;
   assetId: string;
 }
+
+export interface RecipientsValidationResult {
+  recipients: {
+    deserializedAddresses: string[];
+    deserializedAmounts: Uint8Array[];
+  };
+  isValid: boolean;
+}
diff --git a/modules/sdk-coin-apt/src/lib/transaction/transferTransaction.ts b/modules/sdk-coin-apt/src/lib/transaction/transferTransaction.ts
@@ -4,13 +4,15 @@ import {
   AccountAddress,
   Aptos,
   AptosConfig,
+  EntryFunctionArgument,
+  InputGenerateTransactionPayloadData,
   Network,
   TransactionPayload,
   TransactionPayloadEntryFunction,
 } from '@aptos-labs/ts-sdk';
 
 import { BaseCoin as CoinConfig, NetworkType } from '@bitgo/statics';
-import { APTOS_COIN, COIN_TRANSFER_FUNCTION } from '../constants';
+import { APTOS_COIN, COIN_BATCH_TRANSFER_FUNCTION, COIN_TRANSFER_FUNCTION } from '../constants';
 import utils from '../utils';
 
 export class TransferTransaction extends Transaction {
@@ -21,36 +23,24 @@ export class TransferTransaction extends Transaction {
   }
 
   protected parseTransactionPayload(payload: TransactionPayload): void {
-    if (
-      !(payload instanceof TransactionPayloadEntryFunction) ||
-      payload.entryFunction.args.length !== 2 ||
-      payload.entryFunction.type_args.length !== 1 ||
-      payload.entryFunction.type_args[0].toString().length === 0
-    ) {
+    if (!this.isValidPayload(payload)) {
       throw new InvalidTransactionError('Invalid transaction payload');
     }
-    const entryFunction = payload.entryFunction;
+    const entryFunction = (payload as TransactionPayloadEntryFunction).entryFunction;
     this._assetId = entryFunction.type_args[0].toString();
-    this.recipients = [
-      {
-        address: entryFunction.args[0].toString(),
-        amount: utils.getAmountFromPayloadArgs(entryFunction.args[1].bcsToBytes()),
-      },
-    ] as TransactionRecipient[];
+    const addressArg = entryFunction.args[0];
+    const amountArg = entryFunction.args[1];
+    this.recipients = this.parseRecipients(addressArg, amountArg);
   }
 
   protected async buildRawTransaction(): Promise<void> {
     const network: Network = this._coinConfig.network.type === NetworkType.MAINNET ? Network.MAINNET : Network.TESTNET;
     const aptos = new Aptos(new AptosConfig({ network }));
     const senderAddress = AccountAddress.fromString(this._sender);
-    const recipientAddress = AccountAddress.fromString(this.recipients[0].address);
+
     const simpleTxn = await aptos.transaction.build.simple({
       sender: senderAddress,
-      data: {
-        function: COIN_TRANSFER_FUNCTION,
-        typeArguments: [this.assetId],
-        functionArguments: [recipientAddress, this.recipients[0].amount],
-      },
+      data: this.buildData(this.recipients) as InputGenerateTransactionPayloadData,
       options: {
         maxGasAmount: this.maxGasAmount,
         gasUnitPrice: this.gasUnitPrice,
@@ -60,4 +50,43 @@ export class TransferTransaction extends Transaction {
     });
     this._rawTransaction = simpleTxn.rawTransaction;
   }
+
+  private isValidPayload(payload: TransactionPayload): boolean {
+    return (
+      payload instanceof TransactionPayloadEntryFunction &&
+      payload.entryFunction.args.length === 2 &&
+      payload.entryFunction.type_args.length === 1 &&
+      payload.entryFunction.type_args[0].toString().length > 0
+    );
+  }
+
+  private parseRecipients(addressArg: EntryFunctionArgument, amountArg: EntryFunctionArgument): TransactionRecipient[] {
+    const { recipients, isValid } = utils.fetchAndValidateRecipients(addressArg, amountArg);
+    if (!isValid) {
+      throw new InvalidTransactionError('Invalid transaction recipients');
+    }
+    return recipients.deserializedAddresses.map((address, index) => ({
+      address,
+      amount: utils.getAmountFromPayloadArgs(recipients.deserializedAmounts[index]),
+    })) as TransactionRecipient[];
+  }
+
+  private buildData(recipients: TransactionRecipient[]): InputGenerateTransactionPayloadData {
+    if (recipients.length > 1) {
+      return {
+        function: COIN_BATCH_TRANSFER_FUNCTION,
+        typeArguments: [this.assetId],
+        functionArguments: [
+          recipients.map((recipient) => AccountAddress.fromString(recipient.address)),
+          recipients.map((recipient) => recipient.amount),
+        ],
+      };
+    } else {
+      return {
+        function: COIN_TRANSFER_FUNCTION,
+        typeArguments: [this.assetId],
+        functionArguments: [AccountAddress.fromString(recipients[0].address), recipients[0].amount],
+      };
+    }
+  }
 }
diff --git a/modules/sdk-coin-apt/src/lib/transactionBuilder/transferBuilder.ts b/modules/sdk-coin-apt/src/lib/transactionBuilder/transferBuilder.ts
@@ -2,7 +2,6 @@ import { TransactionBuilder } from './transactionBuilder';
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
 import { TransactionType } from '@bitgo/sdk-core';
 import { TransferTransaction } from '../transaction/transferTransaction';
-import BigNumber from 'bignumber.js';
 import utils from '../utils';
 import { TransactionPayload, TransactionPayloadEntryFunction } from '@aptos-labs/ts-sdk';
 
@@ -29,26 +28,27 @@ export class TransferBuilder extends TransactionBuilder {
     return this;
   }
 
-  protected isValidTransactionPayload(payload: TransactionPayload) {
+  protected isValidTransactionPayload(payload: TransactionPayload): boolean {
     try {
-      if (
-        !(payload instanceof TransactionPayloadEntryFunction) ||
-        payload.entryFunction.args.length !== 2 ||
-        payload.entryFunction.type_args.length !== 1 ||
-        payload.entryFunction.type_args[0].toString().length === 0
-      ) {
+      if (!this.isValidPayload(payload)) {
         console.error('invalid transaction payload');
         return false;
       }
-      const entryFunction = payload.entryFunction;
+      const entryFunction = (payload as TransactionPayloadEntryFunction).entryFunction;
       this.validatePartsOfAssetId(entryFunction.type_args[0].toString());
-      const recipientAddress = entryFunction.args[0].toString();
-      const amountBuffer = Buffer.from(entryFunction.args[1].bcsToBytes());
-      const recipientAmount = new BigNumber(amountBuffer.readBigUint64LE().toString());
-      return utils.isValidAddress(recipientAddress) && !recipientAmount.isLessThan(0);
+      return utils.fetchAndValidateRecipients(entryFunction.args[0], entryFunction.args[1]).isValid;
     } catch (e) {
       console.error('invalid transaction payload', e);
       return false;
     }
   }
+
+  private isValidPayload(payload: TransactionPayload): boolean {
+    return (
+      payload instanceof TransactionPayloadEntryFunction &&
+      payload.entryFunction.args.length === 2 &&
+      payload.entryFunction.type_args.length === 1 &&
+      payload.entryFunction.type_args[0].toString().length > 0
+    );
+  }
 }
diff --git a/modules/sdk-coin-apt/src/lib/utils.ts b/modules/sdk-coin-apt/src/lib/utils.ts
@@ -1,11 +1,14 @@
 import {
+  AccountAddress,
   AuthenticationKey,
   Deserializer,
   Ed25519PublicKey,
+  EntryFunctionArgument,
   Hex,
   SignedTransaction,
   TransactionPayload,
   TransactionPayloadEntryFunction,
+  U64,
 } from '@aptos-labs/ts-sdk';
 import {
   BaseUtils,
@@ -19,12 +22,16 @@ import {
   APT_BLOCK_ID_LENGTH,
   APT_SIGNATURE_LENGTH,
   APT_TRANSACTION_ID_LENGTH,
+  COIN_BATCH_TRANSFER_FUNCTION,
   COIN_TRANSFER_FUNCTION,
   DIGITAL_ASSET_TRANSFER_FUNCTION,
   FUNGIBLE_ASSET_TRANSFER_FUNCTION,
   SECONDS_PER_WEEK,
+  ADDRESS_BYTES_LENGTH,
+  AMOUNT_BYTES_LENGTH,
 } from './constants';
 import BigNumber from 'bignumber.js';
+import { RecipientsValidationResult } from './iface';
 
 export class Utils implements BaseUtils {
   /** @inheritdoc */
@@ -80,6 +87,7 @@ export class Utils implements BaseUtils {
     const uniqueIdentifier = `${moduleAddress}::${moduleIdentifier}::${functionIdentifier}`;
     switch (uniqueIdentifier) {
       case COIN_TRANSFER_FUNCTION:
+      case COIN_BATCH_TRANSFER_FUNCTION:
         return TransactionType.Send;
       case FUNGIBLE_ASSET_TRANSFER_FUNCTION:
         return TransactionType.SendToken;
@@ -90,12 +98,53 @@ export class Utils implements BaseUtils {
     }
   }
 
+  fetchAndValidateRecipients(
+    addressArg: EntryFunctionArgument,
+    amountArg: EntryFunctionArgument
+  ): RecipientsValidationResult {
+    const addressBytes = addressArg.bcsToBytes();
+    const amountBytes = amountArg.bcsToBytes();
+    let deserializedAddresses: string[];
+    let deserializedAmounts: Uint8Array<ArrayBuffer>[];
+    if (addressBytes.length > ADDRESS_BYTES_LENGTH || amountBytes.length > AMOUNT_BYTES_LENGTH) {
+      deserializedAddresses = utils.deserializeAccountAddressVector(addressBytes);
+      deserializedAmounts = utils.deserializeU64Vector(amountBytes);
+      if (deserializedAddresses.length !== deserializedAmounts.length) {
+        console.error('invalid payload entry function arguments : addresses and amounts length mismatch');
+        return { recipients: { deserializedAddresses, deserializedAmounts }, isValid: false };
+      }
+    } else {
+      deserializedAddresses = [addressArg.toString()];
+      deserializedAmounts = [amountBytes];
+    }
+    const allAddressesValid = deserializedAddresses.every((address) => utils.isValidAddress(address.toString()));
+    const allAmountsValid = deserializedAmounts.every((amount) =>
+      new BigNumber(utils.getAmountFromPayloadArgs(amount)).isGreaterThan(0)
+    );
+    return {
+      recipients: { deserializedAddresses, deserializedAmounts },
+      isValid: allAddressesValid && allAmountsValid,
+    };
+  }
+
   deserializeSignedTransaction(rawTransaction: string): SignedTransaction {
     const txnBytes = Hex.fromHexString(rawTransaction).toUint8Array();
     const deserializer = new Deserializer(txnBytes);
     return deserializer.deserialize(SignedTransaction);
   }
 
+  deserializeAccountAddressVector(serializedBytes: Uint8Array): string[] {
+    const deserializer = new Deserializer(serializedBytes);
+    const deserializedAddresses = deserializer.deserializeVector(AccountAddress);
+    return deserializedAddresses.map((address) => address.toString());
+  }
+
+  deserializeU64Vector(serializedBytes: Uint8Array): Uint8Array[] {
+    const deserializer = new Deserializer(serializedBytes);
+    const deserializedAmounts = deserializer.deserializeVector(U64);
+    return deserializedAmounts.map((amount) => amount.bcsToBytes());
+  }
+
   getBufferFromHexString(hexString: string): Buffer {
     return Buffer.from(Hex.fromHexString(hexString).toUint8Array());
   }
diff --git a/modules/sdk-coin-apt/test/resources/apt.ts b/modules/sdk-coin-apt/test/resources/apt.ts
@@ -43,6 +43,17 @@ export const recipients: Recipient[] = [
   },
 ];
 
+export const batchRecipients: Recipient[] = [
+  {
+    address: '0xdd52c0b72a73696b867d6571a308c413e43bff8f44956a5991abc4d50db0b849',
+    amount: '1000',
+  },
+  {
+    address: '0x2a81760d52db9a96df2609860218214b6d1012e77e84a3fed5145a9a65bf6932',
+    amount: '1000',
+  },
+];
+
 export const fungibleTokenRecipients: Recipient[] = [
   {
     address: addresses.validAddresses[0],
@@ -88,6 +99,9 @@ export const FUNGIBLE_TOKEN_TRANSFER =
 export const DIGITAL_ASSET_TRANSFER =
   '0x1aed808916ab9b1b30b07abb53561afd46847285ce28651221d406173a372449ab00000000000000020000000000000000000000000000000000000000000000000000000000000001066f626a656374087472616e736665720107000000000000000000000000000000000000000000000000000000000000000405746f6b656e05546f6b656e0002202e356062777469d39ca5d9b72512ce2d5713d7938ed6ca9193d4fc2016a819fd20f7405c28a02cf5bab4ea4498240bb3579db45951794eb1c843bef0534c093ad9400d0300000000006400000000000000526798670000000002030020f73836f42257240e43d439552471fc9dbcc3f1af5bd0b4ed83f44b5f66146442400c2c31eae495d22d1d31031b9756e8238a3df6e760515aa3e1108d93b3aec6aeb91684307e8365ad9dc44c0b5957e95a21a6f47d8d4a6e0eb3b145fb3d517f030000dbc87a1c816d9bcd06b683c37e80c7162e4d48da7812198b830e4d5d8e0629f200205223396c531f13e031a9f0cb26d459d799a52e51be9a1cb9e871afb4c31f91ff40dd6c064e44642819dec2f63d32d6daa4f889d62d06025ad99b42562c4c6cdef8b1437739115d7f38050078829efb9dd05528f53309bcab5b89fadb283423100d';
 
+export const COIN_BATCH_TRANSFER =
+  '0xc8f02d25aa698b3e9fbd8a08e8da4c8ee261832a25a4cde8731b5ec356537d0951000000000000000200000000000000000000000000000000000000000000000000000000000000010d6170746f735f6163636f756e741462617463685f7472616e736665725f636f696e73010700000000000000000000000000000000000000000000000000000000000000010a6170746f735f636f696e094170746f73436f696e00024102dd52c0b72a73696b867d6571a308c413e43bff8f44956a5991abc4d50db0b8492a81760d52db9a96df2609860218214b6d1012e77e84a3fed5145a9a65bf69321102e803000000000000e803000000000000400d030000000000640000000000000009d4ea6700000000020300202121dcd098069ae535697dd019cfd8677ca7aba0adac1d1959cbce6dc54b12594047602d08426ce035971e86d57d57fc33a7e9d29da56a87a2e6e9d12ae3b39e25892298fa8b080111c609c9a451264b320236a06a45eab870765f90ffc4a42a030000dbc87a1c816d9bcd06b683c37e80c7162e4d48da7812198b830e4d5d8e0629f200205223396c531f13e031a9f0cb26d459d799a52e51be9a1cb9e871afb4c31f91ff401d817a641b915727057babb0ddfe6876583ac5c8d4b86b4c91385dc94f071f8e12a4908786a417b2721fa9838dd1bee6e153ca02f78de43161a9810407ea0b0f';
+
 export const INVALID_TRANSFER =
   'AAAAAAAAAAAAA6e7361637469bc4a58e500b9e64cb6547ee9b403000000000000002064ba1fb2f2fbd2938a350015d601f4db89cd7e8e2370d0dd9ae3ac4f635c1581111b8a49f67370bc4a58e500b9e64cb6462e39b802000000000000002064ba1fb2f2fbd2938a350015d601f4db89cd7e8e2370d0dd9ae3ac47aa1ff81f01c4173a804406a365e69dfb297d4eaaf002546ebd016400000000000000cba4a48bb0f8b586c167e5dcefaa1c5e96ab3f0836d6ca08f2081732944d1e5b6b406a4a462e39b8030000000000000020b9490ede63215262c434e03f606d9799f3ba704523ceda184b386d47aa1ff81f01000000000000006400000000000000';
 
diff --git a/modules/sdk-coin-apt/test/unit/transactionBuilder/transferBuilder.ts b/modules/sdk-coin-apt/test/unit/transactionBuilder/transferBuilder.ts
