rln 0.4.0

APIs to manage, compute and verify zkSNARK proofs and RLN primitives
Documentation
Build #971663 2023-11-16 01:27:13

# rustc version rustc 1.76.0-nightly (6b771f6b5 2023-11-15)

# docs.rs version docsrs 0.6.0 (a7020daf 2023-11-09)

# build log [INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace-builder/builds/rln-0.4.0/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace-builder/builds/rln-0.4.0/source:/opt/rustwide/workdir:ro,Z" "-v" "/home/cratesfyi/workspace-builder/cargo-home:/opt/rustwide/cargo-home:ro,Z" "-v" "/home/cratesfyi/workspace-builder/rustup-home:/opt/rustwide/rustup-home:ro,Z" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "DOCS_RS=1" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-w" "/opt/rustwide/workdir" "-m" "6442450944" "--cpus" "6" "--user" "1001:1001" "--network" "none" "ghcr.io/rust-lang/crates-build-env/linux@sha256:0c7e0e8312ad82a1bed3696438480b7da990d348377d3754e1cd95b06a8a36c7" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "-Z" "unstable-options" "--config" "build.rustdocflags=[\"-Z\", \"unstable-options\", \"--emit=invocation-specific\", \"--resource-suffix\", \"-20231115-1.76.0-nightly-6b771f6b5\", \"--static-root-path\", \"/-/rustdoc.static/\", \"--cap-lints\", \"warn\", \"--extern-html-root-takes-precedence\"]" "--offline" "-Zunstable-options" "--config=doc.extern-map.registries.crates-io=\"https://docs.rs/{pkg_name}/{version}/x86_64-unknown-linux-gnu\"" "-Zrustdoc-scrape-examples" "-j6" "--target" "x86_64-unknown-linux-gnu", kill_on_drop: false }` [INFO] [stderr] WARNING: Your kernel does not support swap limit capabilities or the cgroup is not mounted. Memory limited without swap. [INFO] [stdout] 9e5aab74690eab30474f4d1cf323da37831ead8fd6c28d78671dd12d49ed682c [INFO] running `Command { std: "docker" "start" "-a" "9e5aab74690eab30474f4d1cf323da37831ead8fd6c28d78671dd12d49ed682c", kill_on_drop: false }` [INFO] [stderr] warning: Target filter specified, but no targets matched. This is a no-op [INFO] [stderr] Documenting rln v0.4.0 (/opt/rustwide/workdir) [INFO] [stderr] warning: could not parse code block as Rust code [INFO] [stderr] --> src/public.rs:64:9 [INFO] [stderr] | [INFO] [stderr] 64 | /// ``` [INFO] [stderr] | _________^ [INFO] [stderr] 65 | | /// use std::io::Cursor; [INFO] [stderr] 66 | | /// [INFO] [stderr] 67 | | /// let tree_height = 20; [INFO] [stderr] ... | [INFO] [stderr] 71 | | /// let mut rln = RLN::new(tree_height, resources); [INFO] [stderr] 72 | | /// ``` [INFO] [stderr] | |___________^ [INFO] [stderr] | [INFO] [stderr] = note: error from rustc: this file contains an unclosed delimiter [INFO] [stderr] = note: `#[warn(rustdoc::invalid_rust_codeblocks)]` on by default [INFO] [stderr] help: mark blocks that do not contain Rust code as text [INFO] [stderr] | [INFO] [stderr] 64 | /// ```text [INFO] [stderr] | ++++ [INFO] [stderr] [INFO] [stderr] warning: redundant explicit link target [INFO] [stderr] --> src/public.rs:579:66 [INFO] [stderr] | [INFO] [stderr] 579 | /// Computes a zkSNARK RLN proof using a [`RLNWitnessInput`](crate::protocol::RLNWitnessInput). [INFO] [stderr] | ----------------- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ explicit target is redundant [INFO] [stderr] | | [INFO] [stderr] | because label contains path that resolves to same destination [INFO] [stderr] | [INFO] [stderr] = note: when a link's destination is not specified, [INFO] [stderr] the label is used to resolve intra-doc links [INFO] [stderr] = note: `#[warn(rustdoc::redundant_explicit_links)]` on by default [INFO] [stderr] help: remove explicit link target [INFO] [stderr] | [INFO] [stderr] 579 | /// Computes a zkSNARK RLN proof using a [`RLNWitnessInput`]. [INFO] [stderr] | ~~~~~~~~~~~~~~~~~~~ [INFO] [stderr] [INFO] [stderr] warning: redundant explicit link target [INFO] [stderr] --> src/public.rs:582:81 [INFO] [stderr] | [INFO] [stderr] 582 | ...or the serialization of a [`RLNWitnessInput`](crate::protocol::RLNWitnessInput) object, containing the public and private inputs to th... [INFO] [stderr] | ----------------- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ explicit target is redundant [INFO] [stderr] | | [INFO] [stderr] | because label contains path that resolves to same destination [INFO] [stderr] | [INFO] [stderr] = note: when a link's destination is not specified, [INFO] [stderr] the label is used to resolve intra-doc links [INFO] [stderr] help: remove explicit link target [INFO] [stderr] | [INFO] [stderr] 582 | /// - `input_data`: a reader for the serialization of a [`RLNWitnessInput`] object, containing the public and private inputs to the ZK circuits (serialization done using [`rln::protocol::serialize_witness`](crate::protocol::serialize_witness)) [INFO] [stderr] | ~~~~~~~~~~~~~~~~~~~ [INFO] [stderr] [INFO] [stderr] warning: redundant explicit link target [INFO] [stderr] --> src/public.rs:1149:60 [INFO] [stderr] | [INFO] [stderr] 1149 | /// Returns the serialization of a [`RLNWitnessInput`](crate::protocol::RLNWitnessInput) populated from the identity secret, the Merk... [INFO] [stderr] | ----------------- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ explicit target is redundant [INFO] [stderr] | | [INFO] [stderr] | because label contains path that resolves to same destination [INFO] [stderr] | [INFO] [stderr] = note: when a link's destination is not specified, [INFO] [stderr] the label is used to resolve intra-doc links [INFO] [stderr] help: remove explicit link target [INFO] [stderr] | [INFO] [stderr] 1149 | /// Returns the serialization of a [`RLNWitnessInput`] populated from the identity secret, the Merkle tree index, the epoch and signal. [INFO] [stderr] | ~~~~~~~~~~~~~~~~~~~ [INFO] [stderr] [INFO] [stderr] warning: redundant explicit link target [INFO] [stderr] --> src/public.rs:1154:68 [INFO] [stderr] | [INFO] [stderr] 1154 | /// The function returns the corresponding [`RLNWitnessInput`](crate::protocol::RLNWitnessInput) object serialized using [`rln::proto... [INFO] [stderr] | ----------------- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ explicit target is redundant [INFO] [stderr] | | [INFO] [stderr] | because label contains path that resolves to same destination [INFO] [stderr] | [INFO] [stderr] = note: when a link's destination is not specified, [INFO] [stderr] the label is used to resolve intra-doc links [INFO] [stderr] help: remove explicit link target [INFO] [stderr] | [INFO] [stderr] 1154 | /// The function returns the corresponding [`RLNWitnessInput`] object serialized using [`rln::protocol::serialize_witness`](crate::protocol::serialize_witness)). [INFO] [stderr] | ~~~~~~~~~~~~~~~~~~~ [INFO] [stderr] [INFO] [stderr] warning: redundant explicit link target [INFO] [stderr] --> src/public.rs:1164:64 [INFO] [stderr] | [INFO] [stderr] 1164 | /// Converts a byte serialization of a [`RLNWitnessInput`](crate::protocol::RLNWitnessInput) object to the corresponding JSON seriali... [INFO] [stderr] | ----------------- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ explicit target is redundant [INFO] [stderr] | | [INFO] [stderr] | because label contains path that resolves to same destination [INFO] [stderr] | [INFO] [stderr] = note: when a link's destination is not specified, [INFO] [stderr] the label is used to resolve intra-doc links [INFO] [stderr] help: remove explicit link target [INFO] [stderr] | [INFO] [stderr] 1164 | /// Converts a byte serialization of a [`RLNWitnessInput`] object to the corresponding JSON serialization. [INFO] [stderr] | ~~~~~~~~~~~~~~~~~~~ [INFO] [stderr] [INFO] [stderr] warning: redundant explicit link target [INFO] [stderr] --> src/public.rs:1167:81 [INFO] [stderr] | [INFO] [stderr] 1167 | ...e byte serialization of a [`RLNWitnessInput`](crate::protocol::RLNWitnessInput) object (serialization done with [`rln::protocol::seri... [INFO] [stderr] | ----------------- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ explicit target is redundant [INFO] [stderr] | | [INFO] [stderr] | because label contains path that resolves to same destination [INFO] [stderr] | [INFO] [stderr] = note: when a link's destination is not specified, [INFO] [stderr] the label is used to resolve intra-doc links [INFO] [stderr] help: remove explicit link target [INFO] [stderr] | [INFO] [stderr] 1167 | /// - `serialized_witness`: the byte serialization of a [`RLNWitnessInput`] object (serialization done with [`rln::protocol::serialize_witness`](crate::protocol::serialize_witness)). [INFO] [stderr] | ~~~~~~~~~~~~~~~~~~~ [INFO] [stderr] [INFO] [stderr] warning: redundant explicit link target [INFO] [stderr] --> src/public.rs:1169:95 [INFO] [stderr] | [INFO] [stderr] 1169 | /// The function returns the corresponding JSON encoding of the input [`RLNWitnessInput`](crate::protocol::RLNWitnessInput) object. [INFO] [stderr] | ----------------- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ explicit target is redundant [INFO] [stderr] | | [INFO] [stderr] | because label contains path that resolves to same destination [INFO] [stderr] | [INFO] [stderr] = note: when a link's destination is not specified, [INFO] [stderr] the label is used to resolve intra-doc links [INFO] [stderr] help: remove explicit link target [INFO] [stderr] | [INFO] [stderr] 1169 | /// The function returns the corresponding JSON encoding of the input [`RLNWitnessInput`] object. [INFO] [stderr] | ~~~~~~~~~~~~~~~~~~~ [INFO] [stderr] [INFO] [stderr] warning: `rln` (lib doc) generated 8 warnings (run `cargo fix --lib -p rln` to apply 1 suggestion) [INFO] [stderr] Finished dev [unoptimized + debuginfo] target(s) in 1.02s [INFO] [stderr] Generated /opt/rustwide/target/x86_64-unknown-linux-gnu/doc/rln/index.html [INFO] running `Command { std: "docker" "inspect" "9e5aab74690eab30474f4d1cf323da37831ead8fd6c28d78671dd12d49ed682c", kill_on_drop: false }` [INFO] running `Command { std: "docker" "rm" "-f" "9e5aab74690eab30474f4d1cf323da37831ead8fd6c28d78671dd12d49ed682c", kill_on_drop: false }` [INFO] [stdout] 9e5aab74690eab30474f4d1cf323da37831ead8fd6c28d78671dd12d49ed682c