Class Faucet

constructor

• new Faucet(config: AptosConfig): Faucet

  Initializes a new instance of the Aptos client with the specified configuration.

  Note that only devnet has a publicly accessible faucet. For testnet, you must use the minting page at https://aptos.dev/network/faucet.

  Parameters

  • config: AptosConfig

    The configuration settings for the Aptos client.

  Returns Faucet

  Example

  import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
  
  async function runExample() {
      // Create a configuration for the Aptos client
      const config = new AptosConfig({ network: Network.DEVNET }); // specify your own network if needed
  
      // Initialize the Aptos client with the configuration
      const aptos = new Aptos(config);
  
      console.log("Aptos client initialized:", aptos);
  }
  runExample().catch(console.error);
  Copy

fundAccount

• fundAccount(
      args: {
          accountAddress: AccountAddressInput;
          amount: number;
          options?: WaitForTransactionOptions;
      },
  ): Promise<UserTransactionResponse>

  This function creates an account if it does not exist and mints the specified amount of coins into that account.

  Note that only devnet has a publicly accessible faucet. For testnet, you must use the minting page at https://aptos.dev/network/faucet.

  Parameters

  • args: {
        accountAddress: AccountAddressInput;
        amount: number;
        options?: WaitForTransactionOptions;
    }

    The arguments for funding the account.

    • accountAddress: AccountAddressInput

      The address of the account to fund.

    • amount: number

      The amount of tokens to fund the account with.

    • Optionaloptions?: WaitForTransactionOptions

      Configuration options for waiting for the transaction.

  Returns Promise<UserTransactionResponse>

  Transaction hash of the transaction that funded the account.

  Example

  import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
  
  const config = new AptosConfig({ network: Network.DEVNET });
  const aptos = new Aptos(config);
  
  async function runExample() {
    // Fund an account with a specified amount of tokens
    const transaction = await aptos.fundAccount({
      accountAddress: "0x1", // replace with your account address
      amount: 100,
    });
  
    console.log("Transaction hash:", transaction.hash);
  }
  runExample().catch(console.error);
  Copy

Readonlyconfig