{"id":22089421,"url":"https://github.com/emretepedev/hardhat-finder","last_synced_at":"2025-10-11T23:30:51.020Z","repository":{"id":63840771,"uuid":"571099183","full_name":"emretepedev/hardhat-finder","owner":"emretepedev","description":"Hardhat plugin to find compiler outputs of contracts.","archived":false,"fork":false,"pushed_at":"2024-12-29T05:22:14.000Z","size":157,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-15T16:39:45.553Z","etag":null,"topics":["hardhat","hardhat-plugin"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/emretepedev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-27T06:33:48.000Z","updated_at":"2024-12-29T05:21:13.000Z","dependencies_parsed_at":"2024-06-21T20:41:04.643Z","dependency_job_id":null,"html_url":"https://github.com/emretepedev/hardhat-finder","commit_stats":{"total_commits":83,"total_committers":1,"mean_commits":83.0,"dds":0.0,"last_synced_commit":"bf95e6290a09270cc28b6a2e117d2cb8da3af6ec"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emretepedev%2Fhardhat-finder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emretepedev%2Fhardhat-finder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emretepedev%2Fhardhat-finder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emretepedev%2Fhardhat-finder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emretepedev","download_url":"https://codeload.github.com/emretepedev/hardhat-finder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235700108,"owners_count":19031668,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hardhat","hardhat-plugin"],"created_at":"2024-12-01T02:12:50.788Z","updated_at":"2025-10-11T23:30:45.453Z","avatar_url":"https://github.com/emretepedev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# hardhat-finder\n\nHardhat plugin to find compiler outputs of contracts.\n\n## What\n\nThis plugin will help you with reviews and implementations by giving compiler outputs of contracts.\n\n## Installation\n\nInstall the plugin via `npm`:\n\n```bash\nnpm install hardhat-finder\n```\n\nInstall the plugin via `yarn`:\n\n```bash\nyarn add hardhat-finder\n```\n\n---\n\nImport the plugin in your `hardhat.config.js`:\n\n```js\nrequire(\"hardhat-finder\");\n```\n\nOr if you are using TypeScript, in your `hardhat.config.ts`:\n\n```ts\nimport \"hardhat-finder\";\n```\n\n## Tasks\n\nThis plugin adds the `finder` task to Hardhat:\n\n```\nUsage: hardhat [GLOBAL OPTIONS] finder [--colorify] [--compact] [--contract-name \u003cSTRING\u003e] [--contract-path \u003cINPUTFILE\u003e] [--depth \u003cINT\u003e] [--include-dependencies] [--max-string-length \u003cINT\u003e] [--no-compile] [--output-dir \u003cSTRING\u003e] [--prettify] [--write-to-file] [...outputs]\n$ hardhat finder --prettify --colorify --contract-path contracts/Example.sol --contract-name Example abi bytecode\n\n@@@@@@@ contracts/Example.sol:Example @@@@@@@\n======= Abi ======= (contracts/Example.sol:Example)\n[\n {\n inputs: [],\n name: 'foo',\n outputs: [\n {\n internalType: 'uint256',\n name: '',\n type: 'uint256'\n }\n ],\n stateMutability: 'pure',\n type: 'function'\n }\n]\n======= Bytecode ======= (contracts/Example.sol:Example)\n'0x608060405234801561001057600080fd5b5060b68061001f6000396000f3fe6080604052348015600f57600080fd5b506004361060285760003560e01c8063c298557814602d575b600080fd5b60336047565b604051603e9190605d565b60405180910390f35b60006005905090565b6057816076565b82525050565b6000602082019050607060008301846050565b92915050565b600081905091905056fea264697066735822122086e7e92f8524c3c79ce92e0551a14a908c36694cb02510ce7a32d137d929e93764736f6c63430008040033'\n```\n\n## Environment extensions\n\nThis plugin extends the Hardhat Runtime Environment by adding an `finder` field whose type is `Finder`.\n\n## Configuration\n\nThis plugin extends the `HardhatUserConfig`'s `FinderUserConfig` object with the `finder` field.\n\nThis is an example of how to set it:\n\n```js\nmodule.exports = {\n finder: {\n contract: {\n path: \"contracts/Example.sol\",\n name: \"Example\",\n },\n outputs: [\n \"metadata\",\n \"storage-layout\",\n \"dependencies-info\",\n \"source-code\",\n \"fully-qualified-name\",\n \"method-identifiers\",\n ],\n depth: Infinity,\n maxStringLength: Infinity,\n includeDependencies: false,\n colorify: false,\n prettify: false,\n compact: false,\n noCompile: false,\n runOnCompile: false,\n },\n};\n```\n\n| Option | Type | Default | Description |\n| ------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |\n| outputs | _String[]_ | [\"artifact\", \"build-info\", \"abi\", \"metadata\", \"bytecode\", \"bytecode-runtime\", \"link-references\", \"link-references-runtime\", \"immutable-references\", \"immutable-references-runtime\", \"source-code\", \"dependencies-source-code\", \"dependencies-info\", \"settings\", \"solc-version\", \"ast\", \"method-identifiers\", \"opcodes\", \"opcodes-runtime\", \"storage-layout\", \"fully-qualified-name\", \"developer-document\", \"user-document\", \"generated-sources\", \"generated-sources-runtime\", \"source-map\", \"source-map-runtime\"] | Types of output the contract wants to print. |\n| depth | _Number_ | Infinity | The maximum number of nested JSON objects to be printed in outputs. |\n| maxStringLength | _Number_ | Infinity | The maximum number of string lengths to be printed in outputs. |\n| includeDependencies | _Boolean_ | false | Include contract dependencies in outputs. |\n| colorify | _Boolean_ | false | Colorize the outputs. |\n| prettify | _Boolean_ | false | Beautify the outputs. |\n| compact | _Boolean_ | false | Compact the outputs. |\n| writeToFile | _Boolean_ | false | Write the outputs to a file. |\n| outputDir | _String_ | finder-outputs | Directory to save the outputs. |\n| noCompile | _Boolean_ | false | Don't compile before running this task. |\n| runOnCompile | _Boolean_ | false | Run finder task during compile task. |\n\n## Usage\n\nThere are no additional steps you need to take for this plugin to work.\n\nInstall it and access `finder` through the Hardhat Runtime Environment anywhere you need it (tasks, scripts, tests, etc).\n\n```ts\nimport { finder } from \"hardhat\";\n\nasync function main() {\n const contractPath = \"contracts/ExampleLibrary.sol\";\n const contractName = \"ExampleLibrary\";\n await finder.setFor({\n contractPath,\n contractName,\n });\n\n console.log(finder.getUserDocument());\n console.log(finder.getDeveloperDocument());\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femretepedev%2Fhardhat-finder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femretepedev%2Fhardhat-finder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femretepedev%2Fhardhat-finder/lists"}