Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consensus changes merge target #401

Merged
merged 20 commits into from
Jul 25, 2024
Merged

Consensus changes merge target #401

Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
a0e0a22
Merge branch 'GH-376-joint-qcs' of https://github.com/antelopeIO/spri…
systemzax Jul 24, 2024
edf1744
Resolved merge conflicts
systemzax Jul 24, 2024
8ded338
Resolved merge conflicts
systemzax Jul 24, 2024
8741b73
Resolved merge conflicts
systemzax Jul 24, 2024
11b02dc
Updated deep-mind.log
systemzax Jul 24, 2024
54ec6eb
Merge branch 'GH-376-joint-qcs' of https://github.com/antelopeIO/spri…
systemzax Jul 24, 2024
bab79b2
Cleaned up comments and added additional checks to svnn_ibc_tests
systemzax Jul 24, 2024
db6248f
Reverted timestamp commitments to block_timestamp_type
systemzax Jul 24, 2024
2233bbe
Updated deep-mind.log
systemzax Jul 24, 2024
0e5ec63
Merge branch 'GH-376-joint-qcs' of https://github.com/antelopeIO/spri…
systemzax Jul 24, 2024
afcec5d
Resolved merge conflicts
systemzax Jul 24, 2024
e7a68f8
Merge branch 'main' of https://github.com/antelopeIO/spring into cons…
systemzax Jul 25, 2024
385e29e
Resolved merge conflicts
systemzax Jul 25, 2024
d7ee0cb
Resolved merge conflicts
systemzax Jul 25, 2024
9c84df3
Resolved merge conflicts
systemzax Jul 25, 2024
a227f26
Clean up
systemzax Jul 25, 2024
8d82fcb
Clean up
systemzax Jul 25, 2024
d16e096
Added back comment
systemzax Jul 25, 2024
3cd9ceb
Fixed comments
systemzax Jul 25, 2024
779dc47
Added explanation of 2-chains finality
systemzax Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions unittests/finality_proof.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ namespace finality_proof {
digest_type level_2_commitments_digest;
digest_type finality_leaf;
digest_type finality_root;
block_timestamp_type parent_timestamp;
};

