Skip to content

Algorand Developer Portal

GitHub Discord X YouTube

Getting Started
Concepts
- Accounts
- Transactions
- Assets
  - Overview
  - Asset Operations
- Smart Contracts
- Consensus Protocol
Build With AlgoKit
- Intro to AlgoKit
- CLI Tools
  - Overview
  - Compile
  - Completions
  - Config
  - TestNet Dispenser
  - Doctor
  - Explore
  - Generate
  - Goal
  - Init
  - Localnet
  - Project
    
    Overview
    Bootstrap
    Deploy
    Link
    List
    Run
  - Tasks
    
    Overview
    Analyze
    IPFS
    Mint
    NFD Lookup
    Asset opt-(in|out)
    Send
    Sign
    Transfer
    Vanity Address
    Wallet
- LORA the Explorer
  - Overview
- Project Templates
- AlgoKit Utils
- Smart Contract Languages
  - Algorand TypeScript
    
    Overview
    Program Structure
    Basic Types
    Storage
    Ops
    Guiding Principles
  - Algorand Python
    
    Overview
    Program Structure
    Types
    Control Flow Structures
    Module Level Constructs
    Overview
    Python Built-Ins
    Error Handling and Assertions
    Data Structures
    Storing Data On-Chain
    Logging
    Transactions
    AVM Operations
    Opcode Budgets
    ARC-4: Application Binary Interface
    ARC-28: Structured Event Logging
    Calling Other Applicaitons
    Compiling to AVM bytecode
    Unsupported Python Features
- Unit Testing
  - TypeScript Unit Testing
    
    Overview
    Concepts
    AVM Types
    ARC4 Types
    Transactions
    Smart Contract Testing
    Smart Signature Testing
    State Management
    AVM Opcodes
  - Python Unit Testing
    
    Overview
    Concepts
    AVM Types
    ARC4 Types
    Transactions
    Smart Contract Testing
    Smart Signature Testing
    State Management
    Subroutines
    AVM Opcodes
- AVM Debugger
  - Overview
- Subscriber
  - Subscriber TypeScript
    
    Overview
    Subsciber
    Subscriptions
  - Subscriber Python
    
    Overview
    Subsciber
    Subscriptions
- Client Generators
  - Typescript
  - Python
Running A Node
- Overview
- NodeKit Overview
- NodeKit Quick Start
- Node Types
- Direct Installation
- Node Management
- Node Reference
- NodeKit Reference
Reference
- AlgoKit CLI
  - Algokit CLI Reference
- Algorand Python
  - API Reference
    
    algopy.arc4
    algopy.gtxn
    algopy.itxn
    algopy.op
    algopy
  - Overview
- Algorand Typescript
  - API Reference
    
    arc4
    
    -internal-
    
    classes
    
    Arc4ArrayBase
    StructBase
    
    interfaces
    
    classMethodDecoratorContext
    IterableIterator
    
    type-aliases
    
    BigUintBitSize
    CompatForArc4Int
    ContractMethod
    NativeForArc4Int
    Readonly
    StructConstructor
    UintBitSize
    
    classes
    
    Address
    ARC4Encoded
    Bool
    Byte
    Contract
    DynamicArray
    DynamicBytes
    StaticArray
    StaticBytes
    Str
    Tuple
    UFixedNxM
    UintN
    UintN8
    UintN16
    UintN32
    UintN64
    UintN128
    UintN256
    
    enumerations
    
    OnCompleteAction
    
    functions
    
    abimethod
    baremethod
    decodeArc4
    encodeArc4
    interpretAsArc4
    methodSelector
    
    type-aliases
    
    AbiMethodConfig
    BareMethodConfig
    BitSize
    CreateOptions
    DefaultArgument
    OnCompleteActionStr
    
    variables
    
    Struct
    
    index
    
    -internal-
    
    interfaces
    
    ApplicationTxn
    ArrayIterator
    AssetConfigTxn
    AssetFreezeTxn
    AssetTransferTxn
    ClassDecoratorContext
    ConcatArray
    CreateBoxMapOptions
    CreateBoxOptions
    CreateBoxRefOptions
    Iterable
    IteratorReturnResult
    IteratorYieldResult
    KeyRegistrationTxn
    PaymentTxn
    TemplateStringsArray
    TransactionBase
    
    type-aliases
    
    AccountInput
    ApplicationInput
    AssetInput
    BuiltinIteratorReturn
    ComparisonFor
    ConstructorFor
    ContractOptions
    DecoratorMetadataObject
    DeliberateAny
    FlatArray
    IteratorResult
    LogicSigOptions
    MatchTest
    NumberRange
    NumericComparison
    Partial
    PropertyKey
    Record
    StateTotals
    
    classes
    
    BaseContract
    LogicSig
    MutableArray
    
    enumerations
    
    OpUpFeeSource
    TransactionType
    
    functions
    
    Account
    Application
    assert
    assertMatch
    Asset
    BigUint
    Box
    BoxMap
    BoxRef
    Bytes
    compile
    contract
    emit
    ensureBudget
    err
    GlobalState
    log
    logicsig
    match
    TemplateVar
    Uint64
    urange
    
    interfaces
    
    BytesBacked
    
    namespaces
    
    gtxn
    
    functions
    
    ApplicationTxn
    AssetConfigTxn
    AssetFreezeTxn
    AssetTransferTxn
    KeyRegistrationTxn
    PaymentTxn
    Transaction
    
    interfaces
    
    ApplicationTxn
    AssetConfigTxn
    AssetFreezeTxn
    AssetTransferTxn
    KeyRegistrationTxn
    PaymentTxn
    
    type-aliases
    
    Transaction
    
    itxn
    
    functions
    
    ApplicationCall
    AssetConfig
    AssetFreeze
    AssetTransfer
    KeyRegistration
    Payment
    SubmitGroup
    
    interfaces
    
    ApplicationCallFields
    ApplicationCallItxnParams
    ApplicationInnerTxn
    AssetConfigFields
    AssetConfigItxnParams
    AssetConfigInnerTxn
    AssetFreezeField
    AssetFreezeInnerTxn
    AssetFreezeItxnParams
    AssetTransferFields
    AssetTransferInnerTxn
    AssetTransferItxnParams
    CommonTransactionFields
    KeyRegistrationFields
    KeyRegistrationInnerTxn
    KeyRegistrationItxnParams
    PaymentFields
    PaymentInnerTxn
    PaymentItxnParams
    
    type-aliases
    
    InnerTransaction
    InnerTxnList
    TxnFor
    
    type-aliases
    
    Account
    Application
    Asset
    biguint
    BigUintCompat
    Box
    BoxMap
    BoxRef
    bytes
    bytesCompat
    CompileContractOptions
    CompiledContract
    CompiledLogicSig
    CompileLogicSigOptions
    GlobalState
    GlobalStateOptions
    LocalState
    LocalStateForAccount
    LocalStateOptions
    StringCompat
    uint64
    Uint64Compat
    
    op
    
    enumerations
    
    Base64
    Ec
    Ecdsa
    MimcConfigurations
    VrfVerify
    
    functions
    
    addw
    appOptedIn
    arg
    balance
    base64Decode
    bitLength
    bsqrt
    btoi
    bzero
    concat
    divmodw
    divw
    ecdsaPkDecompress
    ecdsaPkRecover
    ecdsaVerify
    ed25519verify
    ed25519verifyBare
    exp
    expw
    extract
    extractUint16
    extractUint32
    extractUint64
    falconVerify
    gaid
    getBit
    getByte
    gloadBytes
    itob
    keccak256
    len
    mimc
    minBalance
    mulw
    onlineStake
    replace
    select
    setBit
    setByte
    sha3_256
    sha256
    sha512_256
    shl
    shr
    sqrt
    substring
    sumhash512
    vrfVerify
    
    variables
    
    AcctParams
    AppGlobal
    AppLocal
    AppParams
    AssetHolding
    AssetParams
    Block
    Box
    EllipticCurve
    GITxn
    Global
    GTxn
    ITxn
    ITxnCreate
    JsonRef
    Scratch
    Txn
    VoterParams
  - Overview
- AlgoKit Utils (Python)
  - API Reference
    
    algokit_utils._debugging
    algokit_utils._ensure_funded
    algokit_utils._transfer
    algokit_utils.account
    algokit_utils._debugging
    algokit_utils.application_client
    algokit_utils.application_specification
    algokit_utils.asset
    algokit_utils.common
    algokit_utils.config
    algokit_utils.deploy
    algokit_utils.dispenser_api
    algokit_utils.logic_error
    algokit_utils.models
    algokit_utils.network_clients
    algokit_utils
  - Overview
- AlgoKit Utils (Typescript)
  - API Reference
    
    classes
    
    AlgorandClient
    
    enumerations
    
    EventType
    
    functions
    
    algo
    algos
    assetBulkOptIn
    assetBulkOptOut
    assetOptIn
    assetOptOut
    callApp
    capTransactionFee
    compileTeal
    controlFees
    createApp
    createAsset
    decodeAppState
    deployApp
    encodeLease
    ensureFunded
    getABIMethodSignature
    getABIReturn
    getAccount
    getAccountAddressAsString
    getAccountAddressAsUint8Array
    getAccountAssetInformation
    getAlgodConfigFromEnvironment
    getAlgoIndexerClient
    getAlgoNodeConfig
    getAppArgsForABICall
    getAppArgsForTransaction
    getAppBoxNames
    getAppBoxValue
    getAppBoxValueFromABIType
    getAppBoxValues
    getAppBoxValuesFromABIType
    getAppById
    getAppClient
    getAppClientByCreatorAndName
    getAppClientById
    getAppDeploymentTransactionNote
    getAppGlobalState
    getAppLocalState
    getAppOnCompleteAction
    getAtomicTransactionComposerTransactions
    getBoxReference
    getConfigFromEnvOrDefaults
    getCreatorAppsByName
    getDefaultLocalNetConfig
    getDispenserAccount
    getIndexerConfigFromEnvironment
    getKmdWalletAccount
    getLocalNetDispenserAccount
    getOrCreateKmdWalletAccount
    getSenderAddress
    getSenderTransactionSigner
    getTestNetDispenserApiClient
    getTransactionParams
    getTransactionWithSigner
    isLocalNet
    isMainNet
    isSchemaIsBroken
    isTestNet
    microAlgo
    microAlgos
    mnemonicAccount
    mnemonicAccountFromEnvironment
    multisigAccount
    performAtomicTransactionComposerSimulate
    performTemplateSubstitution
    performTemplateSubstitutionAndCompile
    persistSourceMaps
    populateAppCallResources
    randomAccount
    relayAccount
    rekeyedAccount
    replaceDeployTimeControlParams
    sendAtomicTransactionComposer
    sendGroupOfTransactions
    sendTransaction
    signTransaction
    stripTealComments
    transactionFees
    transactionSignerAccount
    transferAlgos
    transferAsset
    updateApp
    waitForConfirmation
    
    interfaces
    
    AVMTracesEventData
    TealSourceDebugEventData
    TealSourcesDebugEventData
    
    namespaces
    
    indexer
    
    functions
    
    executePaginatedRequest
    lookupAccountByAddress
    lookupAccountCreatedApplicationByAddress
    lookupAssetHoldings
    lookupTransactionById
    searchTransactions
    
    type-aliases
    
    SearchForTransactions
    
    type-aliases
    
    AccountInformation
    EventDataMap
    NumberConverter
    
    variables
    
    ALGOKIT_DIR
    ALGORAND_MIN_TX_FEE
    Config
    DEFAULT_MAX_SEARCH_DEPTH
    MAX_APP_CALL_ACCOUNT_REFERENCES
    MAX_APP_CALL_FOREIGN_REFERENCES
    MAX_TRANSACTION_GROUP_SIZE
    SOURCES_DIR
    TEAL_FILE_EXT
    TEAL_SOURCEMAP_EXT
  - Overview
- Algorand Teal
  - Opcodes List
- SDK
  - Algorand SDK List
- REST API
- ARC Standards
Additional Resources
- Overview

GitHub Discord X YouTube

On this page

Overview

On this page

Overview

AlgoKit Utils (Python)

Previous
algokit_utils Next
AlgorandClient