Struct FaucetClient 

pub struct FaucetClient { /* private fields */ }

Available on crate feature faucet only.

Client for the Aptos faucet service.

The faucet is only available on devnet and testnet. Requests are automatically retried with exponential backoff for transient failures.

Example

use aptos_sdk::api::FaucetClient;
use aptos_sdk::config::AptosConfig;
use aptos_sdk::types::AccountAddress;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let config = AptosConfig::testnet();
    let client = FaucetClient::new(&config)?;
    let address = AccountAddress::from_hex("0x123")?;
    client.fund(address, 100_000_000).await?;
    Ok(())
}

Implementations

impl FaucetClient

pub fn new(config: &AptosConfig) -> AptosResult<Self>

Creates a new faucet client.

Errors

Returns an error if the faucet URL is not configured in the config, or if the HTTP client fails to build (e.g., invalid TLS configuration).

pub fn with_url(url: &str) -> AptosResult<Self>

Creates a faucet client with a custom URL.

Errors

Returns an error if the URL cannot be parsed.

pub async fn fund( &self, address: AccountAddress, amount: u64, ) -> AptosResult<Vec<String>>

Funds an account with the specified amount of octas.

Arguments

• address - The account address to fund
• amount - Amount in octas (1 APT = 10^8 octas)

Returns

The transaction hashes of the funding transactions.

Errors

Returns an error if the URL cannot be built, the HTTP request fails, the API returns an error status code (e.g., rate limiting 429, server error 500), or the response cannot be parsed as JSON.

pub async fn fund_default( &self, address: AccountAddress, ) -> AptosResult<Vec<String>>

Funds an account with a default amount (usually 1 APT).

Errors

Returns an error if the funding request fails (see fund for details).

pub async fn create_and_fund( &self, amount: u64, ) -> AptosResult<(Ed25519Account, Vec<String>)>

Available on crate feature ed25519 only.

Creates an account and funds it.

This is useful for quickly creating test accounts.

Errors

Returns an error if the funding request fails (see fund for details).

Trait Implementations

impl Clone for FaucetClient

fn clone(&self) -> FaucetClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FaucetClient

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

Formats the value using the given formatter.