Revert "Revert "feat(sdk-coin-apt): send many: addition of recipients (single recipient)""

baltiyal · web-flow · commit 8a02601489a6 · 2025-03-25T09:18:48.000+05:30
diff --git a/modules/sdk-coin-apt/src/lib/iface.ts b/modules/sdk-coin-apt/src/lib/iface.ts
@@ -16,6 +16,7 @@ export interface TxData {
   id: string;
   sender: string;
   recipient: TransactionRecipient;
+  recipients: TransactionRecipient[];
   sequenceNumber: number;
   maxGasAmount: number;
   gasUnitPrice: number;
diff --git a/modules/sdk-coin-apt/src/lib/transaction/digitalAssetTransfer.ts b/modules/sdk-coin-apt/src/lib/transaction/digitalAssetTransfer.ts
@@ -37,19 +37,20 @@ export class DigitalAssetTransfer extends Transaction {
       throw new InvalidTransactionError('Invalid transaction payload');
     }
     const entryFunction = payload.entryFunction;
-    if (!this._recipient) {
-      this._recipient = {} as TransactionRecipient;
-    }
     this._assetId = entryFunction.args[0].toString();
-    this._recipient.address = entryFunction.args[1].toString();
-    this._recipient.amount = DIGITAL_ASSET_TRANSFER_AMOUNT;
+    this.recipients = [
+      {
+        address: entryFunction.args[1].toString(),
+        amount: DIGITAL_ASSET_TRANSFER_AMOUNT,
+      },
+    ] as TransactionRecipient[];
   }
 
   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._recipient.address);
+    const recipientAddress = AccountAddress.fromString(this.recipients[0].address);
     const digitalAssetAddress = AccountAddress.fromString(this._assetId);
 
     const transferDigitalAssetAbi: EntryFunctionABI = {
diff --git a/modules/sdk-coin-apt/src/lib/transaction/fungibleAssetTransfer.ts b/modules/sdk-coin-apt/src/lib/transaction/fungibleAssetTransfer.ts
@@ -32,21 +32,21 @@ export class FungibleAssetTransfer extends Transaction {
       throw new InvalidTransactionError('Invalid transaction payload');
     }
     const entryFunction = payload.entryFunction;
-    if (!this._recipient) {
-      this._recipient = {} as TransactionRecipient;
-    }
     this._assetId = entryFunction.args[0].toString();
-    this._recipient.address = entryFunction.args[1].toString();
-    this._recipient.amount = utils.getAmountFromPayloadArgs(entryFunction.args[2].bcsToBytes());
+    this.recipients = [
+      {
+        address: entryFunction.args[1].toString(),
+        amount: utils.getAmountFromPayloadArgs(entryFunction.args[2].bcsToBytes()),
+      },
+    ] as TransactionRecipient[];
   }
 
   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._recipient.address);
+    const recipientAddress = AccountAddress.fromString(this.recipients[0].address);
     const fungibleTokenAddress = this._assetId;
