Opcodes List

This page contains a reference for all available opcodes v11.

OPCODE

NAME

STACK INPUT

STACK OUTPUT

0x00

err

Size	Availability	Doc Cost
1	v1	1

Description

Fail immediately.

Groups

Flow Control

0x01

sha256

[]byte

[32]byte

Size	Availability	Doc Cost
1	v1	35

Description

SHA256 hash of value A, yields [32]byte

Groups

Cryptography

0x02

keccak256

[]byte

[32]byte

Size	Availability	Doc Cost
1	v1	130

Description

Keccak256 hash of value A, yields [32]byte

Groups

Cryptography

0x03

sha512_256

[]byte

[32]byte

Size	Availability	Doc Cost
1	v1	45

Description

SHA512_256 hash of value A, yields [32]byte

Groups

Cryptography

0x04

ed25519verify

[]byte

[64]byte

[32]byte

bool

Size	Availability	Doc Cost
1	v1	1900

Description

for (data A, signature B, pubkey C) verify the signature of ("ProgData" || program_hash || data) against the pubkey => {0 or 1}

Groups

Cryptography

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.

0x05

ecdsa_verify

[32]byte

bool

Size	Availability	Doc Cost
2	v5	Secp256k1=1700; Secp256r1=2500

Description

for (data A, signature B, C and pubkey D, E) verify the signature of the data against the pubkey => {0 or 1}

Groups

Cryptography

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.

Immediate Notes

Comment	Encoding	Name	Reference
curve index	uint8	V	ECDSA

0x06

ecdsa_pk_decompress

[33]byte

[32]byte

Size	Availability	Doc Cost
2	v5	Secp256k1=650; Secp256r1=2400

Description

decompress pubkey A into components X, Y

Groups

Cryptography

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.

Immediate Notes

Comment	Encoding	Name	Reference
curve index	uint8	V	ECDSA

0x07

ecdsa_pk_recover

[32]byte

uint64

[32]byte

Size	Availability	Doc Cost
2	v5	2000

Description

for (data A, recovery id B, signature C, D) recover a public key

Groups

Cryptography

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.

Immediate Notes

Comment	Encoding	Name	Reference
curve index	uint8	V	ECDSA

0x08

uint64

Size	Availability	Doc Cost
1	v1	1

Description

A plus B. Fail on overflow.

Groups

Arithmetic

Notes

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

0x09

uint64

Size	Availability	Doc Cost
1	v1	1

Description

A minus B. Fail if B > A.

Groups

Arithmetic

0x0a

uint64

Size	Availability	Doc Cost
1	v1	1

Description

A divided by B (truncated division). Fail if B == 0.

Groups

Arithmetic

Notes

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

0x0b

uint64

Size	Availability	Doc Cost
1	v1	1

Description

A times B. Fail on overflow.

Groups

Arithmetic

Notes

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

0x0c

uint64

bool

Size	Availability	Doc Cost
1	v1	1

Description

A less than B => {0 or 1}

Groups

Arithmetic

0x0d

uint64

bool

Size	Availability	Doc Cost
1	v1	1

Description

A greater than B => {0 or 1}

Groups

Arithmetic

0x0e

uint64

bool

Size	Availability	Doc Cost
1	v1	1

Description

A less than or equal to B => {0 or 1}

Groups

Arithmetic

0x0f

uint64

bool

Size	Availability	Doc Cost
1	v1	1

Description

A greater than or equal to B => {0 or 1}

Groups

Arithmetic

0x10

uint64

bool

Size	Availability	Doc Cost
1	v1	1

Description

A is not zero and B is not zero => {0 or 1}

Groups

Arithmetic

0x11

uint64

bool

Size	Availability	Doc Cost
1	v1	1

Description

A is not zero or B is not zero => {0 or 1}

Groups

Arithmetic

0x12

any

bool

Size	Availability	Doc Cost
1	v1	1

Description

A is equal to B => {0 or 1}

Groups

Arithmetic

0x13

any

bool

Size	Availability	Doc Cost
1	v1	1

Description

A is not equal to B => {0 or 1}

Groups

Arithmetic

0x14

uint64

Size	Availability	Doc Cost
1	v1	1

Description

A == 0 yields 1; else 0

Groups

Arithmetic

0x15

len

[]byte

uint64

Size	Availability	Doc Cost
1	v1	1

Description

yields length of byte value A

Groups

Byte Array Manipulation

0x16

itob

uint64

[8]byte

Size	Availability	Doc Cost
1	v1	1

Description

converts uint64 A to big-endian byte array, always of length 8

Groups

Arithmetic

0x17

btoi

[]byte

uint64

Size	Availability	Doc Cost
1	v1	1

Description

converts big-endian byte array A to uint64. Fails if len(A) > 8. Padded by leading 0s if len(A) < 8.

Groups

Arithmetic

Notes

`btoi` fails if the input is longer than 8 bytes.

0x18

uint64

Size	Availability	Doc Cost
1	v1	1

Description

A modulo B. Fail if B == 0.

Groups

Arithmetic

0x19

uint64

Size	Availability	Doc Cost
1	v1	1

Description

A bitwise-or B

Groups

Arithmetic

0x1a

uint64

Size	Availability	Doc Cost
1	v1	1

Description

A bitwise-and B

Groups

Arithmetic

0x1b

uint64

Size	Availability	Doc Cost
1	v1	1

Description

A bitwise-xor B

Groups

Arithmetic

0x1c

uint64

Size	Availability	Doc Cost
1	v1	1

Description

bitwise invert value A

Groups

Arithmetic

0x1d

mulw

uint64

Size	Availability	Doc Cost
1	v1	1

Description

