2.14.29 • Published 4 months ago

@nostr-dev-kit/ndk v2.14.29

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

@nostr-dev-kit/ndk

npm version Build Status

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

2.11.0

10 months ago

2.11.1

8 months ago

2.11.2

8 months ago

2.13.0-rc2

7 months ago

2.10.7

11 months ago

2.10.6

11 months ago

2.14.29

4 months ago

2.14.27

4 months ago

2.14.28

4 months ago

2.14.25

4 months ago

2.14.26

4 months ago

2.14.23

5 months ago

2.14.24

5 months ago

2.14.21

5 months ago

2.14.22

5 months ago

2.14.20

5 months ago

2.14.18

5 months ago

2.14.19

5 months ago

2.14.16

5 months ago

2.14.17

5 months ago

2.14.14

5 months ago

2.14.15

5 months ago

2.14.12

5 months ago

2.14.13

5 months ago

2.14.10

5 months ago

2.14.11

5 months ago

2.13.0-rc1.0

7 months ago

2.14.9

6 months ago

2.14.7

6 months ago

2.14.8

6 months ago

2.14.5

6 months ago

2.14.6

6 months ago

2.14.3

6 months ago

2.14.4

6 months ago

2.14.1

6 months ago

2.14.2

6 months ago

2.14.0

6 months ago

2.13.4-rc1

6 months ago

2.13.2

6 months ago

2.13.3

6 months ago

2.13.0

7 months ago

2.13.1

6 months ago

2.12.0

8 months ago

2.13.1-rc5

7 months ago

2.13.1-rc6

7 months ago

2.13.1-rc7

6 months ago

2.13.1-rc1

7 months ago

2.13.1-rc2

7 months ago

2.13.1-rc3

7 months ago

2.13.1-rc4

7 months ago

2.12.1

8 months ago

2.12.2

8 months ago

2.10.5

12 months ago

2.10.2

12 months ago

2.10.3

12 months ago

2.10.4

12 months ago

2.10.1

1 year ago

2.10.0

1 year ago

2.8.2

1 year ago

2.8.1

1 year ago

2.8.0

1 year ago

2.7.0

2 years ago

2.7.1

2 years ago

2.6.1

2 years ago

2.6.0

2 years ago

2.5.1

2 years ago

2.5.0

2 years ago

2.4.2

2 years ago

2.4.1

2 years ago

2.4.0

2 years ago

2.3.3

2 years ago

2.3.2

2 years ago

2.3.1

2 years ago

2.3.0

2 years ago

1.2.0

2 years ago

0.8.9

2 years ago

0.8.8

2 years ago

0.8.5

2 years ago

0.8.4

2 years ago

0.8.7

2 years ago

0.8.15-2

2 years ago

0.8.6

2 years ago

1.2.3

2 years ago

1.2.1

2 years ago

2.0.3

2 years ago

2.0.2

2 years ago

2.0.5

2 years ago

2.0.6

2 years ago

2.0.1

2 years ago

2.0.0

2 years ago

0.7.2

2 years ago

0.7.1

2 years ago

0.7.4

2 years ago

0.7.3

2 years ago

0.7.0

2 years ago

0.8.1

2 years ago

0.8.0

2 years ago

0.8.19-1

2 years ago

0.8.3

2 years ago

0.8.2

2 years ago

1.0.0

2 years ago

1.4.2

2 years ago

2.2.0

2 years ago

0.8.21-1

2 years ago

0.8.18-3

2 years ago

0.8.23

2 years ago

0.8.22

2 years ago

0.7.6

2 years ago

0.7.5

2 years ago

0.8.21

2 years ago

0.8.20

2 years ago

0.7.7

2 years ago

1.3.2

2 years ago

1.3.1

2 years ago

1.3.0

2 years ago

2.1.1

2 years ago

2.1.3

2 years ago

0.8.12

2 years ago

0.8.11

