Struct iota_wallet::ClientOptions

pub struct ClientOptions {
    pub node_manager_builder: NodeManagerBuilder,
    pub network_info: NetworkInfo,
    pub api_timeout: Duration,
    pub remote_pow_timeout: Duration,
    pub offline: bool,
    pub pow_worker_count: Option<usize>,
}

The ClientOptions to build the iota_client for interactions with the IOTA Tangle. Builder to construct client instance with sensible default values

Fields

node_manager_builder: NodeManagerBuilder

Node manager builder

network_info: NetworkInfo

Data related to the used network

api_timeout: Duration

Timeout for API requests

remote_pow_timeout: Duration

Timeout when sending a block that requires remote proof of work

offline: bool

If the Client should be able to use without a node connection

pow_worker_count: Option<usize>

The amount of threads to be used for proof of work

Implementations

impl ClientBuilder

The ClientOptions to build the iota_client for interactions with the IOTA Tangle.

pub fn new() -> ClientBuilder

Creates an IOTA client builder.

pub fn from_json(self, client_config: &str) -> Result<ClientBuilder, Error>

Set the fields from a client JSON config

pub fn to_json(&self) -> Result<String, Error>

Export the client builder as JSON string

pub fn with_node(self, url: &str) -> Result<ClientBuilder, Error>

Adds an IOTA node by its URL.

pub fn with_primary_node(
    self,
    url: &str,
    auth: Option<NodeAuth>
) -> Result<ClientBuilder, Error>

Adds an IOTA node by its URL to be used as primary node, with optional jwt and or basic authentication

pub fn with_primary_pow_node(
    self,
    url: &str,
    auth: Option<NodeAuth>
) -> Result<ClientBuilder, Error>

Adds an IOTA node by its URL to be used as primary PoW node (for remote Pow), with optional jwt and or basic authentication

pub fn with_permanode(
    self,
    url: &str,
    auth: Option<NodeAuth>
) -> Result<ClientBuilder, Error>

Adds a permanode by its URL, with optional jwt and or basic authentication

pub fn with_node_auth(
    self,
    url: &str,
    auth: Option<NodeAuth>
) -> Result<ClientBuilder, Error>

Adds an IOTA node by its URL with optional jwt and or basic authentication

pub fn with_nodes(self, urls: &[&str]) -> Result<ClientBuilder, Error>

Adds a list of IOTA nodes by their URLs.

pub fn with_node_sync_interval(
    self,
    node_sync_interval: Duration
) -> ClientBuilder

Set the node sync interval

pub fn with_node_sync_disabled(self) -> ClientBuilder

Disables the node syncing process. Every node will be considered healthy and ready to use.

pub fn with_offline_mode(self) -> ClientBuilder

Allows creating the client without nodes for offline address generation or signing

pub fn with_quorum(self, quorum: bool) -> ClientBuilder

Set if quorum should be used or not

pub fn with_min_quorum_size(self, min_quorum_size: usize) -> ClientBuilder

Set amount of nodes which should be used for quorum

pub fn with_quorum_threshold(self, threshold: usize) -> ClientBuilder

Set quorum_threshold

pub fn with_network(self, network: &str) -> ClientBuilder

Selects the type of network to get default nodes for it, only “testnet” is supported at the moment. Nodes that don’t belong to this network are ignored. The &str must match a part or all of the networkId returned in the node info from a node. For example, if the networkId is "private-tangle", "tangle" can be used. Default nodes are only used when no other nodes are provided.

pub fn with_local_pow(self, local: bool) -> ClientBuilder

Sets whether the PoW should be done locally or remotely.

pub fn with_pow_worker_count(self, worker_count: usize) -> ClientBuilder

Sets the amount of workers that should be used for PoW, default is num_cpus::get().

pub fn with_fallback_to_local_pow(
    self,
    fallback_to_local_pow: bool
) -> ClientBuilder

Sets whether the PoW should be done locally in case a node doesn’t support remote PoW.

pub fn with_tips_interval(self, tips_interval: u64) -> ClientBuilder

Sets after how many seconds new tips will be requested during PoW

pub fn with_api_timeout(self, timeout: Duration) -> ClientBuilder

Sets the default request timeout.

pub fn with_remote_pow_timeout(self, timeout: Duration) -> ClientBuilder

Sets the request timeout for API usage.

pub fn finish(self) -> Result<Client, Error>

Build the Client instance.

Trait Implementations

impl Clone for ClientBuilder

fn clone(&self) -> ClientBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientBuilder

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

Formats the value using the given formatter.

impl Default for ClientBuilder

fn default() -> ClientBuilder

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClientBuilder

fn deserialize<__D>(
    __deserializer: __D
) -> Result<ClientBuilder, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<ClientBuilder> for ClientBuilder

fn eq(&self, other: &ClientBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ClientBuilder) -> bool

This method tests for !=.

impl Serialize for ClientBuilder

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

Serialize this value into the given Serde serializer.

impl Eq for ClientBuilder

impl StructuralEq for ClientBuilder

impl StructuralPartialEq for ClientBuilder