{"id":19325952,"url":"https://github.com/alephao/solidity-template","last_synced_at":"2025-08-28T06:03:12.278Z","repository":{"id":63012234,"uuid":"481734068","full_name":"alephao/solidity-template","owner":"alephao","description":"Opinionated solidity starter template with too many tools","archived":false,"fork":false,"pushed_at":"2024-01-03T02:12:49.000Z","size":79,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-16T13:55:22.771Z","etag":null,"topics":["contracts","ethereum","evm","forge","foundry","smart-contract","smart-contracts","solidity"],"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/alephao.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-04-14T20:02:38.000Z","updated_at":"2025-04-14T17:53:56.000Z","dependencies_parsed_at":"2024-11-10T02:12:12.174Z","dependency_job_id":"592763ac-2928-4481-a5ba-ec28642428e5","html_url":"https://github.com/alephao/solidity-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alephao%2Fsolidity-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alephao%2Fsolidity-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alephao%2Fsolidity-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alephao%2Fsolidity-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alephao","download_url":"https://codeload.github.com/alephao/solidity-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250318827,"owners_count":21410996,"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":["contracts","ethereum","evm","forge","foundry","smart-contract","smart-contracts","solidity"],"created_at":"2024-11-10T02:12:00.426Z","updated_at":"2025-04-22T20:32:03.758Z","avatar_url":"https://github.com/alephao.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"### Solidity Starter Template\n\nOpinionated solidity template with too many tools.\n\n```bash\ngit clone --recurse-submodules https://github.com/alephao/solidity-template.git\n\n# Install python dependencies\npip install -r requirements.txt -r scripts/solcery/requirements.txt\n\n# Install javascript dependencies\nyarn\n```\n\n**Configuration**\n\n- Compile using solidity `0.8.23`\n- Imports relative to the root folder using `$` e.g.: `import \"$/src/Contract.sol\";`\n- Imports relative to lib fodler using `@` e.g.: `import \"@ds-test/test.sol\";`\n\n**Tooling**\n\n- **[foundry](https://github.com/foundry-rs/foundry)'s `forge`** for building, testing, and gas snapshots\n- **[solhint](https://github.com/protofire/solhint)** for linting\n- **[slither](https://github.com/crytic/slither)** for static analysis and linting\n- **[solcery](https://github.com/alephao/solcery)** for code-generating type-safe errors for tests and error signature comments\n- GitHub Actions CI with three workflows: test, lint, and analyze.\n- Makefile with common commands\n- Deployment script using typescript, ethersjs and typechain\n\n**Support Contracts**\n\n- **[forge-std](https://github.com/foundry-rs/forge-std)**\n\n**CI**\n\nThere are three GitHub Actions workflows configured.\n\n- **Test**: Will run `make test`, running the unit-tests with forge.\n- **Lint**: Will run `make lint`, running solhint and prettier.\n- **Analyze**: Will run `make analyze`, running the slither analyzer.\n\n### Makefile Commands\n\n* **build**: force build with optimization\n* **test**: run only test contracts suffixed with `UnitTest`\n* **snapshot**: create .gas-snapshot, running only tests suffixed with `BenchmarkTest`\n* **codegen**: generate Errors.sol and error's sighash comments\n* **format**: format codebase using prettier\n* **lint**: lint using solhint\n* **analyze**: run analyzer (slither)\n* **typechain**: run analyzer (slither)\n* **deploy**: re-build, re-run typechain, and run deployment script `scripts/deploy.ts`\n\n### Tests\n\n* Unit test contracts should be suffixed with UnitTest\n* Gas/Benchmark test contracts should be suffixed with BenchmarkTest","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falephao%2Fsolidity-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falephao%2Fsolidity-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falephao%2Fsolidity-template/lists"}