A times B as a 128-bit result in two uint64s. X is the high 64 bits, Y is the low

Groups

Arithmetic

0x1e

addw

uint64

Size	Availability	Doc Cost
1	v2	1

Description

A plus B as a 128-bit result. X is the carry-bit, Y is the low-order 64 bits.

Groups

Arithmetic

0x1f

divmodw

uint64

Size	Availability	Doc Cost
1	v4	20

Description

W,X = (A,B / C,D); Y,Z = (A,B modulo C,D)

Groups

Arithmetic

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.

0x20

intcblock

Size	Availability	Doc Cost
0	v1	1

Description

prepare block of uint64 constants for use by intc

Groups

Loading Values

Notes

`intcblock` 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 Notes

Comment	Encoding	Name
a block of int constant values	varuint count, [varuint ...]	UINT ...

0x21

intc

uint64

Size	Availability	Doc Cost
2	v1	1

Description

Ith constant from intcblock

Groups

Loading Values

Immediate Notes

Comment	Encoding	Name
an index in the intcblock	uint8	I

0x22

intc_0

uint64

Size	Availability	Doc Cost
1	v1	1

Description

constant 0 from intcblock

Groups

Loading Values

0x23

intc_1

uint64

Size	Availability	Doc Cost
1	v1	1

Description

constant 1 from intcblock

Groups

Loading Values

0x24

intc_2

uint64

Size	Availability	Doc Cost
1	v1	1

Description

constant 2 from intcblock

Groups

Loading Values

0x25

intc_3

uint64

Size	Availability	Doc Cost
1	v1	1

Description

constant 3 from intcblock

Groups

Loading Values

0x26

bytecblock

Size	Availability	Doc Cost
0	v1	1

Description

prepare block of byte-array constants for use by bytec

Groups

Loading Values

Notes

`bytecblock` 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 Notes

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

0x27

bytec

[]byte

Size	Availability	Doc Cost
2	v1	1

Description

Ith constant from bytecblock

Groups

Loading Values

Immediate Notes

Comment	Encoding	Name
an index in the bytecblock	uint8	I

0x28

bytec_0

[]byte

Size	Availability	Doc Cost
1	v1	1

Description

constant 0 from bytecblock

Groups

Loading Values

0x29

bytec_1

[]byte

Size	Availability	Doc Cost
1	v1	1

Description

constant 1 from bytecblock

Groups

Loading Values

0x2a

bytec_2

[]byte

Size	Availability	Doc Cost
1	v1	1

Description

constant 2 from bytecblock

Groups

Loading Values

0x2b

bytec_3

[]byte

Size	Availability	Doc Cost
1	v1	1

Description

constant 3 from bytecblock

Groups

Loading Values

0x2c

arg

[]byte

Size	Availability	Doc Cost
2	v1	1

Description

Nth LogicSig argument

Groups

Loading Values

Immediate Notes

Comment	Encoding	Name
an arg index	uint8	N

0x2d

arg_0

[]byte

Size	Availability	Doc Cost
1	v1	1

Description

LogicSig argument 0

Groups

Loading Values

0x2e

arg_1

[]byte

Size	Availability	Doc Cost
1	v1	1

Description

LogicSig argument 1

Groups

Loading Values

0x2f

arg_2

[]byte

Size	Availability	Doc Cost
1	v1	1

Description

LogicSig argument 2

Groups

Loading Values

0x30

arg_3

[]byte

Size	Availability	Doc Cost
1	v1	1

Description

LogicSig argument 3

Groups

Loading Values

0x31

txn

any

Size	Availability	Doc Cost
2	v1	1

Description

field F of current transaction

Groups

Loading Values

Immediate Notes

Comment	Encoding	Name	Reference
transaction field index	uint8	F	txn

Argument Details

Index	Argument	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	[]byte
64	ApprovalProgramPages	[]byte
65	NumApprovalProgramPages	uint64
66	ClearStateProgramPages	[]byte
67	NumClearStateProgramPages	uint64

0x32

global

any

Size	Availability	Doc Cost
2	v1	1

Description

global field F

Groups

Loading Values

Immediate Notes

Comment	Encoding	Name	Reference
a global field index	uint8	F	global

Argument Details

Index	Argument	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

0x33

gtxn

any

Size	Availability	Doc Cost
3	v1	1

Description

field F of the Tth transaction in the current group

Groups

