Buidler TypeScript plugin boilerplate
npm install buidler-typechain
_Now supports Ethers v5 and Truffle v5!_
_Updated for TypeChain v2!_
Add Typechain tasks to your Buidler project!
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!
``bash`
npm i buidler-typechain typechain ts-generator choose plugin for required target
npm i @typechain/ethers-v4 @typechain/ethers-v5 @typechain/truffle-v5 @typechain/web3-v1 @typechain/truffle-v4
And add the following statement to your buidler.config.js:
`js`
usePlugin("buidler-typechain");
This plugin adds the _typechain_ task to Buidler:
`
Generate Typechain typings for compiled contracts
This plugin extends the BuidlerConfig 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).
This is an example of how to set it:
`js`
module.exports = {
typechain: {
outDir: "src/types",
target: "ethers-v5",
},
};
npx buidler typechain - Compiles and generates Typescript typings for your contracts.
Example Waffle + Ethers test that uses typedefs for contracts:
`ts
import { ethers } from "@nomiclabs/buidler";
import chai from "chai";
import { Wallet } from "ethers";
import { deployContract, solidity } from "ethereum-waffle";
import CounterArtifact from "../artifacts/Counter.json";
import { Counter } from "../typechain/Counter";
chai.use(solidity);
const { expect } = chai;
describe("Counter", () => {
let counter: Counter;
beforeEach(async () => {
// 1
const signers = await ethers.signers();
// 2
counter = (await deployContract(
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!
You need to add this to your tsconfig.json's files array:"node_modules/buidler-typechain/src/type-extensions.d.ts"`