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.

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

dusk-core: add serde support #3046

Merged
merged 3 commits into from
Feb 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
111 changes: 82 additions & 29 deletions Cargo.lock

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

18 changes: 9 additions & 9 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -50,20 +50,20 @@ rusk-recovery = { version = "1.0.3-alpha.1", path = "./rusk-recovery/" }
wallet-core = { version = "1.0.2-alpha.1", path = "./wallet-core/", package = "dusk-wallet-core" }

# Dusk dependencies outside the workspace
bls12_381-bls = { version = "0.4", default-features = false }
dusk-bls12_381 = { version = "0.13", default-features = false }
bls12_381-bls = { version = "0.5", default-features = false }
dusk-bls12_381 = { version = "0.14", default-features = false }
dusk-bytes = "0.1.7"
dusk-jubjub = { version = "0.14.1", default-features = false }
dusk-jubjub = { version = "0.15.0", default-features = false }
dusk-merkle = "0.5.3"
dusk-plonk = { version = "0.20.2", default-features = false }
dusk-poseidon = "0.40"
jubjub-schnorr = { version = "0.5", default-features = false }
dusk-plonk = { version = "0.21.0", default-features = false }
dusk-poseidon = "0.41"
jubjub-schnorr = { version = "0.6", default-features = false }
kadcast = "0.7"
phoenix-circuits = { version = "0.5", default-features = false }
phoenix-core = { version = "0.33.1", default-features = false }
phoenix-circuits = { version = "0.6", default-features = false }
phoenix-core = { version = "0.34.0", default-features = false }
piecrust = "0.27.1"
piecrust-uplink = "0.17.3"
poseidon-merkle = "0.7"
poseidon-merkle = "0.8"

# External dependencies
aes = "0.7.5"
Expand Down
2 changes: 2 additions & 0 deletions core/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Add `METADATA::PUBLIC_SENDER` [#3341]
- Add `abi::public_sender` host fn [#3341]
- Add serde implementations for `StakeEvent`, `SlashEvent`, `Reward`, `WithdrawEvent`, `ConvertEvent`, `DepositEvent`,
`ContractToContractEvent`, `ContractToAccountEvent`, `PhoenixTransactionEvent` and `MoonlightTransactionEvent`

## [1.0.0] - 2025-01-23

Expand Down
13 changes: 13 additions & 0 deletions core/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,13 @@ ark-bn254 = { workspace = true, features = ["curve"], optional = true }
ark-relations = { workspace = true, optional = true }
ark-serialize = { workspace = true, optional = true }

# serde support dependencies
serde = { workspace = true, features = ["derive"], optional = true }
base64 = { workspace = true, optional = true }

[dev-dependencies]
rand = { workspace = true, features = ["std", "std_rng"] }
serde_json = { workspace = true }

[features]
parallel = [
Expand Down Expand Up @@ -67,3 +72,11 @@ groth16 = [

# Enables std feature for dusk-plonk
std = ["dusk-plonk/std"]

serde = [
"dep:serde",
"base64",
"piecrust-uplink/serde",
"bls12_381-bls/serde",
"phoenix-core/serde",
]
4 changes: 2 additions & 2 deletions core/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ help: ## Display this help screen
@grep -h -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-15s\033[0m %s\n", $$1, $$2}'

test:
cargo test --release --features zk
cargo test --release --features zk,serde
cargo test --release --no-run

clippy: ## Run clippy
@cargo clippy --release -- -D warnings
@cargo clippy --release --features serde -- -D warnings
@cargo clippy --no-default-features --release -- -D warnings

doc: ## Run doc gen
Expand Down
10 changes: 10 additions & 0 deletions core/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ pub use error::Error;
mod dusk;
pub use dusk::{dusk, from_dusk, Dusk, LUX};

#[cfg(feature = "serde")]
mod serde_support;

// elliptic curve types
pub use dusk_bls12_381::BlsScalar;
pub use dusk_jubjub::{
Expand Down Expand Up @@ -135,3 +138,10 @@ fn read_arr<const N: usize>(buf: &mut &[u8]) -> Result<[u8; N], BytesError> {
*buf = &buf[N..];
Ok(a)
}

#[cfg(test)]
mod tests {
// the `unused_crate_dependencies` lint complains for dev-dependencies that
// are only used in integration tests, so adding this work-around here
use serde_json as _;
}
Loading
Loading