Class NDKNwc

Implements the Nostr Wallet Connect (NIP-47) protocol.

Example

const nwc = ndk.nwc("nostr+walletconnect://...");
const balance = await nwc.getBalance();
const payment = await nwc.payInvoice("lnbc1...");

Hierarchy

  • EventEmitter
    • NDKNwc

Constructors

constructor

Properties

active debug getBalance ndk relaySet signer walletService

Methods

blockUntilReady getInfo payInvoice sendReq fromURI

Constructors

constructor

  • new NDKNwc(opts:: {
        ndk: default;
        pubkey: string;
        relayUrls: string[];
        secret: string | Uint8Array;
    }): NDKNwc

  • Parameters

    • opts:: {
          ndk: default;
          pubkey: string;
          relayUrls: string[];
          secret: string | Uint8Array;
      }

      NostrWalletConnectOptions

      • ndk: default
      • pubkey: string
      • relayUrls: string[]
      • secret: string | Uint8Array

    Returns NDKNwc

    NDKNwc

Properties

active

active: boolean = false

debug

debug: Debugger

getBalance

getBalance: ((...args: []) => Promise<NDKNwcResponse<GetBalanceResponse>>) = ...

ndk

ndk: default

relaySet

relaySet: NDKRelaySet

signer

signer: NDKSigner

walletService

walletService: NDKUser

The Wallet Service's public key

Methods

blockUntilReady

  • blockUntilReady(msTimeout?: number): Promise<void>

  • Blocks until we're subscribed to talk to the wallet service

    Parameters

    • OptionalmsTimeout: number

      Timeout in ms to wait for the subscription to be ready

    Returns Promise<void>

getInfo

payInvoice

sendReq

StaticfromURI

Settings

Member Visibility

On This Page

Constructors
Properties
Methods