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

chore(light-client): update according to the RFC changes #3648

Merged
merged 3 commits into from
Oct 24, 2022
Merged

chore(light-client): update according to the RFC changes #3648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
71b7658
chore(light-client): rename the "hash" filed in HeaderDigest to "chil…
chaoticlonghair Oct 20, 2022
bdddb34
docs(light-client): remove outdated documentation and link to the rel…
chaoticlonghair Oct 20, 2022
39ff541
chore(deps): bump ckb-merkle-mountain-range from 0.5.1 to 0.5.2
chaoticlonghair Oct 20, 2022
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
4 changes: 2 additions & 2 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion chain/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ ckb-app-config = { path = "../util/app-config", version = "= 0.105.0-pre" }
ckb-rust-unstable-port = { path = "../util/rust-unstable-port", version = "= 0.105.0-pre" }
ckb-channel = { path = "../util/channel", version = "= 0.105.0-pre" }
faux = { version = "^0.1", optional = true }
ckb-merkle-mountain-range = "0.5.1"
ckb-merkle-mountain-range = "0.5.2"

[dev-dependencies]
ckb-test-chain-utils = { path = "../util/test-chain-utils", version = "= 0.105.0-pre" }
Expand Down
2 changes: 1 addition & 1 deletion store/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ ckb-error = { path = "../error", version = "= 0.105.0-pre" }
ckb-app-config = { path = "../util/app-config", version = "= 0.105.0-pre" }
ckb-db-schema = { path = "../db-schema", version = "= 0.105.0-pre" }
ckb-freezer = { path = "../freezer", version = "= 0.105.0-pre" }
ckb-merkle-mountain-range = "0.5.1"
ckb-merkle-mountain-range = "0.5.2"

[dev-dependencies]
tempfile = "3.0"
Expand Down
2 changes: 1 addition & 1 deletion util/light-client-protocol-server/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ ckb-shared = { path = "../../shared", version = "= 0.105.0-pre" }
ckb-logger = { path = "../logger", version = "= 0.105.0-pre" }
ckb-types = { path = "../types", version = "= 0.105.0-pre" }
ckb-store = { path = "../../store", version = "= 0.105.0-pre" }
ckb-merkle-mountain-range = "0.5.1"
ckb-merkle-mountain-range = "0.5.2"

[dev-dependencies]
ckb-chain = { path = "../../chain", version = "= 0.105.0-pre" }
Expand Down
2 changes: 1 addition & 1 deletion util/snapshot/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ ckb-proposal-table = { path = "../proposal-table", version = "= 0.105.0-pre" }
arc-swap = "1.3"
ckb-db-schema = { path = "../../db-schema", version = "= 0.105.0-pre" }
ckb-freezer = { path = "../../freezer", version = "= 0.105.0-pre" }
ckb-merkle-mountain-range = "0.5.1"
ckb-merkle-mountain-range = "0.5.2"

[features]
portable = ["ckb-db/portable", "ckb-store/portable"]
Expand Down
2 changes: 1 addition & 1 deletion util/types/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ ckb-error = { path = "../../error", version = "= 0.105.0-pre" }
ckb-rational = { path = "../rational", version = "= 0.105.0-pre" }
once_cell = "1.8.0"
derive_more = { version = "0.99.0", default-features=false, features = ["display"] }
ckb-merkle-mountain-range = "0.5.1"
ckb-merkle-mountain-range = "0.5.2"

[dev-dependencies]
proptest = "1.0"
2 changes: 1 addition & 1 deletion util/types/schemas/extensions.mol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ vector OutPointVec <OutPoint>;
/* Types for Light Client */

