Skip to content

AlgoKit Utils TypeScript

Select theme

Home
Capabilities
Migration Guides
- v7 migration
- v8 migration
API Reference
- index
- testing
  - testing
  - classes
    TestLogger
    TransactionLogger
  - functions
    algorandFixture
    getTestAccount
    runWhenIndexerCaughtUp
  - variables
    algoKitLogCaptureFixture
- types
  - account
    types/account
    classes
    MultisigAccount
    SigningAccount
    interfaces
    AccountConfig
    TransactionSignerAccount
    type-aliases
    AccountAssetInformation
    AccountInformation
    variables
    DISPENSER_ACCOUNT
  - account-manager
    types/account-manager
    classes
    AccountManager
    interfaces
    EnsureFundedResult
    variables
    getAccountTransactionSigner
  - algo-http-client-with-retry
    types/algo-http-client-with-retry
    classes
    AlgoHttpClientWithRetry
  - algorand-client
    types/algorand-client
    classes
    AlgorandClient
  - algorand-client-transaction-creator
    types/algorand-client-transaction-creator
    classes
    AlgorandClientTransactionCreator
  - algorand-client-transaction-sender
    types/algorand-client-transaction-sender
    classes
    AlgorandClientTransactionSender
  - amount
    types/amount
    classes
    AlgoAmount
  - app
    types/app
    enumerations
    OnSchemaBreak
    OnUpdate
    interfaces
    AppCallParams
    AppCallTransactionResultOfType
    AppCompilationResult
    AppDeploymentParams
    AppDeployMetadata
    AppLookup
    AppMetadata
    AppReference
    AppState
    AppStorageSchema
    BoxName
    BoxReference
    BoxValueRequestParams
    BoxValuesRequestParams
    CompiledTeal
    CoreAppCallArgs
    CreateAppParams
    RawAppCallArgs
    TealTemplateParams
    UpdateAppParams
    type-aliases
    ABIAppCallArg
    ABIAppCallArgs
    ABIReturn
    AppCallArgs
    AppCallTransactionResult
    AppCallType
    AppReturn
    BoxIdentifier
    SendAppCreateTransactionResult
    SendAppTransactionResult
    SendAppUpdateTransactionResult
    variables
    ABI_RETURN_PREFIX
    APP_DEPLOY_NOTE_DAPP
    APP_PAGE_MAX_SIZE
    DELETABLE_TEMPLATE_NAME
    UPDATABLE_TEMPLATE_NAME
  - app-arc56
    types/app-arc56
    classes
    Arc56Method
    functions
    getABIDecodedValue
    getABIEncodedValue
    getABIStructFromABITuple
    getABITupleFromABIStruct
    getABITupleTypeFromABIStructDefinition
    getArc56Method
    getArc56ReturnValue
    interfaces
    Arc56Contract
    Event
    Method
    ProgramSourceInfo
    StorageKey
    StorageMap
    StructField
    type-aliases
    ABIStruct
    ABIType
    Arc56MethodArg
    Arc56MethodReturnType
    AVMBytes
    AVMString
    AVMType
    AVMUint64
    StructName
  - app-client
    types/app-client
    classes
    AppClient
    ApplicationClient
    interfaces
    AppClientCallABIArgs
    AppClientCallCoreParams
    AppClientCompilationParams
    AppClientCompilationResult
    AppClientDeployCallInterfaceParams
    AppClientDeployCoreParams
    AppClientDeployParams
    AppClientParams
    AppSourceMaps
    FundAppAccountParams
    ResolveAppById
    ResolveAppByIdBase
    SourceMapExport
    type-aliases
    AppClientBareCallParams
    AppClientCallArgs
    AppClientCallParams
    AppClientCallRawArgs
    AppClientClearStateParams
    AppClientCreateOnComplete
    AppClientCreateParams
    AppClientMethodCallParams
    AppClientUpdateParams
    AppDetails
    AppDetailsBase
    AppSpecAppDetails
    AppSpecAppDetailsBase
    AppSpecAppDetailsByCreatorAndName
    AppSpecAppDetailsById
    CallOnComplete
    CloneAppClientParams
    FundAppParams
    ResolveAppByCreatorAndName
    ResolveAppByCreatorAndNameBase
    ResolveAppClientByCreatorAndName
    ResolveAppClientByNetwork
  - app-deployer
    types/app-deployer
    classes
    AppDeployer
    interfaces
    AppLookup
    AppMetadata
    type-aliases
    AppDeployParams
    AppDeployResult
    DeployAppDeleteMethodCall
    DeployAppDeleteParams
    DeployAppUpdateMethodCall
    DeployAppUpdateParams
  - app-factory
    types/app-factory
    classes
    AppFactory
    interfaces
    AppFactoryParams
    type-aliases
    AppFactoryAppClientParams
    AppFactoryCreateMethodCallParams
    AppFactoryCreateParams
    AppFactoryDeployParams
    AppFactoryResolveAppClientByCreatorAndNameParams
    CreateOnComplete
    CreateSchema
  - app-manager
    types/app-manager
    classes
    AppManager
    interfaces
    AppInformation
    BoxReference
    BoxValueRequestParams
    BoxValuesRequestParams
    type-aliases
    BoxIdentifier
    HoldingReference
    LocalsReference
    ResourceReference
  - app-spec
    types/app-spec
    functions
    arc32ToArc56
    interfaces
    AppSources
    AppSpec
    CallConfig
    DeclaredSchemaValueSpec
    Hint
    ReservedSchemaValueSpec
    Schema
    SchemaSpec
    StateSchemaSpec
    Struct
    type-aliases
    ABIType
    AVMType
    CallConfigValue
    DefaultArgument
    FieldName
    HintSpec
    StateSchema
    StructElement
  - asset
    types/asset
    interfaces
    AssetBulkOptInOutParams
    AssetOptInParams
    AssetOptOutParams
    CreateAssetParams
  - asset-manager
    types/asset-manager
    classes
    AssetManager
    interfaces
    AssetInformation
    BulkAssetOptInOutResult
  - async-event-emitter
    types/async-event-emitter
    classes
    AsyncEventEmitter
    type-aliases
    AsyncEventListener
  - client-manager
    types/client-manager
    classes
    ClientManager
    interfaces
    AlgoSdkClients
    TypedAppClient
    TypedAppFactory
    type-aliases
    ClientAppClientByNetworkParams
    ClientAppClientParams
    ClientAppFactoryParams
    ClientResolveAppClientByCreatorAndNameParams
    ClientTypedAppClientByCreatorAndNameParams
    ClientTypedAppClientByNetworkParams
    ClientTypedAppClientParams
    ClientTypedAppFactoryParams
  - composer
    types/composer
    classes
    TransactionComposer
    interfaces
    BuiltTransactions
    type-aliases
    AppCallMethodCall
    AppCallParams
    AppCreateMethodCall
    AppCreateParams
    AppDeleteMethodCall
    AppDeleteParams
    AppMethodCall
    AppMethodCallParams
    AppMethodCallTransactionArgument
    AppUpdateMethodCall
    AppUpdateParams
    AssetConfigParams
    AssetCreateParams
    AssetDestroyParams
    AssetFreezeParams
    AssetOptInParams
    AssetOptOutParams
    AssetTransferParams
    CommonAppCallParams
    CommonTransactionParams
    ErrorTransformer
    OfflineKeyRegistrationParams
    OnlineKeyRegistrationParams
    PaymentParams
    RawSimulateOptions
    SimulateOptions
    SkipSignaturesSimulateOptions
    TransactionComposerParams
    Txn
    variables
    MAX_TRANSACTION_GROUP_SIZE
  - config
    types/config
    classes
    UpdatableConfig
    interfaces
    Config
  - debugging
    types/debugging
    interfaces
    AVMTracesEventData
    TealSourceDebugEventData
    TealSourcesDebugEventData
    variables
    ALGOKIT_DIR
    DEFAULT_MAX_SEARCH_DEPTH
    SOURCES_DIR
    TEAL_FILE_EXT
    TEAL_SOURCEMAP_EXT
  - dispenser-client
    types/dispenser-client
    classes
    TestNetDispenserApiClient
    interfaces
    DispenserFundResponse
    DispenserLimitResponse
    TestNetDispenserApiClientParams
  - expand
    types/expand
    type-aliases
    Expand
  - indexer
    types/indexer
    enumerations
    AccountStatus
    ApplicationOnComplete
    SignatureType
    interfaces
    LookupAssetHoldingsOptions
    type-aliases
    AccountLookupResult
    AccountParticipation
    AccountResult
    AccountStateDelta
    ApplicationCreatedLookupResult
    ApplicationLookupResult
    ApplicationParams
    ApplicationResult
    ApplicationTransactionResult
    AppLocalState
    AssetBalancesLookupResult
    AssetConfigTransactionResult
    AssetFreezeTransactionResult
    AssetHolding
    AssetLookupResult
    AssetParams
    AssetResult
    AssetsCreatedLookupResult
    AssetsLookupResult
    AssetTransferTransactionResult
    EvalDelta
    EvalDeltaKeyValue
    KeyRegistrationTransactionResult
    LogicTransactionSignature
    MerkleArrayProof
    MiniAssetHolding
    MultisigTransactionSignature
    MultisigTransactionSubSignature
    PaymentTransactionResult
    StateDelta
    StateProofTransactionResult
    StateSchema
    TransactionLookupResult
    TransactionResult
    TransactionSearchResults
    TransactionSignature
  - instance-of
    types/instance-of
    type-aliases
    InterfaceOf
  - kmd-account-manager
    types/kmd-account-manager
    classes
    KmdAccountManager
  - lifecycle-events
    types/lifecycle-events
    enumerations
    EventType
    type-aliases
    EventDataMap
  - logging
    types/logging
    type-aliases
    Logger
    variables
    consoleLogger
    infoConsoleLogger
    nullLogger
    verboseConsoleLogger
    warningConsoleLogger
  - logic-error
    types/logic-error
    classes
    LogicError
    interfaces
    LogicErrorDetails
  - network-client
    types/network-client
    functions
    genesisIdIsLocalNet
    interfaces
    AlgoClientConfig
    AlgoConfig
    NetworkDetails
  - testing
    types/testing
    interfaces
    AlgoKitLogCaptureFixture
    AlgorandFixture
    AlgorandFixtureConfig
    AlgorandTestAutomationContext
    GetTestAccountParams
    LogSnapshotConfig
  - transaction
    types/transaction
    interfaces
    AdditionalAtomicTransactionComposerContext
    AtomicTransactionComposerToSend
    ConfirmedTransactionResult
    ConfirmedTransactionResults
    SendAtomicTransactionComposerResults
    SendParams
    SendTransactionParams
    SendTransactionResult
    SendTransactionResults
    TransactionGroupToSend
    TransactionToSign
    type-aliases
    Arc2TransactionNote
    SendSingleTransactionResult
    SendTransactionFrom
    TransactionNote
    TransactionNoteData
  - transfer
    types/transfer
    interfaces
    AlgoRekeyParams
    AlgoTransferParams
    EnsureFundedParams
    EnsureFundedReturnType
    TransferAssetParams

Select theme

On this page

Overview
Interfaces
Type Aliases

On this page

Overview
Interfaces
Type Aliases

types/transaction

Interfaces

Section titled “Interfaces”

AdditionalAtomicTransactionComposerContext
AtomicTransactionComposerToSend
ConfirmedTransactionResult
ConfirmedTransactionResults
SendAtomicTransactionComposerResults
SendParams
SendTransactionParams
SendTransactionResult
SendTransactionResults
TransactionGroupToSend
TransactionToSign

Type Aliases

Section titled “Type Aliases”

Arc2TransactionNote
SendSingleTransactionResult
SendTransactionFrom
TransactionNote
TransactionNoteData