Boundless

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.

Repository Structure

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

Developing

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 | bash

Next we can install the RISC Zero toolchain by running rzup install:

rzup install

You can verify the installation was successful by running:

cargo risczero --version

If you don't already have Forge installed, you can install it using Foundry:

curl -L https://foundry.paradigm.xyz | bash
foundryup

To build the Solidity contracts, run:

forge build

To build the Rust crates, run:

cargo build

Documentation

You can find the documentation in the documentation folder.

To build it and serve it locally, run the following commands:

bun install
bun run docs

Then open your browser and navigate to http://localhost:5173.

Audits

See https://github.com/boundless-xyz/boundless-security

License

The Boundless Contracts, Boundless Assessor Library (./crates/assessor) and Boundless Assessor Guest (./crates/guest/assessor) in this repository are licensed under the Business Source License, with conversion to Apache-2.0 at a future date. See LICENSE-BSL for a copy of the license.

Other source code within this repository is licensed under the Apache-2.0 license, unless otherwise stated at the file header. See [LICENSE-Apache-2.0][./LICENSE-Apache-2.0] for a copy of the license.