Loading Values

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`.

Immediate Notes

Comment	Encoding	Name	Reference
transaction group index	uint8	T
transaction field index	uint8	F	txn

Argument Details

Index	Argument	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	[]byte
64	ApprovalProgramPages	[]byte
65	NumApprovalProgramPages	uint64
66	ClearStateProgramPages	[]byte
67	NumClearStateProgramPages	uint64

0x34

load

any

Size	Availability	Doc Cost
2	v1	1

Description

Ith scratch space value. All scratch spaces are 0 at program start.

Groups

Loading Values

Immediate Notes

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

0x35

store

any

Size	Availability	Doc Cost
2	v1	1

Description

store A to the Ith scratch space

Groups

Loading Values

Immediate Notes

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

0x36

txna

any

Size	Availability	Doc Cost
3	v2	1

Description

Ith value of the array field F of the current transaction `txna` can be called using `txn` with 2 immediates.

Groups

Loading Values

Immediate Notes

Comment	Encoding	Name	Reference
transaction field index	uint8	F	txna
transaction field array index	uint8	I

Argument Details

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

0x37

gtxna

any

Size	Availability	Doc Cost
4	v2	1

Description

Ith value of the array field F from the Tth transaction in the current group `gtxna` can be called using `gtxn` with 3 immediates.

Groups

Loading Values

Immediate Notes

Comment	Encoding	Name	Reference
transaction group index	uint8	T
transaction field index	uint8	F	txna
transaction field array index	uint8	I

Argument Details

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

0x38

gtxns

uint64

any

Size	Availability	Doc Cost
2	v3	1

Description

field F of the Ath transaction in the current group

Groups

Loading Values

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.

Immediate Notes

Comment	Encoding	Name	Reference
transaction field index	uint8	F	txn

Argument Details

Index	Argument	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	[]byte
64	ApprovalProgramPages	[]byte
65	NumApprovalProgramPages	uint64
66	ClearStateProgramPages	[]byte
67	NumClearStateProgramPages	uint64

0x39

gtxnsa

uint64

any

Size	Availability	Doc Cost
3	v3	1

Description

Ith value of the array field F from the Ath transaction in the current group `gtxnsa` can be called using `gtxns` with 2 immediates.

Groups

Loading Values

Immediate Notes

Comment	Encoding	Name	Reference
transaction field index	uint8	F	txna
transaction field array index	uint8	I

Argument Details

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

0x3a

gload

any

Size	Availability	Doc Cost
3	v4	1

Description

Ith scratch space value of the Tth transaction in the current group

Groups

Loading Values

Notes

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

Immediate Notes

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

0x3b

gloads

uint64

any

Size	Availability	Doc Cost
2	v4	1

Description

Ith scratch space value of the Ath transaction in the current group

Groups

Loading Values

Notes

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

Immediate Notes

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

0x3c

gaid

uint64

Size	Availability	Doc Cost
2	v4	1

Description

ID of the asset or application created in the Tth transaction of the current group

Groups

Loading Values

Notes

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

Immediate Notes

Comment	Encoding	Name
transaction group index	uint8	T

0x3d

gaids

uint64

Size	Availability	Doc Cost
1	v4	1

Description

ID of the asset or application created in the Ath transaction of the current group

Groups

Loading Values

Notes

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

0x3e

loads

uint64

any

Size	Availability	Doc Cost
1	v5	1

Description

Ath scratch space value. All scratch spaces are 0 at program start.

Groups

Loading Values

0x3f

stores

uint64

any

Size	Availability	Doc Cost
1	v5	1

Description

store B to the Ath scratch space

Groups

Loading Values

0x40

bnz

uint64

Size	Availability	Doc Cost
3	v1	1

Description

branch to TARGET if value A is not zero

Groups

Flow Control

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 Notes

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

0x41

uint64

Size	Availability	Doc Cost
3	v2	1

Description

branch to TARGET if value A is zero

Groups

Flow Control

Notes

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

Immediate Notes

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

0x42

Size	Availability	Doc Cost
3	v2	1

Description

branch unconditionally to TARGET

Groups

Flow Control

Notes

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

Immediate Notes

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

0x43

return

uint64

Size	Availability	Doc Cost
1	v2	1

Description

use A as success value; end

Groups

Flow Control

0x44

assert

uint64

Size	Availability	Doc Cost
1	v3	1

Description

immediately fail unless A is a non-zero number

Groups

Flow Control

0x45

bury

any

Size	Availability	Doc Cost
2	v8	1

Description

replace the Nth value from the top of the stack with A. bury 0 fails.

Groups

Flow Control

Immediate Notes

Comment	Encoding	Name
depth	uint8	N

0x46

popn

Size	Availability	Doc Cost
2	v8	1

Description

remove N values from the top of the stack

Groups

Flow Control

Immediate Notes

Comment	Encoding	Name
stack depth	uint8	N

0x47

dupn

any

Size	Availability	Doc Cost
2	v8	1

Description

duplicate A, N times

Groups

Flow Control

Immediate Notes

Comment	Encoding	Name
copy count	uint8	N

0x48

pop

any

Size	Availability	Doc Cost
1	v1	1

Description

discard A

Groups

Flow Control

0x49

dup

any

Size	Availability	Doc Cost
1	v1	1

Description

duplicate A

Groups

Flow Control

0x4a

dup2

any

Size	Availability	Doc Cost
1	v2	1

Description

duplicate A and B

Groups

Flow Control

0x4b

dig

any

Size	Availability	Doc Cost
2	v3	1

Description

Nth value from the top of the stack. dig 0 is equivalent to dup

Groups

Flow Control

Immediate Notes

Comment	Encoding	Name
depth	uint8	N

0x4c

swap

any

Size	Availability	Doc Cost
1	v3	1

Description

swaps A and B on stack

Groups

Flow Control

0x4d

select

any

uint64

any

Size	Availability	Doc Cost
1	v3	1

Description

selects one of two values based on top-of-stack: B if C != 0, else A

Groups

Flow Control

0x4e

cover

any

Size	Availability	Doc Cost
2	v5	1

Description

remove top of stack, and place it deeper in the stack such that N elements are above it. Fails if stack depth <= N.

Groups

Flow Control

Immediate Notes

Comment	Encoding	Name
depth	uint8	N

0x4f

uncover

any

Size	Availability	Doc Cost
2	v5	1

Description

remove the value at depth N in the stack and shift above items down so the Nth deep value is on top of the stack. Fails if stack depth <= N.

Groups

Flow Control

Immediate Notes

Comment	Encoding	Name
depth	uint8	N

0x50

concat

[]byte

Size	Availability	Doc Cost
1	v2	1

Description

join A and B

Groups

Byte Array Manipulation

Notes

`concat` fails if the result would be greater than 4096 bytes.

0x51

substring

[]byte

Size	Availability	Doc Cost
3	v2	1

Description

A range of bytes from A starting at S up to but not including E. If E < S, or either is larger than the array length, the program fails

Groups

Byte Array Manipulation

Immediate Notes

Comment	Encoding	Name
start position	uint8	S
end position	uint8	E

0x52

substring3

[]byte

uint64

[]byte

Size	Availability	Doc Cost
1	v2	1

Description

A range of bytes from A starting at B up to but not including C. If C < B, or either is larger than the array length, the program fails

Groups

Byte Array Manipulation

0x53

getbit

any

uint64

Size	Availability	Doc Cost
1	v3	1

Description

Bth bit of (byte-array or integer) A. If B is greater than or equal to the bit length of the value (8*byte length), the program fails

Groups

Byte Array Manipulation

Notes

see explanation of bit ordering in setbit

0x54

setbit

any

uint64

any

Size	Availability	Doc Cost
1	v3	1

Description

Copy of (byte-array or integer) A, with the Bth bit set to (0 or 1) C. If B is greater than or equal to the bit length of the value (8*byte length), the program fails

Groups

Byte Array Manipulation

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.

0x55

getbyte

[]byte

uint64

Size	Availability	Doc Cost
1	v3	1

Description

Bth byte of A, as an integer. If B is greater than or equal to the array length, the program fails

Groups

Byte Array Manipulation

0x56

setbyte

[]byte

uint64

[]byte

Size	Availability	Doc Cost
1	v3	1

Description

Copy of A with the Bth byte set to small integer (between 0..255) C. If B is greater than or equal to the array length, the program fails

Groups

Byte Array Manipulation

0x57

extract

[]byte

Size	Availability	Doc Cost
3	v5	1

Description

A range of bytes from A starting at S up to but not including S+L. If L is 0, then extract to the end of the string. If S or S+L is larger than the array length, the program fails

Groups

Byte Array Manipulation

Immediate Notes

Comment	Encoding	Name
start position	uint8	S
length	uint8	L

0x58

extract3

[]byte

uint64

[]byte

Size	Availability	Doc Cost
1	v5	1

Description

A range of bytes from A starting at B up to but not including B+C. If B+C is larger than the array length, the program fails `extract3` can be called using `extract` with no immediates.

Groups

Byte Array Manipulation

0x59

extract_uint16

[]byte

uint64

Size	Availability	Doc Cost
1	v5	1

Description

A uint16 formed from a range of big-endian bytes from A starting at B up to but not including B+2. If B+2 is larger than the array length, the program fails

Groups

Byte Array Manipulation

0x5a

extract_uint32

[]byte

uint64

Size	Availability	Doc Cost
1	v5	1

Description

A uint32 formed from a range of big-endian bytes from A starting at B up to but not including B+4. If B+4 is larger than the array length, the program fails

Groups

Byte Array Manipulation

0x5b

extract_uint64

[]byte

uint64

Size	Availability	Doc Cost
1	v5	1

Description

A uint64 formed from a range of big-endian bytes from A starting at B up to but not including B+8. If B+8 is larger than the array length, the program fails

Groups

Byte Array Manipulation

0x5c

replace2

[]byte

Size	Availability	Doc Cost
2	v7	1

Description

Copy of A with the bytes starting at S replaced by the bytes of B. Fails if S+len(B) exceeds len(A) `replace2` can be called using `replace` with 1 immediate.

Groups

Byte Array Manipulation

Immediate Notes

Comment	Encoding	Name
start position	uint8	S

0x5d

replace3

[]byte

uint64

[]byte

Size	Availability	Doc Cost
1	v7	1

Description

Copy of A with the bytes starting at B replaced by the bytes of C. Fails if B+len(C) exceeds len(A) `replace3` can be called using `replace` with no immediates.

Groups

Byte Array Manipulation

0x5e

base64_decode

[]byte

Size	Availability	Doc Cost
2	v7	1 + 1 per 16 bytes of A

Description

decode A which was base64-encoded using _encoding_ E. Fail if A is not base64 encoded with encoding E

Groups

Byte Array Manipulation

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](https://rfc-editor.org/rfc/rfc4648.html#section-4). 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`.

