Feat: Deploy & Set up GS Token in Sonic & SonicTestnet

README.md

@@ -14,6 +14,30 @@ GammaSwap token used to secure liquidation and rebalancing logic in exchange for
 # Deployment Steps
 
 1. Run 01-deploy-gs-token.ts in every chain
-2. Set addresses of GS Token deployed in every chain in helper-hardhat-config.ts in erc20Tokens section in networkConfigInfo
-3. Run 02-deploy-set-lzpeers.ts to connect every token to every token in every chain where it is deployed
-4. Run 03-deploy-timelock-controller.ts to transfer ownership of the GS Token to the timelock controller
+    (No need to set up mintGSTokenTo or initialGSTokenAmt in helper-hardhat-config.ts unless it's first deployment)
+2. Update helper-hardhat-config.ts
+    Set lzEid and lzEndpoing for new chain from LayerZero's docs
+    Set addresses of GS Token deployed in every chain in helper-hardhat-config.ts in erc20Tokens section in networkConfigInfo
+    Add the chain name to developmentLzPeers and productionLzPeers in helper-hardhat-config.ts
+    Add gnosis multisig address as timelock proposer and executor
+3. Run 02-deploy-set-lzpeers.ts to connect every token to every token in every chain where it is deployed.
+    If it's the first deployment, it must be run for every chain.
+4. Run 03-deploy-timelock-controller.ts to deploy timelockController for new GS token chain (use a short minDelay)
+5. Run 05-transfer-gs-ownership.ts to transfer GS Token ownership to timelock-controller
+6. Run 07-update-enforced-options.ts on all non-new chains to set the enforced options from all peers to new peer.
+7. Run 08-deploy-timelock-set-lzpeers.ts to set LZ peers of non-new chains to new peer
+8. Check that network has correct configurations using task lz-config.ts. Make sure DVNs and Libs are not dead.
+   If they're not set or are dead then set the DVNs, SendLib, ReceiveLib, and Executor following the steps from section below.
+8. Run 06-update-timelock-delay.ts, to set the timelock on the new chain to 1 day (set minDelay to 1 day in seconds)
+
+# How to set DVNs, SendLib, ReceiveLib, and Executors
+
+*The delegate of GS token has to also be the timelockController. Otherwise the timelockController
+won't be able to set the configurations. Set the delegate using task lz-set-delegate.ts.
+
+1. Fill in LZ configurations in helper-hardhat-config.ts.
+    Get DVNs from https://docs.layerzero.network/v2/deployments/dvn-addresses
+    Get Send/Rec/Exec Libs from https://docs.layerzero.network/v2/deployments/deployed-contracts
+2. Make sure the DVN count, confirmations, and providers from send to receive chain match.
+3. Run task lz-set-config.ts
+4. Check configurations were set correctly (i.e. they match on both send and receive chain) using task lz-config.ts

deploy/02-deploy-set-lzpeers.ts

@@ -3,6 +3,7 @@ import { DeployFunction } from "hardhat-deploy/types"
 import { isMainnet } from "../helper-functions"
 import { ethers } from "hardhat";
 import { networkConfig, developmentLzPeers, productionLzPeers } from "../helper-hardhat-config";
+import { Options } from "@layerzerolabs/lz-v2-utilities";
 
 const deploySetLZPeers: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
     // @ts-ignore
@@ -37,6 +38,21 @@ const deploySetLZPeers: DeployFunction = async function (hre: HardhatRuntimeEnvi
                     const tx = await (await gsContract.connect(_deployer).setPeer(lzEid, _gsAddr)).wait(confirmations);
                     if(tx && tx.transactionHash) {
                         log("GS in",network.name,"set peer for",peerNetwork,"in",tx.transactionHash)
+
+                        const op = await gsContract.enforcedOptions(lzEid, 1)
+                        log("op[",lzEid,"] before >> ", op)
+
+                        const options = Options.newOptions().addExecutorLzReceiveOption(200000, 0).toHex().toString()
+                        const enforcedOptionParams = [{
+                            eid: lzEid,
+                            msgType: 1, // 1: SEND, 2: SEND_AND_CALL
+                            options: options
+                        }];
+
+                        const _tx = await (await gsContract.connect(_deployer).setEnforcedOptions(enforcedOptionParams)).wait(confirmations);
+                        if(_tx && _tx.transactionHash) {
+                            log("GS in",network.name,"set options",options,"for",peerNetwork,"in",_tx.transactionHash)
+                        }
                     }
                 } else {
                     log("GS already has peer at",peerNetwork)

deploy/05-transfer-gs-ownership.ts

@@ -47,6 +47,7 @@ const deployTransferGSOwnership: DeployFunction = async function (hre: HardhatRu
     const iface = new hre.ethers.utils.Interface(abi);
 
     const data = iface.encodeFunctionData("acceptOwnership", []);
+    log("data:", data.toString())
 
     const timelockControllerContract = await ethers.getContractAt("TimelockController", timelockController.address);
 

deploy/06-update-timelock-delay.ts

@@ -12,6 +12,7 @@ const updateMinDelay: DeployFunction = async function (hre: HardhatRuntimeEnviro
     log(`deployer: ${deployer}`)
 
     const confirmations = networkConfig[network.name].longBlockConfirmations;
+    log(`confirmations: ${confirmations}`)
 
     const _deployer = await hre.ethers.getSigner(deployer);
 

deploy/07-update-enforced-options.ts

@@ -38,24 +38,32 @@ const updateEnforcedOptions: DeployFunction = async function (hre: HardhatRuntim
             const lzEid = Number(cfg.lzEid || "0");
             const op = await gsContract.enforcedOptions(lzEid, 1)
             log("op[",lzEid,"] before >> ", op)
-
-            const enforcedOptionParams = [{
-                eid: lzEid,
-                msgType: 1, // 1: SEND, 2: SEND_AND_CALL
-                options: options
-            }];
-
-            const data = gsContract.interface.encodeFunctionData('setEnforcedOptions', [enforcedOptionParams]);
-            log("data >>", data)
-            payloads.push(data)
-            targets.push(gs.address)
-            values.push(0)
+            if(op == "0x") {
+                const enforcedOptionParams = [{
+                    eid: lzEid,
+                    msgType: 1, // 1: SEND, 2: SEND_AND_CALL
+                    options: options
+                }];
+
+                const data = gsContract.interface.encodeFunctionData('setEnforcedOptions', [enforcedOptionParams]);
+                log("data >>", data)
+                payloads.push(data)
+                targets.push(gs.address)
+                values.push(0)
+            } else {
+                log("enforced options already set for",peerNetwork,"lzEid:",lzEid)
+            }
         }
     }
     log("payloads >> ", payloads)
     log("targets >> ", targets)
     log("values >> ", values)
 
+    if(payloads.length == 0) {
+        log("enforced options have already been set for all chains")
+        return
+    }
+
     const timelockControllerContract = await ethers.getContractAt("TimelockController", timelockController.address);
 
     const currMinDelay = await timelockControllerContract.getMinDelay();
@@ -71,6 +79,12 @@ const updateEnforcedOptions: DeployFunction = async function (hre: HardhatRuntim
     const lastId = events.length > 0 ? events[events.length - 1].args.id : hre.ethers.constants.HashZero;
     log("lastId:", lastId)
 
+    log("==================scheduleBatch parameters==================")
+    log("payloads:", payloads)
+    log("targets :", targets)
+    log("values  :", values)
+    log("lastId  :", lastId)
+    log("============================================================")
     let tx = await (await timelockControllerContract.connect(_deployer).scheduleBatch(targets, values, payloads, lastId, hre.ethers.constants.HashZero, currMinDelay)).wait(confirmations);
     if(tx && tx.transactionHash) {
         log("scheduled setEnforcedOptions(struct) at", tx.transactionHash)
@@ -94,7 +108,7 @@ const updateEnforcedOptions: DeployFunction = async function (hre: HardhatRuntim
             const cfg = networkConfig[peerNetwork]
             const lzEid = Number(cfg.lzEid || "0");
             const op = await gsContract.enforcedOptions(lzEid, 1)
-            log("op[", lzEid, " after >> ", op)
+            log("op[", lzEid, "] after >> ", op)
         }
     }
     log("----------------------------------------------------")

deploy/08-update-timelock-set-lzpeers.ts

@@ -0,0 +1,119 @@
+import { HardhatRuntimeEnvironment } from "hardhat/types"
+import { DeployFunction } from "hardhat-deploy/types"
+import { isMainnet, sleep } from "../helper-functions";
+import { developmentLzPeers, networkConfig, productionLzPeers } from "../helper-hardhat-config";
+import { ethers } from "hardhat";
+import { TimelockController, GS } from "../typechain-types";
+
+const updateEnforcedOptions: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
+    const { getNamedAccounts, deployments, network } = hre
+    const { log, get } = deployments
+    const { deployer } = await getNamedAccounts()
+    log(`deployer: ${deployer}`)
+
+    const confirmations = networkConfig[network.name].longBlockConfirmations;
+
+    const _deployer = await hre.ethers.getSigner(deployer);
+
+    const timelockController = await get("TimelockController");
+    log(`timelockController: ${timelockController.address}`)
+
+    const gs = await get("GS");
+    log(`gs: ${gs.address}`)
+
+    const gsContract = (await ethers.getContractAt('GS', gs.address)) as unknown as GS;
+
+    const lzPeers = isMainnet(hre) ? productionLzPeers : developmentLzPeers
+
+    const payloads = []
+    const targets = []
+    const values = []
+    for(let i = 0; i < lzPeers.length; i++) {
+        const peerNetwork = lzPeers[i]
+        if (network.name != peerNetwork) {
+            const cfg = networkConfig[peerNetwork]
+            const lzEid = Number(cfg.lzEid || "0");
+            const gsAddr = cfg.erc20Tokens?.gs || ""
+            log("Setting Peer for network",peerNetwork," >> lzEid:", lzEid," gs:",gsAddr)
+            if(lzEid > 0 && ethers.utils.isAddress(gsAddr)) {
+                const _gsAddr = ethers.utils.zeroPad(gsAddr, 32)
+                const hasPeer = await gsContract.isPeer(lzEid, _gsAddr);
+                if(!hasPeer) {
+                    log("set peer")
+                    const _gsAddrStr = ethers.utils.hexlify(_gsAddr)
+                    log("_gsAddr:",_gsAddrStr);
+                    const data = gsContract.interface.encodeFunctionData('setPeer', [lzEid, _gsAddrStr]);
+                    payloads.push(data)
+                    targets.push(gs.address)
+                    values.push(0)
+                } else {
+                    log("GS already has peer at", peerNetwork)
+                }
+            } else {
+                log("Peer not set for", peerNetwork)
+            }
+        }
+    }
+    log("payloads >> ", payloads)
+    log("targets >> ", targets)
+    log("values >> ", values)
+
+    if(payloads.length == 0) {
+        log("Peers have already been set for all chains")
+        return
+    }
+
+    const timelockControllerContract = await ethers.getContractAt("TimelockController", timelockController.address);
+
+    const currMinDelay = await timelockControllerContract.getMinDelay();
+    log(`currMinDelay: ${currMinDelay}`)
+
+    const eventName = "CallScheduled";
+    const latestBlock = await hre.ethers.provider.getBlockNumber();
+    log("latestBlock:", latestBlock)
+
+    // Fetch events
+    const events = await timelockControllerContract.queryFilter(timelockControllerContract.filters[eventName](), 0, latestBlock);
+
+    const lastId = events.length > 0 ? events[events.length - 1].args.id : hre.ethers.constants.HashZero;
+    log("lastId:", lastId)
+
+    log("==================scheduleBatch parameters==================")
+    log("payloads:", payloads)
+    log("targets :", targets)
+    log("values  :", values)
+    log("lastId  :", lastId)
+    log("============================================================")
+    let tx = await (await timelockControllerContract.connect(_deployer).scheduleBatch(targets, values, payloads, lastId, hre.ethers.constants.HashZero, currMinDelay)).wait(confirmations);
+    if(tx && tx.transactionHash) {
+        log("scheduled setPeer(lzEid,peerAddr) at", tx.transactionHash)
+    } else {
+        log("ERROR scheduling setPeer(lzEid,peerAddr)")
+        return
+    }
+
+    const waitSeconds = Number(currMinDelay) + 20
+    log("waitSeconds:",waitSeconds)
+    await sleep(waitSeconds * 1000)
+
+    tx = await (await timelockControllerContract.connect(_deployer).executeBatch(targets, values, payloads, lastId, hre.ethers.constants.HashZero)).wait(confirmations);
+    if(tx && tx.transactionHash) {
+        log("execute setPeer(lzEid,peerAddr) at", tx.transactionHash)
+    }
+
+    for(let i = 0; i < lzPeers.length; i++) {
+        const peerNetwork = lzPeers[i]
+        if (network.name != peerNetwork) {
+            const cfg = networkConfig[peerNetwork]
+            const lzEid = Number(cfg.lzEid || "0");
+            const gsAddr = cfg.erc20Tokens?.gs || ""
+            const _gsAddr = ethers.utils.zeroPad(gsAddr, 32)
+            const hasPeer = await gsContract.isPeer(lzEid, _gsAddr);
+            log("Checking if Peer for network",peerNetwork," lzEid:", lzEid," gs:",gsAddr," is set?",hasPeer)
+        }
+    }
+    log("----------------------------------------------------")
+}
+
+export default updateEnforcedOptions
+updateEnforcedOptions.tags = ["all-timelock", "timelock-lz-peers"]

deployments/sonic/.chainId

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