Improve test fixtures

core/scripts/fetch_external_artifacts.sh

@@ -1,7 +1,10 @@
 #! /bin/bash
 set -eou pipefail
 
-ROOT_DIR="$(realpath "$(dirname $0)/../")"
+ROOT_DIR=$(
+    cd "$(dirname $0)/../"
+    pwd -P
+)
 TMP_DIR=${ROOT_DIR}/tmp/external-artifacts
 EXTERNAL_ARTIFACTS_DIR=${ROOT_DIR}/external
 

core/test/Acre.test.ts

@@ -1,23 +1,23 @@
 import {
-  SnapshotRestorer,
-  loadFixture,
   takeSnapshot,
+  loadFixture,
 } from "@nomicfoundation/hardhat-toolbox/network-helpers"
-import { HardhatEthersSigner } from "@nomicfoundation/hardhat-ethers/signers"
-import { ethers } from "hardhat"
 import { expect } from "chai"
 import { ContractTransactionResponse, ZeroAddress } from "ethers"
-import type { TestERC20, Acre } from "../typechain"
+
+import type { HardhatEthersSigner } from "@nomicfoundation/hardhat-ethers/signers"
+import type { SnapshotRestorer } from "@nomicfoundation/hardhat-toolbox/network-helpers"
+import { deployment } from "./helpers/context"
+import { getUnnamedSigner } from "./helpers/signer"
+
 import { to1e18 } from "./utils"
 
-async function acreFixture() {
-  const [staker1, staker2] = await ethers.getSigners()
+import type { Acre, TestERC20 } from "../typechain"
 
-  const TestERC20 = await ethers.getContractFactory("TestERC20")
-  const tbtc = await TestERC20.deploy()
+async function fixture() {
+  const { tbtc, acre } = await deployment()
 
-  const Acre = await ethers.getContractFactory("Acre")
-  const acre = await Acre.deploy(await tbtc.getAddress())
+  const [staker1, staker2] = await getUnnamedSigner()
 
   const amountToMint = to1e18(100000)
   tbtc.mint(staker1, amountToMint)
@@ -33,7 +33,7 @@ describe("Acre", () => {
   let staker2: HardhatEthersSigner
 
   before(async () => {
-    ;({ acre, tbtc, staker1, staker2 } = await loadFixture(acreFixture))
+    ;({ acre, tbtc, staker1, staker2 } = await loadFixture(fixture))
   })
 
   describe("stake", () => {

core/test/helpers/context.ts

@@ -0,0 +1,15 @@
+import { deployments } from "hardhat"
+
+import { getDeployedContract } from "./contract"
+
+import type { Acre, TestERC20 } from "../../typechain"
+
+// eslint-disable-next-line import/prefer-default-export
+export async function deployment() {
+  await deployments.fixture()
+
+  const tbtc: TestERC20 = await getDeployedContract("TBTC")
+  const acre: Acre = await getDeployedContract("Acre")
+
+  return { tbtc, acre }
+}

core/test/helpers/contract.ts

@@ -0,0 +1,22 @@
+import { ethers } from "ethers"
+import { deployments } from "hardhat"
+
+import type { BaseContract } from "ethers"
+import { getUnnamedSigner } from "./signer"
+
+/**
+ * Get instance of a contract from Hardhat Deployments.
+ * @param deploymentName Name of the contract deployment.
+ * @returns Deployed Ethers contract instance.
+ */
+// eslint-disable-next-line import/prefer-default-export
+export async function getDeployedContract<T extends BaseContract>(
+  deploymentName: string,
+): Promise<T> {
+  const { address, abi } = await deployments.get(deploymentName)
+
+  // Use default unnamed signer from index 0 to initialize the contract runner.
+  const [defaultSigner] = await getUnnamedSigner()
+
+  return new ethers.BaseContract(address, abi, defaultSigner) as T
+}

core/test/helpers/index.ts

@@ -0,0 +1,3 @@
+export * from "./context"
+export * from "./contract"
+export * from "./signer"

core/test/helpers/signer.ts

@@ -0,0 +1,37 @@
+import { ethers, getNamedAccounts, getUnnamedAccounts } from "hardhat"
+
+import type { HardhatEthersSigner } from "@nomicfoundation/hardhat-ethers/signers"
+
+/**
+ * Get named Hardhat Ethers Signers.
+ * @returns Map of named Hardhat Ethers Signers.
+ */
+export async function getNamedSigner(): Promise<{
+  [name: string]: HardhatEthersSigner
+}> {
+  const namedSigners: { [name: string]: HardhatEthersSigner } = {}
+
+  await Promise.all(
+    Object.entries(await getNamedAccounts()).map(async ([name, address]) => {
+      namedSigners[name] = await ethers.getSigner(address)
+    }),
+  )
+
+  return namedSigners
+}
+
+/**
+ * Get unnamed Hardhat Ethers Signers.
+ * @returns Array of unnamed Hardhat Ethers Signers.
+ */
+export async function getUnnamedSigner(): Promise<HardhatEthersSigner[]> {
+  const unnamedSigners: HardhatEthersSigner[] = []
+
+  await Promise.all(
+    (await getUnnamedAccounts()).map(async (address) => {
+      unnamedSigners.push(await ethers.getSigner(address))
+    }),
+  )
+
+  return unnamedSigners
+}