Merge pull request #6346 from BitGo/BTC-2225-payments-api-changes

feat: primary key changes for payment apis

Author: parvbitgo067

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

@@ -28,7 +28,9 @@ export const PAYMENT_FAILURE_INSUFFICIENT_WALLET_BALANCE = 'INSUFFICIENT_WALLET_
 /** Excess custodial lightning balance for the customer's wallet */
 export const PAYMENT_FAILURE_EXCESS_WALLET_BALANCE = 'EXCESS_WALLET_BALANCE';
 export const PAYMENT_FAILURE_INVOICE_EXPIRED = 'INVOICE_EXPIRED';
-export const PAYMENT_FAILURE_PAYMENT_ALREADY_EXISTS = 'PAYMENT_ALREADY_EXISTS';
+export const PAYMENT_FAILURE_PAYMENT_ALREADY_SETTLED = 'PAYMENT_ALREADY_SETTLED';
+export const PAYMENT_FAILURE_PAYMENT_ALREADY_IN_FLIGHT = 'PAYMENT_ALREADY_IN_FLIGHT';
+export const PAYMENT_FAILURE_TRANSIENT_ERROR_RETRY_LATER = 'TRANSIENT_ERROR_RETRY_LATER';
 export const PAYMENT_FAILURE_CANCELED = 'CANCELED';
 export const PAYMENT_FAILURE_FORCE_FAILED = 'FORCE_FAILED';
 
@@ -41,7 +43,9 @@ export const PaymentFailureReason = t.union([
   t.literal(PAYMENT_FAILURE_INSUFFICIENT_WALLET_BALANCE),
   t.literal(PAYMENT_FAILURE_EXCESS_WALLET_BALANCE),
   t.literal(PAYMENT_FAILURE_INVOICE_EXPIRED),
-  t.literal(PAYMENT_FAILURE_PAYMENT_ALREADY_EXISTS),
+  t.literal(PAYMENT_FAILURE_PAYMENT_ALREADY_SETTLED),
+  t.literal(PAYMENT_FAILURE_PAYMENT_ALREADY_IN_FLIGHT),
+  t.literal(PAYMENT_FAILURE_TRANSIENT_ERROR_RETRY_LATER),
   t.literal(PAYMENT_FAILURE_CANCELED),
   t.literal(PAYMENT_FAILURE_FORCE_FAILED),
 ]);
@@ -54,6 +58,7 @@ export type PaymentFailureReason = t.TypeOf<typeof PaymentFailureReason>;
 export const PaymentInfo = t.intersection(
   [
     t.type({
+      id: t.string,
       paymentHash: t.string,
       walletId: t.string,
       txRequestId: t.string,
@@ -83,7 +88,7 @@ export const ListPaymentsResponse = t.intersection(
     }),
     t.partial({
       /**
-       * This is the paymentHash of the last Payment in the last iteration.
+       * This is the paymentId of the last Payment in the last iteration.
        * Providing this value as the prevId in the next request will return the next batch of payments.
        * */
       nextBatchPrevId: t.string,
@@ -102,7 +107,8 @@ export const PaymentQuery = t.partial(
     limit: BigIntFromString,
     startDate: DateFromISOString,
     endDate: DateFromISOString,
-    /** paymentHash provided by nextBatchPrevId in the previous list */
+    paymentHash: t.string,
+    /** paymentId provided by nextBatchPrevId in the previous list */
     prevId: t.string,
   },
   'PaymentQuery'
@@ -129,6 +135,7 @@ export const LndCreatePaymentResponse = t.intersection(
       paymentHash: t.string,
     }),
     t.partial({
+      paymentId: t.string,
       paymentPreimage: t.string,
       amountMsat: t.string,
       feeMsat: t.string,

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

@@ -170,19 +170,20 @@ export interface ILightningWallet {
    */
   withdrawOnchain(params: LightningOnchainWithdrawParams): Promise<LightningOnchainWithdrawResponse>;
   /**
-   * Get payment details by payment hash
-   * @param {string} paymentHash - Payment hash to lookup
+   * Get payment details by payment id
+   * @param {string} paymentId - Payment id to lookup
    * @returns {Promise<PaymentInfo>} Payment details
-   * @throws {InvalidPaymentHash} When payment hash is not valid
+   * @throws {InvalidPaymentId} When payment id is not valid
    */
-  getPayment(paymentHash: string): Promise<PaymentInfo>;
+  getPayment(paymentId: string): Promise<PaymentInfo>;
   /**
    * List payments for a wallet with optional filtering
    * @param {PaymentQuery} params Query parameters for filtering payments
    * @param {string} [params.status] The status of the payment
    * @param {bigint} [params.limit] The maximum number of payments to return
    * @param {Date} [params.startDate] The start date for the query
    * @param {Date} [params.endDate] The end date for the query
+   * @param {string} [params.paymentHash] The payment hash of the payments
    * @param {string} [params.prevId] Continue iterating (provided by nextBatchPrevId in the previous list)
    * @returns {Promise<ListPaymentsResponse>} List of payments and nextBatchPrevId
    */
@@ -393,9 +394,9 @@ export class LightningWallet implements ILightningWallet {
     };
   }
 
-  async getPayment(paymentHash: string): Promise<PaymentInfo> {
+  async getPayment(paymentId: string): Promise<PaymentInfo> {
     const response = await this.wallet.bitgo
-      .get(this.wallet.bitgo.url(`/wallet/${this.wallet.id()}/lightning/payment/${paymentHash}`, 2))
+      .get(this.wallet.bitgo.url(`/wallet/${this.wallet.id()}/lightning/payment/${paymentId}`, 2))
       .result();
     return decodeOrElse(PaymentInfo.name, PaymentInfo, response, (error) => {
       throw new Error(`Invalid payment response: ${error}`);

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

@@ -534,6 +534,7 @@ describe('Lightning wallets', function () {
 
     it('should get payments', async function () {
       const payment: PaymentInfo = {
+        id: '8308fddb-2356-49aa-8548-10c23099854c',
         paymentHash: 'foo',
         walletId: wallet.wallet.id(),
         txRequestId: 'txReqId',
@@ -562,6 +563,7 @@ describe('Lightning wallets', function () {
 
     it('should work properly with pagination while listing payments', async function () {
       const payment1: PaymentInfo = {
+        id: '8308fddb-2356-49aa-8548-10c23099854c',
         paymentHash: 'foo1',
         walletId: wallet.wallet.id(),
         txRequestId: 'txReqId1',
@@ -575,12 +577,14 @@ describe('Lightning wallets', function () {
       };
       const payment2: PaymentInfo = {
         ...payment1,
+        id: '8308fddb-2356-49aa-8548-10c23099854d',
         paymentHash: 'foo2',
         txRequestId: 'txReqId2',
         invoice: 'tlnfoobar2',
       };
       const payment3: PaymentInfo = {
         ...payment1,
+        id: '8308fddb-2356-49aa-8548-10c23099854e',
         paymentHash: 'foo3',
         txRequestId: 'txReqId3',
         invoice: 'tlnfoobar3',