SDK Reference
Eight packages, grouped by what your app needs. Open a package, then choose a task for its example and integration details.
Choose a package
nostr-wot-sdk
Profiles, notes, relay connections, signer clients, uploads and storage.
v3.0.0@nostr-wot/identity
Accounts, encrypted vaults, permissions, signing approvals and remote signer hosting.
v1.0.0@nostr-wot/dm
Private messages, inbox state and hooks
v2.0.0@nostr-wot/wallet
Zaps, WebLN, NWC and receipt validation
v2.0.0@nostr-wot/auth
Server-side NIP-98 login and sessions
v5.0.0@nostr-wot/ui
Reusable login controls and session UI
v2.0.0@nostr-wot/wot
Trust queries over a supplied data source
v3.0.0@nostr-wot/pq
Post-quantum cryptographic primitives
v1.0.0Migration from older packages
The eleven previous package names remain compatibility wrappers. Replace their imports with the paths below. Install the package, not its subpath. Old versions remain downloadable.
| Previous package | New import |
|---|---|
@nostr-wot/relay | nostr-wot-sdk/relay |
@nostr-wot/data | nostr-wot-sdk/data |
@nostr-wot/signers | nostr-wot-sdk/signers |
@nostr-wot/blossom | nostr-wot-sdk/blossom |
@nostr-wot/storage | nostr-wot-sdk/storage |
@nostr-wot/accounts | @nostr-wot/identity/accounts |
@nostr-wot/vault | @nostr-wot/identity/vault |
@nostr-wot/permissions | @nostr-wot/identity/permissions |
@nostr-wot/signer-core | @nostr-wot/identity/signing |
@nostr-wot/bunker | @nostr-wot/identity/bunker |
@nostr-wot/graph | @nostr-wot/wot/graph |
Topics
- Provider setup
- Data layer
- Relay management
- Sign with an extension or remote account
- Upload files with Blossom
- Storage adapters
- Data cache and collections
- React data hooks
- Shared relay connections
- Relay queries and health
- Encrypted uploads and blob management
- Passkeys and recovery
- Passkey interoperability
- Accounts, imports and seed derivation
- Password vault and key access
- Permissions and authentication grants
- Signing and approval pipeline
- Run a Nostr Connect signer
- Send and read private messages
- Session lifecycle and error handling
- Inbox, history and encrypted storage
- React messaging hooks
- Encrypted files and private state
- Pay invoices and send zaps
- Nostr Wallet Connect
- Zaps and Lightning invoices
- Authenticate an HTTP session
- Server login, cookies and JWTs
- Login UI
- Login components and sessions
- Themes and styling
- Web of Trust distances
- Oracle compatibility
- Oracle queries and React hooks
- Post-quantum attestations
- Hybrid post-quantum messages