Interface: FaucetClientLike
Methods
request()
request(address, asyncOpts_?): Promise<string | undefined>;
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.
Parameters
address
asyncOpts_?
signal
AbortSignal
Returns
Promise<string | undefined>
requestAndWait()
requestAndWait(address, asyncOpts_?): Promise<FaucetReceipt | undefined>;
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.
If you intend to use the transferred tokens with the graphql client,
consider using request_and_wait_for_finalized instead to ensure
the tokens are available in the indexer.
Parameters
address
asyncOpts_?
signal
AbortSignal
Returns
Promise<FaucetReceipt | undefined>
requestAndWaitForFinalized()
requestAndWaitForFinalized(
address,
client,
asyncOpts_?
): Promise<FaucetReceipt | undefined>;
Request gas from the faucet and wait until the request is completed and
token is transferred and finalized on the ledger. Returns
FaucetReceipt if the request is successful, which contains the
list of tokens transferred, and the transaction digest.
This is a convenience method that combines request_and_wait and
waiting for the funding transactions to be finalized using the provided
GraphQL Client.
Parameters
address
client
asyncOpts_?
signal
AbortSignal
Returns
Promise<FaucetReceipt | undefined>
requestStatus()
requestStatus(id, asyncOpts_?): Promise<BatchSendStatus | undefined>;
Check the faucet request status.
Possible statuses are defined in: BatchSendStatusType
Parameters
id
string
asyncOpts_?
signal
AbortSignal
Returns
Promise<BatchSendStatus | undefined>