Struct SpawnedCluster 

pub struct SpawnedCluster { /* private fields */ }

A running regtest cluster containing Bitcoin Core and LND containers.

Implementations

impl SpawnedCluster

pub async fn spawn(config: SpawnLndConfig) -> Result<Self, SpawnError>

Spawn a cluster using a validated config and a default Docker connection.

pub async fn spawn_with_docker( docker: DockerClient, config: SpawnLndConfig, ) -> Result<Self, SpawnError>

Spawn a cluster using a caller-provided Docker client.

pub fn cluster_id(&self) -> &str

Return the generated cluster id used in Docker labels.

pub fn config(&self) -> &SpawnLndConfig

Return the config used to spawn this cluster.

pub fn network(&self) -> &ManagedNetwork

Return the managed Docker network used by this cluster.

pub fn bitcoinds(&self) -> &[BitcoinCore]

Return all spawned Bitcoin Core chain groups.

pub fn node(&self, alias: &str) -> Option<&SpawnedNode>

Look up a spawned LND node by alias.

pub fn nodes(&self) -> impl Iterator<Item = &SpawnedNode>

Iterate spawned LND nodes in configured order.

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

Iterate node aliases in configured order.

pub fn node_configs(&self) -> Vec<LndNodeConfig>

Build connection configs for all LND nodes.

pub async fn connect_nodes(&self) -> Result<LndNodeClients, SpawnError>

Connect to all LND nodes with lnd_grpc_rust.

pub async fn connect_peer( &self, from_alias: &str, to_alias: &str, ) -> Result<PeerConnection, SpawnError>

Connect one LND node to another over the Docker bridge network.

pub async fn connect_all_peers(&self) -> Result<Vec<PeerConnection>, SpawnError>

Connect every LND node to every other LND node.

pub async fn fund_node(&self, alias: &str) -> Result<FundingReport, SpawnError>

Fund one LND node with DEFAULT_FUNDING_AMOUNT_BTC.

pub async fn fund_node_with_amount( &self, alias: &str, amount_btc: f64, ) -> Result<FundingReport, SpawnError>

Fund one LND node with a caller-provided BTC amount.

pub async fn fund_nodes<I, S>( &self, aliases: I, ) -> Result<Vec<FundingReport>, SpawnError>

where I: IntoIterator<Item = S>, S: AsRef<str>,

Batch-fund multiple LND nodes with DEFAULT_FUNDING_AMOUNT_BTC each.

pub async fn fund_nodes_with_amount<I, S>( &self, aliases: I, amount_btc: f64, ) -> Result<Vec<FundingReport>, SpawnError>

where I: IntoIterator<Item = S>, S: AsRef<str>,

Batch-fund multiple LND nodes with the same caller-provided BTC amount.

pub async fn open_channel( &self, from_alias: &str, to_alias: &str, ) -> Result<ChannelReport, SpawnError>

Open a public channel with DEFAULT_CHANNEL_CAPACITY_SAT.

pub async fn open_channel_with_amount( &self, from_alias: &str, to_alias: &str, local_funding_amount_sat: i64, ) -> Result<ChannelReport, SpawnError>

Open a public channel with a caller-provided satoshi capacity.

pub async fn stop_lnd(&self, alias: &str) -> Result<(), SpawnError>

Stop an LND container without removing it.

pub async fn start_lnd(&mut self, alias: &str) -> Result<(), SpawnError>

Start an existing LND container and wait until it is synced to chain.

pub async fn restart_lnd(&mut self, alias: &str) -> Result<(), SpawnError>

Restart an LND container and wait until it is synced to chain.

pub async fn stop_bitcoind(&self, group_index: usize) -> Result<(), SpawnError>

Stop a Bitcoin Core chain group container without removing it.

pub async fn start_bitcoind( &mut self, group_index: usize, ) -> Result<(), SpawnError>

Start an existing Bitcoin Core chain group and wait for dependent nodes.

pub async fn restart_bitcoind( &mut self, group_index: usize, ) -> Result<(), SpawnError>

Restart a Bitcoin Core chain group and wait for dependent nodes.

pub async fn shutdown(&mut self) -> Result<CleanupReport, SpawnError>

Stop and remove all containers in this cluster unless keep_containers is set.

Trait Implementations

impl Debug for SpawnedCluster

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

Formats the value using the given formatter.

impl Drop for SpawnedCluster

fn drop(&mut self)

Executes the destructor for this type.