Type Alias Actions

type Actions = {
    listTokenBalances: (
        options: Omit<ListTokenBalancesOptions, "address">,
    ) => Promise<ListTokenBalancesResult>;
    requestFaucet: (
        options: Omit<RequestFaucetOptions, "address">,
    ) => Promise<RequestFaucetResult>;
}

Index

Properties

listTokenBalances requestFaucet

Properties

listTokenBalances

listTokenBalances: (
options: Omit<ListTokenBalancesOptions, "address">,
) => Promise<ListTokenBalancesResult>

List the token balances of an account.

Type declaration

- (
  options: Omit<ListTokenBalancesOptions, "address">,
  ): Promise<ListTokenBalancesResult>
- Parameters
  - options: Omit<ListTokenBalancesOptions, "address">
    The options for the list token balances.
    - network
      The network to list the token balances on.
  Returns Promise<ListTokenBalancesResult>
  The result of the list token balances.

Example

const balances = await account.listTokenBalances({
  network: "base-sepolia",
});

requestFaucet

requestFaucet: (
options: Omit<RequestFaucetOptions, "address">,
) => Promise<RequestFaucetResult>

Requests funds from an EVM faucet.

Type declaration

- (options: Omit<RequestFaucetOptions, "address">): Promise<RequestFaucetResult>
- Parameters
  - options: Omit<RequestFaucetOptions, "address">
    Parameters for requesting funds from the EVM faucet.
    - network
      The network to request funds from.
    - token
      The token to request funds for.
    - idempotencyKey
      An idempotency key.
  Returns Promise<RequestFaucetResult>
  A promise that resolves to the transaction hash.

Example

const result = await account.requestFaucet({
  network: "base-sepolia",
  token: "eth",
});

Type Alias Actions

Index

Properties

Properties

listTokenBalances

Type declaration

Parameters

network

Returns Promise<ListTokenBalancesResult>

Example

requestFaucet

Type declaration

Parameters

network

token

idempotencyKey

Returns Promise<RequestFaucetResult>

Example

Settings

On This Page