Struct BootstrapConfig 

pub struct BootstrapConfig {

    pub backwards_compatible_writes: bool,
    pub cache_dir: PathBuf,
    pub cache_save_scaling_factor: u32,
    pub disable_cache_writing: bool,
    pub disable_cache_reading: bool,
    pub disable_env_peers: bool,
    pub first: bool,
    pub initial_peers: Vec<Multiaddr>,
    pub local: bool,
    pub max_cache_save_duration: Duration,
    pub max_concurrent_dials: usize,
    pub max_contacted_peers_before_termination: usize,
    pub max_cached_peers: usize,
    pub max_addrs_per_cached_peer: usize,
    pub min_cache_save_duration: Duration,
    pub network_contacts_url: Vec<String>,
}

Configuration for Bootstrapping

If you have InitialPeersConfig, you can convert it to BootstrapConfig using TryFrom trait.

Fields

backwards_compatible_writes: bool

Enable backwards compatibility while writing the cache file. This will write the cache file in all versions of the cache file format.

cache_dir: 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

cache_save_scaling_factor: u32

The cache save scaling factor. We start with the min_cache_save_duration and scale it up to the max_cache_save_duration.

disable_cache_writing: bool

Flag to disable writing to the cache file

disable_cache_reading: bool

Flag to disable reading from the cache file

disable_env_peers: bool

Flag to disable reading peers from the ANT_PEERS environment variable

first: bool

Indicate that this is the first node in a new network.

initial_peers: Vec<Multiaddr>

The initial peers that are used to bootstrap/connect the network.

local: bool

If set to true, the cache filename will be suffixed with “_local”

max_cache_save_duration: Duration

The max time duration until we save the bootstrap cache to disk.

max_concurrent_dials: usize

The max number of concurrent dials to be made during the initial bootstrap process.

This is the number of peers we will try to dial in parallel. Default is 5.

max_contacted_peers_before_termination: usize

The max number of peers to be added to RT / connected before stopping the initial bootstrap process. Default is 5.

max_cached_peers: usize

Maximum number of peers to store inside the bootstrap cache

When the number of cached peers exceeds this value, the least recently seen peers will be removed. Default is 1500.

max_addrs_per_cached_peer: usize

Maximum number of addresses stored per peer inside the bootstrap cache. Default is 3.

min_cache_save_duration: Duration

The min time duration until we save the bootstrap cache to disk.

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.

Implementations

impl BootstrapConfig

pub fn new(local: bool) -> Self

Creates a new BootstrapConfig with default settings

pub fn with_backwards_compatible_writes(self, enable: bool) -> Self

Set backwards compatible writes

pub fn with_local(self, enable: bool) -> Self

Set the local flag

pub fn with_cache_dir<P: AsRef<Path>>(self, path: P) -> Self

Update the config with a custom cache file path

pub fn with_max_concurrent_dials(self, max_dials: usize) -> Self

Sets the maximum number of concurrent dials to be made during the initial bootstrap process Default is 5.

pub fn with_max_contacted_peers_before_termination( self, max_peers: usize, ) -> Self

Sets the maximum number of peers to be added / contacted before stopping the initial bootstrap process Default is 5.

pub fn with_max_cached_peers(self, max_peers: usize) -> Self

Sets the maximum number of cached peers

pub fn with_max_addrs_per_cached_peer(self, max_addrs: usize) -> Self

Sets the maximum number of addresses for a single peer in the bootstrap cache

pub fn with_disable_cache_writing(self, disable: bool) -> Self

Sets the flag to disable writing to the cache file

pub fn with_disable_cache_reading(self, disable: bool) -> Self

Sets the flag to disable reading from the cache file

pub fn with_disable_env_peers(self, disable: bool) -> Self

Sets the flag to disable reading peers from the ANT_PEERS environment variable

pub fn with_first(self, first: bool) -> Self

Sets whether this config represents the first node in the network

pub fn with_initial_peers(self, peers: Vec<Multiaddr>) -> Self

Sets the initial peers that should be used for bootstrapping

pub fn with_cache_save_scaling_factor(self, factor: u32) -> Self

Sets the cache save scaling factor

pub fn with_max_cache_save_duration(self, duration: Duration) -> Self

Sets the maximum duration between cache saves

pub fn with_min_cache_save_duration(self, duration: Duration) -> Self

Sets the minimum duration between cache saves

pub fn with_network_contacts_url(self, urls: Vec<String>) -> Self

Sets the list of network contact URLs

Trait Implementations

impl Clone for BootstrapConfig

fn clone(&self) -> BootstrapConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BootstrapConfig

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

Formats the value using the given formatter.

impl Default for BootstrapConfig

fn default() -> Self

Returns the “default value” for a type.

impl TryFrom<&InitialPeersConfig> for BootstrapConfig

type Error = Error

The type returned in the event of a conversion error.

fn try_from(config: &InitialPeersConfig) -> Result<Self>

Performs the conversion.