Merge pull request #6081 from BitGo/BTC-2072-withdraw-params-change

fix: making satsPerVbyte compulsory

Author: parvbitgo067

modules/abstract-lightning/src/codecs/api/withdraw.ts

@@ -1,15 +1,15 @@
 import * as t from 'io-ts';
-import { LightningOnchainRequest } from '@bitgo/public-types';
+import { LightningOnchainRecipient } from '@bitgo/public-types';
 import { PendingApprovalData, TxRequestState } from '@bitgo/sdk-core';
+import { BigIntFromString } from 'io-ts-types';
 
 // todo:(current) which to keep here which to take to common types
-export const LightningOnchainWithdrawParams = t.intersection([
-  LightningOnchainRequest,
-  t.type({
-    // todo:(current) add passphrase
-    // passphrase: t.string,
-  }),
-]);
+export const LightningOnchainWithdrawParams = t.type({
+  recipients: t.array(LightningOnchainRecipient),
+  satsPerVbyte: BigIntFromString,
+  // todo:(current) add passphrase
+  // passphrase: t.string,
+});
 
 export type LightningOnchainWithdrawParams = t.TypeOf<typeof LightningOnchainWithdrawParams>;
 

modules/abstract-lightning/src/wallet/lightning.ts

@@ -163,7 +163,7 @@ export interface ILightningWallet {
    * On chain withdrawal
    * @param {LightningOnchainWithdrawParams} params - Withdraw parameters
    * @param {LightningOnchainRecipient[]} params.recipients - The recipients to pay
-   * @param {bigint} [params.satsPerVbyte] - Optional value for sats per virtual byte
+   * @param {bigint} params.satsPerVbyte - Value for sats per virtual byte
    * @returns {Promise<LightningOnchainWithdrawResponse>} Withdraw result containing transaction request details and status
    */
   withdrawOnchain(params: LightningOnchainWithdrawParams): Promise<LightningOnchainWithdrawResponse>;

modules/express/test/unit/lightning/lightningWithdrawRoutes.test.ts

@@ -82,7 +82,28 @@ describe('Lightning Withdraw Routes', () => {
       should(firstArg).have.property('satsPerVbyte', BigInt(inputParams.satsPerVbyte));
     });
 
-    it('should throw an error if the passphrase is missing in the request params', async () => {
+    it('should throw an error if the satsPerVbyte is missing in the request params', async () => {
+      const inputParams = {
+        recipients: [
+          {
+            amountSat: '500000',
+            address: 'bcrt1qjq48cqk2u80hewdcndf539m8nnnvt845nl68x7',
+          },
+        ],
+      };
+
+      const req = mockRequestObject({
+        params: { id: 'testWalletId', coin },
+        body: inputParams,
+      });
+      req.bitgo = bitgo;
+
+      await should(handleLightningWithdraw(req)).be.rejectedWith(
+        'Invalid request body for withdrawing on chain lightning balance'
+      );
+    });
+
+    it('should throw an error if the recipients is missing in the request params', async () => {
       const inputParams = {
         satsPerVbyte: '15',
       };