Immediate Notes

Comment	Encoding	Name	Reference
encoding index	uint8	E	base64

Argument Details

Index	Argument	Type
0	URLEncoding	any
1	StdEncoding	any

0x5f

json_ref

[]byte

any

Size	Availability	Doc Cost
2	v7	25 + 2 per 7 bytes of A

Description

key B's value, of type R, from a [valid](jsonspec.md) utf-8 encoded json object A

Groups

Byte Array Manipulation

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](https://arc.algorand.foundation/ARCs/arc-0004). This opcode should only be used in cases where JSON is only available option, e.g. when a third-party only signs JSON.

Immediate Notes

Comment	Encoding	Name	Reference
return type index	uint8	R	json_ref

Argument Details

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

0x60

balance

any

uint64

Size	Availability	Doc Cost
1	v2	1

Description

balance for account A, in microalgos. The balance is observed after the effects of previous transactions in the group, and after the fee for the current transaction is deducted. Changes caused by inner transactions are observable immediately following `itxn_submit`

Groups

State Access

Notes

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

0x61

app_opted_in

any

uint64

bool

Size	Availability	Doc Cost
1	v2	1

Description

1 if account A is opted in to application B, else 0

Groups

State Access

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.

0x62

app_local_get

any

stateKey

any

Size	Availability	Doc Cost
1	v2	1

Description

local state of the key B in the current application in account A

Groups

State Access

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.

0x63

app_local_get_ex

any

uint64

stateKey

any

bool

Size	Availability	Doc Cost
1	v2	1

Description

X is the local state of application B, key C in account A. Y is 1 if key existed, else 0

Groups

State Access

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.

0x64

app_global_get

stateKey

any

Size	Availability	Doc Cost
1	v2	1

Description

global state of the key A in the current application

Groups

State Access

Notes

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

0x65

app_global_get_ex

uint64

stateKey

any

bool

Size	Availability	Doc Cost
1	v2	1

Description

X is the global state of application A, key B. Y is 1 if key existed, else 0

Groups

State Access

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.

0x66

app_local_put

any

stateKey

any

Size	Availability	Doc Cost
1	v2	1

Description

write C to key B in account A's local state of the current application

Groups

State Access

Notes

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

0x67

app_global_put

stateKey

any

Size	Availability	Doc Cost
1	v2	1

Description

write B to key A in the global state of the current application

Groups

State Access

0x68

app_local_del

any

stateKey

Size	Availability	Doc Cost
1	v2	1

Description

delete key B from account A's local state of the current application

Groups

State Access

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.)