-
     const faTransferAbi: EntryFunctionABI = {
       typeParameters: [{ constraints: [] }],
       parameters: [parseTypeTag('0x1::object::Object'), new TypeTagAddress(), new TypeTagU64()],
@@ -57,7 +57,7 @@ export class FungibleAssetTransfer extends Transaction {
       data: {
         function: FUNGIBLE_ASSET_TRANSFER_FUNCTION,
         typeArguments: [FUNGIBLE_ASSET_TYPE_ARGUMENT],
-        functionArguments: [fungibleTokenAddress, recipientAddress, this.recipient.amount],
+        functionArguments: [fungibleTokenAddress, recipientAddress, this.recipients[0].amount],
         abi: faTransferAbi,
       },
       options: {
diff --git a/modules/sdk-coin-apt/src/lib/transaction/transaction.ts b/modules/sdk-coin-apt/src/lib/transaction/transaction.ts
@@ -32,13 +32,14 @@ import { DEFAULT_GAS_UNIT_PRICE, UNAVAILABLE_TEXT } from '../constants';
 import utils from '../utils';
 import BigNumber from 'bignumber.js';
 import { AptTransactionExplanation, TxData } from '../iface';
+import assert from 'assert';
 
 export abstract class Transaction extends BaseTransaction {
   protected _rawTransaction: RawTransaction;
   protected _senderSignature: Signature;
   protected _feePayerSignature: Signature;
   protected _sender: string;
-  protected _recipient: TransactionRecipient;
+  protected _recipients: TransactionRecipient[];
   protected _sequenceNumber: number;
   protected _maxGasAmount: number;
   protected _gasUnitPrice: number;
@@ -59,6 +60,7 @@ export abstract class Transaction extends BaseTransaction {
     this._expirationTime = utils.getTxnExpirationTimestamp();
     this._sequenceNumber = 0;
     this._sender = AccountAddress.ZERO.toString();
+    this._recipients = [];
     this._assetId = AccountAddress.ZERO.toString();
     this._isSimulateTxn = false;
     this._senderSignature = {
@@ -90,12 +92,27 @@ export abstract class Transaction extends BaseTransaction {
     this._sender = value;
   }
 
+  /**
+   * @deprecated - use `recipients()`.
+   */
   get recipient(): TransactionRecipient {
-    return this._recipient;
+    assert(this._recipients.length > 0, 'No recipients available');
+    return this._recipients[0];
   }
 
+  /**
+   * @deprecated - use `recipients()`.
+   */
   set recipient(value: TransactionRecipient) {
-    this._recipient = value;
+    this.recipients = [value];
+  }
+
+  get recipients(): TransactionRecipient[] {
+    return this._recipients;
+  }
+
+  set recipients(value: TransactionRecipient[]) {
+    this._recipients = value;
   }
 
   get sequenceNumber(): number {
@@ -258,20 +275,24 @@ export abstract class Transaction extends BaseTransaction {
   }
 
   loadInputsAndOutputs(): void {
+    const totalAmount = this._recipients.reduce(
+      (accumulator, current) => accumulator.plus(current.amount),
+      new BigNumber('0')
+    );
     this._inputs = [
       {
         address: this.sender,
-        value: this.recipient.amount as string,
+        value: totalAmount.toString(),
         coin: this._coinConfig.name,
       },
     ];
-    this._outputs = [
-      {
-        address: this.recipient.address,
-        value: this.recipient.amount as string,
+    this._outputs = this._recipients.map((recipient) => {
+      return {
+        address: recipient.address,
+        value: recipient.amount as string,
         coin: this._coinConfig.name,
-      },
-    ];
+      };
+    });
   }
 
   fromRawTransaction(rawTransaction: string): void {
@@ -303,6 +324,7 @@ export abstract class Transaction extends BaseTransaction {
       id: this.id,
       sender: this.sender,
       recipient: this.recipient,
+      recipients: this.recipients,
       sequenceNumber: this.sequenceNumber,
       maxGasAmount: this.maxGasAmount,
       gasUnitPrice: this.gasUnitPrice,
@@ -335,8 +357,10 @@ export abstract class Transaction extends BaseTransaction {
       'type',
     ];
 
-    const outputs: TransactionRecipient[] = [this.recipient];
-    const outputAmount = outputs[0].amount;
+    const outputs: TransactionRecipient[] = this._recipients;
+    const outputAmount = outputs
+      .reduce((accumulator, current) => accumulator.plus(current.amount), new BigNumber('0'))
+      .toString();
     return {
       displayOrder,
       id: this.id,
diff --git a/modules/sdk-coin-apt/src/lib/transaction/transferTransaction.ts b/modules/sdk-coin-apt/src/lib/transaction/transferTransaction.ts
@@ -30,25 +30,26 @@ export class TransferTransaction extends Transaction {
       throw new InvalidTransactionError('Invalid transaction payload');
     }
     const entryFunction = payload.entryFunction;
-    if (!this._recipient) {
-      this._recipient = {} as TransactionRecipient;
-    }
     this._assetId = entryFunction.type_args[0].toString();
-    this._recipient.address = entryFunction.args[0].toString();
-    this._recipient.amount = utils.getAmountFromPayloadArgs(entryFunction.args[1].bcsToBytes());
+    this.recipients = [
+      {
+        address: entryFunction.args[0].toString(),
+        amount: utils.getAmountFromPayloadArgs(entryFunction.args[1].bcsToBytes()),
+      },
+    ] as TransactionRecipient[];
   }
 
   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._recipient.address);
+    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.recipient.amount],
+        functionArguments: [recipientAddress, this.recipients[0].amount],
       },
       options: {
         maxGasAmount: this.maxGasAmount,
diff --git a/modules/sdk-coin-apt/src/lib/transactionBuilder/transactionBuilder.ts b/modules/sdk-coin-apt/src/lib/transactionBuilder/transactionBuilder.ts
@@ -63,10 +63,22 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
     return this;
   }
 
+  /**
+   * @deprecated - use `recipients()`.
+   */
   recipient(recipient: Recipient): this {
     this.validateAddress({ address: recipient.address });
     this.validateValue(new BigNumber(recipient.amount));
-    this.transaction.recipient = recipient;
+    this.transaction.recipients = [recipient];
+    return this;
+  }
+
+  recipients(recipients: Recipient[]): this {
+    for (const recipient of recipients) {
+      this.validateAddress({ address: recipient.address });
+      this.validateValue(new BigNumber(recipient.amount));
+    }
+    this.transaction.recipients = recipients;
     return this;
   }
 
@@ -143,8 +155,10 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
       throw new Error('transaction not defined');
     }
     this.validateAddress({ address: transaction.sender });
-    this.validateAddress({ address: transaction.recipient.address });
-    this.validateValue(new BigNumber(transaction.recipient.amount));
+    for (const recipient of transaction.recipients) {
+      this.validateAddress({ address: recipient.address });
+      this.validateValue(new BigNumber(recipient.amount));
+    }
   }
 
   isValidRawTransaction(rawTransaction: string): boolean {
diff --git a/modules/sdk-coin-apt/test/unit/transactionBuilder/digitalAssetTransferBuilder.ts b/modules/sdk-coin-apt/test/unit/transactionBuilder/digitalAssetTransferBuilder.ts
diff --git a/modules/sdk-coin-apt/test/unit/transactionBuilder/fungibleAssetTransferBuilder.ts b/modules/sdk-coin-apt/test/unit/transactionBuilder/fungibleAssetTransferBuilder.ts
diff --git a/modules/sdk-coin-apt/test/unit/transactionBuilder/transferBuilder.ts b/modules/sdk-coin-apt/test/unit/transactionBuilder/transferBuilder.ts
