phase_spec.cpp

Go to the documentation of this file.

#include "barretenberg/vm2/tracegen/lib/phase_spec.hpp"
#include "barretenberg/aztec/aztec_constants.hpp"
 
#include <array>
#include <cstdint>
#include <unordered_map>
#include <vector>
 
namespace bb::avm2::tracegen {
 
// Each value of the map is a TxPhaseSpec struct that contains static attributes for the given transaction phase.
// For readability, we only include the fields that are non-zero for the given phase. The default values are 0
// or false (boolean) as per the TxPhaseSpec struct definition, so that each struct is fully initialized.
// Warning: Modify this map with caution. It will likely require changes in the constraints in tx.pil
// and/or tx_context.pil. Our constraint system is relying on several internal properties of this map.
const std::unordered_map<TransactionPhase, TxPhaseSpec>& get_tx_phase_spec_map()
{
    static const std::unordered_map<TransactionPhase, TxPhaseSpec> TX_PHASE_SPEC_MAP = { {
        { TransactionPhase::NR_NULLIFIER_INSERTION,
          {
              .read_pi_start_offset = AVM_PUBLIC_INPUTS_PREVIOUS_NON_REVERTIBLE_ACCUMULATED_DATA_NULLIFIERS_ROW_IDX,
              .read_pi_length_offset =
                  AVM_PUBLIC_INPUTS_PREVIOUS_NON_REVERTIBLE_ACCUMULATED_DATA_ARRAY_LENGTHS_NULLIFIERS_ROW_IDX,
              .append_nullifier = true,
          } },
        { TransactionPhase::NR_NOTE_INSERTION,
          {
              .read_pi_start_offset = AVM_PUBLIC_INPUTS_PREVIOUS_NON_REVERTIBLE_ACCUMULATED_DATA_NOTE_HASHES_ROW_IDX,
              .read_pi_length_offset =
                  AVM_PUBLIC_INPUTS_PREVIOUS_NON_REVERTIBLE_ACCUMULATED_DATA_ARRAY_LENGTHS_NOTE_HASHES_ROW_IDX,
              .append_note_hash = true,
          } },
        { TransactionPhase::NR_L2_TO_L1_MESSAGE,
          {
              .read_pi_start_offset = AVM_PUBLIC_INPUTS_PREVIOUS_NON_REVERTIBLE_ACCUMULATED_DATA_L2_TO_L1_MSGS_ROW_IDX,
              .read_pi_length_offset =
                  AVM_PUBLIC_INPUTS_PREVIOUS_NON_REVERTIBLE_ACCUMULATED_DATA_ARRAY_LENGTHS_L2_TO_L1_MSGS_ROW_IDX,
              .append_l2_l1_msg = true,
          } },
        { TransactionPhase::SETUP,
          {
              .is_public_call_request = true,
              .read_pi_start_offset = AVM_PUBLIC_INPUTS_PUBLIC_SETUP_CALL_REQUESTS_ROW_IDX,
              .read_pi_length_offset = AVM_PUBLIC_INPUTS_PUBLIC_CALL_REQUEST_ARRAY_LENGTHS_SETUP_CALLS_ROW_IDX,
          } },
        { TransactionPhase::R_NULLIFIER_INSERTION,
          {
              .is_revertible = true,
              .read_pi_start_offset = AVM_PUBLIC_INPUTS_PREVIOUS_REVERTIBLE_ACCUMULATED_DATA_NULLIFIERS_ROW_IDX,
              .read_pi_length_offset =
                  AVM_PUBLIC_INPUTS_PREVIOUS_REVERTIBLE_ACCUMULATED_DATA_ARRAY_LENGTHS_NULLIFIERS_ROW_IDX,
              .append_nullifier = true,
              .next_phase_on_revert = static_cast<uint8_t>(TransactionPhase::TEARDOWN),
          } },
        { TransactionPhase::R_NOTE_INSERTION,
          {
              .is_revertible = true,
              .read_pi_start_offset = AVM_PUBLIC_INPUTS_PREVIOUS_REVERTIBLE_ACCUMULATED_DATA_NOTE_HASHES_ROW_IDX,
              .read_pi_length_offset =
                  AVM_PUBLIC_INPUTS_PREVIOUS_REVERTIBLE_ACCUMULATED_DATA_ARRAY_LENGTHS_NOTE_HASHES_ROW_IDX,
              .append_note_hash = true,
              .next_phase_on_revert = static_cast<uint8_t>(TransactionPhase::TEARDOWN),
          } },
        { TransactionPhase::R_L2_TO_L1_MESSAGE,
          {
              .is_revertible = true,
              .read_pi_start_offset = AVM_PUBLIC_INPUTS_PREVIOUS_REVERTIBLE_ACCUMULATED_DATA_L2_TO_L1_MSGS_ROW_IDX,
              .read_pi_length_offset =
                  AVM_PUBLIC_INPUTS_PREVIOUS_REVERTIBLE_ACCUMULATED_DATA_ARRAY_LENGTHS_L2_TO_L1_MSGS_ROW_IDX,
              .append_l2_l1_msg = true,
              .next_phase_on_revert = static_cast<uint8_t>(TransactionPhase::TEARDOWN),
          } },
        { TransactionPhase::APP_LOGIC,
          {
              .is_public_call_request = true,
              .is_revertible = true,
              .read_pi_start_offset = AVM_PUBLIC_INPUTS_PUBLIC_APP_LOGIC_CALL_REQUESTS_ROW_IDX,
              .read_pi_length_offset = AVM_PUBLIC_INPUTS_PUBLIC_CALL_REQUEST_ARRAY_LENGTHS_APP_LOGIC_CALLS_ROW_IDX,
              .next_phase_on_revert = static_cast<uint8_t>(TransactionPhase::TEARDOWN),
          } },
        { TransactionPhase::TEARDOWN,
          {
              .is_public_call_request = true,
              .is_teardown = true,
              .is_revertible = true,
              .read_pi_start_offset = AVM_PUBLIC_INPUTS_PUBLIC_TEARDOWN_CALL_REQUEST_ROW_IDX,
              .read_pi_length_offset = AVM_PUBLIC_INPUTS_PUBLIC_CALL_REQUEST_ARRAY_LENGTHS_TEARDOWN_CALL_ROW_IDX,
              .next_phase_on_revert = static_cast<uint8_t>(TransactionPhase::COLLECT_GAS_FEES),
          } },
        { TransactionPhase::COLLECT_GAS_FEES,
          {
              .is_collect_fee = true,
              .read_pi_start_offset = AVM_PUBLIC_INPUTS_EFFECTIVE_GAS_FEES_ROW_IDX,
          } },
        { TransactionPhase::TREE_PADDING,
          {
              .is_tree_padding = true,
          } },
        { TransactionPhase::CLEANUP,
          {
              .is_cleanup = true,
          } },
    } };
    return TX_PHASE_SPEC_MAP;
}
 
} // namespace bb::avm2::tracegen