Merge pull request #5081 from BitGo/SC-531-sdk-change-wallet-for-unstaking-to-descriptor-wallet

chore(sdk-core): change unstaking wallet id for btc unstaking

Author: mohammadalfaiyazbitgo

modules/bitgo/test/v2/fixtures/staking/stakingWallet.ts

@@ -23,13 +23,14 @@ export default {
   transaction: function (
     status: string,
     buildParams?: PrebuildTransactionOptions,
-    setTxRequestId = true
+    setTxRequestId = true,
+    transactionType = 'DELEGATE'
   ): StakingTransaction {
     const transaction: StakingTransaction = {
       id: '00566722-daef-40eb-b0ac-fa5402bbfe72',
       stakingRequestId: '8638284a-dab2-46b9-b07f-21109a6e7220',
       delegationId: '505bda16-a000-461a-8421-1cf3f8617883',
-      transactionType: 'DELEGATE',
+      transactionType,
       createdDate: '2022-01-03T22:04:29.264Z',
       status: status,
       statusModifiedDate: '2022-01-03T22:04:29.264Z',
@@ -60,4 +61,20 @@ export default {
       actionType: 'DELEGATE',
     },
   },
+  btcUnstakingBuildParams: {
+    recipients: [
+      {
+        amount: '1234',
+        address: 'address',
+        data: 'data',
+      },
+    ],
+    stakingParams: {
+      requestId: '8638284a-dab2-46b9-b07f-21109a6e7220',
+      amount: '1234',
+      validator: 'validator',
+      actionType: 'DELEGATE',
+    },
+    senderWalletId: 'btcDescriptorWalletId',
+  },
 };

modules/bitgo/test/v2/unit/staking/stakingWalletNonTSS.ts

@@ -13,10 +13,14 @@ describe('non-TSS Staking Wallet', function () {
   let bitgo;
   let ethBaseCoin;
   let maticBaseCoin;
+  let btcBaseCoin;
   let enterprise;
   let ethWalletData: any;
+  let btcWalletData: any;
+  let btcDescriptorWalletData: any;
   let ethStakingWallet: StakingWallet;
   let maticStakingWallet: StakingWallet;
+  let btcStakingWallet: StakingWallet;
 
   before(function () {
     bitgo = TestBitGo.decorate(BitGo, { env: 'mock', microservicesUri } as any);
@@ -25,6 +29,8 @@ describe('non-TSS Staking Wallet', function () {
     ethBaseCoin.keychains();
     maticBaseCoin = bitgo.coin('matic');
     maticBaseCoin.keychains();
+    btcBaseCoin = bitgo.coin('btc');
+    btcBaseCoin.keychains();
 
     enterprise = new Enterprise(bitgo, ethBaseCoin, {
       id: '5cf940949449412d00f53b3d92dbcaa3',
@@ -43,10 +49,26 @@ describe('non-TSS Staking Wallet', function () {
       enterprise: enterprise.id,
       keys: ['5b3424f91bf349930e340175'],
     };
+    btcWalletData = {
+      id: 'btcWalletId',
+      coin: 'btc',
+      enterprise: enterprise.id,
+      keys: ['5b3424f91bf349930e340175'],
+      coinSpecific: {},
+    };
+    btcDescriptorWalletData = {
+      id: 'btcDescriptorWalletId',
+      coin: 'btc',
+      enterprise: enterprise.id,
+      keys: ['5b3424f91bf349930e340175'],
+      coinSpecific: {},
+    };
     const ethWallet = new Wallet(bitgo, ethBaseCoin, ethWalletData);
     const maticWallet = new Wallet(bitgo, maticBaseCoin, maticWalletData);
+    const btcWallet = new Wallet(bitgo, btcBaseCoin, btcWalletData);
     ethStakingWallet = ethWallet.toStakingWallet();
     maticStakingWallet = maticWallet.toStakingWallet();
+    btcStakingWallet = btcWallet.toStakingWallet();
   });
 
   const sandbox = sinon.createSandbox();
@@ -207,4 +229,41 @@ describe('non-TSS Staking Wallet', function () {
       stakingTransaction.should.deepEqual(transaction);
     });
   });
+
+  describe('BTC staking', function () {
+    it('btc delegation transaction', async function () {
+      const transaction = fixtures.transaction('READY', fixtures.buildParams, false);
+
+      nock(microservicesUri)
+        .get(
+          `/api/staking/v1/${btcStakingWallet.coin}/wallets/${btcStakingWallet.walletId}/requests/${transaction.stakingRequestId}/transactions/${transaction.id}`
+        )
+        .query({ expandBuildParams: true })
+        .reply(200, transaction);
+
+      const prebuildTransaction = sandbox.stub(Wallet.prototype, 'prebuildTransaction');
+      const descriptor = sandbox.stub(StakingWallet.prototype, <any>'getDescriptorWallet');
+      await btcStakingWallet.build(transaction);
+      prebuildTransaction.calledOnceWithExactly(transaction.buildParams).should.be.true;
+      descriptor.notCalled.should.be.true;
+    });
+
+    it('btc undelegation transaction', async function () {
+      const transaction = fixtures.transaction('READY', fixtures.btcUnstakingBuildParams, false, 'UNDELEGATE_WITHDRAW');
+
+      nock(microservicesUri)
+        .get(
+          `/api/staking/v1/${btcStakingWallet.coin}/wallets/${btcStakingWallet.walletId}/requests/${transaction.stakingRequestId}/transactions/${transaction.id}`
+        )
+        .query({ expandBuildParams: true })
+        .reply(200, transaction);
+      nock(microservicesUri)
+        .get(`/api/v2/btc/wallet/${btcDescriptorWalletData.id}`)
+        .reply(200, btcDescriptorWalletData);
+
+      const prebuildTransaction = sandbox.stub(Wallet.prototype, 'prebuildTransaction');
+      await btcStakingWallet.build(transaction);
+      prebuildTransaction.calledOnceWithExactly(transaction.buildParams).should.be.true;
+    });
+  });
 });

modules/sdk-core/src/bitgo/staking/stakingWallet.ts

@@ -20,6 +20,7 @@ import {
 import { BitGoBase } from '../bitgoBase';
 import { IWallet, PrebuildTransactionResult } from '../wallet';
 import { ITssUtils, RequestTracer, TssUtils } from '../utils';
+import assert from 'assert';
 
 export class StakingWallet implements IStakingWallet {
   private readonly bitgo: BitGoBase;
@@ -153,9 +154,15 @@ export class StakingWallet implements IStakingWallet {
       if (!transaction.buildParams) {
         throw Error(`Staking transaction ${transaction.id} build params not expanded`);
       }
+      const isBtcUndelegate =
+        this.wallet.baseCoin.getFamily() === 'btc' && transaction.transactionType === 'UNDELEGATE_WITHDRAW';
+      const wallet = isBtcUndelegate
+        ? await this.getDescriptorWallet(transaction)
+        : await this.getWalletForBuildingAndSigning();
+
       return {
         transaction: transaction,
-        result: await (await this.getWalletForBuildingAndSigning()).prebuildTransaction(transaction.buildParams),
+        result: await wallet.prebuildTransaction(transaction.buildParams),
       };
     }
   }
@@ -320,4 +327,9 @@ export class StakingWallet implements IStakingWallet {
       return true;
     }
   }
+
+  private async getDescriptorWallet(transaction: StakingTransaction): Promise<IWallet> {
+    assert(transaction.buildParams?.senderWalletId, 'senderWalletId is required for btc undelegate transaction');
+    return await this.wallet.baseCoin.wallets().get({ id: transaction.buildParams.senderWalletId });
+  }
 }

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

@@ -111,6 +111,15 @@ export interface PrebuildTransactionOptions {
    * This feature is supported only for specific coins, like ADA.
    */
   senderAddress?: string;
+
+  /**
+   * The wallet ID of the sender wallet when sender wallet is different from current wallet id.
+   * @type {string}
+   * @default {undefined}
+   * @description For BTC unstaking, the sender wallet(a descriptor wallet) is different from original wallet
+   * */
+  senderWalletId?: string;
+
   changeAddress?: string;
   allowExternalChangeAddress?: boolean;
   type?: string;