@term-finance/viem-mock-contract

This project adds the ability to deploy a mock contract to the blockchain using the hardhat-viem plugin for hardhat.

Installation

To install this project, run the following commands:

npm:

npm install --save-dev @term-finance/viem-mock-contract

yarn:

yarn add --dev @term-finance/viem-mock-contract

Usage

To use this project, import the deployMock function:

import { deployMock } from "@term-finance/viem-mock-contract";

Then, you can write tests that deploy a mock contract to the blockchain:

import hre from "hardhat";
import { deployMock } from "@term-finance/viem-mock-contract";

describe("MyContract", () => {
  it("should deploy a mock contract", async () => {
    const reader = await hre.viem.getPublicClient();
    const [signer] = await hre.viem.getWalletClients();
    const mockContract = await deployMock(signer, reader);

    // Add expectations to mock
    await deployMock.setup(
      {
        kind: "read",
        abi,
        inputs: [1n, 2n],
        outputs: [3n],
      },
      {
        kind: "revert",
        abi,
        inputs: [2n, 3n],
        reason: "revert reason",
      },
      // ...
    );

    // Call the mock contract
    const result = await reader.readContract(
      mockContract.address,
      "myFunction1",
      [1, 2],
    );

    // Check the result
    expect(result).to.equal(3);

    // Check for a revert
    try {
      await reader.readContract(mockContract.address, "myFunction2", [1, 2]);
      assert.fail("Expected revert");
    } catch (error) {
      expect(error.message).to.contain("revert reason");
    }
  });
});

Testing

To run the tests, run the following command:

yarn install
yarn test