Class FaucetApi

constructor

• new FaucetApi(api: AftermathApi): FaucetApi

  Creates a faucet API helper from an Aftermath provider.

  Parameters

  • api: AftermathApi

    Provider that supplies faucet addresses, event queries, and coin helpers.

  Returns FaucetApi

  Throws

  Error when the provider does not include the required faucet addresses.

Readonlyaddresses

ReadonlyeventTypes

buildRequestCoinTx

• buildRequestCoinTx(inputs: ApiFaucetRequestBody): Transaction

  Builds a transaction that mints and transfers one faucet coin.

  The returned transaction sets walletAddress as sender and recipient.

  Parameters

  • inputs: ApiFaucetRequestBody

    Coin type to mint and wallet that receives it.

  Returns Transaction

  A new transaction containing the mint and transfer commands.

fetchAddCoinEvents

• fetchAddCoinEvents(
      inputs: EventsInputs,
  ): Promise<EventsWithCursor<FaucetAddCoinEvent>>

  Fetches faucet coin-registration events with cursor pagination.

  Parameters

  • inputs: EventsInputs

    Optional event cursor and page limit.

  Returns Promise<EventsWithCursor<FaucetAddCoinEvent>>

  The cast registration events and the next pagination cursor.

fetchBuildMintSuiFrenTx

• fetchBuildMintSuiFrenTx(inputs: ApiFaucetMintSuiFrenBody): Promise<Transaction>

  Fetches a SUI payment coin and builds a SuiFren mint transaction.

  The payment amount is taken from mintFee, and the returned transaction sets walletAddress as its sender.

  Parameters

  • inputs: ApiFaucetMintSuiFrenBody

    Mint fee, SuiFren type, and wallet that signs the transaction.

  Returns Promise<Transaction>

  A promise for the transaction that pays the fee and mints the SuiFren.

fetchMintCoinEvents

• fetchMintCoinEvents(
      inputs: EventsInputs,
  ): Promise<EventsWithCursor<FaucetMintCoinEvent>>

  Fetches faucet coin-mint events with cursor pagination.

  Parameters

  • inputs: EventsInputs

    Optional event cursor and page limit.

  Returns Promise<EventsWithCursor<FaucetMintCoinEvent>>

  The cast mint events and the next pagination cursor.

fetchSupportedCoins

• fetchSupportedCoins(): Promise<string[]>

  Fetches the coin types registered with the faucet.

  The method reads AddedCoin events and returns each coin type with its 0x prefix.

  Returns Promise<string[]>

  The registered faucet coin types.

mintSuiFrenTx

• mintSuiFrenTx(
      inputs: {
          suiFrenType: string;
          suiPaymentCoinId: string | TransactionArgument;
          tx: Transaction;
      },
  ): TransactionResult

  Adds a mint_and_keep Move call for a SuiFren.

  The payment coin may be an object ID or an argument from the supplied transaction. The method mutates inputs.tx and leaves the minted result in the transaction for the caller to compose.

  Parameters

  • inputs: {
        suiFrenType: string;
        suiPaymentCoinId: string | TransactionArgument;
        tx: Transaction;
    }

    • suiFrenType: string

      SuiFren object type to mint.

    • suiPaymentCoinId: string | TransactionArgument

      SUI payment coin object ID or transaction argument.

    • tx: Transaction

      Transaction to mutate.

  Returns TransactionResult

  The result of the added Move call.

requestCoinTx

• requestCoinTx(inputs: { coinType: string; tx: Transaction }): TransactionResult

  Mints coinType's configured default amount and returns the resulting Coin<T>. Use buildRequestCoinTx to mint and transfer it to a wallet in one transaction.

  Parameters

  • inputs: { coinType: string; tx: Transaction }

    • coinType: string

      Coin type to mint.

    • tx: Transaction

      Transaction to mutate.

  Returns TransactionResult

  The transaction result containing the minted coin.