Merge pull request #145 from cowlicks/update-encodable

Update to new version of compact encodable and use it Clean up encoding implementations

Author: cowlicks

.github/workflows/ci.yml

@@ -8,6 +8,8 @@ on:
 env:
   RUST_BACKTRACE: 1
   CARGO_TERM_COLOR: always
+  RUSTFLAGS: "-Dwarnings"
+  RUSTDOCFLAGS: "-Dwarnings"
 
 jobs:
   ci-pass:
@@ -145,4 +147,6 @@ jobs:
         token: ${{ secrets.GITHUB_TOKEN }}
     - name: Format check
       run: |
+        cargo doc
         cargo fmt -- --check
+        cargo clippy --all-targets

Cargo.toml

@@ -27,7 +27,7 @@ ed25519-dalek = { version = "2", features = ["rand_core"] }
 getrandom = { version = "0.2", features = ["js"] }
 thiserror = "1"
 tracing = "0.1"
-compact-encoding = "1"
+compact-encoding = "2"
 flat-tree = "6"
 merkle-tree-stream =  "0.12"
 pretty-hash = "0.4"
@@ -47,8 +47,8 @@ random-access-disk = { version = "3", default-features = false }
 
 [dev-dependencies]
 anyhow = "1.0.70"
-proptest = "1.1.0"
-proptest-derive = "0.2.0"
+proptest = "1.6.0"
+proptest-derive = "0.5.1"
 data-encoding = "2.2.0"
 remove_dir_all = "0.7.0"
 tempfile = "3.1.0"

src/common/mod.rs

@@ -16,7 +16,7 @@ pub use self::store::Store;
 pub(crate) use self::store::{StoreInfo, StoreInfoInstruction, StoreInfoType};
 
 #[derive(Debug, Clone, PartialEq, Eq)]
-pub struct BitfieldUpdate {
+pub(crate) struct BitfieldUpdate {
     pub(crate) drop: bool,
     pub(crate) start: u64,
     pub(crate) length: u64,

src/common/node.rs

@@ -23,6 +23,8 @@ pub struct Node {
     /// This node's index in the Merkle tree
     pub(crate) index: u64,
     /// Hash of the data in this node
+    // TODO make this [u8; 32] like:
+    // https://github.com/holepunchto/hypercore/blob/d21ebdeca1b27eb4c2232f8af17d5ae939ee97f2/lib/messages.js#L246
     pub(crate) hash: Vec<u8>,
     /// Number of bytes in this [`Node::data`]
     pub(crate) length: u64,

src/crypto/hash.rs

@@ -3,7 +3,7 @@ use blake2::{
     Blake2b, Blake2bMac, Digest,
 };
 use byteorder::{BigEndian, WriteBytesExt};
-use compact_encoding::State;
+use compact_encoding::{as_array, to_encoded_bytes, EncodingError, FixedWidthEncoding};
 use ed25519_dalek::VerifyingKey;
 use merkle_tree_stream::Node as NodeTrait;
 use std::convert::AsRef;
@@ -124,10 +124,9 @@ impl Hash {
 
     /// Hash data
     pub(crate) fn data(data: &[u8]) -> Self {
-        let (mut state, mut size) = State::new_with_size(8);
-        state
-            .encode_u64(data.len() as u64, &mut size)
-            .expect("Encoding u64 should not fail");
+        let size =
+            (|| Ok::<_, EncodingError>(to_encoded_bytes!((data.len() as u64).as_fixed_width())))()
+                .expect("Encoding u64 should not fail");
 
         let mut hasher = Blake2b256::new();
         hasher.update(LEAF_TYPE);
@@ -147,10 +146,10 @@ impl Hash {
             (right, left)
         };
 
-        let (mut state, mut size) = State::new_with_size(8);
-        state
-            .encode_u64(node1.length + node2.length, &mut size)
-            .expect("Encoding u64 should not fail");
+        let len = node1.length + node2.length;
+        let size: Box<[u8]> =
+            (|| Ok::<_, EncodingError>(to_encoded_bytes!(len.as_fixed_width())))()
+                .expect("Encoding u64 should not fail");
 
         let mut hasher = Blake2b256::new();
         hasher.update(PARENT_TYPE);
@@ -170,13 +169,13 @@ impl Hash {
 
         for node in roots {
             let node = node.as_ref();
-            let (mut state, mut buffer) = State::new_with_size(16);
-            state
-                .encode_u64(node.index(), &mut buffer)
-                .expect("Encoding u64 should not fail");
-            state
-                .encode_u64(node.len(), &mut buffer)
-                .expect("Encoding u64 should not fail");
+            let buffer = (|| {
+                Ok::<_, EncodingError>(to_encoded_bytes!(
+                    node.index().as_fixed_width(),
+                    node.len().as_fixed_width()
+                ))
+            })()
+            .expect("Encoding u64 should not fail");
 
             hasher.update(node.hash());
             hasher.update(&buffer[..8]);
@@ -212,20 +211,15 @@ impl DerefMut for Hash {
 /// Create a signable buffer for tree. This is treeSignable in Javascript.
 /// See https://github.com/hypercore-protocol/hypercore/blob/70b271643c4e4b1e5ecae5bb579966dfe6361ff3/lib/caps.js#L17
 pub(crate) fn signable_tree(hash: &[u8], length: u64, fork: u64) -> Box<[u8]> {
-    let (mut state, mut buffer) = State::new_with_size(80);
-    state
-        .encode_fixed_32(&TREE, &mut buffer)
-        .expect("Should be able ");
-    state
-        .encode_fixed_32(hash, &mut buffer)
-        .expect("Encoding fixed 32 bytes should not fail");
-    state
-        .encode_u64(length, &mut buffer)
-        .expect("Encoding u64 should not fail");
-    state
-        .encode_u64(fork, &mut buffer)
-        .expect("Encoding u64 should not fail");
-    buffer
+    (|| {
+        Ok::<_, EncodingError>(to_encoded_bytes!(
+            &TREE,
+            as_array::<32>(hash)?,
+            length.as_fixed_width(),
+            fork.as_fixed_width()
+        ))
+    })()
+    .expect("Encoding should not fail")
 }
 
 #[cfg(test)]