Cannon

This is the monorepo for Cannon. If you're just interested in using the project, visit the website.

⚠️ Cannon is under active development. While the interface and functionality are generally stable, use the tool with caution when conducting high-risk deployments.

For more information, please see documentation in the modules listed below:

cli: The command-line interface. Run npx @usecannon/cli --help for usage information.
builder: Builds chain data from cannonfiles. (This is used by the CLI.)
hardhat-cannon: Code for the Hardhat plug-in, which wraps the CLI functionality with defaults pulled from a Hardhat project configuration.
registry: The smart contract for the package registry.
website: The website, hosted at https://usecannon.com

Usage Examples:

router-architecture: Project demonstrating how to setup an upgradable Router Architecture.
sample-hardhat-project: Hardhat project that demonstrates the core functionality of the hardhat-cannon module
sample-foundry-project: Foundry project that demonstrates the core functionality of the cli module

Development

Community contributions to Cannon are greatly appreciated. Please open pull requests, issues, and discussions in the GitHub repository.

To load a development version of Cannon, start by installing the dependencies from the root directory:

npm ci

After making changes, rebuild the project:

npm run build

Use the development version of the CLI:

cd ./packages/cli && npm start -- <package:version>

Test changes to the Hardhat plug-in in the sample project:

cd ./examples/sample-hardhat-project && npx hardhat cannon:build

Preview updates to the website

cd ./packages/website && npm run dev

Contribution Guidelines

See CONTRIBUTING.md

Version and Publish

We bump and publish manually using lerna's version and publish workflow.

Stable Release

To create a stable release, first checkout to a new branch (it can be called release-stable or something similar)

Note, DO NOT use the version name as the branch name as this can cause conflicts with tags. (eg v2.12.1 as a branch name is incorrect)

Run npm run version-* where * can be patch, minor or major.
Create PR for the release branch
From the branch, run npm run publish and follow the prompts.
Run npm run update-stables to make sure that all the other private packages reference to new release.
Merge release PR

Alpha Release

To create an alpha release, first checkout to a new branch (it can be called release-alpha or something similar)

Note, DO NOT use the version name as the branch name as this can cause conflicts with tags. (eg v2.12.1-alpha.0 as a branch name is incorrect)

Run npm run version-alpha to bump package versions to an alpha version.
Create PR for the branch and merge when required tests are passing
From the main branch, run npm run publish-alpha and follow the prompts.

Changesets

We can also use changesets to manage versions on our monorepo.

Currently our release workflow on our CI handles bumping package versions and publishing releases to npm through lerna. It only publishes releases if any changeset PR's have been added to the commit history merged into main.

To trigger a new version bump run the following command (from the root of the repo):

  npm run changeset

License

This project is licensed under the terms of the GNU General Public License v3.0.

harshpatel/cannon