Struct identity_iota::client::ClientBuilder

pub struct ClientBuilder { /* private fields */ }

A ClientBuilder is used to generated a customized Client.

Implementations

impl ClientBuilder

pub fn new() -> ClientBuilder

Creates a new ClientBuilder.

pub fn network(self, network: Network) -> ClientBuilder

Sets the IOTA Tangle network.

pub fn encoding(self, encoding: DIDMessageEncoding) -> ClientBuilder

Sets the DID message encoding used when publishing to the Tangle.

pub fn retry_until_included(self, value: bool) -> ClientBuilder

When publishing to the Tangle, sets whether to retry until the message is confirmed by a milestone. Default: true.

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

Adds an IOTA node by its URL.

pub fn primary_node(
    self,
    url: &str,
    jwt: Option<String>,
    basic_auth: Option<(&str, &str)>
) -> Result<ClientBuilder, Error>

Adds an IOTA node by its URL to be used as primary node.

pub fn primary_pow_node(
    self,
    url: &str,
    jwt: Option<String>,
    basic_auth: Option<(&str, &str)>
) -> Result<ClientBuilder, Error>

Adds an IOTA node by its URL to be used as primary PoW node (for remote PoW).

pub fn permanode(
    self,
    url: &str,
    jwt: Option<String>,
    basic_auth: Option<(&str, &str)>
) -> Result<ClientBuilder, Error>

Adds a permanode by its URL.

pub fn node_auth(
    self,
    url: &str,
    jwt: Option<String>,
    basic_auth: Option<(&str, &str)>
) -> Result<ClientBuilder, Error>

Adds an IOTA node by its URL.

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

Adds a list of IOTA nodes by their URLs.

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

Sets the node sync interval.

pub fn node_sync_disabled(self) -> ClientBuilder

Disables the node sync process.

pub async fn node_pool_urls(
    self,
    urls: &[String]
) -> Result<ClientBuilder, Error>

Get node list from the urls.

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

Enables/disables quorum.

pub fn quorum_size(self, value: usize) -> ClientBuilder

Sets the number of nodes used for quorum.

pub fn quorum_threshold(self, value: usize) -> ClientBuilder

Sets the quorum threshold.

pub fn local_pow(self, value: bool) -> ClientBuilder

Sets whether proof-of-work (PoW) is performed locally or remotely.

Default: false.

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

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

Default: true.

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

Sets the number of seconds that new tips will be requested during PoW.

pub fn request_timeout(self, value: Duration) -> ClientBuilder

Sets the default request timeout.

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

Creates a new Client based on the ClientBuilder configuration.

Trait Implementations

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.