Synthetix Deployments

This is a GitOps repo for deployment of the Synthetix protocol.

Deployment Requirements

Important to not use global cannon installation and rely on cannon cli from the repo by running it with yarn cannon command. Sometimes newer or older versions of cannon may produce incompatible state and as a result deployment state will be borked. Using exactly same cannon version as all the repo maintainers use is a requirement and not an recommendation.

Run yarn upgrade-interactive and make sure that @usecannon/cli and hardhat-cannon are updated to the latest versions. If not, make a separate PR with cannon update (even though cannon updates are automated, there is a delay up to a day for that to happen)

After installing for the first time, run yarn cannon setup to configure a reliable IPFS URL for publishing packages and any other preferred settings, Cannon keeps its settings in file ~/.local/share/cannon/settings.json and it might be more convenient to update it instead of using setup wizard.

Required options to set:

• ipfsUrl: https://ipfs.synthetix.io
• writeIpfsUrl: https://<USER>:<PASS>@ipfs.synthetix.io
• publishIpfsUrl: https://<USER>:<PASS>@ipfs.synthetix.io
• registries: list of per-chain registries with infura RPCs

Here is how your settings.json should look like (with sensitive fields stripped)

{
  "ipfsUrl": "https://ipfs.synthetix.io",
  "writeIpfsUrl": "https://<USER>:<PASS>@ipfs.synthetix.io",
  "publishIpfsUrl": "https://<USER>:<PASS>@ipfs.synthetix.io",
  "registries": [
    {
      "name": "OP Mainnet",
      "chainId": 10,
      "rpcUrl": ["https://optimism-mainnet.infura.io/v3/<INFURA_KEY>"],
      "address": "0x8E5C7EFC9636A6A0408A46BB7F617094B81e5dba"
    },
    {
      "name": "Ethereum Mainnet",
      "chainId": 1,
      "rpcUrl": ["https://mainnet.infura.io/v3/<INFURA_KEY>"],
      "address": "0x8E5C7EFC9636A6A0408A46BB7F617094B81e5dba"
    }
  ]
}

Specify Upgrade

• After publishing any new versions of the provisioned packages (oracle-manager, synthetix and spot-market), bump the versions throughout the cannonfiles to match.
• Add new settings and invoke actions as necessary.
• Increment the version number and update the values in the network-specific omnibus cannonfiles as desired.

Execute Upgrade

Conduct the following process for each network:

• Perform a dry-run and confirm that the actions that would be executed by Cannon are expected:

  yarn cannon build omnibus-base-sepolia-andromeda.toml --dry-run --upgrade-from synthetix-omnibus:latest@andromeda --chain-id 84532 --provider-url https://base-sepolia.infura.io/v3/$INFURA_API_KEY

• Remove the dry-run option to execute the upgrade:

  yarn cannon build omnibus-base-sepolia-andromeda.toml --upgrade-from synthetix-omnibus:latest@andromeda --private-key $TESTNET_DEPLOYER_PRIVATE_KEY --provider-url https://base-sepolia.infura.io/v3/$INFURA_API_KEY

• After this you can run the dry-run command again (without upgrade-from), and should see no changes

  yarn cannon build omnibus-base-sepolia-andromeda.toml --dry-run --chain-id 84532 --provider-url https://base-sepolia.infura.io/v3/$INFURA_API_KEY

The --provider-url and --private-key parameters are unnecessary if using Frame

Finalize Release

• If you've updated the provisioned packages, verify your new contracts on Etherscan:

    yarn cannon verify synthetix-omnibus@andromeda --chain-id 84532 --api-key $ETHERSCAN_API_KEY

• Publish your new packages on the Cannon registry:

  yarn cannon publish synthetix-omnibus@andromeda --chain-id 84532 --private-key $MAINNET_DEPLOYER_PRIVATE_KEY

  If you use frame: (The --private-key parameter is unnecessary if using Frame)

• Commit and merge the change to this repository.

• Run the Export ABIs action in the v3-abi-exporter repository.

Fork-testing locally

Example based on omnibus-base-sepolia-andromeda.toml. Make sure you have a valid INFURA_API_KEY in your terminal session.

1. Run local Anvil node for the required network. Keep this running.

   yarn cannon build omnibus-base-sepolia-andromeda.toml --port 8545 --keep-alive --dry-run --upgrade-from synthetix-omnibus:latest@andromeda --chain-id 84532 --provider-url https://sepolia.base.org | tee ./e2e/cannon-build.log

   or

   yarn start:base-sepolia

2. Open a new terminal window, fetch deployments and store as JSON files

   yarn fetch-deployments

3. Update all prices You may need to run this once an hour while fork is running

   node ./e2e/tasks/doAllPriceUpdates.js 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80

   or

   yarn update-prices

4. Run bootstrap steps Bootstrap ensures that necessary runtime contracts configs are applied. Like setPoolConfiguration.

   DEBUG='e2e:*' node ./e2e/tests/omnibus-base-sepolia-andromeda.toml/bootstrap

5. Execute tests

   DEBUG='e2e:*' mocha e2e/tests/omnibus-base-sepolia-andromeda.toml/*.e2e.js

   or

   yarn test:base-sepolia