Integration tests against Mezo Portal

.github/workflows/solidity.yaml

@@ -140,7 +140,7 @@ jobs:
           path: solidity/
 
       - name: Deploy
-        run: pnpm run deploy --no-compile
+        run: pnpm run deployment --no-compile
 
   solidity-deploy-testnet:
     needs: [solidity-deploy-dry-run]

solidity/.gitignore

@@ -5,3 +5,4 @@ export.json
 export/
 gen/
 typechain/
+deployments/

solidity/deploy/00_resolve_mezo_portal.ts

@@ -11,14 +11,14 @@ const func: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   const { log } = deployments
   const { deployer } = await getNamedAccounts()
 
-  const mezoPortal = await deployments.getOrNull("MezoPortal")
+  let mezoPortal = await deployments.getOrNull("MezoPortal")
+  if (hre.network.name === "integration") {
+    mezoPortal = await deployments.getArtifact("MezoPortal")
+  }
 
   if (mezoPortal && isNonZeroAddress(mezoPortal.address)) {
     log(`using MezoPortal contract at ${mezoPortal.address}`)
-  } else if (
-    (hre.network.config as HardhatNetworkConfig)?.forking?.enabled &&
-    hre.network.name !== "hardhat"
-  ) {
+  } else if ((hre.network.config as HardhatNetworkConfig)?.forking?.enabled) {
     throw new Error("deployed MezoPortal contract not found")
   } else {
     log("deploying Mezo Portal contract stub")

solidity/deploy/00_resolve_tbtc_token.ts

@@ -11,7 +11,10 @@ const func: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   const { log } = deployments
   const { deployer } = await getNamedAccounts()
 
-  const tbtc = await deployments.getOrNull("TBTC")
+  let tbtc = await deployments.getOrNull("TBTC")
+  if (hre.network.name === "integration") {
+    tbtc = await deployments.getArtifact("TBTC")
+  }
 
   if (tbtc && isNonZeroAddress(tbtc.address)) {
     log(`using TBTC contract at ${tbtc.address}`)

solidity/deploy/00_resolve_tbtc_vault.ts

@@ -23,7 +23,11 @@ const func: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   } else {
     log("deploying TBTCVault contract stub")
 
-    const tbtc = await deployments.get("TBTC")
+    let tbtc = await deployments.getOrNull("TBTC")
+    if (hre.network.name === "integration") {
+      tbtc = await deployments.getArtifact("TBTC")
+    }
+
     const bridge = await deployments.get("Bridge")
 
     const deployment = await deployments.deploy("TBTCVault", {
@@ -34,12 +38,14 @@ const func: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
       waitConfirmations: waitConfirmationsNumber(hre),
     })
 
-    await deployments.execute(
-      "TBTC",
-      { from: deployer, log: true },
-      "setOwner",
-      deployment.address,
-    )
+    if (hre.network.name === "hardhat") {
+      await deployments.execute(
+        "TBTC",
+        { from: deployer, log: true },
+        "setOwner",
+        deployment.address,
+      )
+    }
   }
 }
 

solidity/deploy/01_deploy_stbtc.ts

@@ -7,7 +7,10 @@ const func: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   const { treasury, governance } = await getNamedAccounts()
   const { deployer: deployerSigner } = await helpers.signers.getNamedSigners()
 
