Security News
Research
Data Theft Repackaged: A Case Study in Malicious Wrapper Packages on npm
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
@gnosis-guild/typechain-hardhat
Advanced tools
Zero-config TypeChain support for Hardhat
Automatically generate TypeScript bindings for smartcontracts while using Hardhat.
If you use Ethers do:
npm install --save-dev typechain @gnosis-guild/typechain-hardhat @gnosis-guild/typechain-ethers-v6
If you're a Truffle user you need:
npm install --save-dev typechain @gnosis-guild/typechain-hardhat @gnosis-guild/typechain-truffle-v5
And add the following statements to your hardhat.config.js
:
require('@gnosis-guild/typechain-hardhat')
require('@nomicfoundation/hardhat-ethers')
require('@nomicfoundation/hardhat-chai-matchers')
Or, if you use TypeScript, add this to your hardhat.config.ts
:
import '@gnosis-guild/typechain-hardhat'
import '@nomicfoundation/hardhat-ethers'
import '@nomicfoundation/hardhat-chai-matchers'
Here's a sample tsconfig.json
:
{
"compilerOptions": {
"target": "es2018",
"module": "commonjs",
"strict": true,
"esModuleInterop": true,
"outDir": "dist",
"resolveJsonModule": true
},
"include": ["./scripts", "./test", "./typechain-types"],
"files": ["./hardhat.config.ts"]
}
Now typings should be automatically generated each time contract recompilation happens.
Warning: before running it for the first time you need to do hardhat clean
, otherwise TypeChain will think that
there is no need to generate any typings. This is because this plugin will attempt to do incremental generation and
generate typings only for changed contracts. You should also do hardhat clean
if you change any TypeChain related
config option.
typechain-types
.ethers.getContractFactory
will be typed properly - no need for castsThis plugin overrides the compile task and automatically generates new Typechain artifacts on each compilation.
There is an optional flag --no-typechain
which can be passed in to skip Typechain compilation.
This plugin also adds the typechain
task to hardhat:
hardhat typechain # always regenerates typings to all files
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
).
This is an example of how to set it:
module.exports = {
typechain: {
outDir: 'src/types',
target: 'ethers-v6',
alwaysGenerateOverloads: false, // should overloads with full signatures like deposit(uint256) be generated always, even if there are no overloads?
externalArtifacts: ['externalArtifacts/*.json'], // optional array of glob patterns with external artifacts to process (for example external libs from node_modules)
dontOverrideCompile: false, // defaults to false
},
}
npx hardhat compile
- Compiles and generates Typescript typings for your contracts. Example Ethers + Hardhat Chai
Matchers test that uses typedefs for contracts:
import { ethers } from 'hardhat'
import chai from 'chai'
import { Counter } from '../src/types/Counter'
const { expect } = chai
describe('Counter', () => {
let counter: Counter
beforeEach(async () => {
// 1
const signers = await ethers.getSigners()
// 2
counter = await ethers.deployContract('Counter')
// 3
const initialCount = await counter.getCount()
expect(initialCount).to.eq(0)
})
// 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 - this throw a error with solidity ^0.8.0
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)
})
})
})
Original work done by @RHLSTHRM.
Using the types generated by this plugin can lead to Hardhat failing to run. The reason is that the types are not avialable for loading the config, and that's required to generate the types.
To workaround this issue, you can run TS_NODE_TRANSPILE_ONLY=1 npx hardhat compile
.
FAQs
Zero-config TypeChain support for Hardhat
The npm package @gnosis-guild/typechain-hardhat receives a total of 2 weekly downloads. As such, @gnosis-guild/typechain-hardhat popularity was classified as not popular.
We found that @gnosis-guild/typechain-hardhat demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.