Merge pull request #5845 from BitGo/coin-3571-fix-fund-forwarders-script

fix: fund forwarders script

Author: bhavidhingra

CODEOWNERS

@@ -85,6 +85,9 @@
 /modules/sdk-coin-xtz/ @BitGo/ethalt-team
 /modules/sdk-coin-zketh/ @BitGo/ethalt-team
 
+# Examples
+/examples/ @BitGo/ethalt-team
+
 # Trade
 /modules/sdk-core/src/bitgo/address-book/ @BitGo/prime
 /modules/sdk-core/src/bitgo/trading/ @BitGo/prime

examples/ts/apt/fund-forwarders.ts

@@ -0,0 +1,37 @@
+/**
+ * Send funds from a gas tank to a BitGo wallet's receive address.
+ *
+ * Copyright 2025, BitGo, Inc.  All Rights Reserved.
+ */
+import { BitGoAPI } from '@bitgo/sdk-api';
+import { Tapt } from '@bitgo/sdk-coin-apt';
+import { FundForwarderParams } from '@bitgo/sdk-core';
+
+const bitgo = new BitGoAPI({
+  accessToken: '<access token>',
+  env: 'test',
+});
+
+const coin = 'tapt';
+bitgo.register(coin, Tapt.createInstance);
+
+const walletId = '<wallet id>';
+
+async function main() {
+  bitgo.unlock({ otp: '000000' });
+  const walletInstance = await bitgo.coin(coin).wallets().get({ id: walletId });
+
+  const fundForwarderParams: FundForwarderParams = {
+    forwarders: [
+      {
+        forwarderAddress: '<forwarder address>',
+        amount: '<amount>' // optional field
+      },
+    ],
+  }
+
+  const response = await walletInstance.fundForwarders(fundForwarderParams);
+  console.log('Response', response);
+}
+
+main().catch((e) => console.error(e));

examples/ts/eth/fund-forwarder.ts

@@ -1,3 +1,5 @@
+import { FundForwarderParams } from "@bitgo/sdk-core";
+
 /**
  * Send funds from a fee address to a forwarder.
  *
@@ -28,12 +30,16 @@ async function fundForwarder() {
   bitgo.authenticateWithAccessToken({ accessToken });
   const wallet = await bitgo.coin(coin).wallets().get({ id: walletId });
 
-  const fundForwarderOptions = {
-    forwarderAddress: forwarderAddress,
-    amount: amount,
-  };
+  const fundForwarderParams: FundForwarderParams = {
+    forwarders: [
+      {
+        forwarderAddress,
+        amount, // optional field
+      },
+    ],
+  }
 
-  const response = await wallet.fundForwarder(fundForwarderOptions);
+  const response = await wallet.fundForwarders(fundForwarderParams);
   console.log('Response', response);
 }
 

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

@@ -432,6 +432,10 @@ export interface FundForwardersOptions {
   amount?: string;
 }
 
+export interface FundForwarderParams {
+  forwarders: FundForwardersOptions[];
+}
+
 export interface FlushForwarderTokenOptions {
   address?: string;
   id?: string;

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

@@ -99,6 +99,7 @@ import {
   BulkWalletShareKeychain,
   ManageUnspentReservationOptions,
   SignAndSendTxRequestOptions,
+  FundForwarderParams,
 } from './iWallet';
 import { GoStakingWallet, StakingWallet } from '../staking';
 import EddsaUtils from '../utils/tss/eddsa';
@@ -3629,6 +3630,22 @@ export class Wallet implements IWallet {
     return this._wallet;
   }
 
+  /**
+   * Send funds from a fee address to a forwarder.
+   *
+   * @param {Object} params - parameters object
+   * @param {List} params.forwarders - list of fund forwarder options
+   * @returns {*}
+   */
+  public async fundForwarders(params: FundForwarderParams): Promise<any> {
+    if (_.isUndefined(params.forwarders) || params.forwarders.length == 0) {
+      throw new Error('fund forwarder options required');
+    }
+    const url = this.url('/fundforwarders');
+    this._wallet = await this.bitgo.post(url).send(params).result();
+    return this._wallet;
+  }
+
   /**
    * Gets forwarder's balance
    * @param params - optional query parameters