Interface NDKConstructorParams

interface NDKConstructorParams {
    autoConnectUserRelays?: boolean;
    autoFetchUserMutelist?: boolean;
    blacklistRelayUrls?: string[];
    cacheAdapter?: NDKCacheAdapter;
    clientName?: string;
    clientNip89?: string;
    debug?: Debugger;
    devWriteRelayUrls?: string[];
    enableOutboxModel?: boolean;
    explicitRelayUrls?: string[];
    initialValidationRatio?: number;
    lowestValidationRatio?: number;
    mutedIds?: Map<string, string>;
    netDebug?: NDKNetDebug;
    outboxRelayUrls?: string[];
    relayAuthDefaultPolicy?: NDKAuthPolicy;
    signatureVerificationWorker?: Worker;
    signer?: NDKSigner;
    validationRatioFn?: NDKValidationRatioFn;
}

Properties

autoConnectUserRelays? autoFetchUserMutelist? blacklistRelayUrls? cacheAdapter? clientName? clientNip89? debug? devWriteRelayUrls? enableOutboxModel? explicitRelayUrls? initialValidationRatio? lowestValidationRatio? mutedIds? netDebug? outboxRelayUrls? relayAuthDefaultPolicy? signatureVerificationWorker? signer? validationRatioFn?

Properties

OptionalautoConnectUserRelays

autoConnectUserRelays?: boolean

Auto-connect to main user's relays. The "main" user is determined by the presence of a signer. Upon connection to the explicit relays, the user's relays will be fetched and connected to if this is set to true.

Default

true

OptionalautoFetchUserMutelist

autoFetchUserMutelist?: boolean

Automatically fetch user's mutelist

Default

true

OptionalblacklistRelayUrls

blacklistRelayUrls?: string[]

Relays we should never connect to

OptionalcacheAdapter

cacheAdapter?: NDKCacheAdapter

Cache adapter to use for caching events

OptionalclientName

clientName?: string

Client name to add to events' tag

OptionalclientNip89

clientNip89?: string

Client nip89 to add to events' tag

Optionaldebug

debug?: Debugger

Debug instance to use

OptionaldevWriteRelayUrls

devWriteRelayUrls?: string[]

When this is set, we always write only to this relays.

OptionalenableOutboxModel

enableOutboxModel?: boolean

Enable outbox model (defaults to false)

OptionalexplicitRelayUrls

explicitRelayUrls?: string[]

Relays we should explicitly connect to

OptionalinitialValidationRatio

initialValidationRatio?: number

The signature verification validation ratio for new relays.

OptionallowestValidationRatio

lowestValidationRatio?: number

The lowest validation ratio any single relay can have. Relays will have a sample of events verified based on this ratio. When using this, you MUST listen for event:invalid-sig events to handle invalid signatures and disconnect from evil relays.

Default

0.1

OptionalmutedIds

mutedIds?: Map<string, string>

Muted pubkeys and eventIds

OptionalnetDebug

netDebug?: NDKNetDebug

Provide a caller function to receive all networking traffic from relays

OptionaloutboxRelayUrls

outboxRelayUrls?: string[]

Outbox relay URLs.

OptionalrelayAuthDefaultPolicy

relayAuthDefaultPolicy?: NDKAuthPolicy

Default relay-auth policy

OptionalsignatureVerificationWorker

signatureVerificationWorker?: Worker

Whether to verify signatures on events synchronously or asynchronously.

Default

undefined

When set to true, the signature verification will processed in a web worker. You should listen for the event:invalid-sig event to handle invalid signatures.

Example

const worker = new Worker("path/to/signature-verification.js");
ndk.delayedSigVerification = worker;
ndk.on("event:invalid-sig", (event) => {
   console.error("Invalid signature", event);

Optionalsigner

signer?: NDKSigner

Signer to use for signing events by default

OptionalvalidationRatioFn

validationRatioFn?: NDKValidationRatioFn

A function that is invoked to calculate the validation ratio for a relay.

Settings

Member Visibility

On This Page

Properties