Super quick: Create an online gitpod using this template. Once inside the codespace, it will take a minute or two for the environment to setup and configure lilypad and it's service dependencies for the environment, via the npm preinstall hook.
Start up lilypad and a local development environment by opening a terminal in vscode:
> npm run lilypad:up
> npm run lilypad:onchain:cowsayEdit/Update contracts/ExampleClient.sol
> npm run deployAlmost as quick: Clone this repo and run the commands yourself with local vscode + Docker:
> npm run lilypad:setup
> npm run lilypad:up
> npm run lilypad:onchain:cowsayA Hardhat-based template for developing Solidity smart contracts, with sensible defaults.
- Hardhat: compile, run and test smart contracts
- TypeChain: generate TypeScript bindings for smart contracts
- Ethers: renowned Ethereum library and wallet implementation
- Solhint: code linter
- Solcover: code coverage
- Prettier Plugin Solidity: code formatter
Click the Use this template button at the top of the page to
create a new repository with this repo as the initial state.
This template builds upon the frameworks and libraries mentioned above, so for details about their specific features, please consult their respective documentations.
For example, for Hardhat, you can refer to the Hardhat Tutorial and the Hardhat Docs. You might be in particular interested in reading the Testing Contracts section.
This template comes with sensible default configurations in the following files:
├── .editorconfig
├── .eslintignore
├── .eslintrc.yml
├── .gitignore
├── .prettierignore
├── .prettierrc.yml
├── .solcover.js
├── .solhint.json
└── hardhat.config.ts
This template is IDE agnostic, but for the best user experience, you may want to use it in VSCode alongside Nomic Foundation's Solidity extension.
This template comes with GitHub Actions pre-configured. Your contracts will be linted and tested on every push and pull
request made to the main branch.
Note though that to make this work, you must use your INFURA_API_KEY and your MNEMONIC as GitHub secrets.
For more information on how to set up GitHub secrets, check out the docs.
You can edit the CI script in .github/workflows/ci.yml.
First, you need to install the dependencies:
npm installThen, you need to set up all the required Hardhat Configuration Variables. You might also want to install some that are optional.
To assist with the setup process, run npx hardhat vars setup. To set a particular value, such as a BIP-39 mnemonic
variable, execute this:
Note: this is an optional step, hardhat.config.ts contains a default MNEMONIC
npx hardhat vars set MNEMONIC
? Enter value: ‣ here is where your twelve words mnemonic should be put my friendIf you do not already have a mnemonic, you can generate one using this website.
Compile the smart contracts with Hardhat:
npm run compileCompile the smart contracts and generate TypeChain bindings:
npm run typechainRun the tests with Hardhat:
npm run testLint the Solidity code:
npm run lint:solLint the TypeScript code:
npm run lint:tsGenerate the code coverage report:
npm run coverageSee the gas usage per unit test and average gas per method call:
REPORT_GAS=true npm run testDelete the smart contract artifacts, the coverage reports and the Hardhat cache:
npm run cleanDeploy the contracts to Hardhat Network:
npm run deploy:contractsDeploy a new instance of the Lock contract via a task:
npm run task:deployLock --unlock 100 --value 0.1If you use VSCode, you can get Solidity syntax highlighting with the hardhat-solidity extension.
GitPod is an open-source developer platform for remote development.
To view the coverage report generated by npm run coverage, just click Go Live from the status bar to turn the server
on/off.
npm i -g ganacheganache -s testThe
-s testpasses a seed to the local chain and makes it deterministic
Make sure to set the mnemonic in your .env file to that of the instance running with Ganache.
This project is licensed under MIT.