@coinbase/cdp-sdk
Version:
SDK for interacting with the Coinbase Developer Platform Wallet API
34 lines • 1.1 kB
TypeScript
import { type CdpOpenApiClientType } from "../../openapi-client/index.js";
import { Hex } from "../../types/misc.js";
/**
* Options for requesting funds from an EVM faucet.
*/
export interface RequestFaucetOptions {
/** The address of the account. */
address: string;
/** The network to request funds from. */
network: "base-sepolia" | "ethereum-sepolia";
/** The token to request funds for. */
token: "eth" | "usdc" | "eurc" | "cbbtc";
/** The idempotency key. */
idempotencyKey?: string;
}
/**
* The result of requesting funds from an EVM faucet.
*/
export interface RequestFaucetResult {
/** The transaction hash. */
transactionHash: Hex;
}
/**
* Requests funds from an EVM faucet.
*
* @param apiClient - The API client.
* @param options - The options for requesting funds from the EVM faucet.
*
* @returns A promise that resolves to the transaction hash.
*/
export declare function requestFaucet(apiClient: CdpOpenApiClientType, options: RequestFaucetOptions): Promise<{
transactionHash: Hex;
}>;
//# sourceMappingURL=requestFaucet.d.ts.map