Merge branch 'main' into standardize-ci

.github/workflows/dusk_ci.yml

@@ -24,3 +24,4 @@ jobs:
     uses: dusk-network/.github/.github/workflows/run-tests.yml@main
     with:
       test_flags: --no-default-features
+

CHANGELOG.md

@@ -7,9 +7,51 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.5.0] - 2023-10-12
+
+### Changed
+
+- update `dusk-bls12_381` dependency to "0.12"
+- update `dusk-jubjub` dependency to "0.13"
+- update `dusk-pki` dependency to "0.13"
+- update `dusk-schnorr` dependency to "0.14"
+- update `dusk-poseidon` dependency to "0.31"
+- update `poseidon-merkle` dependency to "0.3"
+- update `dusk-plonk` dependency to "0.14"
+- Removed pos field from the license struct
+- Refactored utils to accept external license and opening
+
+### Added
+
+- Add `ff` dependency
+
+## [0.4.1] - 2023-08-09
+
+### Added
+
+- Add Utils implementation
+
+## [0.4.0] - 2023-06-28
+
+### Changed
+
+- Updated dusk_plonk to 0.14
+
+## [0.3.0] - 2023-06-28
+
+### Added
+
+- Add Shelter implementation
+- Rkyv derivation for all protocol structs
+
+### Removed
+
+- Remove the local state module [#54]
+
 ### Changed
 
 - Migrated Merkle tree implementation from Poseidon252 0.28 to dusk_merkle 0.2 [#41]
+- Updated dusk_merkle to 0.4
 
 ## [0.2.0] - 2023-05-17
 
@@ -34,13 +76,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add workflows for the Github Actions
 
 <!-- ISSUES -->
+[#54]: https://github.com/dusk-network/citadel/issues/54
+[#41]: https://github.com/dusk-network/citadel/issues/41
 [#40]: https://github.com/dusk-network/citadel/issues/40
 [#34]: https://github.com/dusk-network/citadel/issues/34
 [#32]: https://github.com/dusk-network/citadel/issues/32
 [#30]: https://github.com/dusk-network/citadel/issues/30
 [#21]: https://github.com/dusk-network/citadel/issues/21
 
 <!-- VERSIONS -->
-[Unreleased]: https://github.com/dusk-network/citadel/compare/v0.2.0...HEAD
-[0.2.0]: https://github.com/dusk-network/citadel/releases/tag/v0.2.0
+[Unreleased]: https://github.com/dusk-network/citadel/compare/v0.5.0...HEAD
+[0.5.0]: https://github.com/dusk-network/citadel/compare/v0.4.1...v0.5.0
+[0.4.1]: https://github.com/dusk-network/citadel/compare/v0.4.0...v0.4.1
+[0.4.0]: https://github.com/dusk-network/citadel/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/dusk-network/citadel/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/dusk-network/citadel/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/dusk-network/citadel/releases/tag/v0.1.0

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "zk-citadel"
-version = "0.2.0"
+version = "0.5.0"
 repository = "https://github.com/dusk-network/citadel"
 description = "Implementation of Citadel, a SSI system integrated in Dusk Network."
 categories = ["cryptography", "authentication", "mathematics", "science"]
@@ -10,20 +10,27 @@ license = "MPL-2.0"
 
 [dependencies]
 dusk-bytes = "0.1"
-dusk-poseidon = { version = "0.28" }
-dusk-merkle = { version = "0.2", features = ["rkyv-impl", "poseidon", "zk", "size_32"] }
-dusk-plonk = { version = "0.13", default-features = false, features = ["alloc"] }
-dusk-bls12_381 = { version = "0.11", default-features = false }
-dusk-jubjub = { version = "0.12", default-features = false }
-dusk-pki = { version = "0.11", default-features = false}
-dusk-schnorr = { version = "0.12" }
+dusk-poseidon = { version = "0.31", default-features = false, features = ["rkyv-impl", "alloc", "size_32", "merkle"] }
+poseidon-merkle = { version = "0.3", features = ["rkyv-impl", "zk", "size_32"] }
+dusk-plonk = { version = "0.16", default-features = false, features = ["rkyv-impl", "alloc"] }
+dusk-bls12_381 = { version = "0.12", default-features = false, features = ["rkyv-impl", "alloc"] }
+dusk-jubjub = { version = "0.13", default-features = false, features = ["rkyv-impl", "alloc"] }
+ff = { version = "0.13", default-features = false }
+dusk-pki = { version = "0.13", default-features = false, features = ["rkyv-impl"] }
+dusk-schnorr = { version = "0.14", features = ["rkyv-impl", "alloc"] }
 rand_core = { version = "0.6", default-features=false, features = ["getrandom"] }
 nstack = { version = "0.16" }
-rkyv = { version = "0.7", optional = true, default-features = false }
+rkyv = { version = "0.7", default-features = false }
+bytecheck = { version = "0.6", default-features = false }
 
 [dev-dependencies]
 criterion = "0.3"
+lazy_static = "1.4"
 
 [[bench]]
 name = "citadel"
 harness = false
+
+[features]
+rkyv-impl = []
+default=["rkyv-impl"]

README.md

@@ -1,9 +1,11 @@
-# Citadel: Self-Sovereign Identities on Dusk Network
+# Citadel: Self-Sovereign Identities on Dusk
 
 ![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 Network blockchain. An academic paper with further details about the protocol can be found [here](https://arxiv.org/pdf/2301.09378.pdf).
+This repository contains the implementation of Citadel, a protocol that integrates a self-sovereign identity system into the Dusk blockchain. An academic paper with further details about the protocol can be found [here](https://arxiv.org/pdf/2301.09378.pdf).
+
+It also contains Shelter, a version of Citadel meant for non-Blockchain use cases. Documentation on this version will be provided soon.
 
 **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.