struct HeaderDigest {
hash: Byte32,
children_hash: Byte32,

total_difficulty: Uint256,

Expand Down
18 changes: 9 additions & 9 deletions util/types/src/generated/extensions.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2490,7 +2490,7 @@ impl ::core::fmt::Debug for HeaderDigest {
impl ::core::fmt::Display for HeaderDigest {
fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
write!(f, "{} {{ ", Self::NAME)?;
write!(f, "{}: {}", "hash", self.hash())?;
write!(f, "{}: {}", "children_hash", self.children_hash())?;
write!(f, ", {}: {}", "total_difficulty", self.total_difficulty())?;
write!(f, ", {}: {}", "start_number", self.start_number())?;
write!(f, ", {}: {}", "end_number", self.end_number())?;
Expand Down Expand Up @@ -2529,7 +2529,7 @@ impl HeaderDigest {
pub const TOTAL_SIZE: usize = 120;
pub const FIELD_SIZES: [usize; 10] = [32, 32, 8, 8, 8, 8, 8, 8, 4, 4];
pub const FIELD_COUNT: usize = 10;
pub fn hash(&self) -> Byte32 {
pub fn children_hash(&self) -> Byte32 {
Byte32::new_unchecked(self.0.slice(0..32))
}
pub fn total_difficulty(&self) -> Uint256 {
Expand Down Expand Up @@ -2586,7 +2586,7 @@ impl molecule::prelude::Entity for HeaderDigest {
}
fn as_builder(self) -> Self::Builder {
Self::new_builder()
.hash(self.hash())
.children_hash(self.children_hash())
.total_difficulty(self.total_difficulty())
.start_number(self.start_number())
.end_number(self.end_number())
Expand Down Expand Up @@ -2617,7 +2617,7 @@ impl<'r> ::core::fmt::Debug for HeaderDigestReader<'r> {
impl<'r> ::core::fmt::Display for HeaderDigestReader<'r> {
fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
write!(f, "{} {{ ", Self::NAME)?;
write!(f, "{}: {}", "hash", self.hash())?;
write!(f, "{}: {}", "children_hash", self.children_hash())?;
write!(f, ", {}: {}", "total_difficulty", self.total_difficulty())?;
write!(f, ", {}: {}", "start_number", self.start_number())?;
write!(f, ", {}: {}", "end_number", self.end_number())?;
Expand All @@ -2644,7 +2644,7 @@ impl<'r> HeaderDigestReader<'r> {
pub const TOTAL_SIZE: usize = 120;
pub const FIELD_SIZES: [usize; 10] = [32, 32, 8, 8, 8, 8, 8, 8, 4, 4];
pub const FIELD_COUNT: usize = 10;
pub fn hash(&self) -> Byte32Reader<'r> {
pub fn children_hash(&self) -> Byte32Reader<'r> {
Byte32Reader::new_unchecked(&self.as_slice()[0..32])
}
pub fn total_difficulty(&self) -> Uint256Reader<'r> {
Expand Down Expand Up @@ -2698,7 +2698,7 @@ impl<'r> molecule::prelude::Reader<'r> for HeaderDigestReader<'r> {
}
#[derive(Debug, Default)]
pub struct HeaderDigestBuilder {
pub(crate) hash: Byte32,
pub(crate) children_hash: Byte32,
pub(crate) total_difficulty: Uint256,
pub(crate) start_number: Uint64,
pub(crate) end_number: Uint64,
Expand All @@ -2713,8 +2713,8 @@ impl HeaderDigestBuilder {
pub const TOTAL_SIZE: usize = 120;
pub const FIELD_SIZES: [usize; 10] = [32, 32, 8, 8, 8, 8, 8, 8, 4, 4];
pub const FIELD_COUNT: usize = 10;
pub fn hash(mut self, v: Byte32) -> Self {
self.hash = v;
pub fn children_hash(mut self, v: Byte32) -> Self {
self.children_hash = v;
self
}
pub fn total_difficulty(mut self, v: Uint256) -> Self {
Expand Down Expand Up @@ -2761,7 +2761,7 @@ impl molecule::prelude::Builder for HeaderDigestBuilder {
Self::TOTAL_SIZE
}
fn write<W: molecule::io::Write>(&self, writer: &mut W) -> molecule::io::Result<()> {
writer.write_all(self.hash.as_slice())?;
writer.write_all(self.children_hash.as_slice())?;
writer.write_all(self.total_difficulty.as_slice())?;
writer.write_all(self.start_number.as_slice())?;
writer.write_all(self.end_number.as_slice())?;
Expand Down
86 changes: 3 additions & 83 deletions util/types/src/utilities/merkle_mountain_range.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,88 +1,8 @@
//! Types for variable difficulty Merkle Mountain Range (MMR) in CKB.
//!
//! Since CKB doesn't record MMR data in headers since the genesis block, we use an activation
//! block number to enable MMR and create all MMR nodes before that block to make sure that the
//! index of MMR leaf is EQUAL to the block number.
//!
//! ```text
//! height position
//!
//! 3 14
//! / \
//! / \
//! / \
//! / \
//! / \
//! / \
//! 2 6 13
//! / \ / \
//! / \ / \
//! / \ / \
//! 1 2 5 9 12 17
//! / \ / \ / \ / \ / \
//! 0 0 1 3 4 7 8 10 11 15 16 18
//! --------------------------------------------------------
//! index 0 1 2 3 4 5 6 7 8 9 10 ... N
//! --------------------------------------------------------
//! number 0 1 2 3 4 5 6 7 8 9 10 ... N
//! --------------------------------------------------------
//! ```
//!
//! - `height`: the MMR node height.
//! - `position`: the MMR node position.
//! - `index`: the MMR leaf index; same as the block height.
//! - `number`: the block height.
//! - `N`: the activation block number; the block number of the last block which doesn't records MMR root hash.
//!
//! There are three kind of blocks base on its MMR data:
//!
//! - The genesis block
//!
//! First node, also first leaf node in MMR; no chain root;
//!
//! - The blocks which height is less than `N`
//!
//! No chain root in blocks but store them in database.
//!
//! - The blocks which height is equal to or greater than `N`
//!
//! Has chain root in blocks.
//!
//! There are two kinds of MMR nodes: leaf node and non-leaf node.
//!
//! Each MMR node is defined as follows:
//!
//! - `hash`
//!
//! - For leaf node, it's an empty hash (`0x0000...0000`).
//!
//! - For non-leaf node, it's the hash of it's child nodes' hashes (concatenate serialized data).
//!
//! - `total_difficulty`
//!
//! - For leaf node, it's the difficulty it took to mine the current block.
//!
//! - For non-leaf node, it's the sum of `total_difficulty` in it's child nodes.
//!
//! - `start_*`
//!
//! Such as `start_number`, `start_epoch`, `start_timestamp`, `start_compact_target`.
//!
//! - For leaf node, it's the data of current block.
//!
//! - For non-leaf node, it's the `start_*` of left node.
//!
//! - `end_*`
//!
//! Such as `end_number`, `end_epoch`, `end_timestamp`, `end_compact_target`.
//!
//! - For leaf node, it's the data of current block.
//!
//! - For non-leaf node, it's the `end_*` of right node.
//!
//! ## References
//!
//! - [Peter Todd, Merkle mountain range.](https://github.com/opentimestamps/opentimestamps-server/blob/master/doc/merkle-mountain-range.md).
//! - [CKB RFC 0044](https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0044-ckb-light-client/0044-ckb-light-client.md)

use ckb_hash::new_blake2b;
use ckb_merkle_mountain_range::{Error as MMRError, Merge, MerkleProof, Result as MMRResult, MMR};
Expand Down Expand Up @@ -211,7 +131,7 @@ impl Merge for MergeHeaderDigest {
type Item = packed::HeaderDigest;

fn merge(lhs: &Self::Item, rhs: &Self::Item) -> MMRResult<Self::Item> {
let hash = {
let children_hash = {
let mut hasher = new_blake2b();
let mut hash = [0u8; 32];
hasher.update(&lhs.calc_mmr_hash().raw_data());
Expand Down Expand Up @@ -249,7 +169,7 @@ impl Merge for MergeHeaderDigest {
}

Ok(Self::Item::new_builder()
.hash(hash.pack())
.children_hash(children_hash.pack())
.total_difficulty(total_difficulty.pack())
.start_number(lhs.start_number())
.start_epoch(lhs.start_epoch())
Expand Down
2 changes: 1 addition & 1 deletion verification/contextual/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ tokio = { version = "1", features = ["sync", "rt-multi-thread"] }
ckb-async-runtime = { path = "../../util/runtime", version = "= 0.105.0-pre" }
ckb-verification-traits = { path = "../traits", version = "= 0.105.0-pre" }
ckb-verification = { path = "..", version = "= 0.105.0-pre" }
ckb-merkle-mountain-range = "0.5.1"
ckb-merkle-mountain-range = "0.5.2"

[dev-dependencies]
ckb-chain = { path = "../../chain", version = "= 0.105.0-pre" }
Expand Down