Awesome
Ethernaut
Ethernaut is a Web3/Solidity based wargame inspired by overthewire, to be played in the Ethereum Virtual Machine. Each level is a smart contract that needs to be 'hacked'.
The game acts both as a tool for those interested in learning ethereum, and as a way to catalogue historical hacks as levels. There can be an infinite number of levels and the game does not require to be played in any particular order.
Deployed Versions
You can find the current, official version at: ethernaut.openzeppelin.com
Install and Build
There are three components to Ethernaut that are needed to run/deploy in order to work with it locally:
- Test Network - A testnet that is running locally, like ganache, hardhat network, geth, etc
- Contract Deployment - In order to work with the contracts, they must be deployed to the locally running testnet
- The Client/Frontend - This is a React app that runs locally and can be accessed on localhost:3000
In order to install, build, and run Ethernaut locally, follow these instructions:
-
Be sure to use a compatible Node version. If you use
nvm
you can runnvm use
at the root level to be sure to select a compatible version. -
Clone the repo and install dependencies:
git clone git@github.com:OpenZeppelin/ethernaut.git yarn install
-
Start deterministic rpc
yarn network
-
Import one of the private keys from the ganache-cli output to your Metamask wallet.
-
Compile contracts
yarn compile:contracts
-
Set
client/src/constants.js
ACTIVE_NETWORK
toNETWORKS.LOCAL
-
Deploy contracts
yarn deploy:contracts
-
Start Ethernaut locally
yarn start:ethernaut
Running locally (goerli network)
The same as using the local network but steps 2, 3 and 6 are not necessary.
In this case, replace point 5 with:
5. Set client/src/constants.js
ACTIVE_NETWORK
to NETWORKS.GOERLI
Running tests
yarn test:contracts
Building
yarn build:ethernaut
Deploying
You will normally need to deploy it on a local network, for this you can just run yarn deploy:contracts
and all the contracts will be deployed on your local node running on localhost:8545
and you will be able to check each level address in the deploy.local.json
file.
To deploy the contracts on Goerli, first set the ACTIVE_NETWORK
variable in constants.js
and then edit deploy.goerli.json
. This file keeps a history of all level and contract instances. To deploy a new instance, add an "x" entry to the array, like so:
{
"0": "x",
"1": "0x4b1d5eb6cd2849c7890bcacd63a6855d1c0e79d5",
"2": "0xdf51a9e8ce57e7787e4a27dd19880fd7106b9a5c",
...
},
Then run yarn deploy:contracts
.
Contributing
Contributions and corrections are always welcome!
Please follow the Contributor's Guide if you would like to help out.