2 years ago

0.8.14

2 years ago

0.8.13

2 years ago

0.8.10

2 years ago

0.8.19

2 years ago

0.8.16

2 years ago

0.8.18

2 years ago

0.8.20-1

2 years ago

0.8.17

2 years ago

0.6.3

2 years ago

0.6.2

2 years ago

0.6.5

2 years ago

0.6.4

2 years ago

0.6.1

2 years ago

0.6.0

2 years ago

0.5.11

2 years ago

0.5.12

2 years ago

0.5.13

2 years ago

0.3.1415

2 years ago

0.3.0

2 years ago

0.3.6

2 years ago

0.3.5

2 years ago

0.3.8

2 years ago

0.3.7

2 years ago

0.3.2

2 years ago

0.3.1

2 years ago

0.3.4

2 years ago

0.3.3

2 years ago

0.5.8

2 years ago

0.5.7

2 years ago

0.3.1-9.1

2 years ago

0.4.5

2 years ago

0.4.4

2 years ago

0.4.6

2 years ago

0.4.0

2 years ago

0.4.3

2 years ago

0.4.2

2 years ago

0.3.31

2 years ago

0.3.30

2 years ago

0.3.141

2 years ago

0.3.39

2 years ago

0.3.38

2 years ago

0.3.37

2 years ago

0.3.36

2 years ago

0.3.35

2 years ago

0.3.34

2 years ago

0.3.33

2 years ago

0.3.32

2 years ago

0.3.29

2 years ago

0.3.20

2 years ago

0.3.28

2 years ago

0.3.27

2 years ago

0.3.26

2 years ago

0.3.25

2 years ago

0.3.23

2 years ago

0.3.22

2 years ago

0.3.18

2 years ago

0.5.4

2 years ago

0.5.3

2 years ago

0.5.6

2 years ago

0.5.5

2 years ago

0.5.0

2 years ago

0.5.2

2 years ago

0.5.1

2 years ago

0.3.9

2 years ago

0.3.17

2 years ago

0.3.16

2 years ago

0.3.15

2 years ago

0.3.14

2 years ago

0.3.13

2 years ago

0.3.12

2 years ago

0.3.11

2 years ago

0.3.10

2 years ago

0.5.7-1

2 years ago

0.2.3

2 years ago

0.2.2

2 years ago

0.2.1

2 years ago

0.2.0

2 years ago

0.1.18

2 years ago

0.1.17

2 years ago

0.1.16

2 years ago

0.1.15

2 years ago

0.1.14

3 years ago

0.1.13

3 years ago

0.1.12

3 years ago

0.1.11

3 years ago

0.1.10

3 years ago

0.1.9

3 years ago

0.1.8

3 years ago

0.1.7

3 years ago

0.1.6

3 years ago

0.1.5

3 years ago

0.1.4

3 years ago

0.1.3

3 years ago

0.1.2

3 years ago

0.1.1

3 years ago

0.1.0

3 years ago

0.0.37

3 years ago

0.0.36

3 years ago

0.0.35

3 years ago

0.0.34

3 years ago

0.0.33

3 years ago

0.0.32

3 years ago

0.0.30

3 years ago

0.0.29

3 years ago

0.0.28

3 years ago

0.0.27

3 years ago

0.0.26

3 years ago

0.0.25

3 years ago

0.0.24

3 years ago

0.0.23

3 years ago

0.0.22

3 years ago

0.0.21

3 years ago

0.0.20

3 years ago

0.0.19

3 years ago

0.0.18

3 years ago

0.0.17

3 years ago

0.0.15

3 years ago

0.0.14

3 years ago

0.0.13

3 years ago

0.0.12

3 years ago

0.0.11

3 years ago

0.0.10

3 years ago

0.0.9

3 years ago

0.0.8

3 years ago

0.0.7

3 years ago

0.0.6

3 years ago

0.0.4

3 years ago