Config class

Configuration for the Breez Services

Use Config::production or Config::staging for default configs of the different supported environments.

Available extensions

Constructors

Config.new({required String breezserver, required String chainnotifierUrl, String? mempoolspaceUrl, required String workingDir, required Network network, required int paymentTimeoutSec, String? defaultLspId, String? apiKey, required double maxfeePercent, required int exemptfeeMsat, required NodeConfig nodeConfig})
const

Properties

apiKey → String?
final
breezserver → String
final
chainnotifierUrl → String
final
defaultLspId → String?
final
exemptfeeMsat → int
Maps to the CLN exemptfee config when paying invoices (lightning-pay)
final
hashCode → int
The hash code for this object.
no setterinherited
maxfeePercent → double
Maps to the CLN maxfeepercent config when paying invoices (lightning-pay)
final
mempoolspaceUrl → String?
If set, this is the mempool.space URL that will be used.
final
network → Network
final
nodeConfig → NodeConfig
final
paymentTimeoutSec → int
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
workingDir → String
Directory in which all SDK files (DB, log) are stored. Defaults to ".", otherwise if it's customized, the folder should exist before starting the SDK.
final

Methods

copyWith({String? breezserver, String? chainnotifierUrl, String? mempoolspaceUrl, String? workingDir, Network? network, int? paymentTimeoutSec, String? defaultLspId, String? apiKey, double? maxfeePercent, int? exemptfeeMsat, NodeConfig? nodeConfig}) → Config

Available on Config, provided by the SDKConfig extension

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