Run a Cannon Package

Start by installing Cannon with the following command:

npm install -g @usecannon/cli

Now you can run any package available on the registry, like so:

cannon synthetix-sandbox

This will start an Anvil node  on port 8545 with a deployment of Synthetix V3 for local testing and development. Press i to interact with the contracts directly in the command-line interface.

You can use the inspect command to retrieve the contract addresses and ABIs. For example:

cannon inspect synthetix-sandbox --write-deployments ./deployments

The command-line tool has a lot of additional functionality, including the ability to run packages on local forks and interact with deployments on remote networks. Learn more

Next, build a protocol and add your own package to the registry.

Supported byCannonRetroPGF