Class default

The NDK class is the main entry point to the library.

Emits

signer:ready when a signer is ready

Emits

invalid-signature when an event with an invalid signature is received

Hierarchy

EventEmitter<{
    event: ((event: NDKEvent, relay: NDKRelay) => void);
    event:invalid-sig: ((event: NDKEvent) => void);
    event:publish-failed: ((event: NDKEvent, error: NDKPublishError, relays: WebSocket["url"][]) => void);
    signer:ready: ((signer: NDKSigner) => void);
    signer:required: (() => void);
}>
- default

Constructors

constructor

new default(opts?: NDKConstructorParams): default
Parameters
- opts: NDKConstructorParams = {}
Returns default
Overrides EventEmitter<{ event: (event: NDKEvent, relay: NDKRelay) => void; "signer:ready": (signer: NDKSigner) => void; "signer:required": () => void; /** * Emitted when an event with an invalid signature is received and the signature * was processed asynchronously. */ "event:invalid-sig": (event: NDKEvent) => void; /** * Emitted when an event fails to publish. * @param event The event that failed to publish * @param error The error that caused the event to fail to publish * @param relays The relays that the event was attempted to be published to */ "event:publish-failed": ( event: NDKEvent, error: NDKPublishError, relays: WebSocket["url"][] ) => void; }>.constructor
- Defined in ndk/src/ndk/index.ts:289

Properties

asyncSigVerification

asyncSigVerification: boolean = false

autoConnectUserRelays

autoConnectUserRelays: boolean = true

autoFetchUserMutelist

autoFetchUserMutelist: boolean = true

`Optional`cacheAdapter

cacheAdapter?: NDKCacheAdapter

`Optional`clientName

clientName?: string

`Optional`clientNip89

clientNip89?: string

debug

debug: Debugger

`Optional`devWriteRelaySet

devWriteRelaySet?: NDKRelaySet

fetchEventFromTag

fetchEventFromTag: ((...args: [tag: NDKTag, originalEvent: NDKEvent, subOpts?: NDKSubscriptionOptions, fallback: NDKFetchFallbackOptions]) => Promise<null | NDKEvent>) = ...

Attempts to fetch an event from a tag, following relay hints and other best practices.

Type declaration

- (...args: [tag: NDKTag, originalEvent: NDKEvent, subOpts?: NDKSubscriptionOptions, fallback: NDKFetchFallbackOptions]): Promise<null | NDKEvent>
- Parameters
  - Rest...args: [tag: NDKTag, originalEvent: NDKEvent, subOpts?: NDKSubscriptionOptions, fallback: NDKFetchFallbackOptions]
  Returns Promise<null | NDKEvent>

httpFetch

httpFetch: undefined | {
(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
(input: string | URL | Request, init?: RequestInit): Promise<Response>;
}

Fetch function to use for HTTP requests.

Type declaration

- (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
- MDN Reference
  Parameters
  - input: URL | RequestInfo
  - Optionalinit: RequestInit
  Returns Promise<Response>
- (input: string | URL | Request, init?: RequestInit): Promise<Response>
- Parameters
  - input: string | URL | Request
  - Optionalinit: RequestInit
  Returns Promise<Response>

Example

import fetch from "node-fetch";

ndk.httpFetch = fetch;

initialValidationRatio

initialValidationRatio: number = 1.0

lowestValidationRatio

lowestValidationRatio: number = 1.0

mutedIds

mutedIds: Map<string, string>

`Optional` `Readonly`netDebug

netDebug?: NDKNetDebug

Provide a caller function to receive all networking traffic from relays

`Optional`outboxPool

outboxPool?: NDKPool

`Optional`outboxTracker

outboxTracker?: OutboxTracker

pool

pool: NDKPool

publishingFailureHandled

publishingFailureHandled: boolean = false

queuesNip05

queuesNip05: Queue<null | ProfilePointer>

queuesZapConfig

queuesZapConfig: Queue<undefined | NDKLnUrlData>

`Optional`relayAuthDefaultPolicy

relayAuthDefaultPolicy?: NDKAuthPolicy

Default relay-auth policy that will be used when a relay requests authentication, if no other policy is specified for that relay.

Example: Disconnect from relays that request authentication:

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

Example: Sign in to relays that request authentication:

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

Example: Sign in to relays that request authentication, asking the user for confirmation:

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);
    }
}