0x69

app_global_del

stateKey

Size	Availability	Doc Cost
1	v2	1

Description

delete key A from the global state of the current application

Groups

State Access

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.)

0x70

asset_holding_get

any

uint64

any

bool

Size	Availability	Doc Cost
2	v2	1

Description

X is field F from account A's holding of asset B. Y is 1 if A is opted into B, else 0

Groups

State Access

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.

Immediate Notes

Comment	Encoding	Name	Reference
asset holding field index	uint8	F	asset_holding

Argument Details

Index	Argument	Type
0	AssetBalance	uint64
1	AssetFrozen	bool

0x71

asset_params_get

uint64

any

bool

Size	Availability	Doc Cost
2	v2	1

Description

X is field F from asset A. Y is 1 if A exists, else 0

Groups

State Access

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.

Immediate Notes

Comment	Encoding	Name	Reference
asset params field index	uint8	F	asset_params

Argument Details

Index	Argument	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

0x72

app_params_get

uint64

any

bool

Size	Availability	Doc Cost
2	v5	1

Description

X is field F from app A. Y is 1 if A exists, else 0

Groups

State Access

Notes

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

Immediate Notes

Comment	Encoding	Name	Reference
app params field index	uint8	F	app_params

Argument Details

Index	Argument	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

0x73

acct_params_get

any

bool

Size	Availability	Doc Cost
2	v6	1

Description

X is field F from account A. Y is 1 if A owns positive algos, else 0

Groups

State Access

Immediate Notes

Comment	Encoding	Name	Reference
account params field index	uint8	F	acct_params

Argument Details

Index	Argument	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

0x74

voter_params_get

any

bool

Size	Availability	Doc Cost
2	v11	1

Description

X is field F from online account A as of the balance round: 320 rounds before the current round. Y is 1 if A had positive algos online in the agreement round, else Y is 0 and X is a type specific zero-value

Groups

State Access

Immediate Notes

Comment	Encoding	Name	Reference
voter params field index	uint8	F	voter_params

0x75

online_stake

uint64

Size	Availability	Doc Cost
1	v11	1

Description

the total online stake in the agreement round

Groups

State Access

0x78

min_balance

any

uint64

Size	Availability	Doc Cost
1	v3	1

Description

minimum required balance for account A, in microalgos. Required balance is affected by ASA, App, and Box usage. When creating or opting into an app, the minimum balance grows before the app code runs, therefore the increase is visible there. When deleting or closing out, the minimum balance decreases after the app executes. Changes caused by inner transactions or box usage are observable immediately following the opcode effecting the change.

Groups

State Access

Notes

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

0x80

pushbytes

[]byte

Size	Availability	Doc Cost
0	v3	1

Description

immediate BYTES

Groups

Loading Values

Notes

pushbytes args are not added to the bytecblock during assembly processes

Immediate Notes

Comment	Encoding	Name
a byte constant	varuint length, bytes	BYTES

0x81

pushint

uint64

Size	Availability	Doc Cost
0	v3	1

Description

immediate UINT

Groups

Loading Values

Notes

pushint args are not added to the intcblock during assembly processes

Immediate Notes

Comment	Encoding	Name
an int constant	varuint	UINT

0x82

pushbytess

Size	Availability	Doc Cost
0	v8	1

Description

push sequences of immediate byte arrays to stack (first byte array being deepest)

Groups

Loading Values

Notes

pushbytess args are not added to the bytecblock during assembly processes

Immediate Notes

Comment	Encoding	Name
a list of byte constants	varuint count, [varuint length, bytes ...]	BYTES ...

0x83

pushints

Size	Availability	Doc Cost
0	v8	1

Description

push sequence of immediate uints to stack in the order they appear (first uint being deepest)

Groups

Loading Values

Notes

pushints args are not added to the intcblock during assembly processes

Immediate Notes

Comment	Encoding	Name
a list of int constants	varuint count, [varuint ...]	UINT ...

0x84

ed25519verify_bare

[]byte

[64]byte

[32]byte

bool

Size	Availability	Doc Cost
1	v7	1900

Description

for (data A, signature B, pubkey C) verify the signature of the data against the pubkey => {0 or 1}

Groups

Cryptography

0x88

callsub

Size	Availability	Doc Cost
3	v4	1

Description

branch unconditionally to TARGET, saving the next instruction on the call stack

Groups

Flow Control

Notes

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

Immediate Notes

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

0x89

retsub

Size	Availability	Doc Cost
1	v4	1

Description

pop the top instruction from the call stack and branch to it

Groups

Flow Control

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.

0x8a

proto

Size	Availability	Doc Cost
3	v8	1

Description

Prepare top call frame for a retsub that will assume A args and R return values.

Groups

Flow Control

Notes

Fails unless the last instruction executed was a `callsub`.

Immediate Notes

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

0x8b

frame_dig

any

Size	Availability	Doc Cost
2	v8	1

Description

