Struct forge::LocalSwarm

pub struct LocalSwarm { /* private fields */ }

Implementations

impl LocalSwarm

pub fn builder( versions: Arc<HashMap<Version, LocalVersion>> ) -> LocalSwarmBuilder

pub fn launch(&mut self) -> Result<()>

pub fn add_validator_fullnode( &mut self, version: &Version, template: NodeConfig, validator_peer_id: PeerId ) -> Result<PeerId>

pub fn chain_id(&self) -> ChainId

pub fn validator(&self, peer_id: PeerId) -> Option<&LocalNode>

pub fn validator_mut(&mut self, peer_id: PeerId) -> Option<&mut LocalNode>

pub fn validators(&self) -> impl Iterator<Item = &LocalNode>

pub fn validators_mut(&mut self) -> impl Iterator<Item = &mut LocalNode>

pub fn fullnode(&self, peer_id: PeerId) -> Option<&LocalNode>

pub fn fullnode_mut(&mut self, peer_id: PeerId) -> Option<&mut LocalNode>

pub fn dir(&self) -> &Path

Trait Implementations

impl Debug for LocalSwarm

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

Formats the value using the given formatter.

impl Drop for LocalSwarm

fn drop(&mut self)

Executes the destructor for this type.

impl Swarm for LocalSwarm

fn health_check(&mut self) -> Result<()>

Performs a health check on the entire swarm, ensuring all Nodes are Live and that no forks have occurred

fn validators<'a>(&'a self) -> Box<dyn Iterator<Item = &'a dyn Validator> + 'a>

Returns an Iterator of references to all the Validators in the Swarm

fn validators_mut<'a>( &'a mut self ) -> Box<dyn Iterator<Item = &'a mut dyn Validator> + 'a>

Returns an Iterator of mutable references to all the Validators in the Swarm

fn validator(&self, id: PeerId) -> Option<&dyn Validator>

Returns a reference to the Validator with the provided PeerId

fn validator_mut(&mut self, id: PeerId) -> Option<&mut dyn Validator>

Returns a mutable reference to the Validator with the provided PeerId

fn upgrade_validator(&mut self, id: PeerId, version: &Version) -> Result<()>

Upgrade a Validator to run specified Version

fn full_nodes<'a>(&'a self) -> Box<dyn Iterator<Item = &'a dyn FullNode> + 'a>

Returns an Iterator of references to all the FullNodes in the Swarm

fn full_nodes_mut<'a>( &'a mut self ) -> Box<dyn Iterator<Item = &'a mut dyn FullNode> + 'a>

Returns an Iterator of mutable references to all the FullNodes in the Swarm

fn full_node(&self, id: PeerId) -> Option<&dyn FullNode>

Returns a reference to the FullNode with the provided PeerId

fn full_node_mut(&mut self, id: PeerId) -> Option<&mut dyn FullNode>

Returns a mutable reference to the FullNode with the provided PeerId

fn add_validator( &mut self, _version: &Version, _template: NodeConfig ) -> Result<PeerId>

Adds a Validator to the swarm with the provided PeerId

fn remove_validator(&mut self, _id: PeerId) -> Result<()>

Removes the Validator with the provided PeerId

fn add_full_node( &mut self, version: &Version, template: NodeConfig ) -> Result<PeerId>

Adds a FullNode to the swarm with the provided PeerId

fn remove_full_node(&mut self, id: PeerId) -> Result<()>

Removes the FullNode with the provided PeerId

fn versions<'a>(&'a self) -> Box<dyn Iterator<Item = Version> + 'a>

Return a list of supported Versions

fn chain_info(&mut self) -> ChainInfo<'_>

Construct a ChainInfo from this Swarm

fn logs_location(&mut self) -> String