Class default

constructor

• new default(opts?: NDKConstructorParams): default

• Parameters

  • opts: NDKConstructorParams = {}

  Returns default

Optional cacheAdapter

Optional clientName

Optional clientNip89

debug

Optional devWriteRelaySet

Optional explicitRelayUrls

httpFetch

import fetch from "node-fetch";

ndk.httpFetch = fetch;
Copy

mutedIds

Optional outboxPool

Optional outboxTracker

pool

Optional relayAuthDefaultPolicy

ndk.relayAuthDefaultPolicy = NDKAuthPolicies.disconnect(ndk.pool);
Copy

ndk.relayAuthDefaultPolicy = NDKAuthPolicies.signIn({ndk})
Copy

ndk.relayAuthDefaultPolicy = (relay: NDKRelay) => {
    const signIn = NDKAuthPolicies.signIn({ndk});
    if (confirm(`Relay ${relay.url} is requesting authentication, do you want to sign in?`)) {
       signIn(relay);
    }
}
Copy

activeUser

• get activeUser(): undefined | NDKUser

• Returns undefined | NDKUser

• set activeUser(user: undefined | NDKUser): void

• Sets the active user for this NDK instance, typically this will be called when assigning a signer to the NDK instance.

  This function will automatically connect to the user's relays if autoConnectUserRelays is set to true.

  It will also fetch the user's mutelist if autoFetchUserMutelist is set to true.

  Parameters

  • user: undefined | NDKUser

  Returns void

signer

• get signer(): undefined | NDKSigner

• Returns undefined | NDKSigner

• set signer(newSigner: undefined | NDKSigner): void

• Parameters

  • newSigner: undefined | NDKSigner

  Returns void

addExplicitRelay

• addExplicitRelay(urlOrRelay: string | NDKRelay, relayAuthPolicy?: NDKAuthPolicy, connect?: boolean): NDKRelay

• Adds an explicit relay to the pool.

  Parameters

  • urlOrRelay: string | NDKRelay

  • Optional relayAuthPolicy: NDKAuthPolicy

    Authentication policy to use if different from the default

  • connect: boolean = true

    Whether to connect to the relay automatically

  Returns NDKRelay

assertSigner

• assertSigner(): void

• Ensures that a signer is available to sign an event.

  Returns void

connect

• connect(timeoutMs?: number): Promise<void>

• Connect to relays with optional timeout. If the timeout is reached, the connection will be continued to be established in the background.

  Parameters

  • Optional timeoutMs: number

  Returns Promise<void>

fetchEvent

• fetchEvent(idOrFilter: string | NDKFilter, opts?: NDKSubscriptionOptions, relaySetOrRelay?: NDKRelay | NDKRelaySet): Promise<null | NDKEvent>

• Fetch a single event.

  Parameters

  • idOrFilter: string | NDKFilter

    event id in bech32 format or filter

  • Optional opts: NDKSubscriptionOptions

    subscription options

  • Optional relaySetOrRelay: NDKRelay | NDKRelaySet

    explicit relay set to use

  Returns Promise<null | NDKEvent>

fetchEvents

• fetchEvents(filters: NDKFilter | NDKFilter[], opts?: NDKSubscriptionOptions, relaySet?: NDKRelaySet): Promise<Set<NDKEvent>>

• Fetch events

  Parameters

  • filters: NDKFilter | NDKFilter[]

  • Optional opts: NDKSubscriptionOptions

  • Optional relaySet: NDKRelaySet

  Returns Promise<Set<NDKEvent>>

getNip96

• getNip96(domain: string): Nip96

• Creates a new Nip96 instance for the given domain.

  Parameters

  • domain: string

    Domain to use for nip96 uploads

  Returns Nip96

  Example

  Upload a file to a NIP-96 enabled domain:

  const blob = new Blob(["Hello, world!"], { type: "text/plain" });
  const nip96 = ndk.getNip96("nostrcheck.me");
  await nip96.upload(blob);
  Copy

getUser

• getUser(opts: GetUserParams): NDKUser

• Get a NDKUser object

  Parameters

  • opts: GetUserParams

  Returns NDKUser

getUserFromNip05

• getUserFromNip05(nip05: string, skipCache?: boolean): Promise<undefined | NDKUser>

• Get a NDKUser from a NIP05

  Parameters

  • nip05: string

    NIP-05 ID

  • skipCache: boolean = false

    Skip cache

  Returns Promise<undefined | NDKUser>

publish

• publish(event: NDKEvent, relaySet?: NDKRelaySet, timeoutMs?: number): Promise<Set<NDKRelay>>

• Publish an event to a relay

  Parameters

  • event: NDKEvent

    event to publish

  • Optional relaySet: NDKRelaySet

    explicit relay set to use

  • Optional timeoutMs: number

    timeout in milliseconds to wait for the event to be published

  Returns Promise<Set<NDKRelay>>

  The relays the event was published to

  Deprecated

  Use event.publish() instead

subscribe

• subscribe(filters: NDKFilter | NDKFilter[], opts?: NDKSubscriptionOptions, relaySet?: NDKRelaySet, autoStart?: boolean): NDKSubscription

• Create a new subscription. Subscriptions automatically start, you can make them automatically close when all relays send back an EOSE by setting opts.closeOnEose to true)

  Parameters

  • filters: NDKFilter | NDKFilter[]

  • Optional opts: NDKSubscriptionOptions

  • Optional relaySet: NDKRelaySet

    explicit relay set to use

  • autoStart: boolean = true

    automatically start the subscription

  Returns NDKSubscription

  NDKSubscription

toJSON

• toJSON(): string

• Returns string