Constants

Git Source

EMPTY_ACTIVE_SOURCE

Initial state of an active source is just the starting offset which is 0x20.

uint256 constant EMPTY_ACTIVE_SOURCE = 0x20;

FSM_YANG_MASK

uint256 constant FSM_YANG_MASK = 1;

FSM_WORD_END_MASK

uint256 constant FSM_WORD_END_MASK = 1 << 1;

FSM_ACCEPTING_INPUTS_MASK

uint256 constant FSM_ACCEPTING_INPUTS_MASK = 1 << 2;

FSM_ACTIVE_SOURCE_MASK

If a source is active we cannot finish parsing without a semi to trigger finalisation.

uint256 constant FSM_ACTIVE_SOURCE_MASK = 1 << 3;

FSM_DEFAULT

*fsm default state is:

  • yin
  • not word end
  • accepting inputs*
uint256 constant FSM_DEFAULT = FSM_ACCEPTING_INPUTS_MASK;

OPERAND_VALUES_LENGTH

The operand values array is 4 words long. In the future we could have some kind of logic that reallocates and expands this if we discover that we need more than 4 operands for a single opcode. Currently there are no opcodes in the main parser that require more than 4 operands. Of course some sub parser could implement something that expects more than 4, in which case we will have to revisit this, but it won't be a breaking change. Consider that operands in the output are only 2 bytes, so a 4 value operand array is already only allowing for 4 bits per value on average, which is pretty tight for anything other than bit flags.

uint256 constant OPERAND_VALUES_LENGTH = 4;