Restructure workspace

dusk-network · Nov 25, 2024 · 5579a71 · 5579a71
1 parent 9d79b44
commit 5579a71
Show file tree

Hide file tree

Showing 19 changed files with 97 additions and 52 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,4 @@
-/target/
-/setup/
+**/target/
 Cargo.lock
 **/*.rs.bk
 .DS_Store

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,34 +1,6 @@
-[package]
-name = "zk-citadel"
-version = "0.14.0"
-repository = "https://github.com/dusk-network/citadel"
-description = "Implementation of Citadel, a SSI system integrated in Dusk Network."
-categories = ["cryptography", "authentication", "mathematics", "science"]
-keywords = ["cryptography", "self-sovereign", "identity", "zk-snarks", "zero-knowledge"]
-edition = "2021"
-license = "MPL-2.0"
-
-[dependencies]
-dusk-bytes = "0.1"
-dusk-poseidon = { version = "0.40", features = ["zk"] }
-poseidon-merkle = { version = "0.7", features = ["rkyv-impl", "zk", "size_32"] }
-dusk-plonk = { version = "0.20", default-features = false, features = ["rkyv-impl", "alloc"] }
-dusk-bls12_381 = { version = "0.13", default-features = false, features = ["rkyv-impl", "alloc"] }
-dusk-jubjub = { version = "0.14", default-features = false, features = ["rkyv-impl", "alloc"] }
-ff = { version = "0.13", default-features = false }
-jubjub-schnorr = { version = "0.5", features = ["zk", "rkyv-impl", "alloc"] }
-phoenix-core = { version = "0.32", features = ["rkyv-impl", "alloc"] }
-rand_core = { version = "0.6", default-features=false, features = ["getrandom"] }
-rkyv = { version = "0.7", default-features = false }
-bytecheck = { version = "0.6", default-features = false }
-
-[dev-dependencies]
-criterion = "0.5"
-
-[[bench]]
-name = "license_circuit"
-harness = false
-
-[features]
-rkyv-impl = []
-default=["rkyv-impl"]
+[workspace]
+members = [
+    "core",
+    "contract",
+]
+resolver = "2"
diff --git a/README.md b/README.md
@@ -3,22 +3,12 @@
 ![Build Status](https://github.com/dusk-network/citadel/workflows/Continuous%20integration/badge.svg)
 [![Repository](https://img.shields.io/badge/github-citadel-blueviolet?logo=github)](https://github.com/dusk-network/citadel)
 
-This repository contains the implementation of Citadel, a protocol that integrates a self-sovereign identity system into the Dusk blockchain. A document with all the details about the protocol can be found [here](https://github.com/dusk-network/citadel/tree/main/docs/specs.pdf).
+This repository contains the implementation of Citadel, a protocol that integrates a self-sovereign identity system into the Dusk blockchain. Our implementation is based on the original idea from this [paper](https://arxiv.org/pdf/2301.09378).
 
-**DISCLAIMER**: this library **has not gone through an exhaustive security analysis**, so it is not intended to be used in a production environment, only for academic purposes.
+This repository is structured as follows:
 
-## Tests
+- :computer: [**Core**](core): the core Citadel protocol implementation, containing all the involved data types, the protocol workflows, and the license circuit.
+- :pencil: [**License Contract**](contract): The license contract, along with all the required code to test and deploy it.
+- :scroll: [**Docs**](docs): A folder where you can find the documentation concerning the our Citadel specific implementation.
 
-The library can be tested by running:
-
-```
-cargo t --release
-```
-
-## Benchmarks
-
-The library can be benchmarked by running:
-
-```
-cargo bench
-```
+**DISCLAIMER**: the code in this repository **has not gone through an exhaustive security analysis**, so it is not intended to be used in a production environment, only for academic purposes.
diff --git a/contract/Cargo.toml b/contract/Cargo.toml
@@ -0,0 +1,6 @@
+[package]
+name = "license-contract"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
diff --git a/contract/LICENSE b/contract/LICENSE
@@ -0,0 +1 @@
+../LICENSE
diff --git a/contract/README.md b/contract/README.md
@@ -0,0 +1,9 @@
+# (WIP) Citadel Contract
+
+![Build Status](https://github.com/dusk-network/citadel/workflows/Continuous%20integration/badge.svg)
+[![Repository](https://img.shields.io/badge/github-citadel-blueviolet?logo=github)](https://github.com/dusk-network/citadel)
+
+This package contains the Citadel contract.
+
+**DISCLAIMER**: this contract **has not gone through an exhaustive security analysis**, so it is not intended to be used in a production environment, only for academic purposes.
+
diff --git a/contract/src/main.rs b/contract/src/main.rs
@@ -0,0 +1,9 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+//
+// Copyright (c) DUSK NETWORK. All rights reserved.
+
+fn main() {
+    println!("Hello, world!");
+}
diff --git a/CHANGELOG.md → core/CHANGELOG.md b/CHANGELOG.md → core/CHANGELOG.md
diff --git a/core/Cargo.toml b/core/Cargo.toml
@@ -0,0 +1,34 @@
+[package]
+name = "zk-citadel"
+version = "0.14.0"
+repository = "https://github.com/dusk-network/citadel/core"
+description = "Implementation of Citadel, a SSI system integrated in Dusk Network."
+categories = ["cryptography", "authentication", "mathematics", "science"]
+keywords = ["cryptography", "self-sovereign", "identity", "zk-snarks", "zero-knowledge"]
+edition = "2021"
+license = "MPL-2.0"
+
+[dependencies]
+dusk-bytes = "0.1"
+dusk-poseidon = { version = "0.40", features = ["zk"] }
+poseidon-merkle = { version = "0.7", features = ["rkyv-impl", "zk", "size_32"] }
+dusk-plonk = { version = "0.20", default-features = false, features = ["rkyv-impl", "alloc"] }
+dusk-bls12_381 = { version = "0.13", default-features = false, features = ["rkyv-impl", "alloc"] }
+dusk-jubjub = { version = "0.14", default-features = false, features = ["rkyv-impl", "alloc"] }
+ff = { version = "0.13", default-features = false }
+jubjub-schnorr = { version = "0.5", features = ["zk", "rkyv-impl", "alloc"] }
+phoenix-core = { version = "0.32", features = ["rkyv-impl", "alloc"] }
+rand_core = { version = "0.6", default-features=false, features = ["getrandom"] }
+rkyv = { version = "0.7", default-features = false }
+bytecheck = { version = "0.6", default-features = false }
+
+[dev-dependencies]
+criterion = "0.5"
+
+[[bench]]
+name = "license_circuit"
+harness = false
+
+[features]
+rkyv-impl = []
+default=["rkyv-impl"]
diff --git a/core/LICENSE b/core/LICENSE
@@ -0,0 +1 @@
+../LICENSE
diff --git a/core/README.md b/core/README.md
@@ -0,0 +1,24 @@
+# Citadel Core
+
+![Build Status](https://github.com/dusk-network/citadel/workflows/Continuous%20integration/badge.svg)
+[![Repository](https://img.shields.io/badge/github-citadel-blueviolet?logo=github)](https://github.com/dusk-network/citadel)
+
+This package contains the core implementation of Citadel.
+
+**DISCLAIMER**: this package **has not gone through an exhaustive security analysis**, so it is not intended to be used in a production environment, only for academic purposes.
+
+## Tests
+
+The package can be tested by running:
+
+```
+cargo t --release
+```
+
+## Benchmarks
+
+The package can be benchmarked by running:
+
+```
+cargo bench
+```
diff --git a/benches/license_circuit.rs → core/benches/license_circuit.rs b/benches/license_circuit.rs → core/benches/license_circuit.rs
diff --git a/src/error.rs → core/src/error.rs b/src/error.rs → core/src/error.rs
diff --git a/src/gadgets.rs → core/src/gadgets.rs b/src/gadgets.rs → core/src/gadgets.rs
diff --git a/src/lib.rs → core/src/lib.rs b/src/lib.rs → core/src/lib.rs
diff --git a/src/license.rs → core/src/license.rs b/src/license.rs → core/src/license.rs
diff --git a/src/request.rs → core/src/request.rs b/src/request.rs → core/src/request.rs
diff --git a/src/session.rs → core/src/session.rs b/src/session.rs → core/src/session.rs
diff --git a/tests/citadel.rs → core/tests/citadel.rs b/tests/citadel.rs → core/tests/citadel.rs