Skip to content
Starter kit for smart contract development using Typescript
TypeScript
Branch: master
Clone or download
Latest commit 3c07116 Nov 22, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
contracts Add project artifacts Oct 27, 2019
scripts Fix deploy script Oct 29, 2019
test Add project artifacts Oct 27, 2019
.gitignore Ignore typechain artifacts Oct 29, 2019
README.md Update README.md Nov 22, 2019
buidler.config.ts Integrate typechain plugin Nov 20, 2019
package-lock.json Integrate typechain plugin Nov 20, 2019
package.json Fix up package scripts Nov 20, 2019
tsconfig.json Integrate typechain plugin Nov 20, 2019

README.md

Typescript Solidity Dev Starter Kit

This is a starter kit for developing, testing, and deploying smart contracts with a full Typescript environment. This stack uses Buidler as the platform layer to orchestrate all the tasks. Ethers is used for all Ethereum interactions and testing.

Using this Project

Clone this repository, then install the dependencies with npm install. Build everything with npm run build. https://buidler.dev has excellent docs, and can be used as reference for extending this project.

Available Functionality

Build Contracts

npm run compile

Generate TypeChain Typings

npm run build

Run Contract Tests

npm run test

Note: As is, the tests fail on purpose. This is to show the Solidity stack traces that Buidler enables!

Deploy to Ethereum

Create/modify network config in buidler.config.ts and add API key and private key, then run:

npx buidler run --network rinkeby scripts/deploy.ts

Verify on Etherscan

Add Etherscan API key to buidler.config.ts, then run:

npx buidler verify-contract --contract-name Counter --address <DEPLOYED ADDRESS>

Enhancement Wish List

  • Better migrations strategy (Buidler working on this)

PRs and feedback welcome!

You can’t perform that action at this time.