Add documentation to the eVRF-based DKG

This commit is contained in:
Luke Parker
2024-07-24 20:55:35 -04:00
parent 96175e115d
commit 05c26d7818
3 changed files with 82 additions and 12 deletions

View File

@@ -39,8 +39,8 @@ dleq = { path = "../dleq", version = "^0.4.1", default-features = false }
# eVRF DKG dependencies
subtle = { version = "2", default-features = false, features = ["std"], optional = true }
generic-array = { version = "1", default-features = false, features = ["alloc"], optional = true }
rand_chacha = { version = "0.3", default-features = false, features = ["std"], optional = true }
blake2 = { version = "0.10", default-features = false, features = ["std"], optional = true }
rand_chacha = { version = "0.3", default-features = false, features = ["std"], optional = true }
generalized-bulletproofs = { path = "../evrf/generalized-bulletproofs", default-features = false, optional = true }
ec-divisors = { path = "../evrf/divisors", default-features = false, optional = true }
generalized-bulletproofs-circuit-abstraction = { path = "./circuit-abstraction", optional = true }
@@ -53,10 +53,6 @@ generalized-bulletproofs = { path = "./generalized-bulletproofs", features = ["t
ec-divisors = { path = "./divisors", features = ["pasta"] }
pasta_curves = "0.5"
[dependencies]
generalized-bulletproofs-circuit-abstraction = { path = "./circuit-abstraction" }
generalized-bulletproofs-ec-gadgets = { path = "./ec-gadgets" }
[features]
std = [
"thiserror",
@@ -79,6 +75,19 @@ std = [
"dleq/serialize"
]
borsh = ["dep:borsh"]
evrf = ["std", "dep:subtle", "dep:generic-array", "dep:rand_chacha", "dep:blake2", "dep:ec-divisors", "dep:generalized-bulletproofs", "dep:evrf"]
evrf = [
"std",
"dep:subtle",
"dep:generic-array",
"dep:blake2",
"dep:rand_chacha",
"dep:generalized-bulletproofs",
"dep:ec-divisors",
"dep:generalized-bulletproofs-circuit-abstraction",
"dep:generalized-bulletproofs-ec-gadgets",
]
tests = ["rand_core/getrandom"]
default = ["std"]