Nth (signed) value from the frame pointer.

Groups

Flow Control

Immediate Notes

Comment	Encoding	Name
frame slot	int8	I

0x8c

frame_bury

any

Size	Availability	Doc Cost
2	v8	1

Description

replace the Nth (signed) value from the frame pointer in the stack with A

Groups

Flow Control

Immediate Notes

Comment	Encoding	Name
frame slot	int8	I

0x8d

switch

uint64

Size	Availability	Doc Cost
0	v8	1

Description

branch to the Ath label. Continue at following instruction if index A exceeds the number of labels.

Groups

Flow Control

Immediate Notes

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

0x8e

match

Size	Availability	Doc Cost
0	v8	1

Description

given match cases from A[1] to A[N], branch to the Ith label where A[I] = B. Continue to the following instruction if no matches are found.

Groups

Flow Control

Notes

`match` 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 Notes

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

0x90

shl

uint64

Size	Availability	Doc Cost
1	v4	1

Description

A times 2^B, modulo 2^64

Groups

Arithmetic

0x91

shr

uint64

Size	Availability	Doc Cost
1	v4	1

Description

A divided by 2^B

Groups

Arithmetic

0x92

sqrt

uint64

Size	Availability	Doc Cost
1	v4	4

Description

The largest integer I such that I^2 <= A

Groups

Arithmetic

0x93

bitlen

any

uint64

Size	Availability	Doc Cost
1	v4	1

Description

The highest set bit in A. If A is a byte-array, it is interpreted as a big-endian unsigned integer. bitlen of 0 is 0, bitlen of 8 is 4

Groups

Arithmetic

Notes

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

0x94

exp

uint64

Size	Availability	Doc Cost
1	v4	1

Description

A raised to the Bth power. Fail if A == B == 0 and on overflow

Groups

Arithmetic

0x95

expw

uint64

Size	Availability	Doc Cost
1	v4	10

Description

A raised to the Bth power as a 128-bit result in two uint64s. X is the high 64 bits, Y is the low. Fail if A == B == 0 or if the results exceeds 2^128-1

Groups

Arithmetic

0x96

bsqrt

bigint

Size	Availability	Doc Cost
1	v6	40

Description

The largest integer I such that I^2 <= A. A and I are interpreted as big-endian unsigned integers

Groups

Byte Array Arithmetic

0x97

divw

uint64

Size	Availability	Doc Cost
1	v6	1

Description

A,B / C. Fail if C == 0 or if result overflows.

Groups

Arithmetic

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.

0x98

sha3_256

[]byte

[32]byte

Size	Availability	Doc Cost
1	v7	130

Description

SHA3_256 hash of value A, yields [32]byte

Groups

Cryptography

0xa0

bigint

[]byte

Size	Availability	Doc Cost
1	v4	10

Description

A plus B. A and B are interpreted as big-endian unsigned integers

Groups

Byte Array Arithmetic

0xa1

bigint

Size	Availability	Doc Cost
1	v4	10

Description

A minus B. A and B are interpreted as big-endian unsigned integers. Fail on underflow.

Groups

Byte Array Arithmetic

0xa2

bigint

Size	Availability	Doc Cost
1	v4	20

Description

A divided by B (truncated division). A and B are interpreted as big-endian unsigned integers. Fail if B is zero.

Groups

Byte Array Arithmetic

0xa3

bigint

[]byte

Size	Availability	Doc Cost
1	v4	20

Description

A times B. A and B are interpreted as big-endian unsigned integers.

Groups

Byte Array Arithmetic

0xa4

bigint

bool

Size	Availability	Doc Cost
1	v4	1

Description

1 if A is less than B, else 0. A and B are interpreted as big-endian unsigned integers

Groups

Byte Array Arithmetic

0xa5

bigint

bool

Size	Availability	Doc Cost
1	v4	1

Description

1 if A is greater than B, else 0. A and B are interpreted as big-endian unsigned integers

Groups

Byte Array Arithmetic

0xa6

b<=

bigint

bool

Size	Availability	Doc Cost
1	v4	1

Description

1 if A is less than or equal to B, else 0. A and B are interpreted as big-endian unsigned integers

Groups

Byte Array Arithmetic

0xa7

b>=

bigint

bool

Size	Availability	Doc Cost
1	v4	1

Description

1 if A is greater than or equal to B, else 0. A and B are interpreted as big-endian unsigned integers

Groups

Byte Array Arithmetic

0xa8

b==

bigint

bool

Size	Availability	Doc Cost
1	v4	1

Description

1 if A is equal to B, else 0. A and B are interpreted as big-endian unsigned integers

Groups

Byte Array Arithmetic

0xa9

b!=

bigint

bool

Size	Availability	Doc Cost
1	v4	1

Description

0 if A is equal to B, else 1. A and B are interpreted as big-endian unsigned integers

Groups

Byte Array Arithmetic

0xaa

bigint

Size	Availability	Doc Cost
1	v4	20

Description

A modulo B. A and B are interpreted as big-endian unsigned integers. Fail if B is zero.

Groups

Byte Array Arithmetic

0xab

[]byte

Size	Availability	Doc Cost
1	v4	6

Description

A bitwise-or B. A and B are zero-left extended to the greater of their lengths

Groups

Byte Array Logic

0xac

[]byte

Size	Availability	Doc Cost
1	v4	6

Description

A bitwise-and B. A and B are zero-left extended to the greater of their lengths

Groups

Byte Array Logic

0xad

[]byte

Size	Availability	Doc Cost
1	v4	6

Description

A bitwise-xor B. A and B are zero-left extended to the greater of their lengths

Groups

Byte Array Logic

0xae

[]byte

Size	Availability	Doc Cost
1	v4	4

