Struct PeersArgs

pub struct PeersArgs {
    pub first: bool,
    pub addrs: Vec<Multiaddr>,
    pub network_contacts_url: Vec<String>,
    pub local: bool,
    pub disable_mainnet_contacts: bool,
    pub ignore_cache: bool,
    pub bootstrap_cache_dir: Option<PathBuf>,
}

Command line arguments for peer configuration

Fields

first: bool

Set to indicate this is the first node in a new network

If this argument is used, any others will be ignored because they do not apply to the first node.

addrs: Vec<Multiaddr>

Addr(s) to use for bootstrap, in a ‘multiaddr’ format containing the peer ID.

A multiaddr looks like ‘/ip4/1.2.3.4/tcp/1200/tcp/p2p/12D3KooWRi6wF7yxWLuPSNskXc6kQ5cJ6eaymeMbCRdTnMesPgFx’ where 1.2.3.4 is the IP, 1200 is the port and the (optional) last part is the peer ID.

This argument can be provided multiple times to connect to multiple peers.

Alternatively, the ANT_PEERS environment variable can provide a comma-separated peer list.

network_contacts_url: Vec<String>

Specify the URL to fetch the network contacts from.

The URL can point to a text file containing Multiaddresses separated by newline character, or a bootstrap cache JSON file.

local: bool

Set to indicate this is a local network. You could also set the local feature flag to set this to true.

This would use mDNS for peer discovery.

disable_mainnet_contacts: bool

Set to indicate this is a testnet.

This disables fetching peers from the mainnet network contacts.

ignore_cache: bool

Set to not load the bootstrap addresses from the local cache.

bootstrap_cache_dir: Option<PathBuf>

The directory to load and store the bootstrap cache. If not provided, the default path will be used.

The JSON filename will be derived automatically from the network ID

The default location is platform specific:

• Linux: $HOME/.local/share/autonomi/bootstrap_cache/bootstrap_cache_<network_id>.json
• macOS: $HOME/Library/Application Support/autonomi/bootstrap_cache/bootstrap_cache_<network_id>.json
• Windows: C:\Users<username>\AppData\Roaming\autonomi\bootstrap_cache\bootstrap_cache_<network_id>.json

Implementations

impl PeersArgs

pub async fn get_addrs( &self, config: Option<BootstrapCacheConfig>, count: Option<usize>, ) -> Result<Vec<Multiaddr>>

Get bootstrap peers sorted by the failure rate. The peer with the lowest failure rate will be the first in the list.

pub async fn get_bootstrap_addr( &self, config: Option<BootstrapCacheConfig>, count: Option<usize>, ) -> Result<Vec<BootstrapAddr>>

Get bootstrap peers sorted by the failure rate. The peer with the lowest failure rate will be the first in the list.

pub fn read_addr_from_env() -> Vec<Multiaddr>

pub fn read_bootstrap_addr_from_env() -> Vec<BootstrapAddr>

pub fn get_bootstrap_cache_path(&self) -> Result<Option<PathBuf>>

Get the path to the bootstrap cache JSON file if Self::bootstrap_cache_dir is set

Trait Implementations

impl Args for PeersArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Clone for PeersArgs

fn clone(&self) -> PeersArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PeersArgs

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

Formats the value using the given formatter.

impl Default for PeersArgs

fn default() -> PeersArgs

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PeersArgs

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromArgMatches for PeersArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl PartialEq for PeersArgs

fn eq(&self, other: &PeersArgs) -> 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 PeersArgs

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PeersArgs