Struct LocalNet 

pub struct LocalNet { /* private fields */ }

A set of Linera validators running locally as native processes.

Implementations

impl LocalNet

pub fn genesis_config(&self) -> Result<GenesisConfig>

Reads the genesis configuration of the local network.

pub fn proxy_internal_port(&self, validator: usize, proxy_id: usize) -> usize

Returns the internal port of the given proxy, which its own shards use to reach it.

pub fn shard_metrics_port(&self, validator: usize, shard: usize) -> usize

Returns the metrics port of the given shard of the given validator.

pub fn proxy_metrics_port(&self, validator: usize, proxy_id: usize) -> usize

Returns the metrics port of the given proxy of the given validator.

pub fn proxy_public_port(&self, validator: usize, proxy_id: usize) -> usize

Returns the public port of the given proxy of the given validator.

pub fn first_public_port() -> usize

Returns the public port of the first proxy of the first validator.

pub async fn ensure_grpc_server_has_started( nickname: &str, port: usize, scheme: &str, ) -> Result<()>

Waits until the gRPC server at the given port responds as healthy.

pub async fn start_validator(&mut self, index: usize) -> Result<()>

Start a validator.

pub async fn restart_validator(&mut self, index: usize) -> Result<()>

Restart a validator. This is similar to start_validator except that the database was already initialized once.

pub async fn stop_validator(&mut self, index: usize) -> Result<()>

Terminates all the processes of a given validator.

pub fn validator_client(&mut self, validator: usize) -> Result<Client>

Returns a linera_rpc::Client to interact directly with a validator.

pub fn validator_address(&self, validator: usize) -> String

Returns the address to connect to a validator’s proxy. In local networks, the zeroth proxy is the validator ingress.

impl LocalNet

pub async fn kill_proxy( &mut self, validator: usize, proxy_id: usize, ) -> Result<()>

Kills one proxy of the given validator, leaving its other proxies and shards running, to check that traffic relayed through it moves to another rather than being stranded.

pub fn validator_keys(&self, validator: usize) -> Option<&(String, String)>

Returns the validating key and an account key of the validator.

pub async fn generate_validator_config( &mut self, validator: usize, ) -> Result<()>

Generates the configuration and keys for the given validator.

pub async fn terminate_server( &mut self, validator: usize, shard: usize, ) -> Result<()>

Terminates the server for the given shard of the given validator.

pub fn remove_validator(&mut self, validator: usize) -> Result<()>

Removes the given validator from the set of running validators.

pub async fn start_server( &mut self, validator: usize, shard: usize, ) -> Result<()>

Starts the server for the given shard of the given validator.

Trait Implementations

impl LineraNet for LocalNet

fn ensure_is_running<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Checks that the net is still running and returns an error otherwise.

fn make_client<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = ClientWrapper> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates a new client to interact with the net.

fn terminate<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Shuts down the net.