clients.dispenser_api_client

Attributes

Classes

Module Contents

class algokit_utils.clients.dispenser_api_client.DispenserApiConfig

BASE*URL = ‘ https://api.dispenser.algorandfoundation.tools’_

class algokit_utils.clients.dispenser_api_client.DispenserAssetName

Bases: enum.IntEnum

Enum where members are also (and must be) ints

ALGO = 0_

class algokit_utils.clients.dispenser_api_client.DispenserAsset

asset*id : int_

The ID of the asset

decimals : int_

The amount of decimal places the asset was created with

description : str_

The description of the asset

class algokit_utils.clients.dispenser_api_client.DispenserFundResponse

tx*id : str_

The transaction ID of the funded transaction

amount : int_

The amount of Algos funded

class algokit_utils.clients.dispenser_api_client.DispenserLimitResponse

amount : int_

The amount of Algos that can be funded

algokit_utils.clients.dispenser_api_client.DISPENSER_ASSETS

algokit*utils.clients.dispenser_api_client.DISPENSER_REQUEST_TIMEOUT = 15_

algokit_utils.clients.dispenser_api_client.DISPENSER_ACCESS_TOKEN_KEY = ‘ALGOKITDISPENSER_ACCESS_TOKEN’_

class algokit_utils.clients.dispenser_api_client.TestNetDispenserApiClient(auth_token: str | None = None, request_timeout: int = DISPENSER_REQUEST_TIMEOUT)

Client for interacting with the AlgoKit TestNet Dispenser API.

To get started create a new access token via algokit dispenser login –ci and pass it to the client constructor as auth_token. Alternatively set the access token as an environment variable ALGOKIT_DISPENSER_ACCESS_TOKEN, and it will be auto-loaded. If both are set, the constructor argument takes precedence.

Default request timeout is 15 seconds. Modify by passing request_timeout to the constructor.

auth*token : str_

request*timeout = 15_

fund(address: str, amount: int) → DispenserFundResponse

fund(address: str, amount: int, asset_id: int | None = None) → DispenserFundResponse

Fund an account with Algos from the dispenser API

• Parameters:
  • address – The address to fund
  • amount – The amount of Algos to fund
  • asset_id – The asset ID to fund (deprecated)
• Returns: The transaction ID of the funded transaction
• Raises: Exception – If the dispenser API request fails
• Example:

dispenser_client = TestNetDispenserApiClient()

disper_client.fund(address="SENDER_ADDRESS", amount=1000000)

refund(refund_txn_id: str) → None

Register a refund for a transaction with the dispenser API

get_limit(address: str) → DispenserLimitResponse

Get current limit for an account with Algos from the dispenser API