Add support for Sonic chain

contracts/deployments/sonic/.chainId

@@ -0,0 +1 @@
+146

contracts/deployments/sonic/.migrations.json

@@ -0,0 +1,2 @@
+{
+}

contracts/dev.env

@@ -1,10 +1,12 @@
 #providers
 PROVIDER_URL=[SET PROVIDER URL HERE]
 HOLESKY_PROVIDER_URL=[SET HOLESKY PROVIDER URL HERE]
+SONIC_PROVIDER_URL=[SET SONIC PROVIDER URL]
 
 # Set it to latest block number or leave it empty
 BLOCK_NUMBER=
 HOLESKY_BLOCK_NUMBER=
+SONIC_BLOCK_NUMBER=
 
 ARBITRUM_PROVIDER_URL=[SET PROVIDER URL HERE]
 

contracts/fork-test.sh

@@ -42,6 +42,9 @@ main()
     elif [[ $FORK_NETWORK_NAME == "holesky" ]]; then
       PROVIDER_URL=$HOLESKY_PROVIDER_URL;
       BLOCK_NUMBER=$HOLESKY_BLOCK_NUMBER;
+    elif [[ $FORK_NETWORK_NAME == "sonic" ]]; then
+          PROVIDER_URL=$SONIC_PROVIDER_URL;
+          BLOCK_NUMBER=$SONIC_BLOCK_NUMBER;
     elif [[ $FORK_NETWORK_NAME == "base" ]]; then
       PROVIDER_URL=$BASE_PROVIDER_URL;
       BLOCK_NUMBER=$BASE_BLOCK_NUMBER;

contracts/hardhat.config.js

