Class NostrWebLNProvider

constructor

• new NostrWebLNProvider(
      options?: NewNostrWeblnProviderOptions,
  ): NostrWebLNProvider

  Parameters

  • Optionaloptions: NewNostrWeblnProviderOptions

  Returns NostrWebLNProvider

Readonlyclient

Readonlysubscribers

options

• get options(): NWCOptions

  Returns NWCOptions

close

• close(): void

  Returns void

enable

• enable(): Promise<void>

  Returns Promise<void>

getBalance

• getBalance(): Promise<GetBalanceResponse>

  Returns Promise<GetBalanceResponse>

getInfo

• getInfo(): Promise<GetInfoResponse>

  Returns Promise<GetInfoResponse>

getPublicKey

• getPublicKey(): Promise<string>

  Returns Promise<string>

keysend

• keysend(args: KeysendArgs): Promise<SendPaymentResponse>

  Parameters

  • args: KeysendArgs

  Returns Promise<SendPaymentResponse>

listTransactions

• listTransactions(args: ListTransactionsArgs): Promise<ListTransactionsResponse>

  Parameters

  • args: ListTransactionsArgs

  Returns Promise<ListTransactionsResponse>

lnurl

• lnurl(
      lnurl: string,
  ): Promise<{ status: "OK" } | { reason: string; status: "ERROR" }>

  Parameters

  • lnurl: string

  Returns Promise<{ status: "OK" } | { reason: string; status: "ERROR" }>

lookupInvoice

• lookupInvoice(args: LookupInvoiceArgs): Promise<LookupInvoiceResponse>

  Parameters

  • args: LookupInvoiceArgs

  Returns Promise<LookupInvoiceResponse>

makeInvoice

• makeInvoice(
      args: string | number | RequestInvoiceArgs,
  ): Promise<MakeInvoiceResponse>

  Parameters

  • args: string | number | RequestInvoiceArgs

  Returns Promise<MakeInvoiceResponse>

multiKeysend

• multiKeysend(keysends: KeysendArgs[]): Promise<MultiKeysendResponse>

  Parameters

  • keysends: KeysendArgs[]

  Returns Promise<MultiKeysendResponse>

notify

• notify(name: WebLNMethod, payload?: unknown): void

  Parameters

  • name: WebLNMethod
  • Optionalpayload: unknown

  Returns void

on

• on(name: string, callback: () => void): void

  Parameters

  • name: string
  • callback: () => void

  Returns void

request

• request(method: WebLNRequestMethod, args?: unknown): Promise<unknown>

  Parameters

  • method: WebLNRequestMethod
  • Optionalargs: unknown

  Returns Promise<unknown>

sendMultiPayment

• sendMultiPayment(paymentRequests: string[]): Promise<SendMultiPaymentResponse>

  Parameters

  • paymentRequests: string[]

  Returns Promise<SendMultiPaymentResponse>

sendPayment

• sendPayment(invoice: string): Promise<SendPaymentResponse>

  Parameters

  • invoice: string

  Returns Promise<SendPaymentResponse>

sendPaymentAsync

• sendPaymentAsync(invoice: string): Promise<Record<string, never>>

  Parameters

  • invoice: string

  Returns Promise<Record<string, never>>

signEvent

• signEvent(event: UnsignedEvent): Promise<Event>

  Parameters

  • event: UnsignedEvent

  Returns Promise<Event>

signMessage

• signMessage(message: string): Promise<SignMessageResponse>

  Parameters

  • message: string

  Returns Promise<SignMessageResponse>

verifyMessage

• verifyMessage(signature: string, message: string): Promise<void>

  Parameters

  • signature: string
  • message: string

  Returns Promise<void>

StaticfromAuthorizationUrl

• fromAuthorizationUrl(
      authorizationBasePath: string,
      options?: NWCAuthorizationUrlOptions,
      secret?: string,
  ): Promise<NostrWebLNProvider>

  Parameters

  • authorizationBasePath: string
  • options: NWCAuthorizationUrlOptions = {}
  • Optionalsecret: string

  Returns Promise<NostrWebLNProvider>