{"id":18947852,"url":"https://github.com/thenaubit/nau-hardhat-typescript-auditor-template","last_synced_at":"2026-04-29T01:08:11.961Z","repository":{"id":169420507,"uuid":"614081792","full_name":"TheNaubit/nau-hardhat-typescript-auditor-template","owner":"TheNaubit","description":"👷‍♂️Hardhat + Typescript auditor template ready to built POCs with it!","archived":false,"fork":false,"pushed_at":"2023-03-16T01:20:50.000Z","size":128,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-17T13:45:12.655Z","etag":null,"topics":["audit","hardhat","solidity","solidity-security","typescript"],"latest_commit_sha":null,"homepage":"https://nauverse.com","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/TheNaubit.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":"2023-03-14T21:17:17.000Z","updated_at":"2023-03-14T22:39:19.000Z","dependencies_parsed_at":null,"dependency_job_id":"b8496093-eb11-4cb2-84f7-8d811b2b5642","html_url":"https://github.com/TheNaubit/nau-hardhat-typescript-auditor-template","commit_stats":null,"previous_names":["thenaubit/nau-hardhat-typescript-auditor-template"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheNaubit%2Fnau-hardhat-typescript-auditor-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheNaubit%2Fnau-hardhat-typescript-auditor-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheNaubit%2Fnau-hardhat-typescript-auditor-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheNaubit%2Fnau-hardhat-typescript-auditor-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheNaubit","download_url":"https://codeload.github.com/TheNaubit/nau-hardhat-typescript-auditor-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239946876,"owners_count":19723014,"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":["audit","hardhat","solidity","solidity-security","typescript"],"created_at":"2024-11-08T13:11:43.947Z","updated_at":"2026-03-27T05:30:22.515Z","avatar_url":"https://github.com/TheNaubit.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Template for Solidity auditing and POCs building\n\n## ![Template for Solidity auditing and POCs building](logo.jpg)\n\nThis is a **simple boilerplate using Hardhat and Typescript** for people looking to have an already working (and updated) template for their **audits / POCs**.\n\nAlthough you can use this to develop Dapps, it is not optimized for it and you might want to install several other dependencies, change config files and so on.\n\nBut for just setting up a project, some contracts or building a quick POC it is perfect.\n\nIt has some cool features like:\n\n- **🪄 Minimal and updated:** I tried to keep this repo updated with the latest stable libraries and settings so you don't have to worry on making this boilerplate work\n- **👷‍♂️ Typed:** It uses Typescript and it even generates types for the contracts when compiling them, so you can use their functions with Intellisense in your scripts\n- **🐈 Linted:** It has Prettier configured both for your script files and your contract files\n- **🪟 Cross-platform:** Don't be worried about why a command doesn't work in your OS. I focus on making this \"1-click to run\" in main OS!\n- **🔌 Plugins ready:** Now you don't have to worry about which plugins you should use. You will be prompted with the recommended auditing plugins in case you don't have them.\n- **⛽ Gas report:** In case you want to test the gas used by some functions, you can get a detailed report\n- **🔥 VS Code Integrated:** Launch your Hardhat local node by just launching it from the VS Code debug section\n\n## 🔧 Installation\n\n1. Clone this repository or click in the \"Use this template\" button in this repository:\n\n```bash\ngit clone https://github.com/NauCode/nau-hardhat-typescript-auditor-template.git\n```\n\n2. Open it in the terminal and instal the node modules:\n\n#### With NPM\n\n```bash\nnpm i\n```\n\n#### With Yarn\n\n```bash\nyarn\n```\n\n3. **Very important**: Run this command:\n\n```bash\nyarn clean\n```\n\n## ⛽ Enabling the Gas Report feature (optional)\n\nIf you want to use the gas report feature, you need to create a .env file like this:\n\n```bash\ncp .env.example .env\n```\n\nThen, if you want the gas report with real prices (this step is optional), set the var `REPORT_GAS` as `TRUE` and [get a CoinMarketCap API key](https://coinmarketcap.com/api/documentation/v1/). Set that API key in the var `COINMARKETCAP_API_KEY`.\nNow you are ready!\n\n## ⚒️ Functions and Tools included\n\n### 🏗️ Compile\n\nCompile your contracts (and generate automatically their types) by running:\n\n```bash\nnpx hardhat compile\n```\n\nor\n\n```bash\nyarn compile\n```\n\n### 🔗 Scripts\n\nRun any script you coded with:\n\n```bash\nnpx hardhat run \u003cscript path\u003e\n```\n\nor\n\n```bash\nyarn run \u003cscript path\u003e\n```\n\n### 🧪 Run tests\n\nRun your Hardhat tests with:\n\n```bash\nnpx hardhat test\n```\n\nor\n\n```bash\nyarn test\n```\n\n### 🪟 Launch your local Node\n\nLaunch a local blockchain node by launching it from the VS Code debug panel or:\n\n```bash\nyarn node\n```\n\n### ⛽ Get a gas report\n\nIf you have configured the gas report settings, just run this command and it will generate a gas report for the contract functions tested in your test files:\n\n```bash\nyarn gas\n```\n\n### 🤔 Having issues?\n\nIf you have any issue, try cleaning the project by running:\n\n```bash\nyarn clean\n```\n\n### 📝 Auto fix formats\n\nApply automatically all the formatting settings in all your files by running:\n\n```bash\nyarn format:fix\n```\n\n### ✔️ Test Coverage\n\nCheck the test coverage of the project with one command:\n\n```bash\nyarn coverage\n```\n\n## 🔌 VS Code Recommended Extensions\n\nThese are the extensions the template will recommend you:\n\n- **Prettier**: [Marketplace docs](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)\n- **Solidity by Juan Blanco**: [Marketplace docs](https://marketplace.visualstudio.com/items?itemName=JuanBlanco.solidity)\n- **Solidity Visual Developer**: [Marketplace docs](https://marketplace.visualstudio.com/items?itemName=tintinweb.solidity-visual-auditor)\n- **Slither**: [Marketplace docs](https://marketplace.visualstudio.com/items?itemName=trailofbits.slither-vscode)\n- **Solidity Metrics**: [Marketplace docs](https://marketplace.visualstudio.com/items?itemName=tintinweb.solidity-metrics)\n\n## 🏗️ Contributions\n\nI am open for contributions in this repo but always remember the main goals of this repo:\n\n- Simple to install and use\n- Updated but without breaking previous functionality\n- Targeted for auditors, not for developers\n  If your contribution fits to those goals, thank you for helping to maintain this!\n\n## ⚠️ Extra\n\n- We are using Ethers 5.7.2 as a dependency. Right now the most updated version is 6.1.0 but several of the Hardhat libraries are not compatible yet with that version, so make sure to don't update it or it won't work!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthenaubit%2Fnau-hardhat-typescript-auditor-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthenaubit%2Fnau-hardhat-typescript-auditor-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthenaubit%2Fnau-hardhat-typescript-auditor-template/lists"}