-  const tbtc = await deployments.get("TBTC")
+  let tbtc = await deployments.getOrNull("TBTC")
+  if (hre.network.name === "integration") {
+    tbtc = await deployments.getArtifact("TBTC")
+  }
 
   const [, stbtcDeployment] = await helpers.upgrades.deployProxy("stBTC", {
     contractName: "stBTC",

solidity/deploy/02_deploy_mezo_allocator.ts

@@ -7,9 +7,13 @@ const func: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   const { governance } = await getNamedAccounts()
   const { deployer } = await helpers.signers.getNamedSigners()
 
-  const tbtc = await deployments.get("TBTC")
   const stbtc = await deployments.get("stBTC")
-  const mezoPortal = await deployments.get("MezoPortal")
+  let tbtc = await deployments.getOrNull("TBTC")
+  let mezoPortal = await deployments.getOrNull("MezoPortal")
+  if (hre.network.name === "integration") {
+    mezoPortal = await deployments.getArtifact("MezoPortal")
+    tbtc = await deployments.getArtifact("TBTC")
+  }
 
   const [, deployment] = await helpers.upgrades.deployProxy("MezoAllocator", {
     factoryOpts: {

solidity/deploy/03_deploy_bitcoin_depositor.ts

@@ -7,9 +7,12 @@ const func: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   const { governance } = await getNamedAccounts()
   const { deployer } = await helpers.signers.getNamedSigners()
 
+  let tbtc = await deployments.getOrNull("TBTC")
+  if (hre.network.name === "integration") {
+    tbtc = await deployments.getArtifact("TBTC")
+  }
   const bridge = await deployments.get("Bridge")
   const tbtcVault = await deployments.get("TBTCVault")
-  const tbtc = await deployments.get("TBTC")
   const stbtc = await deployments.get("stBTC")
 
   const [, deployment] = await helpers.upgrades.deployProxy(

solidity/deploy/04_deploy_bitcoin_redeemer.ts

@@ -6,7 +6,10 @@ const func: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   const { deployments, helpers } = hre
   const { deployer } = await helpers.signers.getNamedSigners()
 
-  const tbtc = await deployments.get("TBTC")
+  let tbtc = await deployments.getOrNull("TBTC")
+  if (hre.network.name === "integration") {
+    tbtc = await deployments.getArtifact("TBTC")
+  }
   const stbtc = await deployments.get("stBTC")
   const tbtcVault = await deployments.get("TBTCVault")
 

solidity/hardhat.config.ts

@@ -29,6 +29,10 @@ const config: HardhatUserConfig = {
     hardhat: {
       tags: ["allowStubs"],
     },
+    integration: {
+      url: "http://localhost:8545",
+      tags: ["allowStubs"],
+    },
     sepolia: {
       url: process.env.CHAIN_API_URL || "",
       chainId: 11155111,
@@ -48,9 +52,18 @@ const config: HardhatUserConfig = {
   },
 
   external: {
+    contracts:
+      process.env.INTEGRATION_TEST === "true"
+        ? [
+            {
+              artifacts: "./external/mainnet",
+            },
+          ]
+        : undefined,
     deployments: {
       sepolia: ["./external/sepolia"],
       mainnet: ["./external/mainnet"],
+      integration: ["./external/mainnet"],
     },
   },
 

solidity/package.json

@@ -16,7 +16,7 @@
   "scripts": {
     "clean": "hardhat clean && rm -rf cache/ export/ gen/ export.json",
     "build": "hardhat compile",
-    "deploy": "hardhat deploy --export export.json",
+    "deployment": "hardhat deploy --export export.json",
     "docs": "hardhat docgen",
     "format": "npm run lint:js && npm run lint:sol && npm run lint:config",
     "format:fix": "npm run lint:js:fix && npm run lint:sol:fix && npm run lint:config:fix",
@@ -26,7 +26,8 @@
     "lint:sol:fix": "solhint 'contracts/**/*.sol' --fix && prettier --write 'contracts/**/*.sol'",
     "lint:config": "prettier --check '**/*.@(json)'",
     "lint:config:fix": "prettier --write '**/*.@(json)'",
-    "test": "hardhat test"
+    "test": "hardhat test ./test/*.test.ts",
+    "test:integration": "INTEGRATION_TEST=true hardhat test ./test/integration/*.test.ts --network integration"
   },
   "devDependencies": {
     "@keep-network/hardhat-helpers": "^0.7.1",

solidity/test/helpers/context.ts

@@ -6,14 +6,15 @@ import type {
   BridgeStub,
   TBTCVaultStub,
   MezoAllocator,
-  MezoPortalStub,
+  IMezoPortal,
   BitcoinDepositor,
   BitcoinRedeemer,
   TestTBTC,
 } from "../../typechain"
 
 // eslint-disable-next-line import/prefer-default-export
 export async function deployment() {
+  const isIntegration = deployments.getNetworkName() === "integration"
   await deployments.fixture()
 
   const stbtc: stBTC = await getDeployedContract("stBTC")
@@ -22,13 +23,16 @@ export async function deployment() {
   const bitcoinRedeemer: BitcoinRedeemer =
     await getDeployedContract("BitcoinRedeemer")
 
-  const tbtc: TestTBTC = await getDeployedContract("TBTC")
+  const tbtc: TestTBTC = await getDeployedContract("TBTC", isIntegration)
   const tbtcBridge: BridgeStub = await getDeployedContract("Bridge")
   const tbtcVault: TBTCVaultStub = await getDeployedContract("TBTCVault")
 
   const mezoAllocator: MezoAllocator =
     await getDeployedContract("MezoAllocator")
-  const mezoPortal: MezoPortalStub = await getDeployedContract("MezoPortal")
+  const mezoPortal: IMezoPortal = await getDeployedContract(
+    "MezoPortal",
+    isIntegration,
+  )
 
   return {
     tbtc,

solidity/test/helpers/contract.ts

@@ -12,9 +12,15 @@ const { getUnnamedSigners } = helpers.signers
 // eslint-disable-next-line import/prefer-default-export
 export async function getDeployedContract<T extends BaseContract>(
   deploymentName: string,
+  isIntegrationTest: boolean = false,
 ): Promise<T> {
-  const { address, abi } = await deployments.get(deploymentName)
-
+  let address: string
+  let abi: string
+  if (isIntegrationTest) {
+    ;({ address, abi } = await deployments.getArtifact(deploymentName))
+  } else {
+    ;({ address, abi } = await deployments.get(deploymentName))
+  }
   // Use default unnamed signer from index 0 to initialize the contract runner.
   const [defaultSigner] = await getUnnamedSigners()