AVM Opcodes | Algorand Developer Portal

AVM Opcodes

NameAvailabilityAllv1v2v3v4v5v6v7v8v10v11v12GroupAllArithmeticBox AccessByte Array ArithmeticByte Array LogicByte Array ManipulationCryptographyFlow ControlInner TransactionsLoading ValuesState AccessReset

-

!

!=

Section titled “!=”

*

Section titled “*”

Notes Overflow is an error condition which halts execution and fails the transaction. Full precision is available from mulw.

/

Section titled “/”

Notesdivmodw is available to divide the two-element values produced by mulw and addw.

&

Section titled “&”

&&

Section titled “&&”

%

Section titled “%”

^

Section titled “^”

+

Section titled “+”

Notes Overflow is an error condition which halts execution and fails the transaction. Full precision is available from addw.

<

Section titled “<”

<=

Section titled “<=”

==

Section titled “==”

>

Section titled “>”

>=

Section titled “>=”

|

Section titled “|”

||

Section titled “||”

~

Section titled “~”

acct_params_get

Section titled “acct_params_get”

Field Reference

Index Name Type
0 AcctBalance uint64
1 AcctMinBalance uint64
2 AcctAuthAddr address
3 AcctTotalNumUint uint64
4 AcctTotalNumByteSlice uint64
5 AcctTotalExtraAppPages uint64
6 AcctTotalAppsCreated uint64
7 AcctTotalAppsOptedIn uint64
8 AcctTotalAssetsCreated uint64
9 AcctTotalAssets uint64
10 AcctTotalBoxes uint64
11 AcctTotalBoxBytes uint64
12 AcctIncentiveEligible bool
13 AcctLastProposed uint64
14 AcctLastHeartbeat uint64

Immediate Parameters

Name Encoding Description
F uint8 account params field index

addw

Section titled “addw”

app_global_del

Section titled “app_global_del”

Notes params: state key.

Deleting a key which is already absent has no effect on the application global state. (In particular, it does not cause the program to fail.)

app_global_get

Section titled “app_global_get”

Notes params: state key. Return: value. The value is zero (of type uint64) if the key does not exist.

app_global_get_ex

Section titled “app_global_get_ex”

Notes params: Txn.ForeignApps offset (or, since v4, an available application id), state key. Return: did_exist flag (top of the stack, 1 if the application and key existed and 0 otherwise), value. The value is zero (of type uint64) if the key does not exist.

app_global_put

Section titled “app_global_put”

app_local_del

Section titled “app_local_del”

Notes params: Txn.Accounts offset (or, since v4, an available account address), state key.

Deleting a key which is already absent has no effect on the application local state. (In particular, it does not cause the program to fail.)

app_local_get

Section titled “app_local_get”

Notes params: Txn.Accounts offset (or, since v4, an available account address), state key. Return: value. The value is zero (of type uint64) if the key does not exist.

app_local_get_ex

Section titled “app_local_get_ex”

Notes params: Txn.Accounts offset (or, since v4, an available account address), available application id (or, since v4, a Txn.ForeignApps offset), state key. Return: did_exist flag (top of the stack, 1 if the application and key existed and 0 otherwise), value. The value is zero (of type uint64) if the key does not exist.

app_local_put

Section titled “app_local_put”

Notes params: Txn.Accounts offset (or, since v4, an available account address), state key, value.

app_opted_in

Section titled “app_opted_in”

Notes params: Txn.Accounts offset (or, since v4, an available account address), available application id (or, since v4, a Txn.ForeignApps offset). Return: 1 if opted in and 0 otherwise.

app_params_get

Section titled “app_params_get”

Notes params: Txn.ForeignApps offset or an available app id. Return: did_exist flag (1 if the application existed and 0 otherwise), value.

Field Reference

Index Name Type
0 AppApprovalProgram []byte
1 AppClearStateProgram []byte
2 AppGlobalNumUint uint64
3 AppGlobalNumByteSlice uint64
4 AppLocalNumUint uint64
5 AppLocalNumByteSlice uint64
6 AppExtraProgramPages uint64
7 AppCreator address
8 AppAddress address
9 AppVersion uint64

