Class NWCClient

constructor

• new NWCClient(options?: NewNWCClientOptions): NWCClient

  Parameters

  • Optionaloptions: NewNWCClientOptions

  Returns NWCClient

lud16

options

relay

relayUrl

secret

walletPubkey

connected

• get connected(): boolean

  Returns boolean

encryptionType

• get encryptionType(): string

  Returns string

nostrWalletConnectUrl

• get nostrWalletConnectUrl(): string

  Returns string

publicKey

• get publicKey(): string

  Returns string

cancelHoldInvoice

• cancelHoldInvoice(
      request: Nip47CancelHoldInvoiceRequest,
  ): Promise<Nip47CancelHoldInvoiceResponse>

  Parameters

  • request: Nip47CancelHoldInvoiceRequest

  Returns Promise<Nip47CancelHoldInvoiceResponse>

close

• close(): void

  Returns void

createConnection

• createConnection(
      request: Nip47CreateConnectionRequest,
  ): Promise<Nip47CreateConnectionResponse>

  Parameters

  • request: Nip47CreateConnectionRequest

  Returns Promise<Nip47CreateConnectionResponse>

decrypt

• decrypt(pubkey: string, content: string): Promise<string>

  Parameters

  • pubkey: string
  • content: string

  Returns Promise<string>

encrypt

• encrypt(pubkey: string, content: string): Promise<string>

  Parameters

  • pubkey: string
  • content: string

  Returns Promise<string>

getBalance

• getBalance(): Promise<Nip47GetBalanceResponse>

  Returns Promise<Nip47GetBalanceResponse>

getBudget

• getBudget(): Promise<Nip47GetBudgetResponse>

  Returns Promise<Nip47GetBudgetResponse>

getEventHash

• getEventHash(event: Event): string

  Parameters

  • event: Event

  Returns string

getInfo

• getInfo(): Promise<Nip47GetInfoResponse>

  Returns Promise<Nip47GetInfoResponse>

getNostrWalletConnectUrl

• getNostrWalletConnectUrl(includeSecret?: boolean): string

  Parameters

  • includeSecret: boolean = true

  Returns string

getPublicKey

• getPublicKey(): Promise<string>

  Returns Promise<string>

getWalletServiceInfo

• getWalletServiceInfo(): Promise<
      {
          capabilities: Nip47Capability[];
          encryptions: string[];
          notifications: (
              "payment_received"
              | "payment_sent"
              | "hold_invoice_accepted"
          )[];
      },
  >

  Returns Promise<
      {
          capabilities: Nip47Capability[];
          encryptions: string[];
          notifications: (
              "payment_received"
              | "payment_sent"
              | "hold_invoice_accepted"
          )[];
      },
  >

listTransactions

• listTransactions(
      request: Nip47ListTransactionsRequest,
  ): Promise<Nip47ListTransactionsResponse>

  Parameters

  • request: Nip47ListTransactionsRequest

  Returns Promise<Nip47ListTransactionsResponse>

lookupInvoice

• lookupInvoice(request: Nip47LookupInvoiceRequest): Promise<Nip47Transaction>

  Parameters

  • request: Nip47LookupInvoiceRequest

  Returns Promise<Nip47Transaction>

makeHoldInvoice

• makeHoldInvoice(request: Nip47MakeHoldInvoiceRequest): Promise<Nip47Transaction>

  Parameters

  • request: Nip47MakeHoldInvoiceRequest

  Returns Promise<Nip47Transaction>

makeInvoice

• makeInvoice(request: Nip47MakeInvoiceRequest): Promise<Nip47Transaction>

  Parameters

  • request: Nip47MakeInvoiceRequest

  Returns Promise<Nip47Transaction>

multiPayInvoice

• multiPayInvoice(
      request: Nip47MultiPayInvoiceRequest,
  ): Promise<Nip47MultiPayInvoiceResponse>

  Parameters

  • request: Nip47MultiPayInvoiceRequest

  Returns Promise<Nip47MultiPayInvoiceResponse>

multiPayKeysend

• multiPayKeysend(
      request: Nip47MultiPayKeysendRequest,
  ): Promise<Nip47MultiPayKeysendResponse>

  Parameters

  • request: Nip47MultiPayKeysendRequest

  Returns Promise<Nip47MultiPayKeysendResponse>

payInvoice

• payInvoice(request: Nip47PayInvoiceRequest): Promise<Nip47PayResponse>

  Parameters

  • request: Nip47PayInvoiceRequest

  Returns Promise<Nip47PayResponse>

payKeysend

• payKeysend(request: Nip47PayKeysendRequest): Promise<Nip47PayResponse>

  Parameters

  • request: Nip47PayKeysendRequest

  Returns Promise<Nip47PayResponse>

settleHoldInvoice

• settleHoldInvoice(
      request: Nip47SettleHoldInvoiceRequest,
  ): Promise<Nip47SettleHoldInvoiceResponse>

  Parameters

  • request: Nip47SettleHoldInvoiceRequest

  Returns Promise<Nip47SettleHoldInvoiceResponse>

signEvent

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

  Parameters

  • event: EventTemplate

  Returns Promise<Event>

signMessage

• signMessage(request: Nip47SignMessageRequest): Promise<Nip47SignMessageResponse>

  Parameters

  • request: Nip47SignMessageRequest

  Returns Promise<Nip47SignMessageResponse>

subscribeNotifications

• subscribeNotifications(
      onNotification: (notification: Nip47Notification) => void,
      notificationTypes?: (
          "payment_received"
          | "payment_sent"
          | "hold_invoice_accepted"
      )[],
  ): Promise<() => void>

  Parameters

  • onNotification: (notification: Nip47Notification) => void
  • OptionalnotificationTypes: ("payment_received" | "payment_sent" | "hold_invoice_accepted")[]

  Returns Promise<() => void>

StaticfromAuthorizationUrl

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

  create a new client-initiated NWC connection via HTTP deeplink

  Parameters

  • authorizationBasePath: string

    the deeplink path e.g. https://my.albyhub.com/apps/new
  • options: NWCAuthorizationUrlOptions = {}

    configure the created app (e.g. the name, budget, expiration)
  • Optionalsecret: string

    optionally pass a secret, otherwise one will be generated.

  Returns Promise<NWCClient>

StaticgetAuthorizationUrl

• getAuthorizationUrl(
      authorizationBasePath: string,
      options?: NWCAuthorizationUrlOptions,
      pubkey: string,
  ): URL

  Parameters

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

  Returns URL

StaticparseWalletConnectUrl

• parseWalletConnectUrl(walletConnectUrl: string): NWCOptions

  Parameters

  • walletConnectUrl: string

  Returns NWCOptions