Skip to content
AlgoKit Utils TypeScript

ensureFunded

ensureFunded<T>(funding, algod, kmd?): Promise<EnsureFundedReturnType | undefined>

Defined in: algokit-utils-ts/src/transfer/transfer.ts:26

Type Parameters

Section titled “Type Parameters”

T

Section titled “T”

T extends EnsureFundedParams

Parameters

Section titled “Parameters”

funding

Section titled “funding”

T

The funding configuration of type EnsureFundedParams, including the account to fund, minimum spending balance, and optional parameters. If you set useDispenserApi to true, you must also set ALGOKIT_DISPENSER_ACCESS_TOKEN in your environment variables.

algod

Section titled “algod”

AlgodClient

An instance of the Algodv2 client.

kmd?

Section titled “kmd?”

KmdClient

An optional instance of the Kmd client.

Returns

Section titled “Returns”

Promise<EnsureFundedReturnType | undefined>

  • EnsureFundedReturnType if funds were transferred.
  • undefined if no funds were needed.