Description

A with all bits inverted

Groups

Byte Array Logic

0xaf

bzero

uint64

[]byte

Size	Availability	Doc Cost
1	v4	1

Description

zero filled byte-array of length A

Groups

Loading Values

0xb0

log

[]byte

Size	Availability	Doc Cost
1	v5	1

Description

write A to log state of the current application

Groups

State Access

Notes

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

0xb1

itxn_begin

Size	Availability	Doc Cost
1	v5	1

Description

begin preparation of a new inner transaction in a new transaction group

Groups

Inner Transactions

Notes

`itxn_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.

0xb2

itxn_field

any

Size	Availability	Doc Cost
2	v5	1

Description

set field F of the current inner transaction to A

Groups

Inner Transactions

Notes

`itxn_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_.)

Immediate Notes

Comment	Encoding	Name	Reference
transaction field index	uint8	F	txn

Argument Details

Index	Argument	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	[]byte
49	ApprovalProgramPages	[]byte
50	ClearStateProgramPages	[]byte

0xb3

itxn_submit

Size	Availability	Doc Cost
1	v5	1

Description

execute the current inner transaction group. Fail if executing this group would exceed the inner transaction limit, or if any transaction in the group fails.

Groups

Inner Transactions

Notes

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

0xb4

itxn

any

Size	Availability	Doc Cost
2	v5	1

Description

field F of the last inner transaction

Groups

Inner Transactions

Immediate Notes

Comment	Encoding	Name	Reference
transaction field index	uint8	F	txn

Argument Details

Index	Argument	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	[]byte
64	ApprovalProgramPages	[]byte
65	NumApprovalProgramPages	uint64
66	ClearStateProgramPages	[]byte
67	NumClearStateProgramPages	uint64

0xb5

itxna

any

Size	Availability	Doc Cost
3	v5	1

Description

Ith value of the array field F of the last inner transaction

Groups

Inner Transactions

Immediate Notes

Comment	Encoding	Name	Reference
transaction field index	uint8	F	txna
a transaction field array index	uint8	I

Argument Details

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

0xb6

itxn_next

Size	Availability	Doc Cost
1	v6	1

Description

begin preparation of a new inner transaction in the same transaction group

Groups

Inner Transactions

Notes

`itxn_next` initializes the transaction exactly as `itxn_begin` does

0xb7

gitxn

any

Size	Availability	Doc Cost
3	v6	1

Description

field F of the Tth transaction in the last inner group submitted

Groups

Inner Transactions

Immediate Notes

Comment	Encoding	Name	Reference
transaction group index	uint8	T
transaction field index	uint8	F	txn

Argument Details

Index	Argument	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	[]byte
64	ApprovalProgramPages	[]byte
65	NumApprovalProgramPages	uint64
66	ClearStateProgramPages	[]byte
67	NumClearStateProgramPages	uint64

0xb8

gitxna

any

Size	Availability	Doc Cost
4	v6	1

Description

Ith value of the array field F from the Tth transaction in the last inner group submitted

Groups

Inner Transactions

Immediate Notes

Comment	Encoding	Name	Reference
transaction group index	uint8	T
transaction field index	uint8	F	txna
transaction field array index	uint8	I

Argument Details

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

0xb9

box_create

boxName

uint64

bool

Size	Availability	Doc Cost
1	v8	1

Description

create a box named A, of length B. Fail if the name A is empty or B exceeds 32,768. Returns 0 if A already existed, else 1

Groups

