Skip to content
Algorand Developer Portal
Search
Ctrl
K
Cancel
GitHub
Discord
X
YouTube
Getting Started
Introduction
Tutorial: Your First Smart Contract
AlgoKit Examples Gallery
Interactive AlgoKit Code Tutorials
Why Algorand?
From Ethereum to Algorand
Concepts
Accounts
Overview
Creating Accounts
Funding Accounts
Keys & Signing
Rekeying Accounts
Multisignature Accounts
Transactions
Overview
Transaction Types
Fees
Atomic Transaction Groups
Signing Transactions
Blocks
Leases
URI Scheme
Transaction Reference
Assets
Overview
Asset Operations
Smart Contracts
Overview
Algorand Virtual Machine
Languages
Python
Typescript
TEAL
Applications
ABI
Control Flow
Inner Transactions
Resource Usage
Opcodes Overview
Logic Signatures
Costs & Constraints
Data Storage
Overview
Local Storage
Global Storage
Box Storage
Scratch Space
Encoding/Decoding
Cryptographic Tools
Development Lifecycle
Consensus Protocol
Overview
Protocol Parameters
Participation Key Management
Account Registration
Staking Rewards
State Proofs
Networks
Randomness
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
Project Structure
Official AlgoKit Templates
Custom AlgoKit Templates
AlgoKit Utils
AlgoKit Clients
TypeScript
Overview
Account Management
Algorand Client
Amount
App Client
App Deployment
Asset
Client
Debugging
Dispenser Client
Event Emitter
Indexer
Testnet Dispenser Client
Testing
Transaction Composer
Transaction
Transfer
Typed Clients
v7 Migration Guide
v8 Migration Guide
Python
Overview
Account Management
Algorand Client
Algo Amount Handling
App Client and Factory
App Deployment
App Management
Assets
Client Management
Debugger
Testnet Dispenser Client
Testing
Transaction Composer
Transaction Management
Algo Transfers (Payments)
Typed Application Clients
Smart Contract Languages
Algorand TypeScript
Overview
Language Guide
Program Structure
Basic Types
Storage
Ops
Guiding Principles
Migration Guides
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
Manual Installation
Catchup & Status
Indexer Installation
Conduit Installation
Node Troubleshooting
Node Management
Best Practices
Software Updates
Switching Networks
Node Reference
Node Artifacts
Configuration Settings
Relay Node Configuration
Telemetry Configuration
NodeKit Reference
Reference
Algorand Python
API Reference
algopy.arc4
algopy.gtxn
algopy.itxn
algopy.op
algopy
Overview
Algorand Typescript
Overview
arc4
-internal-
classes
Arc4ArrayBase
StructBase
Overview
type-aliases
AnyFunction
BigUintBitSize
CompatForArc4Int
InstanceMethod
StructConstructor
UintBitSize
classes
Address
ARC4Encoded
Bool
Byte
Contract
DynamicArray
DynamicBytes
StaticArray
StaticBytes
Str
Tuple
UFixed
Uint
Uint128
Uint16
Uint256
Uint32
Uint64
Uint8
functions
abiCall
abimethod
baremethod
compileArc4
convertBytes
decodeArc4
encodeArc4
methodSelector
readonly
sizeOf
interfaces
AbiCallOptions
ConventionalRouting
type-aliases
AbiCallResponse
AbiMethodConfig
BareCreateApplicationCallFields
BareMethodConfig
BitSize
ContractProxy
ContractProxyMethod
CreateOptions
DefaultArgument
GtxnToItxnFields
ResourceEncodingOptions
TypedApplicationArg
TypedApplicationArgs
TypedApplicationCallFields
TypedApplicationCallResponse
ValidateEncodingOptions
variables
Struct
gtxn
namespaces
gtxn
functions
ApplicationCallTxn
AssetConfigTxn
AssetFreezeTxn
AssetTransferTxn
KeyRegistrationTxn
PaymentTxn
Transaction
interfaces
ApplicationCallTxn
AssetConfigTxn
AssetFreezeTxn
AssetTransferTxn
KeyRegistrationTxn
PaymentTxn
Overview
type-aliases
Transaction
index
-internal-
interfaces
CreateBoxMapOptions
CreateBoxOptions
Overview
type-aliases
ComparisonFor
ConstructorFor
ContractOptions
DeliberateAny
LogicSigOptions
MatchTest
NonNumericComparison
NumberRange
NumberRange
NumericComparison
StateTotals
ToFixedBytesOptions
_TupleOf
classes
BaseContract
FixedArray
LogicSig
ReferenceArray
enumerations
OnCompleteAction
OpUpFeeSource
TransactionType
functions
Account
Application
assert
assertMatch
Asset
BigUint
Box
BoxMap
Bytes
clone
compile
contract
emit
ensureBudget
err
GlobalState
LocalState
log
logicsig
match
TemplateVar
Uint64
urange
validateEncoding
interfaces
AnyTransactionComposeFields
ApplicationCallComposeFields
AssetConfigComposeFields
AssetFreezeComposeFields
AssetTransferComposeFields
BytesBacked
KeyRegistrationComposeFields
PaymentComposeFields
namespaces
Bytes
functions
fromBase32
fromBase64
fromHex
Overview
type-aliases
Account
Application
Asset
biguint
BigUintCompat
Box
BoxMap
bytes
BytesCompat
CompileContractOptions
CompiledContract
CompiledLogicSig
CompileLogicSigOptions
ComposeItxnParams
GlobalState
GlobalStateOptions
ItxnCompose
LocalState
LocalStateForAccount
LocalStateOptions
NTuple
OnCompleteActionStr
StringCompat
uint64
Uint64Compat
variables
itxnCompose
itxn
namespaces
itxn
classes
ApplicationCallItxnParams
AssetConfigItxnParams
AssetFreezeItxnParams
AssetTransferItxnParams
KeyRegistrationItxnParams
PaymentItxnParams
functions
applicationCall
assetConfig
assetFreeze
assetTransfer
keyRegistration
payment
submitGroup
interfaces
ApplicationCallFields
ApplicationCallInnerTxn
AssetConfigFields
AssetConfigInnerTxn
AssetFreezeFields
AssetFreezeInnerTxn
AssetTransferFields
AssetTransferInnerTxn
KeyRegistrationFields
KeyRegistrationInnerTxn
PaymentFields
PaymentInnerTxn
Overview
type-aliases
ItxnParams
TxnFor
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
gloadUint64
itob
keccak256
len
mimc
minBalance
mulw
onlineStake
replace
select
setBit
setByte
sha256
sha3_256
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
AlgoKit CLI
Command Reference
AlgoKit Utils (Python)
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)
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
Overview
algod
Overview
common
GetGenesis
GetReady
GetVersion
HealthCheck
Metrics
SwaggerJSON
data
GetSyncRound
SetSyncRound
UnsetSyncRound
experimental
AccountAssetsInformation
ExperimentalCheck
RawTransactionAsync
nonparticipating
AbortCatchup
AccountApplicationInformation
AccountAssetInformation
AccountInformation
GetApplicationBoxByName
GetApplicationBoxes
GetApplicationByID
GetAssetByID
GetBlock
GetBlockHash
GetBlockLogs
GetBlockTimeStampOffset
GetBlockTxids
GetLedgerStateDelta
GetLedgerStateDeltaForTransactionGroup
GetLightBlockHeaderProof
GetStateProof
GetStatus
GetSupply
GetTransactionGroupLedgerStateDeltasForRound
GetTransactionProof
SetBlockTimeStampOffset
ShutdownNode
SimulateTransaction
StartCatchup
TealCompile
TealDisassemble
TealDryrun
TransactionParams
WaitForBlock
participating
AddParticipationKey
AppendKeys
DeleteParticipationKeyByID
GenerateParticipationKeys
GetParticipationKeyByID
GetParticipationKeys
GetPendingTransactions
GetPendingTransactionsByAddress
PendingTransactionInformation
RawTransaction
private
AbortCatchup
AddParticipationKey
AppendKeys
DeleteParticipationKeyByID
GenerateParticipationKeys
GetConfig
GetDebugSettingsProf
GetParticipationKeyByID
GetParticipationKeys
PutDebugSettingsProf
ShutdownNode
StartCatchup
public
AccountApplicationInformation
AccountAssetInformation
AccountAssetsInformation
AccountInformation
ExperimentalCheck
GetApplicationBoxByName
GetApplicationBoxes
GetApplicationByID
GetAssetByID
GetBlock
GetBlockHash
GetBlockLogs
GetBlockTimeStampOffset
GetBlockTxids
GetGenesis
GetLedgerStateDelta
GetLedgerStateDeltaForTransactionGroup
GetLightBlockHeaderProof
GetPendingTransactions
GetPendingTransactionsByAddress
GetReady
GetStateProof
GetStatus
GetSupply
GetSyncRound
GetTransactionGroupLedgerStateDeltasForRound
GetTransactionProof
GetVersion
HealthCheck
Metrics
PendingTransactionInformation
RawTransaction
RawTransactionAsync
SetBlockTimeStampOffset
SetSyncRound
SimulateTransaction
SwaggerJSON
TealCompile
TealDisassemble
TealDryrun
TransactionParams
UnsetSyncRound
WaitForBlock
indexer
Overview
common
makeHealthCheck
lookup
lookupAccountAppLocalStates
lookupAccountAssets
lookupAccountByID
lookupAccountCreatedApplications
lookupAccountCreatedAssets
lookupAccountTransactions
lookupApplicationBoxByIDAndName
lookupApplicationByID
lookupApplicationLogsByID
lookupAssetBalances
lookupAssetByID
lookupAssetTransactions
lookupBlock
lookupTransaction
search
searchForAccounts
searchForApplicationBoxes
searchForApplications
searchForAssets
searchForBlockHeaders
searchForTransactions
kmd
Overview
Operations
CreateWallet
DeleteKey
DeleteMultisig
ExportKey
ExportMasterKey
ExportMultisig
GenerateKey
GetVersion
GetWalletInfo
ImportKey
ImportMultisig
InitWalletHandleToken
ListKeysInWallet
ListMultisg
ListWallets
ReleaseWalletHandleToken
RenameWallet
RenewWalletHandleToken
SignMultisigProgram
SignMultisigTransaction
SignProgram
SignTransaction
SwaggerHandler
ARC Standards
Index
Guildelines
arc-0000
Living
arc-0001
Final
arc-0002
Final
arc-0003
Final
arc-0004
Final
arc-0005
Final
arc-0006
Deprecated
arc-0007
Deprecated
arc-0008
Deprecated
arc-0009
Deprecated
arc-0010
Deprecated
arc-0011
Deprecated
arc-0012
Withdrawn
arc-0015
Deprecated
arc-0016
Final
arc-0018
Final
arc-0019
Final
arc-0020
Final
arc-0021
Final
arc-0022
Final
arc-0023
Final
arc-0025
Final
arc-0026
Final
arc-0027
Final
arc-0028
Final
arc-0032
Final
arc-0033
Deprecated
arc-0034
Deprecated
arc-0035
Final
arc-0036
Final
arc-0042
Deprecated
arc-0047
Final
arc-0048
Deprecated
arc-0049
Deprecated
arc-0053
Last Call
arc-0054
Final
arc-0055
Final
arc-0056
Final
arc-0059
Final
arc-0060
Draft
arc-0062
Final
arc-0065
Final
arc-0069
Final
arc-0071
Final
arc-0072
Living
arc-0073
Final
arc-0074
Final
arc-0076
Idle
arc-0078
Final
arc-0079
Final
arc-0082
Final
arc-0083
Living
arc-0086
Final
arc-0087
Draft
arc-0200
Living
Bulletins
Disclosure of Vulnerabilities in Puya Smart Contract Compiler
Additional Resources
Overview
Liquid Auth
Algorand Specifications
GitHub
Discord
X
YouTube
Algorand Python Overview