Immediate Parameters

Name Encoding Description
F uint8 app params field index

arg

Section titled “arg”

Immediate Parameters

Name Encoding Description
N uint8 an arg index

arg_0

Section titled “arg_0”

arg_1

Section titled “arg_1”

arg_2

Section titled “arg_2”

arg_3

Section titled “arg_3”

args

Section titled “args”

assert

Section titled “assert”

asset_holding_get

Section titled “asset_holding_get”

Notes params: Txn.Accounts offset (or, since v4, an available address), asset id (or, since v4, a Txn.ForeignAssets offset). Return: did_exist flag (1 if the asset existed and 0 otherwise), value.

Field Reference

Index Name Type
0 AssetBalance uint64
1 AssetFrozen bool

Immediate Parameters

Name Encoding Description
F uint8 asset holding field index

asset_params_get

Section titled “asset_params_get”

Notes params: Txn.ForeignAssets offset (or, since v4, an available asset id. Return: did_exist flag (1 if the asset existed and 0 otherwise), value.

Field Reference

Index Name Type
0 AssetTotal uint64
1 AssetDecimals uint64
2 AssetDefaultFrozen bool
3 AssetUnitName []byte
4 AssetName []byte
5 AssetURL []byte
6 AssetMetadataHash [32]byte
7 AssetManager address
8 AssetReserve address
9 AssetFreeze address
10 AssetClawback address
11 AssetCreator address

Immediate Parameters

Name Encoding Description
F uint8 asset params field index

b

Section titled “b”

Notes See bnz for details on how branches work. b always jumps to the offset.

Immediate Parameters

Name Encoding Description
TARGET int16 (big-endian) branch offset

b-

Section titled “b-”

b!=

Section titled “b!=”

b*

Section titled “b*”

b/

Section titled “b/”

b&

Section titled “b&”

b%

Section titled “b%”

b^

Section titled “b^”

b+

Section titled “b+”

b<

Section titled “b<”

b<=

Section titled “b<=”

b==

Section titled “b==”

b>

Section titled “b>”

b>=

Section titled “b>=”

b|

Section titled “b|”

b~

Section titled “b~”

balance

Section titled “balance”

Notes params: Txn.Accounts offset (or, since v4, an available account address), available application id (or, since v4, a Txn.ForeignApps offset). Return: value.

base64_decode

Section titled “base64_decode”

Notes Warning: Usage should be restricted to very rare use cases. In almost all cases, smart contracts should directly handle non-encoded byte-strings. This opcode should only be used in cases where base64 is the only available option, e.g. interoperability with a third-party that only signs base64 strings.

Decodes A using the base64 encoding E. Specify the encoding with an immediate arg either as URL and Filename Safe (URLEncoding) or Standard (StdEncoding). See RFC 4648 sections 4 and 5. It is assumed that the encoding ends with the exact number of = padding characters as required by the RFC. When padding occurs, any unused pad bits in the encoding must be set to zero or the decoding will fail. The special cases of \n and \r are allowed but completely ignored. An error will result when attempting to decode a string with a character that is not in the encoding alphabet or not one of =, \r, or \n.

Field Reference

Index Name Type
0 URLEncoding any
1 StdEncoding any

Immediate Parameters

Name Encoding Description
E uint8 encoding index

bitlen

Section titled “bitlen”

Notes bitlen interprets arrays as big-endian integers, unlike setbit/getbit

block

Section titled “block”

Field Reference

Index Name Type
0 BlkSeed [32]byte
1 BlkTimestamp uint64
2 BlkProposer address
3 BlkFeesCollected uint64
4 BlkBonus uint64
5 BlkBranch [32]byte
6 BlkFeeSink address
7 BlkProtocol []byte
8 BlkTxnCounter uint64
9 BlkProposerPayout uint64

Immediate Parameters

Name Encoding Description
F uint8 block field index

bnz

Section titled “bnz”

Notes The bnz instruction opcode 0x40 is followed by two immediate data bytes which are a high byte first and low byte second which together form a 16 bit offset which the instruction may branch to. For a bnz instruction at pc, if the last element of the stack is not zero then branch to instruction at pc + 3 + N, else proceed to next instruction at pc + 3. Branch targets must be aligned instructions. (e.g. Branching to the second byte of a 2 byte op will be rejected.) Starting at v4, the offset is treated as a signed 16 bit integer allowing for backward branches and looping. In prior version (v1 to v3), branch offsets are limited to forward branches only, 0-0x7fff.

At v2 it became allowed to branch to the end of the program exactly after the last instruction: bnz to byte N (with 0-indexing) was illegal for a TEAL program with N bytes before v2, and is legal after it. This change eliminates the need for a last instruction of no-op as a branch target at the end. (Branching beyond the end—in other words, to a byte larger than N—is still illegal and will cause the program to fail.)

Immediate Parameters

Name Encoding Description
TARGET int16 (big-endian) branch offset

box_create

Section titled “box_create”

Notes Newly created boxes are filled with 0 bytes. box_create will fail if the referenced box already exists with a different size. Otherwise, existing boxes are unchanged by box_create.

box_del

Section titled “box_del”

box_extract

Section titled “box_extract”

box_get

Section titled “box_get”

Notes For boxes that exceed 4,096 bytes, consider box_create, box_extract, and box_replace

box_len

Section titled “box_len”

box_put

Section titled “box_put”

Notes For boxes that exceed 4,096 bytes, consider box_create, box_extract, and box_replace

box_replace

Section titled “box_replace”

box_resize

Section titled “box_resize”

box_splice

Section titled “box_splice”

Notes Boxes are of constant length. If C < len(D), then len(D)-C bytes will be removed from the end. If C > len(D), zero bytes will be appended to the end to reach the box length.

bsqrt

Section titled “bsqrt”

btoi

Section titled “btoi”

Notesbtoi fails if the input is longer than 8 bytes.

bury

Section titled “bury”

Immediate Parameters

Name Encoding Description
N uint8 depth

bytec

Section titled “bytec”

Immediate Parameters

Name Encoding Description
I uint8 an index in the bytecblock

bytec_0

Section titled “bytec_0”

bytec_1

Section titled “bytec_1”

bytec_2

Section titled “bytec_2”

bytec_3

Section titled “bytec_3”

bytecblock

Section titled “bytecblock”

Notesbytecblock loads the following program bytes into an array of byte-array constants in the evaluator. These constants can be referred to by bytec and bytec_* which will push the value onto the stack. Subsequent calls to bytecblock reset and replace the bytes constants available to the script.

Immediate Parameters

Name Encoding Description
BYTES … varuint count, [varuint length, bytes …] a block of byte constant values

bz

Section titled “bz”

Notes See bnz for details on how branches work. bz inverts the behavior of bnz.

Immediate Parameters

Name Encoding Description
TARGET int16 (big-endian) branch offset

bzero

Section titled “bzero”

callsub

Section titled “callsub”

Notes The call stack is separate from the data stack. Only callsub, retsub, and proto manipulate it.

Immediate Parameters

Name Encoding Description
TARGET int16 (big-endian) branch offset

concat

Section titled “concat”

Notesconcat fails if the result would be greater than 4096 bytes.

cover

Section titled “cover”

Immediate Parameters

Name Encoding Description
N uint8 depth

dig

Section titled “dig”

Immediate Parameters

Name Encoding Description
N uint8 depth

divmodw

Section titled “divmodw”

Notes The notation J,K indicates that two uint64 values J and K are interpreted as a uint128 value, with J as the high uint64 and K the low.

divw

Section titled “divw”

Notes The notation A,B indicates that A and B are interpreted as a uint128 value, with A as the high uint64 and B the low.

dup

Section titled “dup”

dup2

Section titled “dup2”

dupn

Section titled “dupn”

Immediate Parameters

Name Encoding Description
N uint8 copy count

ec_add

Section titled “ec_add”

Notes A and B are curve points in affine representation: field element X concatenated with field element Y. Field element Z is encoded as follows.

For the base field elements (Fp), Z is encoded as a big-endian number and must be lower than the field modulus.

For the quadratic field extension (Fp2), Z is encoded as the concatenation of the individual encoding of the coefficients. For an Fp2 element of the form Z = Z0 + Z1 i, where i is a formal quadratic non-residue, the encoding of Z is the concatenation of the encoding of Z0 and Z1 in this order. (Z0 and Z1 must be less than the field modulus).

The point at infinity is encoded as (X,Y) = (0,0).

Groups G1 and G2 are denoted additively.

Fails if A or B is not in G.

A and/or B are allowed to be the point at infinity.

Does not check if A and B are in the main prime-order subgroup.

Immediate Parameters

Name Encoding Description
G uint8 curve index

ec_map_to

Section titled “ec_map_to”

Notes BN254 points are mapped by the SVDW map. BLS12-381 points are mapped by the SSWU map.

G1 element inputs are base field elements and G2 element inputs are quadratic field elements, with nearly the same encoding rules (for field elements) as defined in ec_add. There is one difference of encoding rule: G1 element inputs do not need to be 0-padded if they fit in less than 32 bytes for BN254 and less than 48 bytes for BLS12-381. (As usual, the empty byte array represents 0.) G2 elements inputs need to be always have the required size.

Immediate Parameters

Name Encoding Description
G uint8 curve index

ec_multi_scalar_mul

Section titled “ec_multi_scalar_mul”

Notes A is a list of concatenated points, encoded and checked as described in ec_add. B is a list of concatenated scalars which, unlike ec_scalar_mul, must all be exactly 32 bytes long.

The name ec_multi_scalar_mul was chosen to reflect common usage, but a more consistent name would be ec_multi_scalar_mul. AVM values are limited to 4096 bytes, so ec_multi_scalar_mul is limited by the size of the points in the group being operated upon.

Immediate Parameters

Name Encoding Description
G uint8 curve index

ec_pairing_check

Section titled “ec_pairing_check”

Notes A and B are concatenated points, encoded and checked as described in ec_add. A contains points of the group G, B contains points of the associated group (G2 if G is G1, and vice versa). Fails if A and B have a different number of points, or if any point is not in its described group or outside the main prime-order subgroup - a stronger condition than other opcodes. AVM values are limited to 4096 bytes, so ec_pairing_check is limited by the size of the points in the groups being operated upon.

Immediate Parameters

Name Encoding Description
G uint8 curve index

ec_scalar_mul

Section titled “ec_scalar_mul”

Notes A is a curve point encoded and checked as described in ec_add. Scalar B is interpreted as a big-endian unsigned integer. Fails if B exceeds 32 bytes.

Immediate Parameters

Name Encoding Description
G uint8 curve index

ec_subgroup_check

Section titled “ec_subgroup_check”

Immediate Parameters

Name Encoding Description
G uint8 curve index

ecdsa_pk_decompress

Section titled “ecdsa_pk_decompress”

Notes The 33 byte public key in a compressed form to be decompressed into X and Y (top) components. All values are big-endian encoded.

Field Reference

Index Name Type
0 Secp256k1 -
1 Secp256r1 -

Immediate Parameters

Name Encoding Description
V uint8 curve index

ecdsa_pk_recover

Section titled “ecdsa_pk_recover”

Notes S (top) and R elements of a signature, recovery id and data (bottom) are expected on the stack and used to deriver a public key. All values are big-endian encoded. The signed data must be 32 bytes long.

Field Reference

Index Name Type
0 Secp256k1 -
1 Secp256r1 -

Immediate Parameters

Name Encoding Description
V uint8 curve index

ecdsa_verify

Section titled “ecdsa_verify”

Notes The 32 byte Y-component of a public key is the last element on the stack, preceded by X-component of a pubkey, preceded by S and R components of a signature, preceded by the data that is fifth element on the stack. All values are big-endian encoded. The signed data must be 32 bytes long, and signatures in lower-S form are only accepted.

Field Reference

Index Name Type
0 Secp256k1 -
1 Secp256r1 -

Immediate Parameters

Name Encoding Description
V uint8 curve index

ed25519verify

Section titled “ed25519verify”

Notes The 32 byte public key is the last element on the stack, preceded by the 64 byte signature at the second-to-last element on the stack, preceded by the data which was signed at the third-to-last element on the stack.

ed25519verify_bare

Section titled “ed25519verify_bare”

err

Section titled “err”

exp

Section titled “exp”

expw

Section titled “expw”

extract

Section titled “extract”

Immediate Parameters

Name Encoding Description
S uint8 start position
L uint8 length

extract_uint16

Section titled “extract_uint16”

extract_uint32

Section titled “extract_uint32”

extract_uint64

Section titled “extract_uint64”

extract3

Section titled “extract3”

extract3 can be called using extract with no immediates.

falcon_verify

Section titled “falcon_verify”

frame_bury

Section titled “frame_bury”

Immediate Parameters

Name Encoding Description
I int8 frame slot

frame_dig

Section titled “frame_dig”

Immediate Parameters

Name Encoding Description
I int8 frame slot

gaid

Section titled “gaid”

Notesgaid fails unless the requested transaction created an asset or application and T < GroupIndex.

Immediate Parameters

Name Encoding Description
T uint8 transaction group index

gaids

Section titled “gaids”

Notesgaids fails unless the requested transaction created an asset or application and A < GroupIndex.

getbit

Section titled “getbit”

Notes see explanation of bit ordering in setbit

getbyte

Section titled “getbyte”

gitxn

Section titled “gitxn”

Field Reference

Index Name Type
0 Sender address
1 Fee uint64
2 FirstValid uint64
3 FirstValidTime uint64
4 LastValid uint64
5 Note []byte
6 Lease [32]byte
7 Receiver address
8 Amount uint64
9 CloseRemainderTo address
10 VotePK [32]byte
11 SelectionPK [32]byte
12 VoteFirst uint64
13 VoteLast uint64
14 VoteKeyDilution uint64
15 Type []byte
16 TypeEnum uint64
17 XferAsset uint64
18 AssetAmount uint64
19 AssetSender address
20 AssetReceiver address
21 AssetCloseTo address
22 GroupIndex uint64
23 TxID [32]byte
24 ApplicationID uint64
25 OnCompletion uint64
26 ApplicationArgs []byte
27 NumAppArgs uint64
28 Accounts address
29 NumAccounts uint64
30 ApprovalProgram []byte
31 ClearStateProgram []byte
32 RekeyTo address
33 ConfigAsset uint64
34 ConfigAssetTotal uint64
35 ConfigAssetDecimals uint64
36 ConfigAssetDefaultFrozen bool
37 ConfigAssetUnitName []byte
38 ConfigAssetName []byte
39 ConfigAssetURL []byte
40 ConfigAssetMetadataHash [32]byte
41 ConfigAssetManager address
42 ConfigAssetReserve address
43 ConfigAssetFreeze address
44 ConfigAssetClawback address
45 FreezeAsset uint64
46 FreezeAssetAccount address
47 FreezeAssetFrozen bool
48 Assets uint64
49 NumAssets uint64
50 Applications uint64
51 NumApplications uint64
52 GlobalNumUint uint64
53 GlobalNumByteSlice uint64
54 LocalNumUint uint64
55 LocalNumByteSlice uint64
56 ExtraProgramPages uint64
57 Nonparticipation bool
58 Logs []byte
59 NumLogs uint64
60 CreatedAssetID uint64
61 CreatedApplicationID uint64
62 LastLog []byte
63 StateProofPK [64]byte
64 ApprovalProgramPages []byte
65 NumApprovalProgramPages uint64
66 ClearStateProgramPages []byte
67 NumClearStateProgramPages uint64
68 RejectVersion uint64

Immediate Parameters

Name Encoding Description
T uint8 transaction group index
F uint8 transaction field index

gitxna

Section titled “gitxna”

Field Reference

Index Name Type
0 ApplicationArgs []byte
1 Accounts address
2 Assets uint64
3 Applications uint64
4 Logs []byte
5 ApprovalProgramPages []byte
6 ClearStateProgramPages []byte

Immediate Parameters

Name Encoding Description
T uint8 transaction group index
F uint8 transaction field index
I uint8 transaction field array index

gitxnas

Section titled “gitxnas”

Immediate Parameters

Name Encoding Description
T uint8 transaction group index
F uint8 transaction field index

gload

Section titled “gload”

Notesgload fails unless the requested transaction is an ApplicationCall and T < GroupIndex.

Immediate Parameters

Name Encoding Description
T uint8 transaction group index
I uint8 position in scratch space to load from

gloads

Section titled “gloads”

Notesgloads fails unless the requested transaction is an ApplicationCall and A < GroupIndex.

Immediate Parameters

Name Encoding Description
I uint8 position in scratch space to load from

gloadss

Section titled “gloadss”

global

Section titled “global”

Field Reference

Index Name Type
0 MinTxnFee uint64
1 MinBalance uint64
2 MaxTxnLife uint64
3 ZeroAddress address
4 GroupSize uint64
5 LogicSigVersion uint64
6 Round uint64
7 LatestTimestamp uint64
8 CurrentApplicationID uint64
9 CreatorAddress address
10 CurrentApplicationAddress address
11 GroupID [32]byte
12 OpcodeBudget uint64
13 CallerApplicationID uint64
14 CallerApplicationAddress address
15 AssetCreateMinBalance uint64
16 AssetOptInMinBalance uint64
17 GenesisHash [32]byte
18 PayoutsEnabled bool
19 PayoutsGoOnlineFee uint64
20 PayoutsPercent uint64
21 PayoutsMinBalance uint64
22 PayoutsMaxBalance uint64

Immediate Parameters

Name Encoding Description
F uint8 a global field index

gtxn

Section titled “gtxn”

Notes for notes on transaction fields available, see txn. If this transaction is i in the group, gtxn i field is equivalent to txn field.

Field Reference

Immediate Parameters

Name Encoding Description
T uint8 transaction group index
F uint8 transaction field index

gtxna

Section titled “gtxna”

gtxna can be called using gtxn with 3 immediates.

Field Reference

Immediate Parameters

gtxnas

Section titled “gtxnas”

Field Reference

Immediate Parameters

Name Encoding Description
T uint8 transaction group index
F uint8 transaction field index

gtxns

Section titled “gtxns”

Notes for notes on transaction fields available, see txn. If top of stack is i, gtxns field is equivalent to gtxn _i_ field. gtxns exists so that i can be calculated, often based on the index of the current transaction.

Field Reference

Immediate Parameters

Name Encoding Description
F uint8 transaction field index

gtxnsa

Section titled “gtxnsa”

gtxnsa can be called using gtxns with 2 immediates.

Field Reference

Immediate Parameters

Name Encoding Description
F uint8 transaction field index
I uint8 transaction field array index

gtxnsas

Section titled “gtxnsas”

Field Reference

Immediate Parameters

Name Encoding Description
F uint8 transaction field index

intc

Section titled “intc”

Immediate Parameters

Name Encoding Description
I uint8 an index in the intcblock

intc_0

Section titled “intc_0”

intc_1

Section titled “intc_1”

intc_2

Section titled “intc_2”

intc_3

Section titled “intc_3”

intcblock

Section titled “intcblock”

Notesintcblock loads following program bytes into an array of integer constants in the evaluator. These integer constants can be referred to by intc and intc_* which will push the value onto the stack. Subsequent calls to intcblock reset and replace the integer constants available to the script.

Immediate Parameters

Name Encoding Description
UINT … varuint count, [varuint …] a block of int constant values

itob

Section titled “itob”

itxn

Section titled “itxn”

Field Reference

Immediate Parameters

Name Encoding Description
F uint8 transaction field index

itxn_begin

Section titled “itxn_begin”

Notesitxn_begin initializes Sender to the application address; Fee to the minimum allowable, taking into account MinTxnFee and credit from overpaying in earlier transactions; FirstValid/LastValid to the values in the invoking transaction, and all other fields to zero or empty values.

itxn_field

Section titled “itxn_field”

Notesitxn_field fails if A is of the wrong type for F, including a byte array of the wrong size for use as an address when F is an address field. itxn_field also fails if A is an account, asset, or app that is not available, or an attempt is made extend an array field beyond the limit imposed by consensus parameters. (Addresses set into asset params of acfg transactions need not be available.)

Field Reference

Index Name Type
0 Sender address
1 Fee uint64
2 Note []byte
3 Receiver address
4 Amount uint64
5 CloseRemainderTo address
6 VotePK [32]byte
7 SelectionPK [32]byte
8 VoteFirst uint64
9 VoteLast uint64
10 VoteKeyDilution uint64
11 Type []byte
12 TypeEnum uint64
13 XferAsset uint64
14 AssetAmount uint64
15 AssetSender address
16 AssetReceiver address
17 AssetCloseTo address
18 ApplicationID uint64
19 OnCompletion uint64
20 ApplicationArgs []byte
21 Accounts address
22 ApprovalProgram []byte
23 ClearStateProgram []byte
24 RekeyTo address
25 ConfigAsset uint64
26 ConfigAssetTotal uint64
27 ConfigAssetDecimals uint64
28 ConfigAssetDefaultFrozen bool
29 ConfigAssetUnitName []byte
30 ConfigAssetName []byte
31 ConfigAssetURL []byte
32 ConfigAssetMetadataHash [32]byte
33 ConfigAssetManager address
34 ConfigAssetReserve address
35 ConfigAssetFreeze address
36 ConfigAssetClawback address
37 FreezeAsset uint64
38 FreezeAssetAccount address
39 FreezeAssetFrozen bool
40 Assets uint64
41 Applications uint64
42 GlobalNumUint uint64
43 GlobalNumByteSlice uint64
44 LocalNumUint uint64
45 LocalNumByteSlice uint64
46 ExtraProgramPages uint64
47 Nonparticipation bool
48 StateProofPK [64]byte
49 ApprovalProgramPages []byte
50 ClearStateProgramPages []byte
51 RejectVersion uint64

Immediate Parameters

Name Encoding Description
F uint8 transaction field index

itxn_next

Section titled “itxn_next”

Notesitxn_next initializes the transaction exactly as itxn_begin does

itxn_submit

Section titled “itxn_submit”

Notesitxn_submit resets the current transaction so that it can not be resubmitted. A new itxn_begin is required to prepare another inner transaction.

itxna

Section titled “itxna”

Field Reference

Immediate Parameters

Name Encoding Description
F uint8 transaction field index
I uint8 a transaction field array index

itxnas

Section titled “itxnas”

Immediate Parameters

Name Encoding Description
F uint8 transaction field index

json_ref

Section titled “json_ref”

Notes Warning: Usage should be restricted to very rare use cases, as JSON decoding is expensive and quite limited. In addition, JSON objects are large and not optimized for size.

Almost all smart contracts should use simpler and smaller methods (such as the ABI. This opcode should only be used in cases where JSON is only available option, e.g. when a third-party only signs JSON.

Field Reference

Index Name Type
0 JSONString []byte
1 JSONUint64 uint64
2 JSONObject []byte

Immediate Parameters

Name Encoding Description
R uint8 return type index

keccak256

Section titled “keccak256”

len

Section titled “len”

load

Section titled “load”

Immediate Parameters

Name Encoding Description
I uint8 position in scratch space to load from

loads

Section titled “loads”

log

Section titled “log”

Noteslog fails if called more than MaxLogCalls times in a program, or if the sum of logged bytes exceeds 1024 bytes.

match

Section titled “match”

Notesmatch consumes N+1 values from the stack. Let the top stack value be B. The following N values represent an ordered list of match cases/constants (A), where the first value (A[0]) is the deepest in the stack. The immediate arguments are an ordered list of N labels (T). match will branch to target T[I], where A[I] = B. If there are no matches then execution continues on to the next instruction.

Immediate Parameters

Name Encoding Description
TARGET … varuint count, [int16 (big-endian) …] list of labels

mimc

Section titled “mimc”

Notes A is a list of concatenated 32 byte big-endian unsigned integer scalars. Fail if A’s length is not a multiple of 32 or any element exceeds the curve modulus.

The MiMC hash function has known collisions since any input which is a multiple of the elliptic curve modulus will hash to the same value. MiMC is thus not a general purpose hash function, but meant to be used in zero knowledge applications to match a zk-circuit implementation.

Immediate Parameters

Name Encoding Description
C uint8 configuration index

min_balance

Section titled “min_balance”

mulw

Section titled “mulw”

online_stake

Section titled “online_stake”

pop

Section titled “pop”

popn

Section titled “popn”

Immediate Parameters

Name Encoding Description
N uint8 stack depth

proto

Section titled “proto”

Notes Fails unless the last instruction executed was a callsub.

Immediate Parameters

Name Encoding Description
A uint8 number of arguments
R uint8 number of return values

pushbytes

Section titled “pushbytes”

Notes pushbytes args are not added to the bytecblock during assembly processes

Immediate Parameters

Name Encoding Description
BYTES varuint length, bytes a byte constant

pushbytess

Section titled “pushbytess”

Notes pushbytess args are not added to the bytecblock during assembly processes

Immediate Parameters

Name Encoding Description
BYTES … varuint count, [varuint length, bytes …] a list of byte constants

pushint

Section titled “pushint”

Notes pushint args are not added to the intcblock during assembly processes

Immediate Parameters

Name Encoding Description
UINT varuint an int constant

pushints

Section titled “pushints”

Notes pushints args are not added to the intcblock during assembly processes

Immediate Parameters

Name Encoding Description
UINT … varuint count, [varuint …] a list of int constants

replace2

Section titled “replace2”

replace2 can be called using replace with 1 immediate.

Immediate Parameters

Name Encoding Description
S uint8 start position

replace3

Section titled “replace3”

replace3 can be called using replace with no immediates.

retsub

Section titled “retsub”

Notes If the current frame was prepared by proto A R, retsub will remove the ‘A’ arguments from the stack, move the R return values down, and pop any stack locations above the relocated return values.

return

Section titled “return”

select

Section titled “select”

setbit

Section titled “setbit”

Notes When A is a uint64, index 0 is the least significant bit. Setting bit 3 to 1 on the integer 0 yields 8, or 2^3. When A is a byte array, index 0 is the leftmost bit of the leftmost byte. Setting bits 0 through 11 to 1 in a 4-byte-array of 0s yields the byte array 0xfff00000. Setting bit 3 to 1 on the 1-byte-array 0x00 yields the byte array 0x10.

setbyte

Section titled “setbyte”

sha256

Section titled “sha256”

sha3_256

Section titled “sha3_256”

sha512_256

Section titled “sha512_256”

shl

Section titled “shl”

shr

Section titled “shr”

sqrt

Section titled “sqrt”

store

Section titled “store”

Immediate Parameters

Name Encoding Description
I uint8 position in scratch space to store to

stores

Section titled “stores”

substring

Section titled “substring”

Immediate Parameters

Name Encoding Description
S uint8 start position
E uint8 end position

substring3

Section titled “substring3”

swap

Section titled “swap”

switch

Section titled “switch”

Immediate Parameters

Name Encoding Description
TARGET … varuint count, [int16 (big-endian) …] list of labels

txn

Section titled “txn”

Field Reference

Immediate Parameters

Name Encoding Description
F uint8 transaction field index

txna

Section titled “txna”

txna can be called using txn with 2 immediates.

Field Reference

Immediate Parameters

Name Encoding Description
F uint8 transaction field index
I uint8 transaction field array index

txnas

Section titled “txnas”

Field Reference

Immediate Parameters

Name Encoding Description
F uint8 transaction field index

uncover

Section titled “uncover”

Immediate Parameters

Name Encoding Description
N uint8 depth

voter_params_get

Section titled “voter_params_get”

Immediate Parameters

Name Encoding Description
F uint8 voter params field index

vrf_verify

Section titled “vrf_verify”

NotesVrfAlgorand is the VRF used in Algorand. It is ECVRF-ED25519-SHA512-Elligator2, specified in the IETF internet draft draft-irtf-cfrg-vrf-03.

Field Reference

Index Name Type
0 VrfAlgorand -

Immediate Parameters

Name Encoding Description
S uint8 parameters index

Ask AI

reCAPTCHA

Recaptcha requires verification.

protected by reCAPTCHA