Struct ldk_node::Builder

pub struct Builder { /* private fields */ }

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

Implementations

impl Builder

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: [u8; 64]) -> &mut Self

Configures the Node instance to source its wallet entropy from the given 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_storage_dir_path(&mut self, storage_dir_path: String) -> &mut Self

Sets the used storage directory path.

Default: /tmp/ldk_node/

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

Sets the Esplora server URL.

Default: https://blockstream.info/api

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

Sets the Bitcoin network used.

Options: mainnet/bitcoin, testnet, regtest, signet

Default: testnet

pub fn set_listening_address( &mut self, listening_address: SocketAddr ) -> &mut Self

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

Default: 0.0.0.0:9735

pub fn build(&self) -> Node

Builds an Node instance according to the options previously configured.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.