Practical overview
When it fits
Use it when you want a repository template with documented Hardhat tasks spanning contract compilation and local testing through configured deployment and verification.
Who it is for
- Developers starting a TypeScript-based Solidity project.
- Smart-contract developers who want documented local testing, coverage, and gas-report workflows.
- Developers configuring a scripted Ethereum deployment and Etherscan verification process.
Documented uses
- Start a TypeScript environment for Solidity smart-contract development.
- Compile contracts and generate TypeChain typings.
- Run tests on a local Hardhat node and inspect callstacks.
- Generate test coverage and gas-usage reports.
- Configure a network deployment and invoke Etherscan verification.
Requirements & limits
The repository is public and the README instructs users to clone it. The supplied metadata does not identify a license.
- The test workflow uses a local Hardhat node in a separate terminal.
- The gas-report command uses
--network localhost; the README warns that callstacks may be less useful in this mode. - Coverage runs delete artifacts; the README says to run
npx hardhat cleanfollowed bynpm run buildbefore testing again. - Deployment and verification require network configuration and API credentials.
- The README’s deployment and verification examples use Rinkeby.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Compile and test contracts on a local Hardhat node
Build the starter project, compile contracts, and run its tests with a local node.
Before you start
- Clone the repository.
- Install dependencies with npm.
- Use two terminals for the local node and test commands.
Steps
Run the command below, then the command below.
npm installnpm run buildCompile contracts and generate TypeChain typings with the command below.
npm run compileStart the local node with the command below.
npx hardhat nodeIn another terminal, run the command below.
npm run test
Expected outcome
Contracts are compiled and the documented test command runs against a local Hardhat node.
Guide limitations
- For a gas report, the README instead specifies
npm run test -- --network localhost; in that mode, callstacks may be less useful. - The README says the gas-usage table may be incomplete without the localhost option.
Configure the documented deployment and verification workflow
Set up the repository’s documented network deployment and Etherscan verification commands.
Before you start
- Clone the repository and install its dependencies.
- A configured target network, API key and private key for deployment.
- An Etherscan API key for verification.
Steps
Create or modify the network configuration in
hardhat.config.tsand add the API key and private key.Run the documented deployment command: the command below.
npx hardhat run --network rinkeby scripts/deploy.tsAdd the Etherscan API key to
hardhat.config.ts.Run the command below with the deployed address.
npx hardhat verify --network rinkeby
Expected outcome
The documented workflow deploys using the configured network and invokes the Etherscan verification command for the deployed address.
Guide limitations
- Rinkeby is the README’s example network; the instructions do not establish its current availability.
- The workflow depends on valid network configuration and credentials.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 17 October 2026
- Original website title
- rhlsthrm/typescript-solidity-dev-starter-kit · Official homepage title · retained in its source language

