Struct narwhal_test_utils::cluster::AuthorityDetails

pub struct AuthorityDetails {
    pub id: usize,
    pub name: PublicKey,
    /* private fields */
}

The authority details hold all the necessary structs and details to identify and manage a specific authority. An authority is composed of its primary node and the worker nodes. Via this struct we can manage the nodes one by one or in batch fashion (ex stop_all). The Authority can be cloned and reused across the instances as its internals are thread safe. So changes made from one instance will be reflected to another.

Fields

id: usize

name: PublicKey

Implementations

impl AuthorityDetails

pub fn new(
    id: usize,
    key_pair: KeyPair,
    network_key_pair: NetworkKeyPair,
    worker_keypairs: Vec<NetworkKeyPair>,
    parameters: Parameters,
    committee: SharedCommittee,
    worker_cache: SharedWorkerCache,
    internal_consensus_enabled: bool
) -> Self

pub async fn start(&self, preserve_store: bool, num_of_workers: Option<usize>)

Starts the node’s primary and workers. If the num_of_workers is provided then only those ones will be started. Otherwise all the available workers will be started instead. If the preserve_store value is true then the previous node’s storage will be preserved. If false then the node will start with a fresh (empty) storage.

pub async fn start_primary(&self, preserve_store: bool)

Starts the primary node. If the preserve_store value is true then the previous node’s storage will be preserved. If false then the node will start with a fresh (empty) storage.

pub async fn stop_primary(&self)

pub async fn start_all_workers(&self, preserve_store: bool)

pub async fn start_worker(&self, id: WorkerId, preserve_store: bool)

Starts the worker node by the provided id. If worker is not found then a panic is raised. If the preserve_store value is true then the previous node’s storage will be preserved. If false then the node will start with a fresh (empty) storage.

pub async fn stop_worker(&self, id: WorkerId)

pub async fn stop_all(&self)

Stops all the nodes (primary & workers).

pub async fn restart(&self, preserve_store: bool, delay: Duration)

Will restart the node with the current setup that has been chosen (ex same number of nodes). preserve_store: if true then the same storage will be used for the node delay: before starting again we’ll wait for that long. If zero provided then won’t wait at all

pub async fn primary(&self) -> PrimaryNodeDetails

Returns the current primary node running as a clone. If the primary node stops and starts again and it’s needed by the user then this method should be called again to get the latest one.

pub async fn worker(&self, id: WorkerId) -> WorkerNodeDetails

Returns the worker with the provided id. If not found then a panic is raised instead. If the worker is stopped and started again then the worker will need to be fetched again via this method.

pub async fn worker_transaction_addresses(&self) -> Vec<Multiaddr>

Helper method to return transaction addresses of all the worker nodes. Important: only the addresses of the running workers will be returned.

pub async fn new_proposer_client(&self) -> ProposerClient<Channel>

Creates a new proposer client that connects to the corresponding client. This should be available only if the internal consensus is disabled. If the internal consensus is enabled then a panic will be thrown instead.

pub async fn new_transactions_client(
    &self,
    worker_id: &WorkerId
) -> TransactionsClient<Channel>

This method returns a new client to send transactions to the dictated worker identified by the worker_id. If the worker_id is not found then a panic is raised.

pub async fn new_configuration_client(&self) -> ConfigurationClient<Channel>

Creates a new configuration client that connects to the corresponding client. This should be available only if the internal consensus is disabled. If the internal consensus is enabled then a panic will be thrown instead.

Trait Implementations

impl Clone for AuthorityDetails

fn clone(&self) -> AuthorityDetails

Returns a copy of the value.

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

Performs copy-assignment from source.