Class Faucet

Provides the high-level faucet API for supported coins and faucet transactions.

Hierarchy (View Summary)

Caller
- Faucet

Index

Constructors

Properties

Methods

getMintSuiFrenTransaction getRequestCoinTransaction getSupportedCoins apiBaseUrlForNetwork defaultFullnodeUrl

Constructors

constructor

new Faucet(config?: CallerConfig, api?: AftermathApi): Faucet
Creates a faucet facade.
Parameters
- Optionalconfig: CallerConfig
  Optional caller configuration, such as the network and access token.
- Optionalapi: AftermathApi
  Optional provider used to build faucet transactions.
Returns Faucet
Overrides Caller.constructor
- Defined in packages/faucet/faucet.ts:25

Properties

`Optional` `Readonly`api

api?: AftermathApi

Optional provider used to build faucet transactions.

config

config: CallerConfig

The mutable configuration used for subsequent requests.

Methods

getMintSuiFrenTransaction

getMintSuiFrenTransaction(
inputs: ApiFaucetMintSuiFrenBody,
): Promise<Transaction>
Fetches the SUI payment coin and builds a transaction that mints a SuiFren.
Parameters
- inputs: ApiFaucetMintSuiFrenBody
  Mint fee, SuiFren type, and wallet that signs the transaction.
Returns Promise<Transaction>
A promise for a transaction ready for the wallet to sign and execute.

Throws
Error when this facade was created without an AftermathApi instance.
- Defined in packages/faucet/faucet.ts:67

getRequestCoinTransaction

getRequestCoinTransaction(inputs: ApiFaucetRequestBody): Transaction
Builds a transaction that mints and transfers one faucet coin.
Parameters
- inputs: ApiFaucetRequestBody
  Coin type to mint and wallet that receives it.
Returns Transaction
A transaction ready for the wallet to sign and execute.

Throws
Error when this facade was created without an AftermathApi instance.
- Defined in packages/faucet/faucet.ts:56

getSupportedCoins

getSupportedCoins(): Promise<string[]>
Fetches the coin types currently supported by the faucet.

Returns Promise<string[]>
A promise for the supported coin type strings.
- Defined in packages/faucet/faucet.ts:41

`Static`apiBaseUrlForNetwork

apiBaseUrlForNetwork(network: SuiNetwork): string
Returns the canonical Aftermath API host for a Sui network.

To target a custom or local host, pass baseUrl in CallerConfig to the constructor instead.
Parameters
- network: SuiNetwork
  The Sui network whose host to return.
Returns string
The network's HTTPS or local HTTP API host.
Inherited from Caller.apiBaseUrlForNetwork
- Defined in general/utils/caller.ts:151

`Static`defaultFullnodeUrl

defaultFullnodeUrl(network: SuiNetwork | undefined): string
Returns the canonical Sui fullnode URL for a network.
Parameters
- network: SuiNetwork | undefined
  The network whose fullnode URL to return. undefined defaults to mainnet.
Returns string
The network's fullnode URL.
Inherited from Caller.defaultFullnodeUrl
- Defined in general/utils/caller.ts:162