Struct AptosConfig 

pub struct AptosConfig { /* private fields */ }

Configuration for the Aptos client.

Use the builder methods to customize the configuration, or use one of the preset configurations like AptosConfig::mainnet(), AptosConfig::testnet(), or AptosConfig::devnet().

Example

use aptos_sdk::AptosConfig;
use aptos_sdk::retry::RetryConfig;
use aptos_sdk::config::PoolConfig;

// Use testnet with default settings
let config = AptosConfig::testnet();

// Custom configuration with retry and connection pooling
let config = AptosConfig::testnet()
    .with_timeout(std::time::Duration::from_secs(30))
    .with_retry(RetryConfig::aggressive())
    .with_pool(PoolConfig::high_throughput());

Implementations

impl AptosConfig

pub fn mainnet() -> Self

Creates a configuration for Aptos mainnet.

Example

use aptos_sdk::AptosConfig;

let config = AptosConfig::mainnet();

pub fn testnet() -> Self

Creates a configuration for Aptos testnet.

Example

use aptos_sdk::AptosConfig;

let config = AptosConfig::testnet();

pub fn devnet() -> Self

Creates a configuration for Aptos devnet.

Example

use aptos_sdk::AptosConfig;

let config = AptosConfig::devnet();

pub fn local() -> Self

Creates a configuration for a local development network.

This assumes the local network is running on the default ports (REST API on 8080, faucet on 8081).

Example

use aptos_sdk::AptosConfig;

let config = AptosConfig::local();

pub fn custom(fullnode_url: &str) -> AptosResult<Self>

Creates a custom configuration with the specified fullnode URL.

Security

Only http:// and https:// URL schemes are allowed. Using https:// is strongly recommended for production. HTTP is acceptable only for localhost development environments.

Errors

Returns an error if the fullnode_url cannot be parsed as a valid URL or uses an unsupported scheme (e.g., file://, ftp://).

Example

use aptos_sdk::AptosConfig;

let config = AptosConfig::custom("https://my-node.example.com/v1").unwrap();

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

Sets the request timeout.

pub fn with_retry(self, retry_config: RetryConfig) -> Self

Sets the retry configuration for transient failures.

Example

use aptos_sdk::AptosConfig;
use aptos_sdk::retry::RetryConfig;

let config = AptosConfig::testnet()
    .with_retry(RetryConfig::aggressive());

pub fn without_retry(self) -> Self

Disables automatic retry for API calls.

This is equivalent to with_retry(RetryConfig::no_retry()).

pub fn with_max_retries(self, max_retries: u32) -> Self

Sets the maximum number of retries for transient failures.

This is a convenience method that modifies the retry config.

pub fn with_pool(self, pool_config: PoolConfig) -> Self

Sets the connection pool configuration.

Example

use aptos_sdk::AptosConfig;
use aptos_sdk::config::PoolConfig;

let config = AptosConfig::testnet()
    .with_pool(PoolConfig::high_throughput());

pub fn with_api_key(self, api_key: impl Into<String>) -> Self

Sets an API key for authenticated access.

This is useful when using Aptos Build or other services that provide higher rate limits with API keys.

pub fn with_indexer_url(self, url: &str) -> AptosResult<Self>

Sets a custom indexer URL.

Security

Only http:// and https:// URL schemes are allowed.

Errors

Returns an error if the url cannot be parsed as a valid URL or uses an unsupported scheme.

pub fn with_faucet_url(self, url: &str) -> AptosResult<Self>

Sets a custom faucet URL.

Security

Only http:// and https:// URL schemes are allowed.

Errors

Returns an error if the url cannot be parsed as a valid URL or uses an unsupported scheme.

pub fn network(&self) -> Network

Returns the network this config is for.

pub fn fullnode_url(&self) -> &Url

Returns the fullnode URL.

pub fn indexer_url(&self) -> Option<&Url>

Returns the indexer URL, if configured.

pub fn faucet_url(&self) -> Option<&Url>

Returns the faucet URL, if configured.

pub fn chain_id(&self) -> ChainId

Returns the chain ID for this configuration.

pub fn retry_config(&self) -> &RetryConfig

Returns the retry configuration.

pub fn timeout(&self) -> Duration

Returns the request timeout.

pub fn pool_config(&self) -> &PoolConfig

Returns the connection pool configuration.

Trait Implementations

impl Clone for AptosConfig

fn clone(&self) -> AptosConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AptosConfig

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

Formats the value using the given formatter.

impl Default for AptosConfig

fn default() -> Self

Returns the “default value” for a type.