{"id":13527525,"url":"https://github.com/rhlsthrm/typescript-solidity-dev-starter-kit","last_synced_at":"2025-04-05T02:10:38.881Z","repository":{"id":35706181,"uuid":"216521759","full_name":"rhlsthrm/typescript-solidity-dev-starter-kit","owner":"rhlsthrm","description":"Starter kit for smart contract development using Typescript","archived":false,"fork":false,"pushed_at":"2023-03-04T05:58:22.000Z","size":2037,"stargazers_count":410,"open_issues_count":18,"forks_count":127,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-29T01:12:50.925Z","etag":null,"topics":["buidler","dapps","ethereum","solidity","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rhlsthrm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-10-21T08:54:16.000Z","updated_at":"2024-09-23T13:12:14.000Z","dependencies_parsed_at":"2023-07-16T23:51:50.407Z","dependency_job_id":null,"html_url":"https://github.com/rhlsthrm/typescript-solidity-dev-starter-kit","commit_stats":null,"previous_names":["rhlsthrm/solidity-ts-dev-stack-example"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhlsthrm%2Ftypescript-solidity-dev-starter-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhlsthrm%2Ftypescript-solidity-dev-starter-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhlsthrm%2Ftypescript-solidity-dev-starter-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhlsthrm%2Ftypescript-solidity-dev-starter-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rhlsthrm","download_url":"https://codeload.github.com/rhlsthrm/typescript-solidity-dev-starter-kit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247276189,"owners_count":20912288,"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":["buidler","dapps","ethereum","solidity","typescript"],"created_at":"2024-08-01T06:01:50.329Z","updated_at":"2025-04-05T02:10:38.843Z","avatar_url":"https://github.com/rhlsthrm.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","Resources","Project Starter"],"sub_categories":[],"readme":"# Typescript Solidity Dev Starter Kit\n\n_Updated to use Hardhat!_\n\nThis is a starter kit for developing, testing, and deploying smart contracts with a full Typescript environment. This stack uses [Hardhat](https://hardhat.org) as the platform layer to orchestrate all the tasks. [Ethers](https://docs.ethers.io/v5/) is used for all Ethereum interactions and testing.\n\n[Blog Post](https://medium.com/@rahulsethuram/the-new-solidity-dev-stack-buidler-ethers-waffle-typescript-tutorial-f07917de48ae)\n\n## Using this Project\n\nClone this repository, then install the dependencies with `npm install`. Build everything with `npm run build`. https://hardhat.org has excellent docs, and can be used as reference for extending this project.\n\n## Available Functionality\n\n### Build Contracts and Generate Typechain Typeings\n\n`npm run compile`\n\n### Run Contract Tests \u0026 Get Callstacks\n\nIn one terminal run `npx hardhat node`\n\nThen in another run `npm run test`\n\nNotes:\n\n- The gas usage table may be incomplete (the gas report currently needs to run with the `--network localhost` flag; see below).\n\n### Run Contract Tests and Generate Gas Usage Report\n\nIn one terminal run `npx hardhat node`\n\nThen in another run `npm run test -- --network localhost`\n\nNotes:\n\n- When running with this `localhost` option, you get a gas report but may not get good callstacks\n- See [here](https://github.com/cgewecke/eth-gas-reporter#installation-and-config) for how to configure the gas usage report.\n\n### Run Coverage Report for Tests\n\n`npm run coverage`\n\nNotes:\n\n- running a coverage report currently deletes artifacts, so after each coverage run you will then need to run `npx hardhat clean` followed by `npm run build` before re-running tests\n- the branch coverage is 75%\n\n### Deploy to Ethereum\n\nCreate/modify network config in `hardhat.config.ts` and add API key and private key, then run:\n\n`npx hardhat run --network rinkeby scripts/deploy.ts`\n\n### Verify on Etherscan\n\nUsing the [hardhat-etherscan plugin](https://hardhat.org/plugins/nomiclabs-hardhat-etherscan.html), add Etherscan API key to `hardhat.config.ts`, then run:\n\n`npx hardhat verify --network rinkeby \u003cDEPLOYED ADDRESS\u003e`\n\nPRs and feedback welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frhlsthrm%2Ftypescript-solidity-dev-starter-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frhlsthrm%2Ftypescript-solidity-dev-starter-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frhlsthrm%2Ftypescript-solidity-dev-starter-kit/lists"}