This is a boilerplate for developing front-ends and smart contract integrations for Synthetix V3.

Install Cannon with npm i -g @usecannon/cli and review the Get Started guide.

⚠️ Remember to always interact with the proxy contracts instead of the router or modules directly.

• Run cannon synthetix-sandbox to start a local node as defined in the Cannonfile for front-end development.
• Run cannon inspect synthetix-sandbox --write-deployments ./deployments to export the smart contract ABIs and addresses.

• Fork this repository.
• Modify the Sample Integration contract.
• Customize the name at the top of cannonfile.toml and make any other modifications.
• Make sure you have the Synthetix Router Cannon plug-in installed: npx cannon plugin add cannon-plugin-router
• Run cannon build to create a local build of your Cannonfile.
• Run cannon <replace-with-new-cannonfile-name> to start it on a local node.

See the Production Cannonfile for an example Cannonfile that deploys the Sample Integration contract integrated with the official Synthetix V3 Deployments.