Merge pull request #7075 from BitGo/BTC-2520-remove-transfer-data

fix: removed transfer data from payment withdraw

Author: parvbitgo067

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

@@ -60,14 +60,6 @@ export type LightningOnchainWithdrawResponse = {
    * 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.
-   * - To track the latest withdraw status, monitor `transfer` asynchronously.
-   * This field is absent if approval is required before processing.
-   */
-  transfer?: any;
 };
 
 export const FundPsbtResponse = t.type(

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

@@ -64,14 +64,6 @@ export type PayInvoiceResponse = {
    * This field is absent if approval is required before processing.
    */
   paymentStatus?: LndCreatePaymentResponse;
-
-  /**
-   * Latest transfer details for this payment request (if available).
-   * - Provides the current state of the transfer.
-   * - To track the final payment status, monitor `transfer` asynchronously.
-   * This field is absent if approval is required before processing.
-   */
-  transfer?: any;
 };
 
 /**
@@ -303,7 +295,7 @@ export class LightningWallet implements ILightningWallet {
       };
     }
 
-    const transfer: { id: string } = await this.wallet.bitgo
+    await this.wallet.bitgo
       .post(
         this.wallet.bitgo.url(
           '/wallet/' + this.wallet.id() + '/txrequests/' + transactionRequestCreate.txRequestId + '/transfers',
@@ -322,22 +314,13 @@ export class LightningWallet implements ILightningWallet {
     );
 
     const coinSpecific = transactionRequestSend.transactions?.[0]?.unsignedTx?.coinSpecific;
-    let updatedTransfer: any = undefined;
-    try {
-      updatedTransfer = await this.wallet.getTransfer({ id: transfer.id });
-    } catch (e) {
-      // If transfer is not found which is possible in cases where the payment has definitely failed
-      // Or even if some unknown error occurs, we will not throw an error here
-      // We still want to return the txRequestId, txRequestState and paymentStatus.
-    }
 
     return {
       txRequestId: transactionRequestCreate.txRequestId,
       txRequestState: transactionRequestSend.state,
       paymentStatus: coinSpecific
         ? t.exact(LndCreatePaymentResponse).encode(coinSpecific as LndCreatePaymentResponse)
         : undefined,
-      transfer: updatedTransfer,
     };
   }
 
@@ -431,7 +414,7 @@ export class LightningWallet implements ILightningWallet {
       };
     }
 
-    const transfer: { id: string } = await this.wallet.bitgo
+    await this.wallet.bitgo
       .post(
         this.wallet.bitgo.url(
           '/wallet/' + this.wallet.id() + '/txrequests/' + transactionRequestWithSignature.txRequestId + '/transfers',
@@ -450,19 +433,10 @@ export class LightningWallet implements ILightningWallet {
     );
 
     const coinSpecific = transactionRequestSend.transactions?.[0]?.unsignedTx?.coinSpecific;
-    let updatedTransfer: any = undefined;
-    try {
-      updatedTransfer = await this.wallet.getTransfer({ id: transfer.id });
-    } catch (e) {
-      // If transfer is not found which is possible in cases where the withdraw has definitely failed
-      // Or even if some unknown error occurs, we will not throw an error here
-      // We still want to return the txRequestId and txRequestState.
-    }
 
     return {
       txRequestId: transactionRequestWithSignature.txRequestId,
       txRequestState: transactionRequestSend.state,
-      transfer: updatedTransfer,
       withdrawStatus:
         coinSpecific && 'status' in coinSpecific
           ? t.exact(LndCreateWithdrawResponse).encode(coinSpecific as LndCreateWithdrawResponse)

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

@@ -401,17 +401,6 @@ describe('Lightning wallets', function () {
         state: 'initialized',
       };
 
-      const transferData = {
-        id: 'fake_id',
-        coin: 'tlnbtc',
-        state: 'confirmed',
-        txid: lndResponse.paymentHash,
-      };
-
-      const getTransferNock = nock(bgUrl)
-        .get(`/api/v2/${coinName}/wallet/${wallet.wallet.id()}/transfer/fake_id`)
-        .reply(200, transferData);
-
       const createTxRequestNock = nock(bgUrl)
         .post(`/api/v2/wallet/${wallet.wallet.id()}/txrequests`)
         .reply(200, txRequestResponse);
@@ -434,7 +423,6 @@ describe('Lightning wallets', function () {
       const response = await wallet.payInvoice(params);
       assert.strictEqual(response.txRequestId, 'txReq123');
       assert.strictEqual(response.txRequestState, 'delivered');
-      assert.strictEqual(response.transfer.id, transferData.id);
       assert.ok(response.paymentStatus);
       assert.strictEqual(
         response.paymentStatus.status,
@@ -457,7 +445,6 @@ describe('Lightning wallets', function () {
         finalPaymentResponse.transactions[0].unsignedTx.coinSpecific.paymentPreimage
       );
 
-      getTransferNock.done();
       createTxRequestNock.done();
       sendTxRequestNock.done();
       createTransferNock.done();
@@ -960,26 +947,6 @@ describe('Lightning wallets', function () {
         createdTime: '2025-06-09T07:47:16.102Z',
       };
 
-      const updatedTransferResponse = {
-        ...transferResponse,
-        txid: '211b8fb30990632751a83d1dc4f0323ff7d2fd3cad88084de13c9be2ae1c6426',
-        date: '2025-06-09T08:50:55.063Z',
-        state: 'signed',
-        history: [
-          {
-            date: '2025-06-09T07:50:55.063Z',
-            user: '6846918281f118cc42c33352779df88f',
-            action: 'signed',
-          },
-          {
-            date: '2025-06-09T07:47:16.102Z',
-            user: '6846918281f118cc42c33352779df88f',
-            action: 'created',
-          },
-        ],
-        signedTime: '2025-06-09T08:50:55.063Z',
-      };
-
       const createTxRequestNock = nock(bgUrl)
         .post(`/api/v2/wallet/${wallet.wallet.id()}/txrequests`)
         .reply(200, txRequestResponse);
@@ -996,10 +963,6 @@ describe('Lightning wallets', function () {
         .post(`/api/v2/wallet/${wallet.wallet.id()}/txrequests/${txRequestResponse.txRequestId}/transactions/0/send`)
         .reply(200, finalWithdrawResponse);
 
-      const getTransferNock = nock(bgUrl)
-        .get(`/api/v2/${coinName}/wallet/${wallet.wallet.id()}/transfer/${transferResponse.id}`)
-        .reply(200, updatedTransferResponse);
-
       const userAuthKeyNock = nock(bgUrl)
         .get('/api/v2/' + coinName + '/key/def')
         .reply(200, userAuthKey);
@@ -1013,15 +976,13 @@ describe('Lightning wallets', function () {
       assert.strictEqual(response.withdrawStatus?.status, 'delivered');
       assert.strictEqual(response.withdrawStatus?.txid, 'tx123');
       assert.strictEqual((response.withdrawStatus as any).signature, undefined);
-      assert.deepStrictEqual(response.transfer, updatedTransferResponse);
 
       userAuthKeyNock.done();
       nodeAuthKeyNock.done();
       createTxRequestNock.done();
       storeSignatureNock.done();
       createTransferNock.done();
       sendTxRequestNock.done();
-      getTransferNock.done();
     });
 
     it('should handle pending approval when withdrawing onchain', async function () {