Function: faucet()

function faucet<ThrowOnError>(options: OmitKeys<RequestOptions<ThrowOnError>, "body" | "url"> & FaucetData & Pick<RequestOptions<ThrowOnError>, "headers">): RequestResult<FaucetResponse, ErrorResponse, ThrowOnError>

Defined in: packages/api/src/client/sdk.gen.ts:48

Request Funds from Faucet
Requests funds from the faucet for testing purposes.

Type Parameters

ThrowOnError extends boolean = false

Parameters

options

OmitKeys<RequestOptions<ThrowOnError>, "body" | "url"> & FaucetData & Pick<RequestOptions<ThrowOnError>, "headers">

Returns

RequestResult<FaucetResponse, ErrorResponse, ThrowOnError>