Struct Config 

pub struct Config {

    pub server_address: String,
    pub esplora_address: Option<String>,
    pub bitcoind_address: Option<String>,
    pub bitcoind_cookiefile: Option<PathBuf>,
    pub bitcoind_user: Option<String>,
    pub bitcoind_pass: Option<String>,
    pub vtxo_refresh_expiry_threshold: BlockHeight,
    pub vtxo_exit_margin: BlockDelta,
    pub htlc_recv_claim_delta: BlockDelta,
    pub fallback_fee_rate: Option<FeeRate>,
    pub round_tx_required_confirmations: BlockHeight,
    pub offboard_required_confirmations: BlockHeight,
    pub daemon_fast_sync_interval_secs: u64,
    pub daemon_slow_sync_interval_secs: u64,
}

Configuration of the Bark wallet.

• Config::esplora_address or Config::bitcoind_address must be provided.
• If you use Config::bitcoind_address, you must also provide:
  • Config::bitcoind_cookiefile or
  • Config::bitcoind_user and Config::bitcoind_pass
• Other optional fields can be omitted.

Example

Configure the wallet using defaults, then override endpoints for public signet:

use bark::Config;

let cfg = Config {
  server_address: "https://ark.signet.2nd.dev".into(),
  esplora_address: Some("https://esplora.signet.2nd.dev".into()),
  ..Config::network_default(bitcoin::Network::Bitcoin)
};
// cfg now has all other fields from the default configuration

Fields

server_address: String

The address of your ark server.

esplora_address: Option<String>

The address of the Esplora HTTP REST server to use.

Either this or the bitcoind_address field has to be provided.

bitcoind_address: Option<String>

The address of the bitcoind RPC server to use.

Either this or the esplora_address field has to be provided. Either bitcoind_cookiefile or bitcoind_user and bitcoind_pass has to be provided.

bitcoind_cookiefile: Option<PathBuf>

The path to the bitcoind rpc cookie file.

Only used with bitcoind_address.

bitcoind_user: Option<String>

The bitcoind RPC username.

Only used with bitcoind_address.

bitcoind_pass: Option<String>

The bitcoind RPC password.

Only used with bitcoind_address.

vtxo_refresh_expiry_threshold: BlockHeight

The number of blocks before expiration to refresh vtxos.

Default value: 144 (24h) for mainnet, 12 for testnets

vtxo_exit_margin: BlockDelta

An upper limit of the number of blocks we expect to need to safely exit the vtxos.

Default value: 12

htlc_recv_claim_delta: BlockDelta

The number of blocks to claim a HTLC-recv VTXO.

Default value: 18

fallback_fee_rate: Option<FeeRate>

A fallback fee rate to use in sat/kWu when we fail to retrieve a fee rate from the configured bitcoind/esplora connection.

Example for 1 sat/vB: –fallback-fee-rate 250

round_tx_required_confirmations: BlockHeight

The number of confirmations required before considering a round tx fully confirmed

Default value: 6 for mainnet, 2 for testnets

offboard_required_confirmations: BlockHeight

The number of confirmations required before considering an offboard tx confirmed. If set to 0, offboard movements are marked as successful immediately without waiting for confirmation.

Default value: 2 for mainnet

daemon_fast_sync_interval_secs: u64

Daemon sync interval in seconds for fast tasks (lightning sync).

This should be significantly smaller than the server’s receive_htlc_forward_timeout (default 30s). If the sync interval is too close to the timeout, lightning receives are more likely to fail because the client may not claim the HTLC in time.

Default value: 1

daemon_slow_sync_interval_secs: u64

Daemon sync interval in seconds for slow tasks (onchain, exits, boards, offboards, maintenance, rounds, mailbox).

Default value: 60

Implementations

impl Config

pub fn network_default(network: Network) -> Self

A network-dependent default config that sets some useful defaults

The Default::default provides a sane default for mainnet

pub fn load(network: Network, path: impl AsRef<Path>) -> Result<Config>

Load config from the config file path, filling missing fields from the network default.

Config values are loaded in the following priority order (highest to lowest):

1. Environment variables with BARK_ prefix (e.g., BARK_ESPLORA_ADDRESS)
2. Config file values
3. Network defaults

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.