buidler-typechain

buidler-typechain

Add Typechain tasks to your Buidler 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 buidler-typechain typechain ts-generator

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

usePlugin("buidler-typechain);

Tasks

This plugin adds the typechain task to Buidler:

Generate Typechain typings for compiled contracts

Configuration

<A description of each extension to the BuidlerConfig or to its fields>

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:

module.exports = {
  typechain: {
    outDir: "src/types",
    target: "web3-v1"
  }
};

Usage

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

TypeScript support

<This section is needed if you are extending types in your plugin>

You need to add this to your tsconfig.json's files array: "node_modules/<npm package name>/src/type-extensions.d.ts"