Box Access

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`.

0xba

box_extract

boxName

uint64

[]byte

Size	Availability	Doc Cost
1	v8	1

Description

read C bytes from box A, starting at offset B. Fail if A does not exist, or the byte range is outside A's size.

Groups

Box Access

0xbb

box_replace

boxName

uint64

[]byte

Size	Availability	Doc Cost
1	v8	1

Description

write byte-array C into box A, starting at offset B. Fail if A does not exist, or the byte range is outside A's size.

Groups

Box Access

0xbc

box_del

boxName

bool

Size	Availability	Doc Cost
1	v8	1

Description

delete box named A if it exists. Return 1 if A existed, 0 otherwise

Groups

Box Access

0xbd

box_len

boxName

uint64

bool

Size	Availability	Doc Cost
1	v8	1

Description

X is the length of box A if A exists, else 0. Y is 1 if A exists, else 0.

Groups

Box Access

0xbe

box_get

boxName

[]byte

bool

Size	Availability	Doc Cost
1	v8	1

Description

X is the contents of box A if A exists, else ''. Y is 1 if A exists, else 0.

Groups

Box Access

Notes

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

0xbf

box_put

boxName

[]byte

Size	Availability	Doc Cost
1	v8	1

Description

replaces the contents of box A with byte-array B. Fails if A exists and len(B) != len(box A). Creates A if it does not exist

Groups

Box Access

Notes

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

0xc0

txnas

uint64

any

Size	Availability	Doc Cost
2	v5	1

Description

Ath value of the array field F of the current transaction

Groups

Loading Values

Immediate Notes

Comment	Encoding	Name	Reference
transaction field index	uint8	F	txna

Argument Details

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

0xc1

gtxnas

uint64

any

Size	Availability	Doc Cost
3	v5	1

Description

Ath value of the array field F from the Tth transaction in the current group

Groups

Loading Values

Immediate Notes

Comment	Encoding	Name	Reference
transaction group index	uint8	T
transaction field index	uint8	F	txna

Argument Details

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

0xc2

gtxnsas

uint64

any

Size	Availability	Doc Cost
2	v5	1

Description

Bth value of the array field F from the Ath transaction in the current group

Groups

Loading Values

Immediate Notes

Comment	Encoding	Name	Reference
transaction field index	uint8	F	txna

Argument Details

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

0xc3

args

uint64

[]byte

Size	Availability	Doc Cost
1	v5	1

Description

Ath LogicSig argument

Groups

Loading Values

0xc4

gloadss

uint64

any

Size	Availability	Doc Cost
1	v6	1

Description

Bth scratch space value of the Ath transaction in the current group

Groups

Loading Values

0xc5

itxnas

uint64

any

Size	Availability	Doc Cost
2	v6	1

Description

Ath value of the array field F of the last inner transaction

Groups

Inner Transactions

Immediate Notes

Comment	Encoding	Name	Reference
transaction field index	uint8	F	txna

0xc6

gitxnas

uint64

any

Size	Availability	Doc Cost
3	v6	1

Description

Ath value of the array field F from the Tth transaction in the last inner group submitted

Groups

Inner Transactions

Immediate Notes

Comment	Encoding	Name	Reference
transaction group index	uint8	T
transaction field index	uint8	F	txna

0xd0

vrf_verify

[]byte

[80]byte

[32]byte

[64]byte

bool

Size	Availability	Doc Cost
2	v7	5700

Description

Verify the proof B of message A against pubkey C. Returns vrf output and verification flag.

Groups

Cryptography

Notes

`VrfAlgorand` is the VRF used in Algorand. It is ECVRF-ED25519-SHA512-Elligator2, specified in the IETF internet draft [draft-irtf-cfrg-vrf-03](https://datatracker.ietf.org/doc/draft-irtf-cfrg-vrf/03/).

Immediate Notes

Comment	Encoding	Name	Reference
parameters index	uint8	S	vrf_verify

0xd1

block

uint64

any

Size	Availability	Doc Cost
2	v7	1

Description

field F of block A. Fail unless A falls between txn.LastValid-1002 and txn.FirstValid (exclusive)

Groups

State Access

Immediate Notes

Comment	Encoding	Name	Reference
block field index	uint8	F	block

Argument Details

Index	Argument	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

0xd2

box_splice

boxName

uint64

[]byte

Size	Availability	Doc Cost
1	v10	1

Description

set box A to contain its previous bytes up to index B, followed by D, followed by the original bytes of A that began at index B+C.

Groups

Box Access

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.

0xd3

box_resize

boxName

uint64

Size	Availability	Doc Cost
1	v10	1

Description

change the size of box named A to be of length B, adding zero bytes to end or removing bytes from the end, as needed. Fail if the name A is empty, A is not an existing box, or B exceeds 32,768.

Groups

Box Access

0xe0

ec_add

[]byte

Size	Availability	Doc Cost
2	v10	BN254g1=125; BN254g2=170; BLS12_381g1=205; BLS12_381g2=290

Description

for curve points A and B, return the curve point A + B

Groups

Cryptography

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 Notes

Comment	Encoding	Name	Reference
curve index	uint8	G	EC

0xe1

ec_scalar_mul

[]byte

Size	Availability	Doc Cost
2	v10	BN254g1=1810; BN254g2=3430; BLS12_381g1=2950; BLS12_381g2=6530

Description

for curve point A and scalar B, return the curve point BA, the point A multiplied by the scalar B.

Groups

Cryptography

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 Notes

Comment	Encoding	Name	Reference
curve index	uint8	G	EC

0xe2

ec_pairing_check

[]byte

bool

Size	Availability	Doc Cost
2	v10	BN254g1=8000 + 7400 per 64 bytes of B; BN254g2=8000 + 7400 per 128 bytes of B; BLS12_381g1=13000 + 10000 per 96 bytes of B; BLS12_381g2=13000 + 10000 per 192 bytes of B

Description

1 if the product of the pairing of each point in A with its respective point in B is equal to the identity element of the target group Gt, else 0

Groups

Cryptography

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 Notes

Comment	Encoding	Name	Reference
curve index	uint8	G	EC

0xe3

ec_multi_scalar_mul

[]byte

Size	Availability	Doc Cost
2	v10	BN254g1=3600 + 90 per 32 bytes of B; BN254g2=7200 + 270 per 32 bytes of B; BLS12_381g1=6500 + 95 per 32 bytes of B; BLS12_381g2=14850 + 485 per 32 bytes of B

Description

for curve points A and scalars B, return curve point B0A0 + B1A1 + B2A2 + ... + BnAn

Groups

Cryptography

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 Notes

Comment	Encoding	Name	Reference
curve index	uint8	G	EC

0xe4

ec_subgroup_check

[]byte

bool

Size	Availability	Doc Cost
2	v10	BN254g1=20; BN254g2=3100; BLS12_381g1=1850; BLS12_381g2=2340

Description

1 if A is in the main prime-order subgroup of G (including the point at infinity) else 0. Program fails if A is not in G at all.

Groups

Cryptography

Immediate Notes

Comment	Encoding	Name	Reference
curve index	uint8	G	EC

0xe5

ec_map_to

[]byte

Size	Availability	Doc Cost
2	v10	BN254g1=630; BN254g2=3300; BLS12_381g1=1950; BLS12_381g2=8150

Description

maps field element A to group G

Groups

Cryptography

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 Notes

Comment	Encoding	Name	Reference
curve index	uint8	G	EC

0xe6

mimc

[]byte

[32]byte

Size	Availability	Doc Cost
2	v11	BN254Mp110=10 + 550 per 32 bytes of A; BLS12_381Mp111=10 + 550 per 32 bytes of A

Description

MiMC hash of scalars A, using curve and parameters specified by configuration C

Groups

Cryptography

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 Notes

Comment	Encoding	Name	Reference
configuration index	uint8	C	Mimc Configurations