Struct FaucetClient

pub struct FaucetClient { /* private fields */ }

Implementations

impl FaucetClient

pub fn new(faucet_url: &str) -> Self

Construct a new FaucetClient with the given faucet service URL. This FaucetClient expects that the service provides two endpoints: /v1/gas and /v1/status. As such, do not provide the request endpoint, just the top level service endpoint.

• /v1/gas is used to request gas
• /v1/status/taks-uuid is used to check the status of the request

pub fn local() -> Self

Set to local faucet.

pub fn devnet() -> Self

Set to devnet faucet.

pub fn testnet() -> Self

Set to testnet faucet.

pub async fn request(&self, address: Address) -> Result<Option<String>, Error>

Request gas from the faucet. Note that this will return the UUID of the request and not wait until the token is received. Use request_and_wait to wait for the token.

pub async fn request_and_wait( &self, address: Address, ) -> Result<Option<FaucetReceipt>, Error>

Request gas from the faucet and wait until the request is completed and token is transferred. Returns FaucetReceipt if the request is successful, which contains the list of tokens transferred, and the transaction digest.

Note that the faucet is heavily rate-limited, so calling repeatedly the faucet would likely result in a 429 code or 502 code.

pub async fn request_status( &self, id: String, ) -> Result<Option<BatchSendStatus>, Error>

Check the faucet request status.

Possible statuses are defined in: BatchSendStatusType