Debugging

Enable Debug Mode

NDK uses the debug package to assist in understanding what's happening behind the hood. If you are building a package that runs on the server define the DEBUG envionment variable like

export DEBUG='ndk:*'

or in the browser enable it by writing in the DevTools console

localStorage.debug = 'ndk:*'

Network Debugging

You can construct NDK passing a netDebug callback to receive network traffic events, particularly useful for debugging applications not running in a browser.

const netDebug = (msg: string, relay: NDKRelay, direction?: "send" | "recv") = {
    const hostname = new URL(relay.url).hostname;
    netDebug(hostname, msg, direction);
}

ndk = new NDK({ netDebug });

Development Relays

When you're developing an application you can initialise NDK with the devWriteRelayUrls property to tell the NDK instance to write to specific relays:

import NDK from "@nostr-dev-kit/ndk";

const ndk = new NDK({
    devWriteRelayUrls: ["wss://staging.relay", "wss://another.test.relay"],
});

await ndk.connect();

This will write new events to those relays only. Note that if you have provided relays in explicitRelayUrls these will also be used to write events to.