This repository contains the core primitives for Boundless.
Note: If you are a builder looking to build an application on Boundless, you should start with the Boundless Foundry Template and the Boundless Builder Docs.
Note: If you are a prover looking to get started, please refer to the Boundless Prover Quick Start Guide.
The repository is structured as a monorepo and contains Rust crates and Solidity contracts. Some key components:
- Boundless Core Contracts: The core smart contracts for Boundless. ./contracts
- Boundless SDK: Rust SDK for interacting with Boundless. ./crates/boundless-market
- Boundless CLI: Command-line interface for interacting with Boundless. ./crates/boundless-cli
- Boundless Broker: Our sample prover implementation. ./crates/broker
- Boundless zkVM Guests: The zkVM guests required for generating proofs on Boundless. ./crates/guest and ./crates/assessor
If you don't already have Rust installed, start by installing Rust and rustup.
Then download the RISC Zero toolchain and install it using rzup:
curl -L https://risczero.com/install | bashNext we can install the RISC Zero toolchain by running rzup install:
rzup installYou can verify the installation was successful by running:
cargo risczero --versionIf you don't already have Forge installed, you can install it using Foundry:
curl -L https://foundry.paradigm.xyz | bash
foundryupTo build the Solidity contracts, run:
forge buildTo build the Rust crates, run:
cargo buildYou can find the documentation in the documentation folder.
To build it and serve it locally, run the following commands:
bun install
bun run docsThen open your browser and navigate to http://localhost:5173.
See LICENSE.