Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wighawag/template-ethereum-contracts
Template to develop ethereum smart contracts
https://github.com/wighawag/template-ethereum-contracts
Last synced: 19 days ago
JSON representation
Template to develop ethereum smart contracts
- Host: GitHub
- URL: https://github.com/wighawag/template-ethereum-contracts
- Owner: wighawag
- Created: 2020-10-23T11:39:16.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-25T19:30:07.000Z (5 months ago)
- Last Synced: 2024-10-09T12:39:33.700Z (about 1 month ago)
- Language: TypeScript
- Size: 1.2 MB
- Stars: 491
- Watchers: 8
- Forks: 116
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-solidity - wighawag/template-ethereum-contracts - Template to develop smart contracts. (Resources)
- awesome-solidity - wighawag/template-ethereum-contracts - Template to develop smart contracts. (Resources)
- awesome-solidity - wighawag/template-ethereum-contracts - Template to develop smart contracts. (Resources)
- awesome-dapptools - Template Ethereum Contracts
README
# A template for EVM-based smart contract development
## How to use it?
### Compile your contracts
```bash
pnpm compile
```
### Test your contracts
There are 2 flavors of tests
1. Using hardhat
```bash
pnpm test
```
2. Using foundry
```bash
forge test
```
This assumes you have `forge` installed and that you added forge-std in via the following command
```bash
git clone --recursive https://github.com/foundry-rs/forge-std.git lib/forge-std
```
> (You can also add it as a submodule if you prefer, just remove the `lib/forge-std` line in .gitignore first)
### watch for changes and rebuild automatically
```bash
pnpm compile:watch
```
### deploy your contract
- on localhost
This assumes you have a local node running: `pnpm local_node`
```bash
pnpm run deploy localhost
```
- on a network of your choice
Just make sure you have your .env.local setup, see [.env](.env)
```bash
pnpm run deploy
```
### execute scripts
```bash
pnpm execute scripts/setMessage.ts
```
or if you want to execute in a forked environment :
```bash
pnpm fork:execute scripts/setMessage.ts "Hello world"
```
### zellij
[zellij](https://zellij.dev/) is a useful multiplexer (think tmux) for which we have included a [layout file](./zellij.kdl) to get started
Once installed simply run the following to get a local in-memory Ethereum node running along with the tests
```bash
pnpm start
```
if you want to try Zellij without installing it, try this :
```bash
bash <(curl -L zellij.dev/launch) --layout zellij.kdl
```
In the shell in the upper pane, you execute the script as mentioned above
```bash
pnpm execute localhost scripts/setMessage.ts "Hello everyone"
```
## Initial Setup
You need to have these installed
- [nodejs](https://nodejs.org/en)
- [pnpm](https://pnpm.io/)
```bash
npm i -g pnpm
```
Then you need to install the local dependencies with the following command:
```bash
pnpm i
```
We also recommend installing [Zellij](https://zellij.dev/) to have your dev env setup in one go via `pnpm start`