Assembly

Constraint

All operations available to the constraint checker. Note that this is a subset of the operations available to state read execution.

Stack

Operations related to stack manipulation.

Name	Stack In	Stack Out	Panics	Description
Push: 0x1 arg bytes: 8		value		Push one word onto the stack.
Pop: 0x2	a			Pop one word from the stack.
Dup: 0x3	value	value, value		Duplicate the top word on the stack.
DupFrom: 0x4	index	value_i		Duplicate the word at the given stack depth index. `0` is the index of the element at the top of the stack.
Swap: 0x5	a, b	b, a		Swap top two words on stack.
SwapIndex: 0x6	a, b, c, d, index	a, d, c, b	Index is out of range.	Swap the top word on the stack with the word at the given stack depth index. `0` is the index of the element at the top of the stack.
Select: 0x7	a, b, cond	b		Conditionally keep one of the top two elements on the stack. If condition is `true`, the top element is kept.
SelectRange: 0x8	arr_a_0, ..arr_a_N, arr_b_0, ..arr_b_N, len, cond	arr_b_0, ..arr_b_N		Conditionally keep one of the top two ranges on the stack. If condition is `true`, the top range is kept. The ranges must be of equal length. The ranges must be stacked sequentially. Here `N` is `len -1`.
Repeat: 0x9	num_repeats, count_up_bool			Repeat a section of code the number of times. Takes a boolean to either count from 0 up or from the number of repeats down to 0.
RepeatEnd: 0xA			If there is no counter on the repeat stack., If there is no repeat registered to return to.	Increment or decrements the top counter on the repeat stack. If the counter is counting up and `counter == limit - 1` then this pops the counter and continues with the program. If the counter is counting down and the counter is 0 then this pops the counter and continues with the program. If it is `< limit - 1` or `> 0` respectively then the program jumps to the last Repeat

Pred

Operations for computing predicates.

Name	Stack In	Stack Out	Description
Eq: 0x10	lhs, rhs	lhs == rhs	Check equality of two words.
EqRange: 0x11	arr_a_0, ..arr_a_N, arr_b_0, ..arr_b_N, len	(top-(2*len))..(top - len) == (top - len)..top	Check equality of two ranges on the stack. The ranges must be of equal length. The ranges must be stacked sequentially. Here `N` is `len -1`.
Gt: 0x12	lhs, rhs	lhs > rhs	Check if left-hand side is greater than right-hand side.
Lt: 0x13	lhs, rhs	lhs < rhs	Check if left-hand side is less than right-hand side.
Gte: 0x14	lhs, rhs	lhs >= rhs	Check if left-hand side is greater than or equal to right-hand side.
Lte: 0x15	lhs, rhs	lhs <= rhs	Check if left-hand side is less than or equal to right-hand side.
And: 0x16	lhs, rhs	lhs && rhs	Logical AND of two words.
Or: 0x17	lhs, rhs	lhs	rhs
Not: 0x18	a	!a	Logical NOT of a word.

Alu

Operations for computing arithmetic and logic.

Name	Stack In	Stack Out	Description
Add: 0x20	lhs, rhs	lhs + rhs	Add two words.
Sub: 0x21	lhs, rhs	lhs - rhs	Subtract two words.
Mul: 0x22	lhs, rhs	lhs * rhs	Multiply two words.
Div: 0x23	lhs, rhs	lhs / rhs	Integer division.
Mod: 0x24	lhs, rhs	lhs % rhs	Modulus of lhs by rhs.

Access

Operations for accessing input data.

Name	Stack In	Stack Out	Panics	Description
DecisionVar: 0x30	slot	decision_word	The slot is out of range., If the slot is empty.	Access the first word in a decision variable slot by `slot`. The slot must be in range. Returns a decision word.
DecisionVarAt: 0x31	slot, index	decision_word	The slot is out of range., The index is out of range.	Access a word in a decision variable slot by `slot` and `index`. The slot and index must be in range. Returns a decision word.
DecisionVarRange: 0x32	slot, index, len	elem: decision_word len: range	The slot is out of range., The range `index..(index + len)` is out of range.	Access a range of decision variables slot words starting from a specified slot and index. Returns a list of decision words with length equal to the specified len.
DecisionVarLen: 0x33	slot	len	The slot is out of range.	Get the length of a specified `slot`.
State: 0x34	slot, delta	state_slot_w0, ...state_slot_wN	The slot is out of range.	Access a state variable by `slot`. If the slot is empty, this is a noop. The `delta` parameter determines if changes are considered. Use `StateLen` to get the length of the state variable.
StateRange: 0x35	slot, range, delta	state_word_0, ...state_word_M, state_word_0, ...state_word_N, ...	The range `slot..(slot + range)` is out of range.	Access a range of state variables starting from a specified slot. Empty slots will not write anything to the stack. The delta parameter determines if changes are considered. Returns a list of state words with length equal to the specified range. Use `StateLenRange` to get the lengths of the state variables.
StateLen: 0x36	slot, delta	len	The slot is out of range.	Get the length of a state variable at a specified `slot`. Returns a the length of the state variable.
StateLenRange: 0x37	slot, range, delta	elem: length len: range	The range `slot..(slot + range)` is out of range.	Get the lengths of a `range` of state variables starting from a specified `slot`. Returns a list of lengths, each being the length of a state variable in the range.
MutKeysLen: 0x38		word		Get the number of mutable keys being proposed for mutation. This operation returns a single word representing the length.
MutKeysContains: 0x39	key, key_len	bool		Check if the mutable keys being proposed contain the given key. This operation returns a true if the key is found, false otherwise.
ThisAddress: 0x3A		key		Get the content hash of this predicate. This operation returns a list of words with a length of 4, representing the hash.
ThisContractAddress: 0x3B		key		Get the content hash of the contract this predicate belongs to. This operation returns a list of words with a length of 4, representing the contract's hash.
ThisPathway: 0x3C		in		Get the pathway of this predicate. This operation returns the index of the solution data currently being used to check this predicate.
RepeatCounter: 0x3D		counter_value		Access the top repeat counters current value.
Transient: 0x3E	key_0, ...key_N, key_len, pathway	elem: slot_word len: value_len		Get the solution data indexed by pathway and key.
TransientLen: 0x3F	key_0, ...key_N, key_len, pathway	len		Get the length of solution data indexed by pathway and key.
PredicateAt: 0x40	pathway	contract_key_0, contract_key_1, contract_key_2, contract_key_3, predicate_key_0, predicate_key_1, predicate_key_2, predicate_key_3		Get the predicate at solution data pathway.
ThisTransientLen: 0x41		len		Get the length of the transient data at this predicate.
ThisTransientContains: 0x42	key_0, ...key_N, key_len	bool		Check if the transient data at this predicate contains the given key.

