feat: add support for withdrawals from receive addr for ADA

TICKET: WIN-3537

Author: shivpippal

modules/bitgo/test/v2/unit/wallet.ts

@@ -30,6 +30,8 @@ import {
   BaseTssUtils,
   KeyType,
   SendManyOptions,
+  PopulatedIntent,
+  TxRequestVersion,
 } from '@bitgo/sdk-core';
 
 import { TestBitGo } from '@bitgo/sdk-test';
@@ -46,6 +48,12 @@ require('should-sinon');
 
 nock.disableNetConnect();
 
+type CreateTxRequestBody = {
+  intent: PopulatedIntent;
+  apiversion: TxRequestVersion;
+  preview?: boolean;
+};
+
 describe('V2 Wallet:', function () {
   const reqId = new RequestTracer();
   const bitgo = TestBitGo.decorate(BitGo, { env: 'test' });
@@ -4387,5 +4395,46 @@ describe('V2 Wallet:', function () {
       sinon.stub(BaseTssUtils.default.prototype, 'sendTxRequest').resolves('sendTxResponse');
       await adaWallet.sendMany(sendManyParams);
     });
+
+    it('Should send senderAddress in payment intent when using sendmany', async function () {
+      const sendManyParams = {
+        type: 'transfer',
+        recipients: [
+          {
+            address: 'address',
+            amount: '1000',
+          },
+        ],
+        senderAddress: 'senderAddr1',
+      };
+
+      nock(bgUrl)
+        .post(`/api/v2/wallet/${adaWallet.id()}/txrequests`)
+        .reply((url, body: nock.Body) => {
+          const createTxRequestBody = body as CreateTxRequestBody;
+          createTxRequestBody.intent.intentType.should.equal('payment');
+          createTxRequestBody.intent.senderAddress?.should.equal('senderAddr1');
+
+          return [
+            200,
+            {
+              apiVersion: 'lite',
+              unsignedTxs: [
+                {
+                  unsignedTx: {
+                    serializedTxHex: 'serializedTxHex',
+                    feeInfo: 'fee info',
+                  },
+                },
+              ],
+            },
+          ];
+        });
+
+      sinon.stub(adaWallet.baseCoin, 'verifyTransaction').resolves(true);
+      sinon.stub(adaWallet, 'signTransaction').resolves({ txRequestId: 'txRequestId' });
+      sinon.stub(BaseTssUtils.default.prototype, 'sendTxRequest').resolves('sendTxResponse');
+      await adaWallet.sendMany(sendManyParams).should.be.resolved();
+    });
   });
 });

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

@@ -27,6 +27,8 @@ import {
   MPCUnsignedTx,
   MPCSweepRecoveryOptions,
   MPCTxs,
+  PopulatedIntent,
+  PrebuildTransactionWithIntentOptions,
 } from '@bitgo/sdk-core';
 import { KeyPair as AdaKeyPair, Transaction, TransactionBuilderFactory, Utils } from './lib';
 import { BaseCoin as StaticsBaseCoin, CoinFamily, coins } from '@bitgo/statics';
@@ -613,4 +615,10 @@ export class Ada extends BaseCoin {
   private getBuilder(): TransactionBuilderFactory {
     return new TransactionBuilderFactory(coins.get(this.getBaseChain()));
   }
+
+  /** inherited doc */
+  setCoinSpecificFieldsInIntent(intent: PopulatedIntent, params: PrebuildTransactionWithIntentOptions): void {
+    intent.unspents = params.unspents;
+    intent.senderAddress = params.senderAddress;
+  }
 }

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

@@ -25,6 +25,8 @@ import {
   TransactionExplanation,
   TssVerifyAddressOptions,
   VerifyTransactionOptions,
+  PopulatedIntent,
+  PrebuildTransactionWithIntentOptions,
 } from '@bitgo/sdk-core';
 import { BaseCoin as StaticsBaseCoin, BaseNetwork, coins, SuiCoin } from '@bitgo/statics';
 import BigNumber from 'bignumber.js';
@@ -791,4 +793,9 @@ export class Sui extends BaseCoin {
 
     return { transactions: consolidationTransactions, lastScanIndex };
   }
+
+  /** inherited doc */
+  setCoinSpecificFieldsInIntent(intent: PopulatedIntent, params: PrebuildTransactionWithIntentOptions): void {
+    intent.unspents = params.unspents;
+  }
 }

modules/sdk-core/src/bitgo/baseCoin/baseCoin.ts

@@ -45,7 +45,7 @@ import {
 } from './iBaseCoin';
 import { IInscriptionBuilder } from '../inscriptionBuilder';
 import { Hash } from 'crypto';
