🏗 Scaffold-ETH - Optimism Starter Kit

🧫 Prototype frontend experiences to build on Optimistic Ethereum (https://www.optimism.io)

Learn more here

Grafana public dashboard

🏄‍♂️ Quick Start

Manual setup

Prerequisites: Node plus Yarn and Git

Installation

git clone -b optimism-starter-kit https://github.com/austintgriffith/scaffold-eth.git optimism-starter-kit

cd optimism-starter-kit

yarn install

yarn start

👉 Visit your frontend at http://localhost:3000

The following requires Docker & Docker Compose

Creating a node

Download the docker images.

Clone the Optimism monorepo.

in a second terminal window:

git clone https://github.com/ethereum-optimism/optimism.git

Starting the node

This process downloads the images from the Docker hub, and depending on the hardware it can take up to ten minutes.

cd optimism/ops
docker-compose -f docker-compose-nobuild.yml up -t 3600

You might get a timeout at first. If that is the case, just run the docker-compose command again.

Make changes to hardhat.config.js in packages/hardhat/test to deploy on the network you want.

Here, it was set to "localOptimism"by default.

All of the default hardhat accounts are funded with ETH on both L1 and L2. Therefore, you have to add the mnemonic:

'test test test test test test test test test test test junk'

in a third terminal window, 🛰 deploy your contract:

cd optimism-starter-kit
yarn deploy

🔏 Edit your smart contract YourContract.sol in packages/hardhat/contracts

📝 Edit your frontend App.jsx in packages/react-app/src

💼 Edit your deployment scripts in packages/hardhat/deploy

📱 Open http://localhost:3000 to see the app

Deploy to a real network

Once you're app is ready, you can deploy it to a testnet such as Optimistic Kovan. Edit hardhat.config.js to add your account mnemonic to kovanOptimism.

Same procedure for deploying on Optimism mainnet.

Need some ETH accross multiple testnets?

Use Paradigm faucet to get you set up.

📚 Documentation

Documentation, tutorials, challenges, and many more resources, visit: docs.scaffoldeth.io

🔭 Learning Solidity

📕 Read the docs: https://docs.soliditylang.org

📚 Go through each topic from solidity by example editing YourContract.sol in 🏗 scaffold-eth

• Primitive Data Types
• Mappings
• Structs
• Modifiers
• Events
• Inheritance
• Payable
• Fallback

📧 Learn the Solidity globals and units

🛠 Buidl

Check out all the active branches, open issues, and join/fund the 🏰 BuidlGuidl!

• 🚤 Follow the full Ethereum Speed Run

• 🎟 Create your first NFT

• 🥩 Build a staking smart contract

• 🏵 Deploy a token and vendor

• 🎫 Extend the NFT example to make a "buyer mints" marketplace

• 🎲 Learn about commit/reveal

• ✍️ Learn how ecrecover works

• 👩‍👩‍👧‍👧 Build a multi-sig that uses off-chain signatures

• ⏳ Extend the multi-sig to stream ETH

• ⚖️ Learn how a simple DEX works

• 🦍 Ape into learning!

💬 Support Chat

Join the telegram support chat 💬 to ask questions and find others building with 🏗 scaffold-eth!

---

🙏 Please check out our Gitcoin grant too!