@aptos-labs/ts-sdk/dist/internal/faucet.js

Aptos TypeScript SDK

// Copyright © Aptos Foundation
// SPDX-License-Identifier: Apache-2.0
import { postAptosFaucet } from "../client/index.js";
import { AccountAddress } from "../core/index.js";
import { TransactionResponseType } from "../types/index.js";
import { DEFAULT_TXN_TIMEOUT_SEC } from "../utils/const.js";
import { waitForTransaction } from "./transaction.js";
/**
 * Funds an account with a specified amount of tokens from the Aptos faucet.
 * This function is useful for quickly providing a new or existing account with tokens to facilitate transactions.
 *
 * Note that only devnet has a publicly accessible faucet. For testnet, you must use
 * the minting page at https://aptos.dev/network/faucet.
 *
 * @param args - The arguments for funding the account.
 * @param args.aptosConfig - The configuration settings for connecting to the Aptos network.
 * @param args.accountAddress - The address of the account to be funded.
 * @param args.amount - The amount of tokens to fund the account with.
 * @param args.options - Optional parameters for the transaction.
 * @param args.options.timeoutSecs - The maximum time to wait for the transaction to complete, in seconds.
 * @param args.options.checkSuccess - A flag indicating whether to check if the transaction was successful.
 *
 * @throws Error if the transaction does not return a user transaction type.
 * @group Implementation
 */
export async function fundAccount(args) {
    const { aptosConfig, accountAddress, amount, options } = args;
    const timeout = options?.timeoutSecs || DEFAULT_TXN_TIMEOUT_SEC;
    const { data } = await postAptosFaucet({
        aptosConfig,
        path: "fund",
        body: {
            address: AccountAddress.from(accountAddress).toString(),
            amount,
        },
        originMethod: "fundAccount",
    });
    const txnHash = data.txn_hashes[0];
    const res = await waitForTransaction({
        aptosConfig,
        transactionHash: txnHash,
        options: {
            timeoutSecs: timeout,
            checkSuccess: options?.checkSuccess,
        },
    });
    // Response is always User transaction for a user submitted transaction
    if (res.type === TransactionResponseType.User) {
        return res;
    }
    throw new Error(`Unexpected transaction received for fund account: ${res.type}`);
}
//# sourceMappingURL=faucet.js.map