Feature: handle lnurl success action

__tests__/screens/send-bitcoin-completed-screen.spec.tsx

@@ -0,0 +1,119 @@
+import React from "react"
+import { fireEvent, render, screen, waitFor } from "@testing-library/react-native"
+import { loadLocale } from "@app/i18n/i18n-util.sync"
+import { i18nObject } from "@app/i18n/i18n-util"
+import {
+  Success,
+  Queued,
+  Pending,
+  SuccessLUD09Message,
+  SuccessLUD09URL,
+  SuccessLUD09URLWithDesc,
+} from "../../app/screens/send-bitcoin-screen/send-bitcoin-completed-screen.stories"
+import { ContextForScreen } from "./helper"
+import { Linking } from "react-native"
+
+jest.mock("react-native-in-app-review", () => ({
+  isAvailable: () => true,
+  RequestInAppReview: jest.fn(),
+}))
+
+describe("SendBitcoinCompletedScreen", () => {
+  let LL: ReturnType<typeof i18nObject>
+
+  beforeEach(() => {
+    loadLocale("en")
+    LL = i18nObject("en")
+  })
+
+  it("renders the Success state correctly", async () => {
+    render(
+      <ContextForScreen>
+        <Success />
+      </ContextForScreen>,
+    )
+
+    const successTextElement = await waitFor(() => screen.findByTestId("Success Text"))
+    expect(successTextElement.props.children).toContain(
+      "Payment has been sent successfully",
+    )
+  })
+
+  it("renders the Queued state correctly", async () => {
+    render(
+      <ContextForScreen>
+        <Queued />
+      </ContextForScreen>,
+    )
+
+    const queuedTextElement = await waitFor(() => screen.findByTestId("Success Text"))
+    expect(queuedTextElement.props.children).toEqual(
+      expect.stringContaining("Your transaction is queued"),
+    )
+  })
+
+  it("renders the Pending state correctly", async () => {
+    render(
+      <ContextForScreen>
+        <Pending />
+      </ContextForScreen>,
+    )
+
+    const pendingTextElement = await waitFor(() => screen.findByTestId("Success Text"))
+    expect(pendingTextElement.props.children).toEqual(
+      expect.stringContaining("The payment has been sent"),
+    )
+  })
+
+  it("render successAction - LUD 09 - message", async () => {
+    const message = "Thanks for your support."
+
+    render(
+      <ContextForScreen>
+        <SuccessLUD09Message />
+      </ContextForScreen>,
+    )
+
+    expect(screen.getByText(message)).toBeTruthy()
+    expect(screen.getByText(LL.SendBitcoinScreen.note())).toBeTruthy()
+  })
+
+  it("render successAction - LUD 09 - URL", async () => {
+    const url = "https://es.blink.sv"
+
+    render(
+      <ContextForScreen>
+        <SuccessLUD09URL />
+      </ContextForScreen>,
+    )
+
+    const button = screen.getByText(LL.ScanningQRCodeScreen.openLinkTitle())
+
+    expect(button).toBeTruthy()
+
+    fireEvent.press(button)
+
+    expect(Linking.openURL).toHaveBeenCalledWith(url)
+  })
+
+  it("render successAction - LUD 09 - URL with description", async () => {
+    const url = "https://es.blink.sv"
+    const description = "Example URL + description"
+
+    render(
+      <ContextForScreen>
+        <SuccessLUD09URLWithDesc />
+      </ContextForScreen>,
+    )
+
+    expect(screen.getByText(description)).toBeTruthy()
+
+    const button = screen.getByText(LL.ScanningQRCodeScreen.openLinkTitle())
+
+    expect(button).toBeTruthy()
+
+    fireEvent.press(button)
+
+    expect(Linking.openURL).toHaveBeenCalledWith(url)
+  })
+})

app/graphql/generated.gql

@@ -323,6 +323,16 @@ mutation lnInvoicePaymentSend($input: LnInvoicePaymentInput!) {
       __typename
     }
     status
