receiveTestnetAsset

suspend fun receiveTestnetAsset(chainId: String, params: FundParams): Result<FundResponse>

Requests testnet assets for a given chain ID.

This function calls the underlying API to request testnet assets (e.g., faucet funds) for a specific blockchain identified by its chain ID. It's typically used in development or testing environments to obtain tokens without using real assets.

Return

A Result object that encapsulates the outcome of the operation:

Parameters

chainId

The unique identifier of the blockchain for which testnet assets are requested. e.g., "ethereum-goerli", "polygon-mumbai".

params

The parameters required for the funding request, such as the target address and asset details. See FundParams for the specific structure of this parameter.

Throws

if the API request fails. The specific exception type will depend on the nature of the failure.