Welcome to the project documentation! This repository contains essential documentation to guide you through the setup and usage of the project. As a submodule of the Cartesi Machines repositories, it plays a crucial role in ensuring smooth operations. Follow the steps below to get started:
-
Before you begin, make sure you have the required environment variables properly configured. Create an environment by executing the following command:
$ make env
-
Ensure you provide the necessary parameters in the generated environment file.
-
As we are using the Foundry framework to develop robustness contracts, an important change must be made in the rollup submodule:
$ cat lib/rollups/onchain/rollups/contracts/library/LibOutputValidation.sol
- Change line 16 to
import {MerkleV2} from "../../../rollups-arbitration/lib/solidity-util/contracts/MerkleV2.sol";insteadimport {MerkleV2} from "@cartesi/util/contracts/MerkleV2.sol";.
- Change line 16 to
-
To implement the system in testnet, run the command below:
$ make system CONFIG="--network <NETWORK_NAME>" -
⚠️ Supported Networks:- sepolia
- mumbai
-
To interact with the Cartesi machines, follow the instructions contained in the readme of each one:
View the generated documentation locally by serving it on a local server at port 4002. Use:
$ forge doc --serve --port 4002Access the documentation through your web browser by navigating to http://localhost:4002.