Merge pull request #6378 from BitGo/BTC-2234-withdraw-failure-reason

feat: added withdrawStatus in response lightning

Author: parvbitgo067

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

@@ -3,7 +3,11 @@ 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 WithdrawStatusDelivered = 'delivered';
+export const WithdrawStatusFailed = 'failed';
+
+export const WithdrawStatus = t.union([t.literal(WithdrawStatusDelivered), t.literal(WithdrawStatusFailed)]);
+
 export const LightningOnchainWithdrawParams = t.type({
   recipients: t.array(LightningOnchainRecipient),
   satsPerVbyte: BigIntFromString,
@@ -13,6 +17,20 @@ export const LightningOnchainWithdrawParams = t.type({
 
 export type LightningOnchainWithdrawParams = t.TypeOf<typeof LightningOnchainWithdrawParams>;
 
+export const LndCreateWithdrawResponse = t.intersection(
+  [
+    t.type({
+      status: WithdrawStatus,
+    }),
+    t.partial({
+      txid: t.string,
+      failureReason: t.string,
+    }),
+  ],
+  'LndCreateWithdrawResponse'
+);
+export type LndCreateWithdrawResponse = t.TypeOf<typeof LndCreateWithdrawResponse>;
+
 export type LightningOnchainWithdrawResponse = {
   /**
    * Unique identifier for withdraw request submitted to BitGo.
@@ -32,6 +50,14 @@ export type LightningOnchainWithdrawResponse = {
    */
   pendingApproval?: PendingApprovalData;
 
+  /**
+   * Current snapshot of withdraw status (if available).
+   * - **`'delivered'`**: Withdraw request is delivered to the blockchain.
+   * - **`'failed'`**: Withdraw failed.
+   * This field is absent if approval is required before processing.
+   */
+  withdrawStatus?: LndCreateWithdrawResponse;
+
   /**
    * Latest transfer details for this withdraw request (if available).
    * - Provides the current state of the transfer.
@@ -77,10 +103,16 @@ export const SendPsbtRequest = t.type(
 );
 export type SendPsbtRequest = t.TypeOf<typeof SendPsbtRequest>;
 
-export const SendPsbtResponse = t.type(
-  {
-    label: t.string,
-  },
+export const SendPsbtResponse = t.intersection(
+  [
+    t.type({
+      label: t.string,
+    }),
+    t.partial({
+      status: WithdrawStatus,
+      failureReason: t.string,
+    }),
+  ],
   'SendPsbtResponse'
 );
 export type SendPsbtResponse = t.TypeOf<typeof SendPsbtResponse>;

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

@@ -27,6 +27,7 @@ import {
   LightningOnchainWithdrawResponse,
   ListInvoicesResponse,
   ListPaymentsResponse,
+  LndCreateWithdrawResponse,
 } from '../codecs';
 import { LightningPaymentIntent, LightningPaymentRequest } from '@bitgo/public-types';
 
@@ -378,6 +379,7 @@ export class LightningWallet implements ILightningWallet {
       reqId
     );
 
+    const coinSpecific = transactionRequestSend.transactions?.[0]?.unsignedTx?.coinSpecific;
     let updatedTransfer: any = undefined;
     try {
       updatedTransfer = await this.wallet.getTransfer({ id: transfer.id });
@@ -391,6 +393,10 @@ export class LightningWallet implements ILightningWallet {
       txRequestId: transactionRequestCreate.txRequestId,
       txRequestState: transactionRequestSend.state,
       transfer: updatedTransfer,
+      withdrawStatus:
+        coinSpecific && 'status' in coinSpecific
+          ? t.exact(LndCreateWithdrawResponse).encode(coinSpecific as LndCreateWithdrawResponse)
+          : undefined,
     };
   }
 

modules/bitgo/test/v2/unit/lightning/lightningWallets.ts

@@ -832,9 +832,19 @@ describe('Lightning wallets', function () {
         state: 'pendingDelivery',
       };
 
-      const finalPaymentResponse = {
+      const finalWithdrawResponse = {
         txRequestId: 'txReq123',
         state: 'delivered',
+        transactions: [
+          {
+            unsignedTx: {
+              coinSpecific: {
+                status: 'delivered',
+                txid: 'tx123',
+              },
+            },
+          },
+        ],
       };
 
       const transferResponse = {
@@ -935,7 +945,7 @@ describe('Lightning wallets', function () {
 
       const sendTxRequestNock = nock(bgUrl)
         .post(`/api/v2/wallet/${wallet.wallet.id()}/txrequests/${txRequestResponse.txRequestId}/transactions/0/send`)
-        .reply(200, finalPaymentResponse);
+        .reply(200, finalWithdrawResponse);
 
       const getTransferNock = nock(bgUrl)
         .get(`/api/v2/${coinName}/wallet/${wallet.wallet.id()}/transfer/${transferResponse.id}`)
@@ -944,6 +954,8 @@ describe('Lightning wallets', function () {
       const response = await wallet.withdrawOnchain(params);
       assert.strictEqual(response.txRequestId, 'txReq123');
       assert.strictEqual(response.txRequestState, 'delivered');
+      assert.strictEqual(response.withdrawStatus?.status, 'delivered');
+      assert.strictEqual(response.withdrawStatus?.txid, 'tx123');
       assert.deepStrictEqual(response.transfer, updatedTransferResponse);
 
       createTxRequestNock.done();

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

@@ -1,7 +1,7 @@
 import * as sinon from 'sinon';
 import * as should from 'should';
 import * as express from 'express';
-import { PayInvoiceResponse } from '@bitgo/abstract-lightning';
+import { LightningOnchainWithdrawResponse } from '@bitgo/abstract-lightning';
 import { BitGo } from 'bitgo';
 import { handleLightningWithdraw } from '../../../src/lightning/lightningWithdrawRoutes';
 
@@ -34,9 +34,13 @@ describe('Lightning Withdraw Routes', () => {
         satsPerVbyte: '15',
       };
 
-      const expectedResponse: PayInvoiceResponse = {
+      const expectedResponse: LightningOnchainWithdrawResponse = {
         txRequestState: 'delivered',
         txRequestId: '123',
+        withdrawStatus: {
+          status: 'delivered',
+          txid: 'tx123',
+        },
       };
 
       const onchainWithdrawStub = sinon.stub().resolves(expectedResponse);