MCPcopy Index your code
hub / github.com/arkworks-rs/std

github.com/arkworks-rs/std @v0.6.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.6.0 ↗ · + Follow
66 symbols 98 edges 8 files 18 documented · 27%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

arkworks::std

<img src="https://github.com/arkworks-rs/utils/workflows/CI/badge.svg?branch=master">
<a href="https://github.com/arkworks-rs/utils/blob/master/LICENSE-APACHE"><img src="https://img.shields.io/badge/license-APACHE-blue.svg"></a>
<a href="https://github.com/arkworks-rs/utils/blob/master/LICENSE-MIT"><img src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
<a href="https://deps.rs/repo/github/arkworks-rs/utils"><img src="https://deps.rs/repo/github/arkworks-rs/utils/status.svg"></a>

The arkworks ecosystem consists of Rust libraries for designing and working with zero knowledge succinct non-interactive arguments (zkSNARKs). This repository contains ark-std, a library that serves as a compatibility layer for no_std use cases, and also contains useful methods and types used by the rest of the arkworks ecosystem.

This library is released under the MIT License and the Apache v2 License (see License).

WARNING: This is an academic proof-of-concept prototype, and in particular has not received careful code review. This implementation is NOT ready for production use.

Build guide

The library compiles on the stable toolchain of the Rust compiler. To install the latest version of Rust, first install rustup by following the instructions here, or via your platform's package manager. Once rustup is installed, install the Rust toolchain by invoking:

rustup install stable

After that, use cargo, the standard Rust build tool, to build the libraries:

git clone https://github.com/arkworks-rs/utils.git
cd utils
cargo build --release

Tests

This library comes with comprehensive unit and integration tests for each of the provided crates. Run the tests with:

cargo test --all

Benchmarks

To run the benchmarks, install the nightly Rust toolchain, via rustup install nightly, and then run the following command:

cargo +nightly bench

License

The crates in this repository are licensed under either of the following licenses, at your discretion.

  • Apache License Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
  • MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

Unless you explicitly state otherwise, any contribution submitted for inclusion in this library by you shall be dual licensed as above (as defined in the Apache v2 License), without any additional terms or conditions.

Acknowledgements

This work was supported by: a Google Faculty Award; the National Science Foundation; the UC Berkeley Center for Long-Term Cybersecurity; and donations from the Ethereum Foundation, the Interchain Foundation, and Qtum.

An earlier version of this library was developed as part of the paper "ZEXE: Enabling Decentralized Private Computation".

Extension points exported contracts — how you extend this code

Read (Interface)
The `Read` trait allows for reading bytes from a source. Implementors of the `Read` trait are called 'readers'. Reader [3 …
src/io/mod.rs
Iterable (Interface)
The trait [`Iterable`] represents a streamable object that can produce an arbitrary number of streams of length [`Iterab [2 …
src/iterable/mod.rs
Error (Interface)
(no doc) [2 implementers]
src/error.rs
UniformRand (Interface)
(no doc) [1 implementers]
src/rand_helper.rs
Write (Interface)
(no doc) [5 implementers]
src/io/mod.rs

Core symbols most depended-on inside this repo

len
called by 20
src/iterable/mod.rs
write
called by 3
src/io/mod.rs
is_empty
called by 3
src/iterable/mod.rs
get_buf
called by 2
src/io/mod.rs
kind
called by 2
src/io/error.rs
read
called by 1
src/io/mod.rs
slice_write
called by 1
src/io/mod.rs
vec_write
called by 1
src/io/mod.rs

Shape

Method 39
Function 13
Class 6
Interface 5
Enum 3

Languages

Rust100%

Modules by API surface

src/io/mod.rs21 symbols
src/io/error.rs16 symbols
src/rand_helper.rs10 symbols
src/perf_trace.rs5 symbols
src/error.rs5 symbols
src/iterable/mod.rs4 symbols
src/iterable/rev.rs3 symbols
src/lib.rs2 symbols

For agents

$ claude mcp add std \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page