NdkConfig class
Configuration class for the Nostr Development Kit (NDK)
This class holds various settings and dependencies required for the NDK to function properly
Constructors
-
NdkConfig({required EventVerifier eventVerifier, EventSigner? eventSigner, required CacheManager cache, NdkEngine engine = NdkEngine.RELAY_SETS, List<
String> ignoreRelays = const [], List<String> bootstrapRelays = DEFAULT_BOOTSTRAP_RELAYS, List<EventFilter> eventOutFilters = const []}) - Creates a new instance of NdkConfig.
Properties
-
bootstrapRelays
↔ List<
String> -
A list of initial relay URLs to use for bootstrapping the network.
These connect on start.
getter/setter pair
- cache ↔ CacheManager
-
The cache manager (DB) used to store and retrieve Nostr data. E.g MemCacheManager()
getter/setter pair
- engine ↔ NdkEngine
-
The engine mode to use for Nostr network operations (inbox/outbox mode).
getter/setter pair
-
eventOutFilters
↔ List<
EventFilter> -
filters that are applied to the output stream
getter/setter pair
- eventSigner ↔ EventSigner?
-
The signer used to sign Nostr events.
getter/setter pair
- eventVerifier ↔ EventVerifier
-
The verifier used to validate Nostr events. E.g. RustEventVerifier(), Bip340EventVerifier
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
-
ignoreRelays
↔ List<
String> -
A list of relay URLs to ignore for inbox/outbox operations.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
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