@@ -10,7 +10,12 @@ const {
   isBaseFork,
   isBaseForkTest,
   isBaseUnitTest,
+  isSonic,
+  isSonicFork,
+  isSonicForkTest,
+  isSonicUnitTest,
   baseProviderUrl,
+  sonicProviderUrl,
   arbitrumProviderUrl,
   holeskyProviderUrl,
   adjustTheForkBlockNumber,
@@ -20,6 +25,7 @@ const {
 require("@nomiclabs/hardhat-etherscan");
 require("@nomiclabs/hardhat-waffle");
 require("@nomiclabs/hardhat-solhint");
+
 require("hardhat-deploy");
 require("hardhat-tracer");
 require("hardhat-contract-sizer");
@@ -74,6 +80,8 @@ if (isHolesky || isHoleskyForkTest || isHoleskyFork) {
   paths.deploy = "deploy/holesky";
 } else if (isBase || isBaseFork || isBaseForkTest || isBaseUnitTest) {
   paths.deploy = "deploy/base";
+} else if (isSonic || isSonicFork || isSonicForkTest || isSonicUnitTest) {
+  paths.deploy = "deploy/sonic";
 } else {
   // holesky deployment files are in contracts/deploy/mainnet
   paths.deploy = "deploy/mainnet";
@@ -179,6 +187,13 @@ module.exports = {
       live: true,
       saveDeployments: true,
     },
+    sonic: {
+      url: sonicProviderUrl,
+      accounts: [
+        process.env.DEPLOYER_PK || privateKeys[0],
+        process.env.GOVERNOR_PK || privateKeys[0],
+      ],
+    }
   },
   mocha: {
     bail: process.env.BAIL === "true",
@@ -204,6 +219,7 @@ module.exports = {
       arbitrumOne: MAINNET_DEPLOYER,
       holesky: HOLESKY_DEPLOYER,
       base: MAINNET_DEPLOYER,
+      sonic: MAINNET_DEPLOYER,
     },
     governorAddr: {
       default: 1,
@@ -227,6 +243,7 @@ module.exports = {
       mainnet: MAINNET_GOVERNOR,
       holesky: HOLESKY_DEPLOYER, // on Holesky the deployer is also the governor
       base: BASE_GOVERNOR,
+      sonic: MAINNET_GOVERNOR,
     },
     /* Local node environment currently has no access to Decentralized governance
      * address, since the contract is in another repo. Once we merge the ousd-governance
@@ -347,6 +364,14 @@ module.exports = {
           browserURL: "https://basescan.org",
         },
       },
+      {
+        network: "sonic",
+        chainId: 146,
+        urls: {
+          apiURL: "https://api.sonicscan.org/api",
+          browserURL: "https://sonicscan.org",
+        },
+      },
     ],
   },
   gasReporter: {

contracts/node.sh

@@ -33,6 +33,9 @@ main()
         elif [[ $FORK_NETWORK_NAME == "holesky" ]]; then
           PROVIDER_URL=$HOLESKY_PROVIDER_URL;
           BLOCK_NUMBER=$HOLESKY_BLOCK_NUMBER;
+        elif [[ $FORK_NETWORK_NAME == "sonic" ]]; then
+          PROVIDER_URL=$SONIC_PROVIDER_URL;
+          BLOCK_NUMBER=$SONIC_BLOCK_NUMBER;
         elif [[ $FORK_NETWORK_NAME == "base" ]]; then
           PROVIDER_URL=$BASE_PROVIDER_URL;
           BLOCK_NUMBER=$BASE_BLOCK_NUMBER;

contracts/package.json

@@ -16,6 +16,7 @@
     "node:arb": "FORK_NETWORK_NAME=arbitrumOne yarn run node:fork",
     "node:hol": "FORK_NETWORK_NAME=holesky yarn run node:fork",
     "node:base": "FORK_NETWORK_NAME=base yarn run node:fork",
+    "node:sonic": "FORK_NETWORK_NAME=sonic yarn run node:fork",
     "lint": "yarn run lint:js && yarn run lint:sol",
     "lint:js": "eslint \"test/**/*.js\" \"tasks/**/*.js\" \"deploy/**/*.js\"",
     "lint:sol": "solhint \"contracts/**/*.sol\"",
@@ -25,10 +26,12 @@
     "prettier:sol": "prettier --write \"contracts/**/*.sol\"",
     "test": "rm -rf deployments/hardhat && IS_TEST=true npx hardhat test",
     "test:base": "rm -rf deployments/hardhat && UNIT_TESTS_NETWORK=base IS_TEST=true npx hardhat test",
+    "test:sonic": "rm -rf deployments/hardhat && UNIT_TESTS_NETWORK=sonic IS_TEST=true npx hardhat test",
     "test:fork": "./fork-test.sh",
     "test:arb-fork": "FORK_NETWORK_NAME=arbitrumOne ./fork-test.sh",
     "test:base-fork": "FORK_NETWORK_NAME=base ./fork-test.sh",
     "test:hol-fork": "FORK_NETWORK_NAME=holesky ./fork-test.sh",
+    "test:sonic-fork": "FORK_NETWORK_NAME=sonic ./fork-test.sh",
     "test:fork:w_trace": "TRACE=true ./fork-test.sh",
     "fund": "FORK=true npx hardhat fund --network localhost",
     "echidna": "yarn run clean && rm -rf echidna-corpus && echidna . --contract Echidna --config echidna-config.yaml",
@@ -43,14 +46,19 @@
     "test:coverage:fork": "REPORT_COVERAGE=true ./fork-test.sh",
     "test:coverage:arb-fork": "REPORT_COVERAGE=true FORK_NETWORK_NAME=arbitrumOne ./fork-test.sh",
     "test:coverage:base-fork": "REPORT_COVERAGE=true FORK_NETWORK_NAME=base ./fork-test.sh",
-    "test:coverage:hol-fork": "REPORT_COVERAGE=true FORK_NETWORK_NAME=holesky ./fork-test.sh"
+    "test:coverage:hol-fork": "REPORT_COVERAGE=true FORK_NETWORK_NAME=holesky ./fork-test.sh",
+    "test:coverage:sonic-fork": "REPORT_COVERAGE=true FORK_NETWORK_NAME=sonic ./fork-test.sh"
   },
   "author": "Origin Protocol Inc <[email protected]>",
   "license": "MIT",
   "devDependencies": {
     "@aws-sdk/client-kms": "^3.598.0",
     "@aws-sdk/client-s3": "^3.600.0",
+    "@nomicfoundation/hardhat-chai-matchers": "^2.0.0",
+    "@nomicfoundation/hardhat-ethers": "^3.0.0",
+    "@nomicfoundation/hardhat-ignition-ethers": "^0.15.0",
     "@nomicfoundation/hardhat-network-helpers": "^1.0.9",
+    "@nomicfoundation/hardhat-verify": "^2.0.0",
     "@nomiclabs/hardhat-ethers": "^2.0.2",
     "@nomiclabs/hardhat-etherscan": "^3.1.7",
     "@nomiclabs/hardhat-solhint": "^2.0.0",
@@ -65,6 +73,10 @@
     "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
+    "@typechain/ethers-v6": "^0.5.0",
+    "@typechain/hardhat": "^9.0.0",
+    "@types/chai": "^4.2.0",
+    "@types/mocha": ">=9.1.0",
     "@uniswap/v3-core": "^1.0.0",
     "@uniswap/v3-periphery": "^1.1.1",
     "axios": "^1.4.0",
@@ -96,6 +108,7 @@
     "ssv-keys": "^1.1.0",
     "ssv-scanner": "github:bloxapp/ssv-scanner",
     "sync-fetch": "^0.5.2",
+    "ts-node": ">=8.0.0",
     "uuid": "^9.0.1",
     "web3-utils": "^1.5.2"
   },

contracts/test/helpers.js

@@ -305,6 +305,10 @@ const isBase = hre.network.name == "base";
 const isBaseFork = isFork && process.env.FORK_NETWORK_NAME == "base";
 const isBaseOrFork = isBase || isBaseFork;
 const isBaseUnitTest = process.env.UNIT_TESTS_NETWORK === "base";
+const isSonic = hre.network.name == "sonic";
+const isSonicFork = isFork && process.env.FORK_NETWORK_NAME == "sonic";
+const isSonicOrFork = isSonic || isSonicFork;
+const isSonicUnitTest = process.env.UNIT_TESTS_NETWORK === "sonic";
 
 /// Advances the EVM time by the given number of seconds
 const advanceTime = async (seconds) => {
@@ -838,6 +842,10 @@ module.exports = {
   isBaseFork,
   isBaseOrFork,
   isBaseUnitTest,
+  isSonic,
+  isSonicFork,
+  isSonicOrFork,
+  isSonicUnitTest,
   getOracleAddress,
   setOracleTokenPriceUsd,
   getOracleAddresses,

contracts/utils/hardhat-helpers.js

@@ -7,19 +7,24 @@ const isHoleskyFork = process.env.FORK_NETWORK_NAME === "holesky";
 const isHolesky = process.env.NETWORK_NAME === "holesky";
 const isBase = process.env.NETWORK_NAME === "base";
 const isBaseFork = process.env.FORK_NETWORK_NAME === "base";
+const isSonic = process.env.NETWORK_NAME === "sonic";
+const isSonicFork = process.env.FORK_NETWORK_NAME === "sonic";
 
 const isForkTest = isFork && process.env.IS_TEST === "true";
 const isArbForkTest = isForkTest && isArbitrumFork;
 const isHoleskyForkTest = isForkTest && isHoleskyFork;
 const isBaseForkTest = isForkTest && isBaseFork;
 const isBaseUnitTest = process.env.UNIT_TESTS_NETWORK === "base";
+const isSonicForkTest = isForkTest && isSonicFork;
+const isSonicUnitTest = process.env.UNIT_TESTS_NETWORK === "sonic";
 
 const providerUrl = `${
   process.env.LOCAL_PROVIDER_URL || process.env.PROVIDER_URL
 }`;
 const arbitrumProviderUrl = `${process.env.ARBITRUM_PROVIDER_URL}`;
 const holeskyProviderUrl = `${process.env.HOLESKY_PROVIDER_URL}`;
 const baseProviderUrl = `${process.env.BASE_PROVIDER_URL}`;
+const sonicProviderUrl = `${process.env.SONIC_PROVIDER_URL}`;
 const standaloneLocalNodeRunning = !!process.env.LOCAL_PROVIDER_URL;
 
 /**
@@ -44,6 +49,10 @@ const adjustTheForkBlockNumber = () => {
       forkBlockNumber = process.env.BASE_BLOCK_NUMBER
         ? process.env.BASE_BLOCK_NUMBER
         : undefined;
+    } else if (isSonicForkTest) {
+      forkBlockNumber = process.env.SONIC_BLOCK_NUMBER
+        ? process.env.SONIC_BLOCK_NUMBER
+        : undefined;
     } else {
       forkBlockNumber = process.env.BLOCK_NUMBER
         ? Number(process.env.BLOCK_NUMBER)
@@ -108,6 +117,8 @@ const getHardhatNetworkProperties = () => {
     chainId = 17000;
   } else if (isBaseFork && isFork) {
     chainId = 8453;
+  } else if (isSonicFork && isFork) {
+    chainId = 146;
   } else if (isFork) {
     // is mainnet fork
     chainId = 1;
@@ -119,6 +130,8 @@ const getHardhatNetworkProperties = () => {
       provider = arbitrumProviderUrl;
     } else if (isHoleskyForkTest) {
       provider = holeskyProviderUrl;
+    } else if (isSonicForkTest) {
+      provider = sonicProviderUrl;
     } else if (isBaseForkTest) {
       provider = baseProviderUrl;
     }
@@ -133,6 +146,7 @@ const networkMap = {
   42161: "arbitrumOne",
   1337: "hardhat",
   8453: "base",
+  146: "sonic",
 };
 
 module.exports = {
@@ -144,6 +158,10 @@ module.exports = {
   isBaseUnitTest,
   isHoleskyFork,
   isHolesky,
+  isSonic,
+  isSonicFork,
+  isSonicForkTest,
+  isSonicUnitTest,
   isForkTest,
   isArbForkTest,
   isHoleskyForkTest,
@@ -154,4 +172,5 @@ module.exports = {
   getHardhatNetworkProperties,
   networkMap,
   baseProviderUrl,
+  sonicProviderUrl,
 };