@unipeer/hardhat-typechain v0.3.2

hardhat-typechain

Better integration with hardhat builtin tasks!

Add Typechain tasks to your hardhat project!

What

TypeChain gives you Typescript bindings for your smart contracts. Now, your tests and frontend code can be typesafe and magically autocomplete smart contract function names!

Installation

npm i @unipeer/hardhat-typechain typechain ts-generator

And add the following statement to your hardhat.config.js:

require("@unipeer/hardhat-typechain");

or for typescript:

import "@unipeer/hardhat-typechain";

Tasks

This plugin adds the typechain task to hardhat:

Generate Typechain typings for compiled contracts

Configuration

This plugin extends the hardhatConfig optional typechain object. The object contains two fields, outDir and target. outDir is the output directory of the artifacts that TypeChain creates (defaults to typechain). target is one of the targets specified by the TypeChain docs (defaults to ethers).

You can also configure this plugin to automatically run after every compile command by setting the runOnCompile field to true. runOnCompile is true by default and is recommended to avoid any frustrations in case where you forget to re-generate types after updating a contract and your tests are out of sync with your contract code.

These are the default configs that you can change:

module.exports = {
  typechain: {
    outDir: "types",
    target: "ethers-v5",
    runOnCompile: true
  },
};

Usage

npx hardhat typechain - Compiles and generates Typescript typings for your contracts.

Example Waffle + Ethers test that uses typedefs for contracts:

import { ethers } from "hardhat";
import chai from "chai";
import { Wallet } from "ethers";
import { deployContract, solidity } from "ethereum-waffle";

import CounterArtifact from "../artifacts/Counter.json";
import { Counter } from "../types/Counter";

chai.use(solidity);
const { expect } = chai;

describe("Counter", () => {
  let counter: Counter;

  beforeEach(async () => {
    // 1
    const signers = await ethers.signers();

    // 2
    counter = (await deployContract(
      <Wallet>signers[0],
      CounterArtifact
    )) as Counter;
    const initialCount = await counter.getCount();

    // 3
    expect(initialCount).to.eq(0);
    expect(counter.address).to.properAddress;
  });

  // 4
  describe("count up", async () => {
    it("should count up", async () => {
      await counter.countUp();
      let count = await counter.getCount();
      expect(count).to.eq(1);
    });
  });

  describe("count down", async () => {
    // 5
    it("should fail", async () => {
      await counter.countDown();
    });

    it("should count down", async () => {
      await counter.countUp();

      await counter.countDown();
      const count = await counter.getCount();
      expect(count).to.eq(0);
    });
  });
});

See this starter kit for a full example!