subManager

subManager: NDKSubscriptionManager

`Optional`validationRatioFn

validationRatioFn?: NDKValidationRatioFn

`Optional`walletConfig

walletConfig?: NDKWalletConfig

Accessors

activeUser

get activeUser(): undefined | NDKUser
Returns undefined | NDKUser
- Defined in ndk/src/ndk/index.ts:396
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
- Defined in ndk/src/ndk/index.ts:409

explicitRelayUrls

get explicitRelayUrls(): string[]
Returns string[]
- Defined in ndk/src/ndk/index.ts:355
set explicitRelayUrls(urls: string[]): void
Parameters
- urls: string[]
Returns void
- Defined in ndk/src/ndk/index.ts:350

signatureVerificationWorker

set signatureVerificationWorker(worker: undefined | Worker): void
Parameters
- worker: undefined | Worker
Returns void
- Defined in ndk/src/ndk/index.ts:359

signer

get signer(): undefined | NDKSigner
Returns undefined | NDKSigner
- Defined in ndk/src/ndk/index.ts:422
set signer(newSigner: undefined | NDKSigner): void
Parameters
- newSigner: undefined | NDKSigner
Returns void
- Defined in ndk/src/ndk/index.ts:426

Methods

addExplicitRelay

addExplicitRelay(urlOrRelay: string | NDKRelay, relayAuthPolicy?: NDKAuthPolicy, connect?: boolean): NDKRelay
Adds an explicit relay to the pool.
Parameters
- urlOrRelay: string | NDKRelay
- OptionalrelayAuthPolicy: NDKAuthPolicy
  Authentication policy to use if different from the default
- connect: boolean = true
  Whether to connect to the relay automatically
Returns NDKRelay
- Defined in ndk/src/ndk/index.ts:373

assertSigner

assertSigner(): void
Ensures that a signer is available to sign an event.

Returns void
- Defined in ndk/src/ndk/index.ts:699

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
- OptionaltimeoutMs: number
Returns Promise<void>
- Defined in ndk/src/ndk/index.ts:440

fetchEvent

fetchEvent(idOrFilter: string | NDKFilter | NDKFilter[], opts?: NDKSubscriptionOptions, relaySetOrRelay?: NDKRelay | NDKRelaySet): Promise<null | NDKEvent>
Fetch a single event.
Parameters
- idOrFilter: string | NDKFilter | NDKFilter[]
  event id in bech32 format or filter
- Optionalopts: NDKSubscriptionOptions
  subscription options
- OptionalrelaySetOrRelay: NDKRelay | NDKRelaySet
  explicit relay set to use
Returns Promise<null | NDKEvent>
- Defined in ndk/src/ndk/index.ts:567

fetchEvents

