Class NWAClient

constructor

• new NWAClient(options: NewNWAClientOptions): NWAClient

  Parameters

  • options: NewNWAClientOptions

  Returns NWAClient

appSecretKey

options

relay

connectionUri

• get connectionUri(): string

  returns the NWA connection URI which should be given to the wallet

  Returns string

getConnectionUri

• getConnectionUri(nwaSchemeSuffix?: string): string

  returns the NWA connection URI which should be given to the wallet

  Parameters

  • nwaSchemeSuffix: string = ""

    open a specific wallet. e.g. "alby" will set the scheme to nostr+walletauth+alby to ensure the link will be opened in an Alby wallet

  Returns string

subscribe

• subscribe(
      args: { onSuccess: (nwcClient: NWCClient) => void },
  ): Promise<{ unsub: () => void }>

  Waits for a new app connection to be created via NWA (https://github.com/nostr-protocol/nips/pull/851)

  Parameters

  • args: { onSuccess: (nwcClient: NWCClient) => void }

  Returns Promise<{ unsub: () => void }>

  a new NWCClient

StaticparseWalletAuthUrl

• parseWalletAuthUrl(walletAuthUrl: string): NWAOptions

  Parameters

  • walletAuthUrl: string

  Returns NWAOptions