+    transaction {
+      settlementVia {
+        ... on SettlementViaLn {
+          preImage
+          __typename
+        }
+        __typename
+      }
+      __typename
+    }
     __typename
   }
 }

app/graphql/generated.ts

@@ -2954,7 +2954,7 @@ export type LnInvoicePaymentSendMutationVariables = Exact<{
 }>;
 
 
-export type LnInvoicePaymentSendMutation = { readonly __typename: 'Mutation', readonly lnInvoicePaymentSend: { readonly __typename: 'PaymentSendPayload', readonly status?: PaymentSendResult | null, readonly errors: ReadonlyArray<{ readonly __typename: 'GraphQLApplicationError', readonly message: string }> } };
+export type LnInvoicePaymentSendMutation = { readonly __typename: 'Mutation', readonly lnInvoicePaymentSend: { readonly __typename: 'PaymentSendPayload', readonly status?: PaymentSendResult | null, readonly errors: ReadonlyArray<{ readonly __typename: 'GraphQLApplicationError', readonly message: string }>, readonly transaction?: { readonly __typename: 'Transaction', readonly settlementVia: { readonly __typename: 'SettlementViaIntraLedger' } | { readonly __typename: 'SettlementViaLn', readonly preImage?: string | null } | { readonly __typename: 'SettlementViaOnChain' } } | null } };
 
 export type LnNoAmountUsdInvoicePaymentSendMutationVariables = Exact<{
   input: LnNoAmountUsdInvoicePaymentInput;
@@ -6533,6 +6533,13 @@ export const LnInvoicePaymentSendDocument = gql`
       message
     }
     status
+    transaction {
+      settlementVia {
+        ... on SettlementViaLn {
+          preImage
+        }
+      }
+    }
   }
 }
     `;

app/navigation/stack-param-lists.ts

@@ -1,3 +1,4 @@
+import { LNURLPaySuccessAction } from "lnurl-pay/dist/types/types"
 import { PhoneCodeChannelType, UserContact, WalletCurrency } from "@app/graphql/generated"
 import { EarnSectionType } from "@app/screens/earns-screen/sections"
 import { PhoneLoginInitiateType } from "@app/screens/phone-auth-screen"
@@ -52,6 +53,8 @@ export type RootStackParamList = {
   sendBitcoinCompleted: {
     arrivalAtMempoolEstimate?: number
     status: PaymentSendCompletedStatus
+    successAction?: LNURLPaySuccessAction
+    preimage?: string
   }
   language: undefined
   currency: undefined

app/screens/send-bitcoin-screen/payment-details/index.types.ts

@@ -1,5 +1,7 @@
-import { LnUrlPayServiceResponse } from "lnurl-pay/dist/types/types"
-
+import {
+  LnUrlPayServiceResponse,
+  LNURLPaySuccessAction,
+} from "lnurl-pay/dist/types/types"
 import {
   GraphQlApplicationError,
   IntraLedgerPaymentSendMutationHookResult,
@@ -87,6 +89,7 @@ export type SendPaymentMutation = (
 
 export type PaymentSendExtraInfo = {
   arrivalAtMempoolEstimate?: number
+  preimage?: string | null
 }
 
 export type SetAmount<T extends WalletCurrency> = (
@@ -101,6 +104,10 @@ export type SetInvoice<T extends WalletCurrency> = (params: {
   paymentRequestAmount: BtcMoneyAmount
 }) => PaymentDetail<T>
 
+export type SetSuccessAction<T extends WalletCurrency> = (
+  successAction: LNURLPaySuccessAction | undefined,
+) => PaymentDetail<T>
+
 type BasePaymentDetail<T extends WalletCurrency> = {
   memo?: string
   paymentType:
@@ -152,6 +159,11 @@ export type PaymentDetailSetAmount<T extends WalletCurrency> =
       destinationSpecifiedAmount: BtcMoneyAmount // the amount that comes from the destination
     }
 
+export type PaymentDetailSetSuccessAction<T extends WalletCurrency> = {
+  setSuccessAction?: SetSuccessAction<T>
+  successAction?: LNURLPaySuccessAction
+}
+
 // sendPayment and getFee are defined together
 export type PaymentDetailSendPaymentGetFee<T extends WalletCurrency> =
   | {
@@ -179,14 +191,16 @@ type LnurlSpecificProperties<T extends WalletCurrency> =
       paymentType: typeof PaymentType.Lnurl
       lnurlParams: LnUrlPayServiceResponse
       setInvoice: SetInvoice<T>
+      setSuccessAction: SetSuccessAction<T>
     }
 
 // combine all rules together with base type
 export type PaymentDetail<T extends WalletCurrency> = BasePaymentDetail<T> &
   LnurlSpecificProperties<T> &
   PaymentDetailSetMemo<T> &
   PaymentDetailSetAmount<T> &
-  PaymentDetailSendPaymentGetFee<T>
+  PaymentDetailSendPaymentGetFee<T> &
+  PaymentDetailSetSuccessAction<T>
 
 export const AmountInvalidReason = {
   InsufficientBalance: "InsufficientBalance",

app/screens/send-bitcoin-screen/payment-details/lightning.ts

@@ -1,4 +1,7 @@
-import { LnUrlPayServiceResponse } from "lnurl-pay/dist/types/types"
+import {
+  LnUrlPayServiceResponse,
+  LNURLPaySuccessAction,
+} from "lnurl-pay/dist/types/types"
 
 import { WalletCurrency } from "@app/graphql/generated"
 import {
@@ -13,6 +16,7 @@ import { PaymentType } from "@galoymoney/client"
 
 import {
   ConvertMoneyAmount,
+  SetSuccessAction,
   SetInvoice,
   GetFee,
   PaymentDetail,
@@ -250,10 +254,17 @@ export const createAmountLightningPaymentDetails = <T extends WalletCurrency>(
         },
       },
     })
+    const { settlementVia } = data?.lnInvoicePaymentSend.transaction || {}
 
     return {
       status: data?.lnInvoicePaymentSend.status,
       errors: data?.lnInvoicePaymentSend.errors,
+      extraInfo: {
+        preimage:
+          settlementVia?.__typename === "SettlementViaLn"
+            ? settlementVia.preImage
+            : undefined,
+      },
     }
   }
 
@@ -368,6 +379,7 @@ export type CreateLnurlPaymentDetailsParams<T extends WalletCurrency> = {
   paymentRequest?: string
   paymentRequestAmount?: BtcMoneyAmount
   unitOfAccountAmount: MoneyAmount<WalletOrDisplayCurrency>
+  successAction?: LNURLPaySuccessAction
 } & BaseCreatePaymentDetailsParams<T>
 
 export const createLnurlPaymentDetails = <T extends WalletCurrency>(
@@ -383,6 +395,7 @@ export const createLnurlPaymentDetails = <T extends WalletCurrency>(
     sendingWalletDescriptor,
     destinationSpecifiedMemo,
     senderSpecifiedMemo,
+    successAction,
   } = params
 
   const destinationSpecifiedAmount =
@@ -465,6 +478,13 @@ export const createLnurlPaymentDetails = <T extends WalletCurrency>(
     })
   }
 
+  const setSuccessAction: SetSuccessAction<T> = (newSuccessAction) => {
+    return createLnurlPaymentDetails({
+      ...params,
+      successAction: newSuccessAction,
+    })
+  }
+
   const setSendingWalletDescriptor: SetSendingWalletDescriptor<T> = (
     newSendingWalletDescriptor,
   ) => {
@@ -488,6 +508,8 @@ export const createLnurlPaymentDetails = <T extends WalletCurrency>(
     setInvoice,
     convertMoneyAmount,
     setConvertMoneyAmount,
+    successAction,
+    setSuccessAction,
     ...setAmount,
     ...setMemo,
     ...sendPaymentAndGetFee,