1.18.2 • Published 9 months ago
hardhat-generate-function-selectors v1.18.2
generate-function-selectors plugin
Hardhat TS plugin to generate function selectors from each of the ABI/.json files found in the artifacts/contracts. (Depth/organization doesn't matter)
Outputs 'selectors.json' to project's root directory, which looks like the below for the hardhat example project:
{
"Lock.sol": {
"0x251c1aa3": "unlockTime",
"0x3ccfd60b": "withdraw",
"0x8da5cb5b": "owner"
}
}Quick Start
- Install the Hardhat plug-in
npm install hardhat-generate-function-selectorsyarn add hardhat-generate-function-selectors- Add this to your hardhat.config.js
require("hardhat-generate-function-selectors");import "hardhat-generate-function-selectors";- Add this to your hardhat.config.js as well:
| option | description | default |
|---|---|---|
separateContractSelectors | separate by contract | true |
orderedByValue | order function selectors by hex value, least to greatest | false |
outputPath | directory including filename where output file should be written | ./selectors.json |
pretty | pretty print the output JSON(s) | true |
runOnCompile | run the selectors task on compile | true |
includeParams | include the parameters in the selector title (outputs only) | true |
only | Array of String matchers used to select included contracts, defaults to all contracts if length is 0 | [] |
except | Array of String matchers used to exclude contracts | [] |
skipSelectors | Array of selectors to be excluded from generated output | [] |
<your hardhat config> = {
functionSelectors: {
separateContractSelectors: true,
orderedByValue: true,
<other optional params>
},
};Now you're able to to generate the function selectors with:
npx hardhat selectorsyarn hardhat selectors