NDK

Why NDK?

Packages

Core

Framework Integration

Advanced Features

Cache Adapters

Quick Start

Svelte 5

import { NDKSvelte } from '@nostr-dev-kit/svelte';
import NDKCacheDexie from '@nostr-dev-kit/ndk-cache-dexie';
const ndk = new NDKSvelte({
 explicitRelayUrls: ['wss://relay.damus.io', 'wss://relay.nostr.band'],
 cacheAdapter: new NDKCacheDexie({ dbName: 'my-app' })
});
ndk.connect();
// Reactive subscriptions with Svelte 5 runes
const notes = ndk.subscribe({ kinds: [1], limit: 50 });
// Access reactive properties in your template
notes.events; // Array of events (reactive)
notes.eosed; // EOSE flag (reactive)

React

import { useSubscription } from '@nostr-dev-kit/react';
function Feed() {
 const { events, eosed } = useSubscription({ kinds: [1], limit: 50 });
 return (
 <div>
 {events.map(event => (
 <div key={event.id}>{event.content}</div>
 ))}
 </div>
 );
}

Vanilla JavaScript

import NDK from '@nostr-dev-kit/ndk';
const ndk = new NDK({
 explicitRelayUrls: ['wss://relay.damus.io']
});
await ndk.connect();
const sub = ndk.subscribe({ kinds: [1], limit: 50 }, {
 onEvent: (event) => {
 console.log('New note:', event.content);
 }
});

Key Features

🌐 Web of Trust

import { NDKSvelte } from '@nostr-dev-kit/svelte';
const ndk = new NDKSvelte(config);
// Load WoT data
await ndk.wot.load({ maxDepth: 2 });
// Enable automatic filtering on all subscriptions
ndk.wot.enableAutoFilter({
 maxDepth: 2,
 minScore: 0.5,
 includeUnknown: false
});
// All subscriptions now automatically filter by WoT
const notes = ndk.subscribe({ kinds: [1] });

🔄 Negentropy Sync

import { NDKSync } from '@nostr-dev-kit/sync';
const sync = new NDKSync(ndk);
// Sync events efficiently with set reconciliation
await sync.syncFilter(
 { kinds: [1], authors: [pubkey] },
 relayUrl,
 { initialBackfillSeconds: 86400 * 7 } // Last 7 days
);

👤 Multi-Account Sessions

import { NDKNip07Signer } from '@nostr-dev-kit/ndk';
// Login with browser extension
const signer = new NDKNip07Signer();
await ndk.sessions.login(signer);
// Switch between accounts
ndk.sessions.switch(otherPubkey);
// Access current user
const currentUser = ndk.sessions.currentUser;
const profile = ndk.sessions.profile;
const follows = ndk.sessions.follows;

💰 Wallet Integration

import { NDKCashuWallet } from '@nostr-dev-kit/wallet';
const wallet = new NDKCashuWallet(ndk);
await wallet.init();
ndk.wallet.set(wallet);
// Reactive balance
const balance = ndk.wallet.balance;
// Send payments
await wallet.cashuPay({ amount: 1000, unit: 'sat', target: event });

NIPs Support

Core Features

Subscription Management

Signing Adapters

Relay Discovery

Caching

Developer Experience

Testing Your App

import { RelayPoolMock, UserGenerator, EventGenerator } from '@nostr-dev-kit/ndk/test';
// Create mock relay environment
const pool = new RelayPoolMock();
pool.addMockRelay('wss://relay.example.com');
// Generate test users and events
const alice = UserGenerator.getUser('alice', ndk);
const event = await EventGenerator.createSignedTextNote('Hello!', alice.pubkey);
// Simulate relay behavior
const relay = pool.getMockRelay('wss://relay.example.com');
relay.simulateEvent(event);
relay.simulateEOSE();
// Test your app's event handling

Documentation

Package Documentation

Examples

Real-World Applications

Contributing

Development

# Clone the repository
git clone https://github.com/nostr-dev-kit/ndk.git
cd ndk
# Install dependencies
bun install
# Build all packages
bun run build
# Run tests
bun test
# Start development mode
bun run dev

Community

License

Credits