Merge pull request #4988 from BitGo/BTC-1527-add-build-only-flag

feat(wp): add manage unspents build flag to fanoutUnspents

Author: davidkaplanbitgo

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

@@ -1500,7 +1500,6 @@ describe('V2 Wallet:', function () {
     it('should pass unspents parameter when calling fanout unspents', async function () {
       const path = `/api/v2/${wallet.coin()}/wallet/${wallet.id()}/fanoutUnspents`;
       const response = nock(bgUrl)
-        .persist()
         .post(path, _.matches({ unspents })) // use _.matches to do a partial match on request body object instead of strict matching
         .reply(200);
 
@@ -1513,6 +1512,26 @@ describe('V2 Wallet:', function () {
 
       response.isDone().should.be.true();
     });
+
+    it('should only build tx (not sign/send) while fanning out unspents', async function () {
+      const path = `/api/v2/${wallet.coin()}/wallet/${wallet.id()}/fanoutUnspents`;
+      const response = nock(bgUrl).post(path, _.matches({ unspents })).reply(200);
+
+      const unusedNocks = nock(bgUrl);
+      unusedNocks.get(`/api/v2/${wallet.coin()}/key/${wallet.keyIds()[0]}`).reply(200);
+      unusedNocks.post(`/api/v2/${wallet.coin()}/wallet/${wallet.id()}/tx/send`).reply(200);
+
+      try {
+        await wallet.fanoutUnspents({ address, unspents }, ManageUnspentsOptions.BUILD_ONLY);
+      } catch (e) {
+        // the fanoutUnspents method will probably throw an exception for not having all of the correct nocks
+        // we only care about /fanoutUnspents and whether unspents is an allowed parameter
+      }
+
+      response.isDone().should.be.true();
+      unusedNocks.pendingMocks().length.should.eql(2);
+      nock.cleanAll();
+    });
   });
 
   describe('manage unspents', function () {
@@ -1570,6 +1589,7 @@ describe('V2 Wallet:', function () {
       await wallet.consolidateUnspents({ bulk: true, walletPassphrase });
 
       nocks.forEach((n) => {
+        console.log(n);
         n.isDone().should.be.true();
       });
     });

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

@@ -815,9 +815,14 @@ export class Wallet implements IWallet {
    * @param {Number} params.maxFeeRate - The max limit for a fee rate in satoshis/kB
    * @param {Number} params.maxNumInputsToUse - the number of unspents you want to use in the transaction
    * @param {Number} params.numUnspentsToMake - the number of new unspents to make
+   *
+   * @param {ManageUnspentsOptions} option - flag to toggle build and send or build only
    */
-  async fanoutUnspents(params: FanoutUnspentsOptions = {}): Promise<unknown> {
-    return this.manageUnspents('fanout', params);
+  async fanoutUnspents(
+    params: FanoutUnspentsOptions = {},
+    option = ManageUnspentsOptions.BUILD_SIGN_SEND
+  ): Promise<unknown> {
+    return this.manageUnspents('fanout', params, option);
   }
 
   /**