README.md

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.

Required system packages (Linux)

mold is a required linker for this repository's Rust build configuration. Install it before running cargo build:

sudo apt-get update
sudo apt-get install -y build-essential binutils lld mold

If mold (or linker tooling) is missing, builds can fail with linker errors like: collect2: fatal error: cannot find 'ld'.

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 boundless-xyz/docs repo.

Audits

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

Migrating to Broker 2.0

The following broker.toml config field names have been removed. Update your config to use the new names:

Old name	New name
mcycle_price	min_mcycle_price
max_stake	max_collateral
stake_balance_warn_threshold	collateral_balance_warn_threshold
stake_balance_error_threshold	collateral_balance_error_threshold
max_concurrent_locks	max_concurrent_proofs
batch_size	min_batch_size
expired_order_fulfillment_priority	order_commitment_priority

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 for a copy of the license.