-import { MPCSweepRecoveryOptions, MPCTxs } from '../utils';
+import { MPCSweepRecoveryOptions, MPCTxs, PopulatedIntent, PrebuildTransactionWithIntentOptions } from '../utils';
 
 export abstract class BaseCoin implements IBaseCoin {
   protected readonly bitgo: BitGoBase;
@@ -551,4 +551,15 @@ export abstract class BaseCoin implements IBaseCoin {
   async createBroadcastableSweepTransaction(params: MPCSweepRecoveryOptions): Promise<MPCTxs> {
     throw new NotImplementedError('createBroadcastableSweepTransaction is not supported for this coin');
   }
+
+  /**
+   * Sets coinspecific fields in intent from input params.
+   * This method should be overridden in coin-specific classes
+   * to configure these fields in the intent
+   * @param intent - intent in which coinspecific fields are to be set
+   * @param params
+   */
+  setCoinSpecificFieldsInIntent(intent: PopulatedIntent, params: PrebuildTransactionWithIntentOptions): void {
+    return;
+  }
 }

modules/sdk-core/src/bitgo/baseCoin/iBaseCoin.ts

@@ -7,14 +7,14 @@ import { IMarkets } from '../market';
 import { IPendingApprovals } from '../pendingApproval';
 import { InitiateRecoveryOptions } from '../recovery';
 import { EcdsaMPCv2Utils, EcdsaUtils } from '../utils/tss/ecdsa';
-import EddsaUtils, { TxRequest } from '../utils/tss/eddsa';
+import EddsaUtils, { PrebuildTransactionWithIntentOptions, TxRequest } from '../utils/tss/eddsa';
 import { CustomSigningFunction, IWallet, IWallets, Wallet, WalletData } from '../wallet';
 
 import { IWebhooks } from '../webhook/iWebhooks';
 import { TransactionType } from '../../account-lib';
 import { IInscriptionBuilder } from '../inscriptionBuilder';
 import { Hash } from 'crypto';
-import { MPCTx } from '../utils';
+import { MPCTx, PopulatedIntent } from '../utils';
 
 export interface Output extends ITransactionRecipient {
   address: string;
@@ -537,4 +537,5 @@ export interface IBaseCoin {
   buildNftTransferData(params: BuildNftTransferDataOptions): string;
   getHashFunction(): Hash;
   broadcastTransaction(params: BaseBroadcastTransactionOptions): Promise<BaseBroadcastTransactionResult>;
+  setCoinSpecificFieldsInIntent(intent: PopulatedIntent, params: PrebuildTransactionWithIntentOptions): void;
 }

modules/sdk-core/src/bitgo/utils/mpcUtils.ts

@@ -169,9 +169,7 @@ export abstract class MpcUtils {
       }
     }
 
-    if (['ada', 'sui'].includes(baseCoin.getFamily()) && params.unspents) {
-      baseIntent.unspents = params.unspents;
-    }
+    this.baseCoin.setCoinSpecificFieldsInIntent(baseIntent, params);
 
     if (params.feeOptions !== undefined) {
       return {

modules/sdk-core/src/bitgo/utils/tss/baseTypes.ts

@@ -195,6 +195,11 @@ export interface PrebuildTransactionWithIntentOptions extends IntentOptionsBase
   custodianTransactionId?: string;
   receiveAddress?: string;
   unspents?: string[];
+  /**
+   * The receive address from which funds will be withdrawn.
+   * This feature is supported only for specific coins, like ADA.
+   */
+  senderAddress?: string;
 }
 export interface IntentRecipient {
   address: {
@@ -233,6 +238,11 @@ export interface PopulatedIntent extends PopulatedIntentBase {
   token?: string;
   enableTokens?: TokenEnablement[];
   unspents?: string[];
+  /**
+   * The receive address from which funds will be withdrawn.
+   * This feature is supported only for specific coins, like ADA.
+   */
+  senderAddress?: string;
   // ETH & ETH-like params
   selfSend?: boolean;
   feeOptions?: FeeOption | EIP1559FeeOptions;

modules/sdk-core/src/bitgo/wallet/iWallet.ts

@@ -106,6 +106,11 @@ export interface PrebuildTransactionOptions {
   gasPrice?: number;
   noSplitChange?: boolean;
   unspents?: any[];
+  /**
+   * The receive address from which funds will be withdrawn.
+   * This feature is supported only for specific coins, like ADA.
+   */
+  senderAddress?: string;
   changeAddress?: string;
   allowExternalChangeAddress?: boolean;
   type?: string;

modules/sdk-core/src/bitgo/wallet/wallet.ts

@@ -3135,6 +3135,7 @@ export class Wallet implements IWallet {
             feeOptions,
             custodianTransactionId: params.custodianTransactionId,
             unspents: params.unspents,
+            senderAddress: params.senderAddress,
           },
           apiVersion,
           params.preview