Crypto

Operations providing cryptographic functionality.

Name	Stack In	Stack Out	Description
Sha256: 0x50	data, data_len	hash_w0, hash_w1, hash_w2, hash_w3	Produce a SHA 256 hash from the specified data.
VerifyEd25519: 0x51	data, data_len, sig_w0, sig_w1, sig_w2, sig_w3, sig_w4, sig_w5, sig_w6, sig_w7, key_w0, key_w1, key_w2, key_w3	bool	Validate an Ed25519 signature against a public key.
RecoverSecp256k1: 0x52	hash_0, hash_1, hash_2, hash_3, sig_w0, sig_w1, sig_w2, sig_w3, sig_w4, sig_w5, sig_w6, sig_w7, sig_8	pub_key_w0, pub_key_w1, pub_key_w2, pub_key_w3, pub_key_4	Recover the public key from a secp256k1 signature. If the signature is invalid, the operation will return all zeros.

TotalControlFlow

Control flow operations that keep the program total.

Name	Stack In	Panics	Description
Halt: 0x60			End the execution of the program.
HaltIf: 0x61	value		Halt the program if the value is true.
JumpForwardIf: 0x63	n_instruction, condition	The jump is out of bounds., The jump is negative., The jump distance is zero.	Jump forward the given number of instructions if the value is true.

Temporary

Operations for temporary memory.

Name	Stack In	Stack Out	Panics	Description
Alloc: 0x70	size	index	Max memory size reached.	Allocate new memory to the end of the temporary memory. Sets new memory to 0. Returns the index to the start of the new block of memory.
Load: 0x71	index	value	Index is out of bounds.	Load the value at the index of temporary memory onto the stack.
Store: 0x72	index, value		Index is out of bounds.	Store the value at the index of temporary memory.

StateSlots

Operations for controlling mutable state slots.

Name	Stack In	Stack Out	Panics	Description
AllocSlots: 0x80	size			Allocate new slots to the end of the memory.
Load: 0x81	index	elem: value_word len: value_len	Index is out of bounds.	Load the value at the index of a slot onto the stack. Noop if the slot is empty.
Store: 0x82	value_word_0, ...value_word_len, len, index		Index is out of bounds.	Store the value at the index of state slots.
LoadWord: 0x83	slot, index	Value_word	Slot or Index is out of bounds.	Load the word at the index of the value at the slot onto the stack.
StoreWord: 0x84	slot, index, word		Slot or Index is out of bounds.	Store the word at the index of the value at the slot.
Clear: 0x85	index		Index is out of bounds.	Clear the value at the index.
ClearRange: 0x86	index, amount		The range is out of bounds.	Clear a range of values.
Length: 0x87		length		Get the current length of the memory.
ValueLen: 0x88	index	length		Get the current length of a given value at the index.

KeyRange

Name	Stack In	Stack Out	Panics	Description
KeyRange: 0x90	key_w0, ...key_wN, key_len, num_keys_to_read, slot_index			Read a range of values at each key from state starting at the key into state slots starting at the slot index. The key is lexographically incremented for each value read. All keys are assumed to be the same length. Returns the values onto the stack, followed by their indices.

KeyRangeExtern

Name	Stack In	Stack Out	Panics	Description
KeyRangeExtern: 0x91	ext_w0, ext_w1, ext_w2, ext_w3, key_w0, ...key_wN, key_len, num_keys_to_read, slot_index			Read a range of values at each key from external state starting at the key into state slots starting at the slot index. The key is lexographically incremented for each value read. The external state is at the `ext` address. Returns the values onto the stack, followed by their indices.

Essential Specs