Ndk class
Main entry point for the NDK (Nostr Development Kit) library.
This file contains the primary class Ndk which provides access to various Nostr-related functionalities/usecases and manages the global state of the application.
Constructors
- Ndk.new(NdkConfig config)
-
Creates a new instance of Ndk with the given
config - Ndk.defaultConfig()
- Creates a new instance of Ndk with default configuration
- Ndk.emptyBootstrapRelaysConfig()
- Creates a new instance of Ndk with default configuration and empty bootstrap relays
Properties
- accounts → Accounts
-
Accounts
no setter
- blossom → Blossom
-
Blossom usecase
upload, download, delete, list files
low level usecase, recommended for advanced usersno setter - blossomUserServerList → BlossomUserServerList
-
Blossom User Server list
used to manage the list of blossom servers for a user
low level usecase, recommended for advanced usersno setter - broadcast → Broadcast
-
Provides access to low-level Nostr broadcast/publish.
no setter
- bunkers → Bunkers
-
Bunker - NIP-46 remote signing protocol
no setter
- config → NdkConfig
-
Configuration for the NDK instance
final
- connectivity → Connectivy
-
Use case for managing relay connectivity
get notified about relay connectivity changes
and update NDK about your application connectivity
for faster reconnectsno setter - files → Files
-
manage files on nostr
upload, download, delete files
high level usecase, recommended for most usersno setter - follows → Follows
-
Handles operations related to user follows
no setter
- giftWrap → GiftWrap
-
Gift wrap - NIP-59
crate gift wraps
unwrap gift wraps \no setter - hashCode → int
-
The hash code for this object.
no setterinherited
- lists → Lists
-
Manages various types of lists in the Nostr network
no setter
- metadata → Metadatas
-
user metadata operations
no setter
- nip05 → VerifyNip05
-
Verifies NIP-05 events
no setter
- nwc → Nwc
-
Nostr Wallet connect
no setter
- relays → RelayManager
-
Relay Manager
no setter
- relaySets → RelaySets
-
calculate relay set
no setter
- requests → Requests
-
Provides access to low-level Nostr requests.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- search → Search
-
Search
no setter
- userRelayLists → UserRelayLists
-
user relay lists usecase
similar to nip65 but more generic, contact list relays can also be consideredno setter - zaps → Zaps
-
Zaps
no setter
Methods
-
destroy(
) → Future< void> - Close all transports on relay manager
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited