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
- 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 CLI
  - Command Reference
- AlgoKit Utils (Python)
  - API Reference
    
    Index
    
    accounts
    
    Index
    
    account_manager
    
    Index
    AccountInformation
    AccountManager
    EnsureFundedFromTestnetDispenserApiResult
    EnsureFundedResult
    
    kmd_account_manager
    
    Index
    KmdAccount
    KmdAccountManager
    
    algorand
    
    Index
    AlgorandClient
    
    applications
    
    Index
    
    abi
    
    Index
    ABIReturn
    BoxABIValue
    get_abi_decoded_value
    get_abi_encoded_value
    get_abi_struct_from_abi_tuple
    get_abi_tuple_from_abi_struct
    get_abi_tuple_type_from_abi_struct_definition
    get_arc56_value
    
    app_client
    
    Index
    AppClient
    AppClientBareCallCreateParams
    AppClientBareCallParams
    AppClientCompilationParams
    AppClientCompilationResult
    AppClientCreateSchema
    AppClientMethodCallCreateParams
    AppClientMethodCallParams
    AppClientParams
    BaseAppClientMethodCallParams
    CommonAppCallCreateParams
    CommonAppCallParams
    FundAppAccountParams
    get_constant_block_offset
    
    app_deployer
    
    Index
    AppDeployer
    AppDeploymentMetaData
    AppDeployParams
    AppDeployResult
    ApplicationLookup
    ApplicationMetaData
    ApplicationReference
    
    app_factory
    
    Index
    AppFactory
    AppFactoryCreateMethodCallParams
    AppFactoryCreateMethodCallResult
    AppFactoryCreateParams
    AppFactoryDeployResult
    AppFactoryParams
    SendAppCreateFactoryTransactionResult
    SendAppFactoryTransactionResult
    SendAppUpdateFactoryTransactionResult
    
    app_manager
    
    Index
    AppManager
    
    app_spec
    
    Index
    
    arc32
    
    Index
    Arc32Contract
    CallConfig
    DefaultArgumentDict
    MethodHints
    StructArgDict
    
    arc56
    
    Index
    Actions
    Arc56Contract
    BareActions
    Boxes
    ByteCode
    CallEnum
    Compiler
    CompilerInfo
    CompilerVersion
    CreateEnum
    DefaultValue
    Event
    EventArg
    Global
    Keys
    Local
    Maps
    Method
    MethodArg
    Network
    PcOffsetMethod
    ProgramSourceInfo
    Recommendations
    Returns
    Schema
    ScratchVariables
    Source
    SourceInfo
    SourceInfoModel
    State
    StorageKey
    StorageMap
    StructField
    TemplateVariables
    
    enums
    
    Index
    OnSchemaBreak
    OnUpdate
    OperationPerformed
    
    assets
    
    Index
    
    asset_manager
    
    Index
    AccountAssetInformation
    AssetInformation
    AssetManager
    BulkAssetOptInOutResult
    
    clients
    
    Index
    
    client_manager
    
    Index
    AlgoSdkClients
    ClientManager
    NetworkDetail
    
    dispenser_api_client
    
    Index
    DispenserApiConfig
    DispenserAsset
    DispenserAssetName
    DispenserFundResponse
    DispenserLimitResponse
    TestNetDispenserApiClient
    
    config
    
    Index
    AlgoKitLogger
    UpdatableConfig
    
    errors
    
    Index
    
    logic_error
    
    Index
    LogicError
    LogicErrorData
    parse_logic_error
    
    models
    
    Index
    
    account
    
    Index
    LogicSigAccount
    MultiSigAccount
    MultisigMetadata
    SigningAccount
    TransactionSignerAccount
    
    amount
    
    Index
    algo
    AlgoAmount
    micro_algo
    transaction_fees
    
    application
    
    Index
    AppCompilationResult
    AppInformation
    AppSourceMaps
    AppState
    CompiledTeal
    
    network
    
    Index
    AlgoClientConfigs
    AlgoClientNetworkConfig
    
    simulate
    
    Index
    SimulationTrace
    
    state
    
    Index
    BoxName
    BoxReference
    BoxValue
    DataTypeFlag
    
    transaction
    
    Index
    BaseArc2Note
    JsonFormatArc2Note
    SendParams
    StringFormatArc2Note
    TransactionWrapper
    
    protocols
    
    Index
    
    account
    
    Index
    TransactionSignerAccountProtocol
    
    typed_clients
    
    Index
    TypedAppClientProtocol
    TypedAppFactoryProtocol
    
    transactions
    
    Index
    
    transaction_composer
    
    Index
    AppCallMethodCallParams
    AppCallParams
    AppCreateMethodCallParams
    AppCreateParams
    AppCreateSchema
    AppDeleteMethodCallParams
    AppDeleteParams
    AppUpdateMethodCallParams
    AppUpdateParams
    AssetConfigParams
    AssetCreateParams
    AssetDestroyParams
    AssetFreezeParams
    AssetOptInParams
    AssetOptOutParams
    AssetTransferParams
    BuiltTransactions
    calculate_extra_program_pages
    OfflineKeyRegistrationParams
    OnlineKeyRegistrationParams
    PaymentParams
    populate_app_call_resources
    prepare_group_for_sending
    send_atomic_transaction_composer
    SendAtomicTransactionComposerResults
    TransactionComposer
    TransactionComposerBuildResult
    
    transaction_creator
    
    Index
    AlgorandClientTransactionCreator
    
    transaction_sender
    
    Index
    AlgorandClientTransactionSender
    SendAppCreateTransactionResult
    SendAppTransactionResult
    SendAppUpdateTransactionResult
    SendSingleAssetCreateTransactionResult
    SendSingleTransactionResult
- AlgoKit Utils (Typescript)
  - API Reference
    
    Overview
    
    classes
    
    TestLogger
    TransactionLogger
    AccountManager
    MultisigAccount
    SigningAccount
    AlgoHttpClientWithRetry
    AlgorandClientTransactionCreator
    AlgorandClientTransactionSender
    AlgorandClient
    AlgoAmount
    Arc56Method
    AppClient
    ApplicationClient
    AppDeployer
    AppFactory
    AppManager
    AssetManager
    AsyncEventEmitter
    ClientManager
    TransactionComposer
    UpdatableConfig
    TestNetDispenserApiClient
    KmdAccountManager
    LogicError
    
    enums
    
    OnSchemaBreak
    OnUpdate
    AccountStatus
    ApplicationOnComplete
    SignatureType
    EventType
    
    interfaces
    
    EnsureFundedResult
    AccountConfig
    TransactionSignerAccount
    Arc56Contract
    Event
    Method
    ProgramSourceInfo
    StorageKey
    StorageMap
    StructField
    AppClientCallABIArgs
    AppClientCallCoreParams
    AppClientCompilationParams
    AppClientCompilationResult
    AppClientDeployCallInterfaceParams
    AppClientDeployCoreParams
    AppClientDeployParams
    AppClientParams
    AppSourceMaps
    FundAppAccountParams
    ResolveAppById
    ResolveAppByIdBase
    SourceMapExport
    AppLookup
    AppMetadata
    AppFactoryParams
    AppInformation
    BoxReference
    BoxValueRequestParams
    BoxValuesRequestParams
    AppSources
    AppSpec
    CallConfig
    DeclaredSchemaValueSpec
    Hint
    ReservedSchemaValueSpec
    Schema
    SchemaSpec
    StateSchemaSpec
    Struct
    AppCallParams
    AppCallTransactionResultOfType\<T\>
    AppCompilationResult
    AppDeploymentParams
    AppDeployMetadata
    AppLookup
    AppMetadata
    AppReference
    AppState
    AppStorageSchema
    BoxName
    BoxReference
    BoxValueRequestParams
    BoxValuesRequestParams
    CompiledTeal
    CoreAppCallArgs
    CreateAppParams
    RawAppCallArgs
    TealTemplateParams
    UpdateAppParams
    AssetInformation
    BulkAssetOptInOutResult
    AssetBulkOptInOutParams
    AssetOptInParams
    AssetOptOutParams
    CreateAssetParams
    AlgoSdkClients
    TypedAppClient\<TClient\>
    TypedAppFactory\<TClient\>
    BuiltTransactions
    Config
    AVMTracesEventData
    TealSourceDebugEventData
    TealSourcesDebugEventData
    DispenserFundResponse
    DispenserLimitResponse
    TestNetDispenserApiClientParams
    LookupAssetHoldingsOptions
    LogicErrorDetails
    AlgoClientConfig
    AlgoConfig
    NetworkDetails
    AlgoKitLogCaptureFixture
    AlgorandFixture
    AlgorandFixtureConfig
    AlgorandTestAutomationContext
    GetTestAccountParams
    LogSnapshotConfig
    AdditionalAtomicTransactionComposerContext
    AtomicTransactionComposerToSend
    ConfirmedTransactionResult
    ConfirmedTransactionResults
    SendAtomicTransactionComposerResults
    SendParams
    SendTransactionParams
    SendTransactionResult
    SendTransactionResults
    TransactionGroupToSend
    TransactionToSign
    AlgoRekeyParams
    AlgoTransferParams
    EnsureFundedParams
    EnsureFundedReturnType
    TransferAssetParams
    
    modules
    
    index
    Namespace: indexer
    testing
    types/account
    types/account-manager
    types/account-manager.spec
    types/algo-http-client-with-retry
    types/algorand-client
    types/algorand-client.asset.spec
    types/algorand-client.spec
    types/algorand-client-transaction-creator
    types/algorand-client-transaction-sender
    types/algorand-client.transfer.spec
    types/amount
    types/amount.spec
    types/app
    types/app-arc56
    types/app-client
    types/app-client.spec
    types/app-deployer
    types/app-factory
    types/app-factory-and-client.spec
    types/app-manager
    types/app-spec
    types/asset
    types/asset-manager
    types/async-event-emitter
    types/async-event-emitter.spec
    types/client-manager
    types/client-manager.spec
    types/composer
    types/composer.spec
    types/config
    types/debugging
    types/dispenser-client
    types/dispenser-client.spec
    types/expand
    types/indexer
    types/instance-of
    types/kmd-account-manager
    types/lifecycle-events
    types/logging
    types/logic-error
    types/network-client
    types/testing
    types/transaction
    types/transfer
- Algorand TEAL
  - AVM Opcodes
- SDK
  - Algorand SDK List
- REST API
- ARC Standards
Additional Resources
- Overview

GitHub Discord X YouTube

On this page

Overview
Classes

On this page

Overview
Classes

protocols.typed_clients

Classes

`TypedAppClientProtocol`	Base class for protocol classes.
`TypedAppFactoryProtocol`	Base class for protocol classes.

Previous
TransactionSignerAccountProtocol Next
TypedAppClientProtocol