Struct ldk_node::Builder

pub struct Builder { /* private fields */ }

Available on non-crate feature uniffi only.

A builder for an Node instance, allowing to set some configuration and module choices from the getgo.

Defaults

• Wallet entropy is sourced from a keys_seed file located under Config::storage_dir_path
• Chain data is sourced from the Esplora endpoint https://blockstream.info/api
• Gossip data is sourced via the peer-to-peer network

Implementations

impl NodeBuilder

pub fn new() -> Self

Creates a new builder instance with the default configuration.

pub fn from_config(config: Config) -> Self

Creates a new builder instance from an Config.

pub fn set_entropy_seed_path(&mut self, seed_path: String) -> &mut Self

Configures the Node instance to source its wallet entropy from a seed file on disk.

If the given file does not exist a new random seed file will be generated and stored at the given location.

pub fn set_entropy_seed_bytes( &mut self, seed_bytes: Vec<u8>, ) -> Result<&mut Self, BuildError>

Configures the Node instance to source its wallet entropy from the given 64 seed bytes.

pub fn set_entropy_bip39_mnemonic( &mut self, mnemonic: Mnemonic, passphrase: Option<String>, ) -> &mut Self

Configures the Node instance to source its wallet entropy from a BIP 39 mnemonic.

pub fn set_esplora_server(&mut self, esplora_server_url: String) -> &mut Self

Configures the Node instance to source its chain data from the given Esplora server.

pub fn set_gossip_source_p2p(&mut self) -> &mut Self

Configures the Node instance to source its gossip data from the Lightning peer-to-peer network.

pub fn set_gossip_source_rgs(&mut self, rgs_server_url: String) -> &mut Self

Configures the Node instance to source its gossip data from the given RapidGossipSync server.

pub fn set_liquidity_source_lsps2( &mut self, address: SocketAddress, node_id: PublicKey, token: Option<String>, ) -> &mut Self

Configures the Node instance to source its inbound liquidity from the given LSPS2 service.

Will mark the LSP as trusted for 0-confirmation channels, see Config::trusted_peers_0conf.

The given token will be used by the LSP to authenticate the user.

pub fn set_storage_dir_path(&mut self, storage_dir_path: String) -> &mut Self

Sets the used storage directory path.

pub fn set_log_dir_path(&mut self, log_dir_path: String) -> &mut Self

Sets the log dir path if logs need to live separate from the storage directory path.

pub fn set_network(&mut self, network: Network) -> &mut Self

Sets the Bitcoin network used.

pub fn set_listening_addresses( &mut self, listening_addresses: Vec<SocketAddress>, ) -> Result<&mut Self, BuildError>

Sets the IP address and TCP port on which Node will listen for incoming network connections.

pub fn set_log_level(&mut self, level: LogLevel) -> &mut Self

Sets the level at which Node will log messages.

pub fn build(&self) -> Result<Node, BuildError>

Builds a Node instance with a SqliteStore backend and according to the options previously configured.

pub fn build_with_fs_store(&self) -> Result<Node, BuildError>

Builds a Node instance with a FilesystemStore backend and according to the options previously configured.

pub fn build_with_store( &self, kv_store: Arc<dyn KVStore + Sync + Send>, ) -> Result<Node, BuildError>

Builds a Node instance according to the options previously configured.

Trait Implementations

impl Debug for NodeBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.