Skip to content

Commit 8e692c1

Browse files
benesjanbenesjan
authored
fix: issue with run_nargo_fmt.sh + minor yellow paper naming improvements (AztecProtocol#3833)
When input param was not set (which is expected when we want to apply the changes) the script failed with > ./run_nargo_fmt.sh: line 31: $1: unbound variable I decided to solve this by allowing for unbound vars. Other than this I sneaked in a few changes I discussed with Lasse: 1. Renamed content hash as body hash because we have a struct called body and the hash is hash of body so it makes it a bit more clear of what the hash is. 2. Renamed `l1_to_l2_message_tree` as `l1_to_l2_messages_tree` in the yellow paper to make it consistent with our codebase.
1 parent 1f5b2c6 commit 8e692c1

File tree

63 files changed

+256
-256
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+256
-256
lines changed

‎circuits/cpp/src/aztec3/circuits/abis/block_header.hpp

+13-13
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ template <typename NCT> struct BlockHeader {
2525
fr note_hash_tree_root = 0;
2626
fr nullifier_tree_root = 0;
2727
fr contract_tree_root = 0;
28-
fr l1_to_l2_messages_tree_root = 0;
28+
fr l1_to_l2_message_tree_root = 0;
2929
fr archive_root = 0;
3030
fr private_kernel_vk_tree_root = 0; // TODO: future enhancement
3131

@@ -37,7 +37,7 @@ template <typename NCT> struct BlockHeader {
3737
MSGPACK_FIELDS(note_hash_tree_root,
3838
nullifier_tree_root,
3939
contract_tree_root,
40-
l1_to_l2_messages_tree_root,
40+
l1_to_l2_message_tree_root,
4141
archive_root,
4242
private_kernel_vk_tree_root,
4343
public_data_tree_root,
@@ -47,7 +47,7 @@ template <typename NCT> struct BlockHeader {
4747
{
4848
return note_hash_tree_root == other.note_hash_tree_root && nullifier_tree_root == other.nullifier_tree_root &&
4949
contract_tree_root == other.contract_tree_root &&
50-
l1_to_l2_messages_tree_root == other.l1_to_l2_messages_tree_root && archive_root == other.archive_root &&
50+
l1_to_l2_message_tree_root == other.l1_to_l2_message_tree_root && archive_root == other.archive_root &&
5151
private_kernel_vk_tree_root == other.private_kernel_vk_tree_root &&
5252
public_data_tree_root == other.public_data_tree_root &&
5353
global_variables_hash == other.global_variables_hash;
@@ -60,7 +60,7 @@ template <typename NCT> struct BlockHeader {
6060
note_hash_tree_root.assert_is_zero();
6161
nullifier_tree_root.assert_is_zero();
6262
contract_tree_root.assert_is_zero();
63-
l1_to_l2_messages_tree_root.assert_is_zero();
63+
l1_to_l2_message_tree_root.assert_is_zero();
6464
archive_root.assert_is_zero();
6565
private_kernel_vk_tree_root.assert_is_zero();
6666
public_data_tree_root.assert_is_zero();
@@ -75,9 +75,9 @@ template <typename NCT> struct BlockHeader {
7575
auto to_ct = [&](auto& e) { return aztec3::utils::types::to_ct(builder, e); };
7676

7777
BlockHeader<CircuitTypes<Builder>> data = {
78-
to_ct(note_hash_tree_root), to_ct(nullifier_tree_root), to_ct(contract_tree_root),
79-
to_ct(l1_to_l2_messages_tree_root), to_ct(archive_root), to_ct(private_kernel_vk_tree_root),
80-
to_ct(public_data_tree_root), to_ct(global_variables_hash),
78+
to_ct(note_hash_tree_root), to_ct(nullifier_tree_root), to_ct(contract_tree_root),
79+
to_ct(l1_to_l2_message_tree_root), to_ct(archive_root), to_ct(private_kernel_vk_tree_root),
80+
to_ct(public_data_tree_root), to_ct(global_variables_hash),
8181
};
8282

8383
return data;
@@ -89,9 +89,9 @@ template <typename NCT> struct BlockHeader {
8989
auto to_nt = [&](auto& e) { return aztec3::utils::types::to_nt<Builder>(e); };
9090

9191
BlockHeader<NativeTypes> data = {
92-
to_nt(note_hash_tree_root), to_nt(nullifier_tree_root), to_nt(contract_tree_root),
93-
to_nt(l1_to_l2_messages_tree_root), to_nt(archive_root), to_nt(private_kernel_vk_tree_root),
94-
to_nt(public_data_tree_root), to_nt(global_variables_hash),
92+
to_nt(note_hash_tree_root), to_nt(nullifier_tree_root), to_nt(contract_tree_root),
93+
to_nt(l1_to_l2_message_tree_root), to_nt(archive_root), to_nt(private_kernel_vk_tree_root),
94+
to_nt(public_data_tree_root), to_nt(global_variables_hash),
9595
};
9696

9797
return data;
@@ -104,7 +104,7 @@ template <typename NCT> struct BlockHeader {
104104
note_hash_tree_root.set_public();
105105
nullifier_tree_root.set_public();
106106
contract_tree_root.set_public();
107-
l1_to_l2_messages_tree_root.set_public();
107+
l1_to_l2_message_tree_root.set_public();
108108
archive_root.set_public();
109109
private_kernel_vk_tree_root.set_public();
110110
public_data_tree_root.set_public();
@@ -116,7 +116,7 @@ template <typename NCT> struct BlockHeader {
116116
return { note_hash_tree_root,
117117
nullifier_tree_root,
118118
contract_tree_root,
119-
l1_to_l2_messages_tree_root,
119+
l1_to_l2_message_tree_root,
120120
archive_root, // TODO(#3441) Note private_kernel_vk_tree_root, is not included yet as
121121
// it is not present in noir,
122122
public_data_tree_root,
@@ -130,7 +130,7 @@ template <typename NCT> struct BlockHeader {
130130
note_hash_tree_root,
131131
nullifier_tree_root,
132132
contract_tree_root,
133-
l1_to_l2_messages_tree_root,
133+
l1_to_l2_message_tree_root,
134134
public_data_tree_root);
135135
}
136136
};

‎circuits/cpp/src/aztec3/circuits/abis/rollup/root/root_rollup_inputs.hpp

+4-4
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ template <typename NCT> struct RootRollupInputs {
2020

2121
// inputs required to process l1 to l2 messages
2222
std::array<fr, NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP> new_l1_to_l2_messages{};
23-
std::array<fr, L1_TO_L2_MSG_SUBTREE_SIBLING_PATH_LENGTH> new_l1_to_l2_messages_tree_root_sibling_path{};
23+
std::array<fr, L1_TO_L2_MSG_SUBTREE_SIBLING_PATH_LENGTH> new_l1_to_l2_message_tree_root_sibling_path{};
2424

25-
AppendOnlyTreeSnapshot<NCT> start_l1_to_l2_messages_tree_snapshot{};
25+
AppendOnlyTreeSnapshot<NCT> start_l1_to_l2_message_tree_snapshot{};
2626

2727
// inputs required to add the block hash
2828
AppendOnlyTreeSnapshot<NCT> start_archive_snapshot{};
@@ -31,8 +31,8 @@ template <typename NCT> struct RootRollupInputs {
3131
// For serialization, update with new fields
3232
MSGPACK_FIELDS(previous_rollup_data,
3333
new_l1_to_l2_messages,
34-
new_l1_to_l2_messages_tree_root_sibling_path,
35-
start_l1_to_l2_messages_tree_snapshot,
34+
new_l1_to_l2_message_tree_root_sibling_path,
35+
start_l1_to_l2_message_tree_snapshot,
3636
start_archive_snapshot,
3737
new_archive_sibling_path);
3838
bool operator==(RootRollupInputs<NCT> const&) const = default;

‎circuits/cpp/src/aztec3/circuits/abis/rollup/root/root_rollup_public_inputs.hpp

+12-12
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ template <typename NCT> struct RootRollupPublicInputs {
3737
AppendOnlyTreeSnapshot<NCT> start_tree_of_historical_contract_tree_roots_snapshot{};
3838
AppendOnlyTreeSnapshot<NCT> end_tree_of_historical_contract_tree_roots_snapshot{};
3939

40-
AppendOnlyTreeSnapshot<NCT> start_l1_to_l2_messages_tree_snapshot{};
41-
AppendOnlyTreeSnapshot<NCT> end_l1_to_l2_messages_tree_snapshot{};
40+
AppendOnlyTreeSnapshot<NCT> start_l1_to_l2_message_tree_snapshot{};
41+
AppendOnlyTreeSnapshot<NCT> end_l1_to_l2_message_tree_snapshot{};
4242

43-
AppendOnlyTreeSnapshot<NCT> start_tree_of_historical_l1_to_l2_messages_tree_roots_snapshot{};
44-
AppendOnlyTreeSnapshot<NCT> end_tree_of_historical_l1_to_l2_messages_tree_roots_snapshot{};
43+
AppendOnlyTreeSnapshot<NCT> start_tree_of_historical_l1_to_l2_message_tree_roots_snapshot{};
44+
AppendOnlyTreeSnapshot<NCT> end_tree_of_historical_l1_to_l2_message_tree_roots_snapshot{};
4545

4646
AppendOnlyTreeSnapshot<NCT> start_archive_snapshot{};
4747
AppendOnlyTreeSnapshot<NCT> end_archive_snapshot{};
@@ -64,10 +64,10 @@ template <typename NCT> struct RootRollupPublicInputs {
6464
end_tree_of_historical_note_hash_tree_roots_snapshot,
6565
start_tree_of_historical_contract_tree_roots_snapshot,
6666
end_tree_of_historical_contract_tree_roots_snapshot,
67-
start_l1_to_l2_messages_tree_snapshot,
68-
end_l1_to_l2_messages_tree_snapshot,
69-
start_tree_of_historical_l1_to_l2_messages_tree_roots_snapshot,
70-
end_tree_of_historical_l1_to_l2_messages_tree_roots_snapshot,
67+
start_l1_to_l2_message_tree_snapshot,
68+
end_l1_to_l2_message_tree_snapshot,
69+
start_tree_of_historical_l1_to_l2_message_tree_roots_snapshot,
70+
end_tree_of_historical_l1_to_l2_message_tree_roots_snapshot,
7171
start_archive_snapshot,
7272
end_archive_snapshot,
7373
calldata_hash,
@@ -86,17 +86,17 @@ template <typename NCT> struct RootRollupPublicInputs {
8686
write(buf, start_tree_of_historical_note_hash_tree_roots_snapshot);
8787
write(buf, start_tree_of_historical_contract_tree_roots_snapshot);
8888
write(buf, start_public_data_tree_root);
89-
write(buf, start_l1_to_l2_messages_tree_snapshot);
90-
write(buf, start_tree_of_historical_l1_to_l2_messages_tree_roots_snapshot);
89+
write(buf, start_l1_to_l2_message_tree_snapshot);
90+
write(buf, start_tree_of_historical_l1_to_l2_message_tree_roots_snapshot);
9191
write(buf, start_archive_snapshot);
9292
write(buf, end_note_hash_tree_snapshot);
9393
write(buf, end_nullifier_tree_snapshot);
9494
write(buf, end_contract_tree_snapshot);
9595
write(buf, end_tree_of_historical_note_hash_tree_roots_snapshot);
9696
write(buf, end_tree_of_historical_contract_tree_roots_snapshot);
9797
write(buf, end_public_data_tree_root);
98-
write(buf, end_l1_to_l2_messages_tree_snapshot);
99-
write(buf, end_tree_of_historical_l1_to_l2_messages_tree_roots_snapshot);
98+
write(buf, end_l1_to_l2_message_tree_snapshot);
99+
write(buf, end_tree_of_historical_l1_to_l2_message_tree_roots_snapshot);
100100
write(buf, end_archive_snapshot);
101101

102102
// Stitching calldata hash together

‎circuits/cpp/src/aztec3/circuits/hash.hpp

+6-6
Original file line numberDiff line numberDiff line change
@@ -130,14 +130,14 @@ template <typename NCT> typename NCT::fr compute_block_hash(typename NCT::fr con
130130
typename NCT::fr const& note_hash_tree_root,
131131
typename NCT::fr const& nullifier_tree_root,
132132
typename NCT::fr const& contract_tree_root,
133-
typename NCT::fr const& l1_to_l2_messages_tree_root,
133+
typename NCT::fr const& l1_to_l2_message_tree_root,
134134
typename NCT::fr const& public_data_tree_root)
135135
{
136136
using fr = typename NCT::fr;
137137

138138
std::vector<fr> const inputs = {
139-
globals_hash, note_hash_tree_root, nullifier_tree_root,
140-
contract_tree_root, l1_to_l2_messages_tree_root, public_data_tree_root,
139+
globals_hash, note_hash_tree_root, nullifier_tree_root,
140+
contract_tree_root, l1_to_l2_message_tree_root, public_data_tree_root,
141141
};
142142

143143
return NCT::hash(inputs, aztec3::GeneratorIndex::BLOCK_HASH);
@@ -148,14 +148,14 @@ typename NCT::fr compute_block_hash_with_globals(abis::GlobalVariables<NCT> cons
148148
typename NCT::fr const& note_hash_tree_root,
149149
typename NCT::fr const& nullifier_tree_root,
150150
typename NCT::fr const& contract_tree_root,
151-
typename NCT::fr const& l1_to_l2_messages_tree_root,
151+
typename NCT::fr const& l1_to_l2_message_tree_root,
152152
typename NCT::fr const& public_data_tree_root)
153153
{
154154
using fr = typename NCT::fr;
155155

156156
std::vector<fr> const inputs = {
157-
globals.hash(), note_hash_tree_root, nullifier_tree_root,
158-
contract_tree_root, l1_to_l2_messages_tree_root, public_data_tree_root,
157+
globals.hash(), note_hash_tree_root, nullifier_tree_root,
158+
contract_tree_root, l1_to_l2_message_tree_root, public_data_tree_root,
159159
};
160160

161161
return NCT::hash(inputs, aztec3::GeneratorIndex::BLOCK_HASH);

‎circuits/cpp/src/aztec3/circuits/kernel/public/.test.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@ PublicKernelInputs<NT> get_kernel_inputs_with_previous_kernel(NT::boolean privat
332332
.note_hash_tree_root = ++seed,
333333
.nullifier_tree_root = ++seed,
334334
.contract_tree_root = ++seed,
335-
.l1_to_l2_messages_tree_root = ++seed,
335+
.l1_to_l2_message_tree_root = ++seed,
336336
.archive_root = ++seed,
337337
.private_kernel_vk_tree_root = ++seed,
338338
.public_data_tree_root = ++seed,
@@ -372,7 +372,7 @@ PublicKernelInputs<NT> get_kernel_inputs_with_previous_kernel(NT::boolean privat
372372
[[maybe_unused]] BlockHeader<NT> const historical_tree_roots = {
373373
.note_hash_tree_root = 1000,
374374
.contract_tree_root = 2000,
375-
.l1_to_l2_messages_tree_root = 3000,
375+
.l1_to_l2_message_tree_root = 3000,
376376
.private_kernel_vk_tree_root = 4000,
377377
};
378378

‎circuits/cpp/src/aztec3/circuits/rollup/base/.test.cpp

+12-12
Original file line numberDiff line numberDiff line change
@@ -741,8 +741,8 @@ TEST_F(base_rollup_tests, native_single_public_state_read)
741741
MemoryStore public_data_tree_store;
742742
MerkleTree public_data_tree(public_data_tree_store, PUBLIC_DATA_TREE_HEIGHT);
743743

744-
MemoryStore l1_to_l2_messages_tree_store;
745-
MerkleTree l1_to_l2_messages_tree(l1_to_l2_messages_tree_store, L1_TO_L2_MSG_TREE_HEIGHT);
744+
MemoryStore l1_to_l2_message_tree_store;
745+
MerkleTree l1_to_l2_message_tree(l1_to_l2_message_tree_store, L1_TO_L2_MSG_TREE_HEIGHT);
746746

747747
auto data_read = abis::PublicDataRead<NT>{
748748
.leaf_index = fr(1),
@@ -752,7 +752,7 @@ TEST_F(base_rollup_tests, native_single_public_state_read)
752752
std::array<PreviousKernelData<NT>, 2> kernel_data = { get_empty_kernel(), get_empty_kernel() };
753753
kernel_data[0].public_inputs.end.public_data_reads[0] = data_read;
754754
auto inputs = test_utils::utils::base_rollup_inputs_from_kernels(
755-
kernel_data, note_hash_tree, contract_tree, public_data_tree, l1_to_l2_messages_tree);
755+
kernel_data, note_hash_tree, contract_tree, public_data_tree, l1_to_l2_message_tree);
756756

757757
BaseOrMergeRollupPublicInputs outputs =
758758
aztec3::circuits::rollup::native_base_rollup::base_rollup_circuit(builder, inputs);
@@ -777,8 +777,8 @@ TEST_F(base_rollup_tests, native_single_public_state_write)
777777
MemoryStore public_data_tree_store;
778778
MerkleTree public_data_tree(public_data_tree_store, PUBLIC_DATA_TREE_HEIGHT);
779779

780-
MemoryStore l1_to_l2_messages_tree_store;
781-
MerkleTree l1_to_l2_messages_tree(l1_to_l2_messages_tree_store, L1_TO_L2_MSG_TREE_HEIGHT);
780+
MemoryStore l1_to_l2_message_tree_store;
781+
MerkleTree l1_to_l2_message_tree(l1_to_l2_message_tree_store, L1_TO_L2_MSG_TREE_HEIGHT);
782782

783783

784784
auto data_write = abis::PublicDataUpdateRequest<NT>{
@@ -791,7 +791,7 @@ TEST_F(base_rollup_tests, native_single_public_state_write)
791791
kernel_data[0].public_inputs.end.public_data_update_requests[0] = data_write;
792792

793793
auto inputs = test_utils::utils::base_rollup_inputs_from_kernels(
794-
kernel_data, note_hash_tree, contract_tree, public_data_tree, l1_to_l2_messages_tree);
794+
kernel_data, note_hash_tree, contract_tree, public_data_tree, l1_to_l2_message_tree);
795795

796796
BaseOrMergeRollupPublicInputs outputs =
797797
aztec3::circuits::rollup::native_base_rollup::base_rollup_circuit(builder, inputs);
@@ -816,8 +816,8 @@ TEST_F(base_rollup_tests, native_multiple_public_state_read_writes)
816816
MemoryStore public_data_tree_store;
817817
MerkleTree public_data_tree(public_data_tree_store, PUBLIC_DATA_TREE_HEIGHT);
818818

819-
MemoryStore l1_to_l2_messages_tree_store;
820-
MerkleTree l1_to_l2_messages_tree(l1_to_l2_messages_tree_store, L1_TO_L2_MSG_TREE_HEIGHT);
819+
MemoryStore l1_to_l2_message_tree_store;
820+
MerkleTree l1_to_l2_message_tree(l1_to_l2_message_tree_store, L1_TO_L2_MSG_TREE_HEIGHT);
821821

822822
std::array<PreviousKernelData<NT>, 2> kernel_data = { get_empty_kernel(), get_empty_kernel() };
823823

@@ -840,7 +840,7 @@ TEST_F(base_rollup_tests, native_multiple_public_state_read_writes)
840840
make_public_data_update_request(fr(4), fr(204), fr(304));
841841

842842
auto inputs = test_utils::utils::base_rollup_inputs_from_kernels(
843-
kernel_data, note_hash_tree, contract_tree, public_data_tree, l1_to_l2_messages_tree);
843+
kernel_data, note_hash_tree, contract_tree, public_data_tree, l1_to_l2_message_tree);
844844

845845
BaseOrMergeRollupPublicInputs outputs =
846846
aztec3::circuits::rollup::native_base_rollup::base_rollup_circuit(builder, inputs);
@@ -868,8 +868,8 @@ TEST_F(base_rollup_tests, native_multiple_public_state_read_writes)
868868
// MemoryStore public_data_tree_store;
869869
// MerkleTree public_data_tree(public_data_tree_store, PUBLIC_DATA_TREE_HEIGHT);
870870

871-
// MemoryStore l1_to_l2_messages_tree_store;
872-
// MerkleTree l1_to_l2_messages_tree(l1_to_l2_messages_tree_store, L1_TO_L2_MSG_TREE_HEIGHT);
871+
// MemoryStore l1_to_l2_message_tree_store;
872+
// MerkleTree l1_to_l2_message_tree(l1_to_l2_message_tree_store, L1_TO_L2_MSG_TREE_HEIGHT);
873873

874874
// auto data_read = abis::PublicDataRead<NT>{
875875
// .leaf_index = fr(1),
@@ -879,7 +879,7 @@ TEST_F(base_rollup_tests, native_multiple_public_state_read_writes)
879879
// std::array<PreviousKernelData<NT>, 2> kernel_data = { get_empty_kernel(), get_empty_kernel() };
880880
// kernel_data[0].public_inputs.end.public_data_reads[0] = data_read;
881881
// auto inputs = test_utils::utils::base_rollup_inputs_from_kernels(
882-
// kernel_data, note_hash_tree, contract_tree, public_data_tree, l1_to_l2_messages_tree);
882+
// kernel_data, note_hash_tree, contract_tree, public_data_tree, l1_to_l2_message_tree);
883883

884884
// // We change the initial tree root so the read value does not match
885885
// public_data_tree.update_element(1, fr(43));

‎circuits/cpp/src/aztec3/circuits/rollup/base/native_base_rollup_circuit.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -145,14 +145,14 @@ void perform_archive_membership_checks(DummyBuilder& builder, BaseRollupInputs c
145145
auto note_hash_tree_root = historical_block.note_hash_tree_root;
146146
auto nullifier_tree_root = historical_block.nullifier_tree_root;
147147
auto contract_tree_root = historical_block.contract_tree_root;
148-
auto l1_to_l2_messages_tree_root = historical_block.l1_to_l2_messages_tree_root;
148+
auto l1_to_l2_message_tree_root = historical_block.l1_to_l2_message_tree_root;
149149
auto public_data_tree_root = historical_block.public_data_tree_root;
150150

151151
auto previous_block_hash = compute_block_hash<NT>(historical_block.global_variables_hash,
152152
note_hash_tree_root,
153153
nullifier_tree_root,
154154
contract_tree_root,
155-
l1_to_l2_messages_tree_root,
155+
l1_to_l2_message_tree_root,
156156
public_data_tree_root);
157157

158158
abis::MembershipWitness<NT, ARCHIVE_HEIGHT> const historical_root_witness =

0 commit comments

Comments
 (0)