Cartesi Co-Processor CLI Tool

Overview

The Cartesi Co-Processor CLI Tool simplifies bootstrapping, registering, and deploying Cartesi co-processor programs. This tool streamlines the development workflow for Cartesi-based applications, allowing developers to focus on building their logic instead of wrestling with setup and deployment processes.

Features

• Bootstrap Projects: Quickly initialize a Cartesi project with a simple Foundry project inheriting the co-processor base contracts.
• Simplified Registration: Easily build, generate .car files and finally update the co-processor task issuer with your program/machine details.
• Simplified Deployment: Automate the deployment and registration of co-processor programs.

Installation

Using Cargo

Ensure you have Rust and Cargo installed. You can then install the CLI tool directly from crates.io:

cargo install cartesi-coprocessor

From Source

Clone the repository and build the tool manually:

git clone https://github.com/Mugen-Builders/co-processor-cli
cd co-processor-cli
cargo install --path .

Note:

• You need to have all the necessary dependencies installed and running before you can use this tool.
  • Nonodo.
  • Docker.
  • Cartesi machine.
  • Carize.
  • W3 (web3 storage CLI).
  • foundry.
• You need to clone and build the Carize tool manually also before calling any of the commands.

Usage

Run the CLI tool with:

cartesi-coprocessor [COMMAND] [OPTIONS]

Commands

Bootstrap a Project

Initialize a new Foundry project with Cartesi base contracts:

cartesi-coprocessor create --dapp-name <project_name> --template <language template>

Register a Co-Processor Program

Register your Cartesi co-processor program: Note: this should be run in the directory for your Cartesi program not the base directory or the solidity contract directory

cartesi-coprocessor register --email <w3 storage account email> --network <devnet, mainnet or testnet>

Check Status

Checks with the coprocessor task issuer for the status of the machine download process: Note: this should be run in the directory for your Cartesi program not the base directory or the solidity contract directory

cartesi-coprocessor check-status --network <devnet, mainnet or testnet>

Deploy

Deploys the solidity contract of your project to any specified network of your choice: Note: this should be run in the directory for your solidity contract not the base directory. Note; Each successful deployment is logged and stored in a separate directory called deployment_history.

cartesi-coprocessor deploy --contract-name <contract name> --network <devnet, mainnet or testnet> --constructor-args <Add as musch argument as needed seperated by single space>

Start devnet environment

Start docker containers for coprocessor task manager and solver for devnet:

cartesi-coprocessor start-devnet

Stop devnet environment

Stop docker containers for coprocessor task manager and solver for devnet:

cartesi-coprocessor stop-devnet

Address Book

Prints a list of useful contacts and their addresses. Note: running this command in the directory containing your Cartesi program and not the base directory or solidity contract directory also displays the machine hash of your program if your program has been built previously

cartesi-coprocessor address-book

Example Workflow

1. Bootstrap a Project

cartesi-coprocessor create --dapp-name my-cartesi-project --template rust
cd my-cartesi-project

2. Add Logic to the solidity Contract

   Edit the pre-generated child contract in the src folder to implement your business logic.

3. Add Logic to the Cartesi program

   Edit the pre-generated Cartesi file with your implementation in your pre-selected language.

4. Start the Devnet Environments

   Start the devnet containers containing the coprocessor task issuer and also the solver.

cartesi-coprocessor start-devnet

5. Register the Program

cartesi-coprocessor register --email test@gmail.com --network devnet

6. Check with the task manager to confirm your program has been sucessfully registered

   Run the command to confirm that the coprocessor is ready to start running your program, this should be run from the same directory as your Cartesi program.

cartesi-coprocessor check-status --network devnet

6. Deply Solidity Contract

cartesi-coprocessor deploy --contract-name CounterCaller --network devnet --constructor-args 0x95401dc811bb5740090279Ba06cfA8fcF6113778 0x69d8519f2b52b73e547ba150698732c586e083ad8a56e53ca8a8227b02983f6c

Contributing

We welcome contributions! To get started:

1. Fork the repository.
2. Create a new branch: git checkout -b feature-name
3. Make your changes and test them.
4. Submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Support

If you encounter issues or have feature requests, please open an issue on GitHub. Or drop a message on Cartesi discord under the Co-Procesor thread.