static digest_type hash_pair(const digest_type& a, const digest_type& b) {
Expand Down Expand Up @@ -140,6 +141,9 @@ namespace finality_proof {
finalizer_policy active_finalizer_policy;
digest_type active_finalizer_policy_digest;

block_timestamp_type timestamp;
block_timestamp_type parent_timestamp;

// counter to (optimistically) track internal policy changes
std::unordered_map<digest_type, policy_count> blocks_since_proposed_policy;

Expand Down Expand Up @@ -168,21 +172,26 @@ namespace finality_proof {

//skip this part on genesis
if (!is_genesis){
parent_timestamp = timestamp;
for (const auto& p : blocks_since_proposed_policy){
//under the happy path with strong QCs in every block, a policy becomes active `2 * eosio::testing::num_chains_to_final` blocks after being proposed
if (p.second.blocks_since_proposed == 2 * eosio::testing::num_chains_to_final){

//under the happy path with strong QCs in every block, a policy becomes active 6 blocks after being proposed
linh2931 marked this conversation as resolved.
Show resolved Hide resolved
if (p.second.blocks_since_proposed == 2 * eosio::testing::num_chains_to_final && p.first != active_finalizer_policy_digest){
active_finalizer_policy = p.second.policy;
active_finalizer_policy_digest = p.first;
}
//under the happy path with strong QCs in every block, a policy becomes pending `num_chains_to_final` blocks after being proposed
else if (p.second.blocks_since_proposed == eosio::testing::num_chains_to_final){
//under the happy path with strong QCs in every block, a policy becomes pending 3 blocks after being proposed
linh2931 marked this conversation as resolved.
Show resolved Hide resolved
else if (p.second.blocks_since_proposed == eosio::testing::num_chains_to_final && p.first != last_pending_finalizer_policy_digest){

last_pending_finalizer_policy = p.second.policy;
last_pending_finalizer_policy_digest = p.first;
last_pending_finalizer_policy_start_num = block->block_num();
}
}
}

timestamp = block->timestamp;

// if we have policy diffs, process them
if (has_finalizer_policy_diffs(block)){
if (is_genesis) {
Expand All @@ -203,8 +212,6 @@ namespace finality_proof {
}
}

ilog("block num : ${bn} : lpfp_sn -> ${sn}", ("bn", block->block_num())("sn", last_pending_finalizer_policy_start_num));

//process votes and collect / compute the IBC-relevant data
this->process_votes(1, this->num_needed_for_quorum); //enough to reach quorum threshold

Expand Down Expand Up @@ -242,6 +249,8 @@ namespace finality_proof {
// compute finality leaf
digest_type finality_leaf = fc::sha256::hash(valid_t::finality_leaf_node_t{
.block_num = block->block_num(),
.timestamp = timestamp,
.parent_timestamp = parent_timestamp,
.finality_digest = finality_digest,
.action_mroot = action_mroot
});
Expand Down Expand Up @@ -273,7 +282,8 @@ namespace finality_proof {
.level_3_commitments_digest = level_3_commitments_digest,
.level_2_commitments_digest = level_2_commitments_digest,
.finality_leaf = finality_leaf,
.finality_root = finality_root
.finality_root = finality_root ,
.parent_timestamp = parent_timestamp
};

}
Expand Down Expand Up @@ -302,4 +312,4 @@ namespace finality_proof {

};

}
}
110 changes: 51 additions & 59 deletions unittests/svnn_ibc_tests.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ using namespace eosio::testing;

using mvo = mutable_variant_object;


std::string bitset_to_input_string(const boost::dynamic_bitset<unsigned char>& bitset) {
static const char* hexchar = "0123456789abcdef";

Expand Down Expand Up @@ -54,9 +53,6 @@ auto active_finalizers_string = [](const finality_proof::ibc_block_data_t& bd)

BOOST_AUTO_TEST_SUITE(svnn_ibc)

BOOST_AUTO_TEST_CASE(ibc_test) {} // TODO remove this and re-enable actual ibc_test
#if 0 // TODO re-enabled

BOOST_AUTO_TEST_CASE(ibc_test) { try {

// cluster is set up with the head about to produce IF Genesis
Expand Down Expand Up @@ -119,8 +115,8 @@ BOOST_AUTO_TEST_CASE(ibc_test) {} // TODO remove this and re-enable actual ibc_t
("finality_mroot", block_3_result.finality_root)
)
("qc", mvo()
("signature", block_5_result.qc_data.qc.value().active_policy_sig.sig.to_string())
("finalizers", active_finalizers_string(block_5_result))
("signature", block_4_result.qc_data.qc.value().active_policy_sig.sig.to_string())
linh2931 marked this conversation as resolved.
Show resolved Hide resolved
("finalizers", active_finalizers_string(block_4_result))
)
)
("target_block_proof_of_inclusion", mvo()
Expand All @@ -135,6 +131,8 @@ BOOST_AUTO_TEST_CASE(ibc_test) {} // TODO remove this and re-enable actual ibc_t
("witness_hash", block_2_result.level_2_commitments_digest)
("finality_mroot", block_2_result.finality_root)
)
("timestamp", block_2_result.block->timestamp)
("parent_timestamp", block_2_result.parent_timestamp)
("dynamic_data", mvo()
("block_num", block_2_result.block->block_num())
("action_proofs", fc::variants())
Expand All @@ -158,8 +156,8 @@ BOOST_AUTO_TEST_CASE(ibc_test) {} // TODO remove this and re-enable actual ibc_t
("finality_mroot", block_3_result.finality_root)
)
("qc", mvo()
("signature", block_5_result.qc_data.qc.value().active_policy_sig.sig.to_string())
("finalizers", active_finalizers_string(block_5_result))
("signature", block_4_result.qc_data.qc.value().active_policy_sig.sig.to_string())
("finalizers", active_finalizers_string(block_4_result))
)
)
("target_block_proof_of_inclusion", mvo()
Expand All @@ -169,6 +167,8 @@ BOOST_AUTO_TEST_CASE(ibc_test) {} // TODO remove this and re-enable actual ibc_t
("major_version", 1)
("minor_version", 0)
("finality_digest", block_2_result.finality_digest)
("timestamp", block_2_result.block->timestamp)
("parent_timestamp", block_2_result.parent_timestamp)
("dynamic_data", mvo()
("block_num", block_2_result.block->block_num())
("action_proofs", fc::variants())
Expand All @@ -192,8 +192,8 @@ BOOST_AUTO_TEST_CASE(ibc_test) {} // TODO remove this and re-enable actual ibc_t
("finality_mroot", block_4_result.finality_root)
)
("qc", mvo()
("signature", block_6_result.qc_data.qc.value().active_policy_sig.sig.to_string())
("finalizers", active_finalizers_string(block_6_result))
("signature", block_5_result.qc_data.qc.value().active_policy_sig.sig.to_string())
("finalizers", active_finalizers_string(block_5_result))
)
)
("target_block_proof_of_inclusion", mvo()
Expand All @@ -208,6 +208,8 @@ BOOST_AUTO_TEST_CASE(ibc_test) {} // TODO remove this and re-enable actual ibc_t
("witness_hash", block_2_result.level_2_commitments_digest)
("finality_mroot", block_2_result.finality_root)
)
("timestamp", block_2_result.block->timestamp)
("parent_timestamp", block_2_result.parent_timestamp)
("dynamic_data", mvo()
("block_num", block_2_result.block->block_num())
("action_proofs", fc::variants())
Expand All @@ -233,6 +235,8 @@ BOOST_AUTO_TEST_CASE(ibc_test) {} // TODO remove this and re-enable actual ibc_t
("witness_hash", block_2_result.level_2_commitments_digest)
("finality_mroot", block_2_result.finality_root)
)
("timestamp", block_2_result.block->timestamp)
("parent_timestamp", block_2_result.parent_timestamp)
("dynamic_data", mvo()
("block_num", block_2_result.block->block_num())
("action_proofs", fc::variants())
Expand Down Expand Up @@ -284,9 +288,9 @@ BOOST_AUTO_TEST_CASE(ibc_test) {} // TODO remove this and re-enable actual ibc_t
// take note of policy digest prior to changes
digest_type previous_policy_digest = cluster.active_finalizer_policy_digest;

// at this stage, we can test the change in pending policy.
// At this stage, we can prepare to test the change of pending policy.

// we first take a note of the pending policy. When we get a QC on block #9, the pending policy will update.
// We first take a note of the pending policy. When we get a QC on block #9, the pending policy will update.
digest_type pending_policy_digest = cluster.last_pending_finalizer_policy_digest;

// change the finalizer policy by rotating the key of node0
Expand All @@ -295,25 +299,30 @@ BOOST_AUTO_TEST_CASE(ibc_test) {} // TODO remove this and re-enable actual ibc_t
// produce a new block. This block contains a new proposed finalizer policy
auto block_8_result = cluster.produce_block();

// verify we have a QC
BOOST_TEST(block_8_result.qc_data.qc.has_value());

// verify the block header contains the proposed finalizer policy differences
BOOST_TEST(finality_proof::has_finalizer_policy_diffs(block_8_result.block));

// advance finality
auto block_9_result = cluster.produce_block();

// verify we have a QC
BOOST_TEST(block_9_result.qc_data.qc.has_value());

// pending policy is still the same
BOOST_TEST(pending_policy_digest==cluster.last_pending_finalizer_policy_digest);

// QC on #9 included in #10 makes #8 final, proposed policy is now pending
auto block_10_result = cluster.produce_block();

// verify that the last pending policy has been updated
BOOST_TEST(pending_policy_digest!=cluster.last_pending_finalizer_policy_digest);

// verify we have all the QCs up to this point
BOOST_TEST(block_8_result.qc_data.qc.has_value());
BOOST_TEST(block_9_result.qc_data.qc.has_value());
// verify we have a QC
BOOST_TEST(block_10_result.qc_data.qc.has_value());
BOOST_TEST(!block_10_result.qc_data.qc.value().pending_policy_sig.has_value()); //verify this block requires a single QC

// Verify that the last pending policy has been updated
BOOST_TEST(pending_policy_digest!=cluster.last_pending_finalizer_policy_digest);

// At this stage, we can prove the inclusion of actions into block #7.

Expand Down Expand Up @@ -387,8 +396,8 @@ BOOST_AUTO_TEST_CASE(ibc_test) {} // TODO remove this and re-enable actual ibc_t
("finality_mroot", block_8_result.finality_root)
)
("qc", mvo()
("signature", block_10_result.qc_data.qc.value().active_policy_sig.sig.to_string())
("finalizers", active_finalizers_string(block_10_result))
("signature", block_9_result.qc_data.qc.value().active_policy_sig.sig.to_string())
("finalizers", active_finalizers_string(block_9_result))
)
)
("target_block_proof_of_inclusion", mvo()
Expand All @@ -403,6 +412,8 @@ BOOST_AUTO_TEST_CASE(ibc_test) {} // TODO remove this and re-enable actual ibc_t
("witness_hash", block_7_result.level_2_commitments_digest)
("finality_mroot", block_7_result.finality_root)
)
("timestamp", block_7_result.block->timestamp)
("parent_timestamp", block_7_result.parent_timestamp)
("dynamic_data", mvo()
("block_num", block_7_result.block->block_num())
("action_proofs", fc::variants({onblock_action_proof}))
Expand All @@ -427,6 +438,8 @@ BOOST_AUTO_TEST_CASE(ibc_test) {} // TODO remove this and re-enable actual ibc_t
("witness_hash", block_7_result.level_2_commitments_digest)
("finality_mroot", block_7_result.finality_root)
)
("timestamp", block_7_result.block->timestamp)
("parent_timestamp", block_7_result.parent_timestamp)
("dynamic_data", mvo()
("block_num", block_7_result.block->block_num())
("action_proofs", fc::variants({action_proof_1, action_proof_2}))
Expand All @@ -440,47 +453,22 @@ BOOST_AUTO_TEST_CASE(ibc_test) {} // TODO remove this and re-enable actual ibc_t
action_trace check_action_heavy_proof_trace = cluster.node0.push_action("ibc"_n, "checkproof"_n, "ibc"_n, action_heavy_proof)->action_traces[0];

action_trace check_action_light_proof_trace = cluster.node0.push_action("ibc"_n, "checkproof"_n, "ibc"_n, action_light_proof)->action_traces[0];

// At this stage, we can test the change in pending policy.

// We first take a note of the pending policy. When we get a QC on block #10, the pending policy will update.
digest_type pending_policy_digest = cluster.last_pending_finalizer_policy_digest;

// still the same
BOOST_TEST(pending_policy_digest==cluster.last_pending_finalizer_policy_digest);

// QC on #10 included in #11 makes #8 final, proposed policy is now pending
auto block_11_result = cluster.produce_block();

BOOST_TEST(!block_11_result.qc_data.qc.value().pending_policy_sig.has_value());

// verify that the last pending policy has been updated
BOOST_TEST(pending_policy_digest!=cluster.last_pending_finalizer_policy_digest);

auto block_12_result = cluster.produce_block();

// block #12 contains our first joint policies QCs
BOOST_TEST(block_12_result.qc_data.qc.value().pending_policy_sig.has_value());

auto block_13_result = cluster.produce_block(); //new policy takes effect on next block

BOOST_TEST(block_13_result.qc_data.qc.value().pending_policy_sig.has_value());

//verify that the current finalizer policy is still in force up to this point
BOOST_TEST(previous_policy_digest==cluster.active_finalizer_policy_digest);

auto block_14_result = cluster.produce_block();
auto block_11_result = cluster.produce_block(); // last pending policy (proposed in #8) takes effect and becomes active on next block
BOOST_TEST(block_11_result.qc_data.qc.value().pending_policy_sig.has_value()); //this block requires joint policies QCs

BOOST_TEST(block_14_result.qc_data.qc.value().pending_policy_sig.has_value());
auto block_12_result = cluster.produce_block();
BOOST_TEST(block_12_result.qc_data.qc.value().pending_policy_sig.has_value()); //this block requires joint policies QCs

//verify that the new finalizer policy is now in force
BOOST_TEST(previous_policy_digest!=cluster.active_finalizer_policy_digest);

auto block_13_result = cluster.produce_block();
auto block_13_result = cluster.produce_block();
BOOST_TEST(!block_13_result.qc_data.qc.value().pending_policy_sig.has_value()); //verify this block requires a single QC

auto block_14_result = cluster.produce_block();
auto block_15_result = cluster.produce_block();

BOOST_TEST(!block_15_result.qc_data.qc.value().pending_policy_sig.has_value());
auto block_15_result = cluster.produce_block();

auto block_16_result = cluster.produce_block();
auto block_17_result = cluster.produce_block();
Expand Down Expand Up @@ -516,8 +504,8 @@ BOOST_AUTO_TEST_CASE(ibc_test) {} // TODO remove this and re-enable actual ibc_t
("finality_mroot", block_11_result.finality_root)
)
("qc", mvo()
("signature", block_14_result.qc_data.qc.value().active_policy_sig.sig.to_string())
("finalizers", active_finalizers_string(block_14_result))
("signature", block_12_result.qc_data.qc.value().active_policy_sig.sig.to_string())
("finalizers", active_finalizers_string(block_12_result))
)
)
("target_block_proof_of_inclusion", mvo()
Expand All @@ -528,13 +516,15 @@ BOOST_AUTO_TEST_CASE(ibc_test) {} // TODO remove this and re-enable actual ibc_t
("major_version", 1)
("minor_version", 0)
("finalizer_policy_generation", 1)
("last_pending_finalizer_policy_start_num", block_11_result.block->block_num())
("final_on_strong_qc_block_num", 13)
("new_finalizer_policy", cluster.last_pending_finalizer_policy)
("witness_hash", block_10_result.base_digest)
("reversible_blocks_mroot", block_10_result.finality_data.reversible_blocks_mroot)
("last_pending_finalizer_policy_start_num", block_10_result.last_pending_finalizer_policy_start_num )
("finality_mroot", block_10_result.finality_root)
)
("timestamp", block_10_result.block->timestamp)
("parent_timestamp", block_10_result.parent_timestamp)
("dynamic_data", mvo()
("block_num", block_10_result.block->block_num())
("action_proofs", fc::variants())
Expand Down Expand Up @@ -565,8 +555,8 @@ BOOST_AUTO_TEST_CASE(ibc_test) {} // TODO remove this and re-enable actual ibc_t
("finality_mroot", block_12_result.finality_root)
)
("qc", mvo()
("signature", block_15_result.qc_data.qc.value().active_policy_sig.sig.to_string())
("finalizers", active_finalizers_string(block_15_result))
("signature", block_13_result.qc_data.qc.value().active_policy_sig.sig.to_string())
("finalizers", active_finalizers_string(block_13_result))
)
)
("target_block_proof_of_inclusion", mvo()
Expand All @@ -581,6 +571,8 @@ BOOST_AUTO_TEST_CASE(ibc_test) {} // TODO remove this and re-enable actual ibc_t
("witness_hash", block_11_result.level_2_commitments_digest)
("finality_mroot", block_11_result.finality_root)
)
("timestamp", block_11_result.block->timestamp)
("parent_timestamp", block_11_result.parent_timestamp)
("dynamic_data", mvo()
("block_num", block_11_result.block->block_num())
("action_proofs", fc::variants())
Expand Down Expand Up @@ -684,5 +676,5 @@ BOOST_AUTO_TEST_CASE(ibc_test) {} // TODO remove this and re-enable actual ibc_t
);

} FC_LOG_AND_RETHROW() }
#endif // TODO re-enable

BOOST_AUTO_TEST_SUITE_END()
Loading