{"id":21471510,"url":"https://github.com/max-tonny8/abigen_hardhat","last_synced_at":"2025-03-27T20:19:39.042Z","repository":{"id":250665418,"uuid":"807973063","full_name":"max-tonny8/abigen_hardhat","owner":"max-tonny8","description":"This project is to add Plugin for Hardhat to generate ABI files","archived":false,"fork":false,"pushed_at":"2024-05-30T06:19:08.000Z","size":111,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-01T22:41:19.678Z","etag":null,"topics":["ethereum","hardhat","hardhat-plugin","javascript","npm-package","smart-contracts","soldiity","typescript","web3"],"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/max-tonny8.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":"2024-05-30T06:17:44.000Z","updated_at":"2024-12-25T15:03:43.000Z","dependencies_parsed_at":"2024-07-29T08:54:48.998Z","dependency_job_id":null,"html_url":"https://github.com/max-tonny8/abigen_hardhat","commit_stats":null,"previous_names":["tonny0831/abigen_hardhat","max-tonny8/abigen_hardhat"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/max-tonny8%2Fabigen_hardhat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/max-tonny8%2Fabigen_hardhat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/max-tonny8%2Fabigen_hardhat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/max-tonny8%2Fabigen_hardhat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/max-tonny8","download_url":"https://codeload.github.com/max-tonny8/abigen_hardhat/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245916741,"owners_count":20693400,"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":["ethereum","hardhat","hardhat-plugin","javascript","npm-package","smart-contracts","soldiity","typescript","web3"],"created_at":"2024-11-23T09:35:43.764Z","updated_at":"2025-03-27T20:19:39.026Z","avatar_url":"https://github.com/max-tonny8.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hardhat Abigen Plugin\n\nThis repository contains a plugin for Hardhat, a popular Ethereum development environment. The Hardhat Abigen Plugin generates ABI (Application Binary Interface) files from smart contracts, making it easier to interact with contracts on the Ethereum blockchain.\n\n## Installation\n\nTo use this plugin, follow these steps:\n\n1. Ensure you have [Node.js](https://nodejs.org) installed on your machine.\n2. Install Hardhat by running `npm install --save-dev hardhat`.\n3. Install the Hardhat-Abigen plugin by running `npm install --save-dev hardhat-abigen`.\n\n## Usage\n\nAfter installing the plugin, you can import it in your TypeScript or JavaScript files by adding the following line:\n\n```typescript\nimport \"hardhat-abigen\";\n```\n\nor\n\n```javascript\nrequire(\"hardhat-abigen\");\n```\n\nThis will enable the necessary functionality provided by the plugin.\n\n## Configuration\n\nThe Hardhat-Abigen plugin supports a configuration file that allows you to customize its behavior. Create a file named `hardhat.config.js` or `hardhat.config.ts` in the root directory of your project and add the following configuration options:\n\n### JavaScript\n\n```javascript\nmodule.exports = {\n  // ...other configuration options...\n\n  abigen: {\n    outDir: \"abi\",            // The output directory for generated ABI files (default: \"abi\")\n    inDir: \"contracts\",       // The input directory containing your contract files (default: \"contracts\")\n    includeContracts: [\"*\"],  // An array of contract patterns to include in the generate ABIs (default: [\"*\"])\n    excludeContracts: [],     // An array of contract patterns to exclude from the generate ABIs (default: [])\n    space: 2,                 // The number of spaces to use for indentation in the generated ABIs (default: 2)\n    autoCompile: true         // Whether to automatically compile contracts before generating ABIs (default: true)\n  },\n};\n```\n\n### TypeScript\n\n```typescript\nimport { HardhatUserConfig } from \"hardhat/config\";\n\nconst config: HardhatUserConfig = {\n  // ...other configuration options...\n\n  abigen: {\n    outDir: \"abi\",            // The output directory for generated ABI files (default: \"abi\")\n    inDir: \"contracts\",       // The input directory containing your contract files (default: \"contracts\")\n    includeContracts: [\"*\"],  // An array of contract patterns to include in the generate ABIs (default: [\"*\"])\n    excludeContracts: [],     // An array of contract patterns to exclude from the generate ABIs (default: [])\n    space: 2,                 // The number of spaces to use for indentation in the generated ABIs (default: 2)\n    autoCompile: true         // Whether to automatically compile contracts before generating ABIs (default: true)\n  },\n};\n\nexport default config;\n```\n\nMake sure to replace the values with your desired configuration options.\n\n## Generating ABIs\n\nTo generate ABIs for your contracts, run the following command:\n\n```\nnpx hardhat abigen\n```\n\nThis will compile your contracts (if `autoCompile` is set to `true`) and generate the corresponding ABI files in the specified `outDir` directory.\n\n## License\n\nThis plugin is open-source and available under the [MIT License](LICENSE). Feel free to use, modify, and distribute it as per the terms of the license.\n\n---\n\nI hope this plugin simplifies your development workflow by automatically generating ABIs from your contracts. If you encounter any issues or have suggestions for improvements, please [open an issue](https://github.com/nazarkhatsko/hardhat-abigen/issues). Contributions are also welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmax-tonny8%2Fabigen_hardhat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmax-tonny8%2Fabigen_hardhat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmax-tonny8%2Fabigen_hardhat/lists"}