Struct IotaClientBuilder

pub struct IotaClientBuilder { /* private fields */ }

Builder for creating an IotaClient for connecting to the IOTA network.

By default maximum concurrent requests is set to 256 and request timeout is set to 60 seconds. These can be adjusted using Self::max_concurrent_requests(), and the Self::request_timeout(). If you use the WebSocket, consider setting ws_ping_interval appropriately to prevent an inactive WS subscription being disconnected due to proxy timeout.

Examples

use iota_sdk::IotaClientBuilder;

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let iota = IotaClientBuilder::default()
        .build("http://127.0.0.1:9000")
        .await?;

    println!("IOTA local network version: {:?}", iota.api_version());
    Ok(())
}

Implementations

impl IotaClientBuilder

pub fn request_timeout(self, request_timeout: Duration) -> Self

Set the request timeout to the specified duration.

pub fn max_concurrent_requests(self, max_concurrent_requests: usize) -> Self

Set the max concurrent requests allowed.

pub fn ws_url(self, url: impl AsRef<str>) -> Self

Set the WebSocket URL for the IOTA network.

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

Set the WebSocket ping interval.

pub fn basic_auth( self, username: impl AsRef<str>, password: impl AsRef<str>, ) -> Self

Set the basic auth credentials for the HTTP client.

pub fn custom_headers(self, headers: HashMap<String, String>) -> Self

Set custom headers for the HTTP client

pub fn tls_config(self, config: ClientConfig) -> Self

Set a TLS configuration for the HTTP client.

pub async fn build(self, http: impl AsRef<str>) -> IotaRpcResult<IotaClient>

Return an IotaClient object connected to the IOTA network accessible via the provided URI.

Examples

use iota_sdk::IotaClientBuilder;

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let iota = IotaClientBuilder::default()
        .build("http://127.0.0.1:9000")
        .await?;

    println!("IOTA local version: {:?}", iota.api_version());
    Ok(())
}

pub async fn build_localnet(self) -> IotaRpcResult<IotaClient>

Return an IotaClient object that is ready to interact with the local development network (by default it expects the IOTA network to be up and running at 127.0.0.1:9000).

For connecting to a custom URI, use the build function instead.

Examples

use iota_sdk::IotaClientBuilder;

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let iota = IotaClientBuilder::default().build_localnet().await?;

    println!("IOTA local version: {:?}", iota.api_version());
    Ok(())
}

pub async fn build_devnet(self) -> IotaRpcResult<IotaClient>

Return an IotaClient object that is ready to interact with the IOTA devnet.

For connecting to a custom URI, use the build function instead.

Examples

use iota_sdk::IotaClientBuilder;

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let iota = IotaClientBuilder::default().build_devnet().await?;

    println!("{:?}", iota.api_version());
    Ok(())
}

pub async fn build_testnet(self) -> IotaRpcResult<IotaClient>

Return an IotaClient object that is ready to interact with the IOTA testnet.

For connecting to a custom URI, use the build function instead.

Examples

use iota_sdk::IotaClientBuilder;

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let iota = IotaClientBuilder::default().build_testnet().await?;

    println!("{:?}", iota.api_version());
    Ok(())
}

pub async fn build_mainnet(self) -> IotaRpcResult<IotaClient>

Returns an IotaClient object that is ready to interact with the IOTA mainnet.

For connecting to a custom URI, use the build function instead.

Examples

use iota_sdk::IotaClientBuilder;

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let iota = IotaClientBuilder::default().build_mainnet().await?;

    println!("{:?}", iota.api_version());
    Ok(())
}

Trait Implementations

impl Default for IotaClientBuilder

fn default() -> Self

Returns the “default value” for a type.