Merge pull request #93 from dusk-network/vlopes11/microkelvin-hosted

PoseidonTree canon and canon_host features

.github/workflows/dusk_ci.yml

@@ -65,6 +65,21 @@ jobs:
           command: test
           args: --release --features canon
 
+  test_nightly_canon_host:
+    name: Nightly tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: nightly
+          override: true
+      - uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: --release --features canon_host
+
   fmt:
     name: Rustfmt
     runs-on: ubuntu-latest

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.13.1] - 06-11-20
+### Changed
+- Feature split between `canon` and `canon_host` for constrained and unconstrained environments.
+- Canon implementation for PoseidonTree.
+
 ## [0.13.0] - 04-11-20
 ### Changed
 - PoseidonLeaf pos setter for API consistency with Phoenix

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "poseidon252"
-version = "0.13.0"
+version = "0.13.1"
 authors = [
   "zer0 <[email protected]>",	"vlopes11 <[email protected]>",	"CPerezz <[email protected]>", "Kristoffer Ström <[email protected]>"
 ]
@@ -25,6 +25,7 @@ criterion = "0.3"
 
 [features]
 canon = ["canonical", "canonical_derive", "nstack", "microkelvin", "dusk-plonk/canon"]
+canon_host = ["canon", "canonical/host"]
 
 [profile.dev]
 opt-level = 3

README.md

@@ -170,6 +170,15 @@ fn main() -> Result<()> {
 }
 ```
 
+## Canonical
+The canonical implementations aim to make available a single representation of the Merkle tree to constrained (referred to as "hosted") and unconstrained (referred to as "host") environments.
+
+For that, we rely on the features `canon` and `canon_host`.
+
+`canon` feature will require all the crates needed for the Merkle tree to function.
+
+`canon_host` feature will require `canon`, with the addition of the host environment implementations.
+
 ## Documentation
 This crate contains info about all of the functions that the library provides as well as the
 documentation regarding the data structures that it exports. To check it, please feel free to go to

src/tree/mod.rs

@@ -5,9 +5,8 @@
 // Copyright (c) DUSK NETWORK. All rights reserved.
 
 use anyhow::{anyhow, Result};
-
-#[cfg(feature = "canon")]
 use canonical::{Canon, Store};
+use canonical_derive::Canon;
 use dusk_plonk::prelude::BlsScalar;
 use microkelvin::{Branch, Cardinality, Nth};
 use nstack::NStack;
@@ -54,7 +53,7 @@ where
 ///
 /// The `BlsScalar` borrow of the annotation must represent the root poseidon merkle opening
 /// for the annotated subtree
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, Canon)]
 pub struct PoseidonTree<L, A, S, const DEPTH: usize>
 where
     L: PoseidonLeaf<S>,

src/tree/tests.rs

@@ -4,7 +4,6 @@
 //
 // Copyright (c) DUSK NETWORK. All rights reserved.
 
-#![cfg(feature = "canon")]
 use crate::tree::zk::merkle_opening;
 use crate::tree::{
     PoseidonAnnotation, PoseidonLeaf, PoseidonMaxAnnotation, PoseidonTree,