fetchEvents(filters: NDKFilter | NDKFilter[], opts?: NDKSubscriptionOptions, relaySet?: NDKRelaySet): Promise<Set<NDKEvent>>
Fetch events
Parameters
- filters: NDKFilter | NDKFilter[]
- Optionalopts: NDKSubscriptionOptions
- OptionalrelaySet: NDKRelaySet
Returns Promise<Set<NDKEvent>>
- Defined in ndk/src/ndk/index.ts:651

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);
```
- Defined in ndk/src/ndk/index.ts:717

getUser

getUser(opts: GetUserParams): NDKUser
Get a NDKUser object
Parameters
- opts: GetUserParams
Returns NDKUser
- Defined in ndk/src/ndk/index.ts:471

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>
- Defined in ndk/src/ndk/index.ts:483

nwc

nwc(uri: string, connectTimeout?: number | false): Promise<NDKNwc>
Creates a new Nostr Wallet Connect instance for the given URI and waits for it to be ready.
Parameters
- uri: string
  WalletConnect URI
- connectTimeout: number | false = 2000
  Timeout in milliseconds to wait for the NWC to be ready. Set to false to avoid connecting.
Returns Promise<NDKNwc>
Example
```
const nwc = await ndk.nwc("nostr+walletconnect://....")
nwc.payInvoice("lnbc...")
```
- Defined in ndk/src/ndk/index.ts:729

publish

publish(event: NDKEvent, relaySet?: NDKRelaySet, timeoutMs?: number): Promise<Set<NDKRelay>>
Publish an event to a relay
Parameters
- event: NDKEvent
  event to publish
- OptionalrelaySet: NDKRelaySet
  explicit relay set to use
- OptionaltimeoutMs: 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
- Defined in ndk/src/ndk/index.ts:539

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[]
- Optionalopts: NDKSubscriptionOptions
- OptionalrelaySet: NDKRelaySet
  explicit relay set to use
- autoStart: boolean = true
  automatically start the subscription
Returns NDKSubscription
NDKSubscription
- Defined in ndk/src/ndk/index.ts:496

toJSON

toJSON(): string
Returns string
- Defined in ndk/src/ndk/index.ts:392

zap

zap(target: NDKEvent | NDKUser, amount: number, __namedParameters: {
    comment?: string;
    onCashuPay?: false | CashuPayCb;
    onComplete?: ((results: Map<NDKZapSplit, undefined | Error | NDKPaymentConfirmation>) => void);
    onLnPay?: false | LnPayCb;
    signer?: NDKSigner;
    tags?: NDKTag[];
    unit?: string;
}): NDKZapper
Zap a user or an event

This function wi
Parameters
- target: NDKEvent | NDKUser
- amount: number
  The amount to zap in millisatoshis
- __namedParameters: {
      comment?: string;
      onCashuPay?: false | CashuPayCb;
      onComplete?: ((results: Map<NDKZapSplit, undefined | Error | NDKPaymentConfirmation>) => void);
      onLnPay?: false | LnPayCb;
      signer?: NDKSigner;
      tags?: NDKTag[];
      unit?: string;
  }
  - Optionalcomment?: string
  - OptionalonCashuPay?: false | CashuPayCb
  - OptionalonComplete?: ((results: Map<NDKZapSplit, undefined | Error | NDKPaymentConfirmation>) => void)
    - (results: Map<NDKZapSplit, undefined | Error | NDKPaymentConfirmation>): void
      Parameters
      results: Map<NDKZapSplit, undefined | Error | NDKPaymentConfirmation>
      Returns void
  - OptionalonLnPay?: false | LnPayCb
  - Optionalsigner?: NDKSigner
  - Optionaltags?: NDKTag[]
  - Optionalunit?: string
Returns NDKZapper
- Defined in ndk/src/ndk/index.ts:748

Class default

Emits

Emits

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns default

Properties

asyncSigVerification

autoConnectUserRelays

autoFetchUserMutelist

OptionalcacheAdapter

OptionalclientName

OptionalclientNip89

debug

OptionaldevWriteRelaySet

fetchEventFromTag

Type declaration

Parameters

Returns Promise<null | NDKEvent>

httpFetch

Type declaration

Parameters

Returns Promise<Response>

Parameters

Returns Promise<Response>

Example

initialValidationRatio

lowestValidationRatio

mutedIds

Optional ReadonlynetDebug

OptionaloutboxPool

OptionaloutboxTracker

pool

publishingFailureHandled

queuesNip05

queuesZapConfig

OptionalrelayAuthDefaultPolicy

Example: Disconnect from relays that request authentication:

Example: Sign in to relays that request authentication:

Example: Sign in to relays that request authentication, asking the user for confirmation:

subManager

OptionalvalidationRatioFn

OptionalwalletConfig

Accessors

activeUser

Returns undefined | NDKUser

Parameters

Returns void

explicitRelayUrls

Returns string[]

Parameters

Returns void

signatureVerificationWorker

Parameters

Returns void

signer

Returns undefined | NDKSigner

Parameters

Returns void

Methods

addExplicitRelay

Parameters

Returns NDKRelay

assertSigner

Returns void

connect

Parameters

Returns Promise<void>

fetchEvent

Parameters

Returns Promise<null | NDKEvent>

fetchEvents

Parameters

`Optional`cacheAdapter

`Optional`clientName

`Optional`clientNip89

`Optional`devWriteRelaySet

`Optional` `Readonly`netDebug

`Optional`outboxPool

`Optional`outboxTracker

`Optional`relayAuthDefaultPolicy

`Optional`validationRatioFn

`Optional`walletConfig

`Optional`comment?: string

`Optional`onCashuPay?: false | CashuPayCb

`Optional`onComplete?: ((results: Map<NDKZapSplit, undefined | Error | NDKPaymentConfirmation>) => void)

`Optional`onLnPay?: false | LnPayCb

`Optional`signer?: NDKSigner

`Optional`tags?: NDKTag[]

`Optional`unit?: string