@nostr-dev-kit/ndk NPM

@nostr-dev-kit/ndk

NDK (Nostr Development Kit) is a TypeScript/JavaScript library that simplifies building Nostr clients, relays, and related applications.

Features

Outbox model support
Relay connection pool with automatic reconnection and failover
Flexible subscription API with caching, batching, and auto-closing
Event creation, validation, and wrappers for major NIPs (e.g., NIP-01, NIP-04, NIP-07, NIP-18, NIP-57, NIP-60, NIP-61)
Signer adapters: private key, browser extension (NIP-07), remote signing (NIP-46)
Pluggable cache adapters (Redis, Dexie, SQLite, etc.)
Data Vending Machine support (NIP-90)
Zap utilities (NIP-57, NIP-61)
Threading, event kinds, and utility functions (URL normalization, metadata tags, filters)

Modular design with many pluggable packages for different frameworks (Mobile, Svelte 4 and 5, React)

Installation

npm install @nostr-dev-kit/ndk
# or
yarn add @nostr-dev-kit/ndk
# or
bun add @nostr-dev-kit/ndk

Quick Start

import NDK, { NDKEvent, NDKPrivateKeySigner } from '@nostr-dev-kit/ndk';

async function main() {
  const signer = NDKPrivateKeySigner.generate();
  const ndk = new NDK({
    explicitRelayUrls: ['wss://relay.primal.net'],
    signer
  });

  // Connect to relays
  await ndk.connect();

  // Publish a simple text note
  const event = new NDKEvent(ndk, {
    kind: 1,
    content: 'Hello Nostr via NDK!',
  })
  await event.sign();
  event.publish();

 // subscribe to all event interactions
  ndk.subscribe(event.filter(), { closeOnEose: false }, {
   onEvent: (replyEvent: NDKEvent) => console.log(replyEvent.author.npub, "interacted with our hello world with a kind", replyEvent.kind);
  })

  // Subscribe to incoming text notes
  const subscription = ndk.subscribe(
    { kinds: [1] },
    { closeOnEose: true },
    {
      onEvent: (evt) => console.log('Received event:', evt),
      onEose: () => console.log('End of stream'),
    }
  );
}

main().catch(console.error);

Documentation

Full API reference and guides are available at https://nostr-dev-kit.github.io/ndk.

License

MIT

nostr

@noble/curves @noble/hashes @noble/secp256k1 @scure/base debug light-bolt11-decoder tseep typescript-lru-cache

@everything-registry/sub-chunk-666 javascript-frost javascript-dlc libnostrsite lw-test-module create-iris blossom-server-ts @feririarte/react ndk-cli ndk-svelte nsecbunker-ping nsecbunker-watchdog nsecbunkerd nutsack nsite-cli nip47 nostr-pwa-pack nostr-hooks nostr-login nostr-mcp nostr-engine nostr-chunkey-monkey simple-nostr-hooks smart-widget-builder @nostr-dev-kit/ndk-wallet @nostrdev/httpn @nostrdev/nhp-server-common @nostr-dev-kit/ndk-blossom @nostr-dev-kit/ndk-cache-dexie @nostr-dev-kit/ndk-cache-nostr @nostr-dev-kit/ndk-cache-redis @nostr-dev-kit/ndk-hooks @nostr-dev-kit/ndk-mobile @nostr-dev-kit/ndk-svelte @nostr-dev-kit/ndk-svelte-components @lawallet/module @lawallet/react @lawallet/sdk @lawallet/utils @blockcore/nostr-login @amunrarara/nostr-hooks @colealbon/y-ndk @gandlaf21/cashu-ts-nostr-req @gandlaf21/cashu-wallet-engine @feririarte/utils @mseep/nostr-mcp-server

1 year ago

1 year ago

1 year ago

11 months ago

1 year ago

1 year ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

11 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

11 months ago

11 months ago

11 months ago

11 months ago

1 year ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

12 months ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago