Struct swarm_nl::setup::BootstrapConfig

pub struct BootstrapConfig { /* private fields */ }

Configuration data required for node bootstrap.

Implementations

impl BootstrapConfig

pub fn from_file(file_path: &str) -> Self

Read from a bootstrap config file on disk.

Panics

This function will panic if the file is not found at the specified path.

pub fn new() -> Self

Return a new BootstrapConfig struct populated by default (empty) values.

Must be called first if the config is to be explicitly built without reading .ini file from disk.

pub fn with_bootnodes( self, boot_nodes: HashMap<PeerIdString, MultiaddrString> ) -> Self

Configure available bootnodes.

pub fn with_blacklist(self, list: Vec<PeerId>) -> Self

Configure a list of peers to add to blacklist.

pub fn with_tcp(self, tcp_port: Port) -> Self

Configure the TCP/IP port.

Note: Port must range between MIN_PORT and MAX_PORT.

pub fn with_udp(self, udp_port: Port) -> Self

Configure the UDP port.

Note: Port must range between MIN_PORT and MAX_PORT

pub fn generate_keypair( self, key_type: KeyType, rsa_pk8_filepath: Option<&str> ) -> Self

Generate a Cryptographic Keypair for node identity creation and message signing.

An RSA keypair cannot be generated on-the-fly. It has to be generated from a .pk8 file. Hence the rsa_pk8_filepath parameter must always be set to None except in the case of RSA. Please note that calling this function overrides whatever might have been read from the .ini file

Panics

This function will panic if:

1. The RSA key type is specified and the rsa_pk8_filepath is set to None.
2. If the file contains invalid data and an RSA keypair cannot be generated from it.

pub fn generate_keypair_from_protobuf( self, key_type_str: &str, bytes: &mut [u8] ) -> Self

Generate a Cryptographic Keypair from a protobuf format.

This will override any already set keypair.

Panics

This function will panic if the u8 buffer is not parsable into the specified key type. This could be because one of two reasons:

1. If the key type is valid, but the keypair data is not valid for that key type.
2. If the key type is invalid.

pub fn keypair(&self) -> Keypair

Return a node’s cryptographic keypair.

pub fn ports(&self) -> (Port, Port)

Return the configured ports in a tuple i.e (TCP Port, UDP port).

pub fn bootnodes(&self) -> HashMap<PeerIdString, MultiaddrString>

Return the configured bootnodes for the network.

pub fn blacklist(&self) -> Blacklist

Return the PeerId’s of nodes that are to be blacklisted.

Trait Implementations

impl Debug for BootstrapConfig

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

Formats the value using the given formatter.

impl Default for BootstrapConfig

Default implementation for BootstrapConfig.

fn default() -> Self

Returns the “default value” for a type.