\n\n\n# Description\n\nAutomatically generate TypeScript bindings for smartcontracts while using [Hardhat](https://hardhat.org/).\n\n# Installation\n\nIf you use Ethers do:\n\n```bash\nnpm install --save-dev typechain @typechain/hardhat @typechain/ethers-v6\n```\n\nIf you're a Truffle user you need:\n\n```bash\nnpm install --save-dev typechain @typechain/hardhat @typechain/truffle-v5\n```\n\nAnd add the following statements to your `hardhat.config.js`:\n\n```javascript\nrequire('@typechain/hardhat')\nrequire('@nomicfoundation/hardhat-ethers')\nrequire('@nomicfoundation/hardhat-chai-matchers')\n```\n\nOr, if you use TypeScript, add this to your `hardhat.config.ts`:\n\n```typescript\nimport '@typechain/hardhat'\nimport '@nomicfoundation/hardhat-ethers'\nimport '@nomicfoundation/hardhat-chai-matchers'\n```\n\nHere's a sample `tsconfig.json`:\n\n```json\n{\n \"compilerOptions\": {\n \"target\": \"es2018\",\n \"module\": \"commonjs\",\n \"strict\": true,\n \"esModuleInterop\": true,\n \"outDir\": \"dist\",\n \"resolveJsonModule\": true\n },\n \"include\": [\"./scripts\", \"./test\", \"./typechain-types\"],\n \"files\": [\"./hardhat.config.ts\"]\n}\n```\n\nNow typings should be automatically generated each time contract recompilation happens.\n\n**Warning**: before running it for the first time you need to do `hardhat clean`, otherwise TypeChain will think that\nthere is no need to generate any typings. This is because this plugin will attempt to do incremental generation and\ngenerate typings only for changed contracts. You should also do `hardhat clean` if you change any TypeChain related\nconfig option.\n\n## Features\n\n- **Zero Config Usage** - Run the _compile_ task as normal, and Typechain artifacts will automatically be generated in a\n root directory called `typechain-types`.\n- **Incremental generation** - Only recompiled files will have their types regenerated\n- **Frictionless** - return type of `ethers.getContractFactory` will be typed properly - no need for casts\n\n## Tasks\n\nThis plugin overrides the _compile_ task and automatically generates new Typechain artifacts on each compilation.\n\nThere is an optional flag `--no-typechain` which can be passed in to skip Typechain compilation.\n\nThis plugin also adds the `typechain` task to hardhat:\n\n```\nhardhat typechain # always regenerates typings to all files\n```\n\n## Configuration\n\nThis plugin extends the `hardhatConfig` optional `typechain` object. The object contains two fields, `outDir` and\n`target`. `outDir` is the output directory of the artifacts that TypeChain creates (defaults to `typechain`). `target`\nis one of the targets specified by the TypeChain [docs](https://github.com/ethereum-ts/TypeChain#cli) (defaults to\n`ethers`).\n\nThis is an example of how to set it:\n\n```js\nmodule.exports = {\n typechain: {\n outDir: 'src/types',\n target: 'ethers-v6',\n alwaysGenerateOverloads: false, // should overloads with full signatures like deposit(uint256) be generated always, even if there are no overloads?\n externalArtifacts: ['externalArtifacts/*.json'], // optional array of glob patterns with external artifacts to process (for example external libs from node_modules)\n dontOverrideCompile: false // defaults to false\n },\n}\n```\n\n## Usage\n\n`npx hardhat compile` - Compiles and generates Typescript typings for your contracts. Example Ethers + Hardhat Chai Matchers test that\nuses typedefs for contracts:\n\n```ts\nimport { ethers } from 'hardhat'\nimport chai from 'chai'\n\nimport { Counter } from '../src/types/Counter'\n\nconst { expect } = chai\n\ndescribe('Counter', () => {\n let counter: Counter\n\n beforeEach(async () => {\n // 1\n const signers = await ethers.getSigners()\n\n // 2\n counter = await ethers.deployContract(\"Counter\")\n\n // 3\n const initialCount = await counter.getCount()\n expect(initialCount).to.eq(0)\n })\n\n // 4\n describe('count up', async () => {\n it('should count up', async () => {\n await counter.countUp()\n let count = await counter.getCount()\n expect(count).to.eq(1)\n })\n })\n\n describe('count down', async () => {\n // 5 - this throw a error with solidity ^0.8.0\n it('should fail', async () => {\n await counter.countDown()\n })\n\n it('should count down', async () => {\n await counter.countUp()\n\n await counter.countDown()\n const count = await counter.getCount()\n expect(count).to.eq(0)\n })\n })\n})\n```\n\n## Examples\n\n- [starter kit](https://github.com/rhlsthrm/typescript-solidity-dev-starter-kit)\n- [example-ethers](https://github.com/ethereum-ts/TypeChain/tree/master/examples/hardhat)\n- [example-truffle](https://github.com/ethereum-ts/TypeChain/tree/master/examples/hardhat-truffle-v5)\n- @paulrberg's [solidity-template](https://github.com/paulrberg/solidity-template)\n\nOriginal work done by [@RHLSTHRM](https://twitter.com/RHLSTHRM).\n\n## Troubleshooting\n\nUsing the types generated by this plugin can lead to Hardhat failing to run. The reason is that the types are not\navialable for loading the config, and that's required to generate the types.\n\nTo workaround this issue, you can run `TS_NODE_TRANSPILE_ONLY=1 npx hardhat compile`.\n","readmeFilename":"README.md","users":{"takez0":true}}
![\"TypeChain\"](\"https://github.com/Neufund/TypeChain/blob/d82f3cc644a11e22ca8e42505c16f035e2f2555d/docs/images/typechain-logo.png?raw=true\"){kind=logo}
\n ![\"Build](\"https://github.com/ethereum-ts/TypeChain/workflows/CI/badge.svg\"){kind=icon}
\n ![\"Downloads\"](\"https://img.shields.io/npm/dm/typechain.svg\")
\n ![\"Prettier\"](\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg\"){kind=icon}
\n ![\"Software](\"https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square\"){kind=icon}
\n