nipz / smart-contract-starter

A starter for Solidity smart contracts for Ethereum

Solidity Ethereum smart contract starter

Heavily influenced by the Big Whale Labs repos.

Usage

1. Clone the repository with git clone [email protected]:Borodutch/smart-contract-starter
2. Install the dependencies with yarn
3. Add environment variables to your .env file
4. Run the scripts below

Environment variables

Name	Description
ETHERSCAN_API_KEY	Etherscan API key
ETH_RPC	Ethereum RPC URL
CONTRACT_OWNER_PRIVATE_KEY	Private key of the contract owner to deploy the contracts
COINMARKETCAP_API_KEY	Coinmarketcap API key

Also check out the .env.sample file for more information.

Available scripts

• yarn build — compiles the contract ts interface to the typechain directory
• yarn test — runs the test suite
• yarn deploy — deploys the contract to the network
• yarn eth-lint — runs the linter for the solidity contract
• yarn lint — runs all the linters
• yarn prettify — prettifies the code in th project
• yarn release — releases the typechain directory to NPM