Struct SpawnLndConfig 

pub struct SpawnLndConfig {
    pub nodes: Vec<NodeConfig>,
    pub bitcoind_image: String,
    pub lnd_image: String,
    pub nodes_per_bitcoind: usize,
    pub keep_containers: bool,
    pub startup_retry: RetryPolicy,
    pub cluster_subnet: Option<String>,
}

Complete cluster configuration.

Fields

nodes: Vec<NodeConfig>

LND node definitions, in spawn order.

bitcoind_image: String

Docker image for Bitcoin Core containers.

lnd_image: String

Docker image for LND containers.

nodes_per_bitcoind: usize

Number of LND nodes backed by each Bitcoin Core container.

keep_containers: bool

Whether cluster shutdown and startup rollback should preserve containers.

startup_retry: RetryPolicy

Retry policy used for daemon startup and readiness checks.

cluster_subnet: Option<String>

Optional IPv4 subnet used for the managed Docker bridge network.

When omitted, this crate chooses an explicit private subnet so Docker accepts static container IP assignment.

Implementations

impl SpawnLndConfig

pub fn builder() -> SpawnLndBuilder

Create a builder using defaults and environment overrides.

pub async fn spawn(self) -> Result<SpawnedCluster, SpawnError>

Spawn a Docker-backed cluster from this configuration.

pub fn validate(&self) -> Result<(), ConfigError>

Validate this configuration without spawning containers.

pub fn chain_group_count(&self) -> usize

Return the number of Bitcoin Core chain groups implied by this config.

pub fn node_aliases(&self) -> impl Iterator<Item = &str>

Iterate configured LND aliases in spawn order.

Trait Implementations

impl Clone for SpawnLndConfig

fn clone(&self) -> SpawnLndConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpawnLndConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SpawnLndConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SpawnLndConfig

fn eq(&self, other: &SpawnLndConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SpawnLndConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SpawnLndConfig

impl StructuralPartialEq for SpawnLndConfig