Struct iota_client::builder::ClientBuilder

pub struct ClientBuilder { /* fields omitted */ }

Builder to construct client instance with sensible default values

Implementations

impl ClientBuilder

pub fn new() -> Self

Creates an IOTA client builder.

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

Adds an IOTA node by its URL.

pub fn with_primary_node(
    self,
    url: &str,
    jwt: Option<String>,
    basic_auth_name_pwd: Option<(&str, &str)>
) -> Result<Self>

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,
    jwt: Option<String>,
    basic_auth_name_pwd: Option<(&str, &str)>
) -> Result<Self>

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,
    jwt: Option<String>,
    basic_auth_name_pwd: Option<(&str, &str)>
) -> Result<Self>

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

pub fn with_node_auth(
    self,
    url: &str,
    jwt: Option<String>,
    basic_auth_name_pwd: Option<(&str, &str)>
) -> Result<Self>

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

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

Adds a list of IOTA nodes by their URLs.

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

Set the node sync interval

pub fn with_node_sync_disabled(self) -> Self

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

pub async fn with_node_pool_urls(
    self,
    node_pool_urls: &[String]
) -> Result<Self>

Get node list from the node_pool_urls

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

Set if quroum should be used or not

pub fn with_quorum_size(self, quorum_size: usize) -> Self

Set amount of nodes which should be used for quorum

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

Set quorum_threshold

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

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. Default nodes are only used when no other nodes are provided.

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

Sets whether the PoW should be done locally or remotely.

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

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

pub fn with_request_timeout(self, timeout: Duration) -> Self

Sets the default request timeout.

pub fn with_api_timeout(self, api: Api, timeout: Duration) -> Self

Sets the request timeout for a specific API usage.

pub async fn finish(self) -> Result<Client>

Build the Client instance.

Trait Implementations

impl Default for ClientBuilder

fn default() -> Self

Returns the “default value” for a type.