Skip to content

Latest commit

 

History

History
133 lines (75 loc) · 6.54 KB

README.md

File metadata and controls

133 lines (75 loc) · 6.54 KB
Raw

🏗 Scaffold-ETH 2 Challenges

Learn how to use 🏗 Scaffold-ETH 2 to create decentralized applications on Ethereum. 🚀

Nick's notes:

This is my fork of Scaffold-Eth2's repo: https://github.com/scaffold-eth/se-2-challenges, which contains Speedrun Ethereum's challenges: https://speedrunethereum.com/

Challenges are stored in branches, you can check out this repo, do a git fetch --all and then checkout a branch to work on.

Alternatively, if you want to work on each challenge in a separate folder, you can clone this same repo but into challenge specific folders like this:

git clone https://github.com/nicwn/se-2-challenges.git challenge-3-dice-game
cd challenge-3-dice-game
git checkout challenge-3-dice-game
yarn install

For general instructions on installing Scaffold ETH, see https://docs.scaffoldeth.io/quick-start/installation

🚩 Challenge 0: 🎟 Simple NFT Example

🎫 Create a simple NFT to learn the basics of 🏗 scaffold-eth. You'll use 👷‍♀️ HardHat to compile and deploy smart contracts. Then, you'll use a template React app full of important Ethereum components and hooks. Finally, you'll deploy an NFT to a public network to share with friends! 🚀

https://github.com/scaffold-eth/se-2-challenges/tree/challenge-0-simple-nft

🚩 Challenge 1: 🔏 Decentralized Staking App

🦸 A superpower of Ethereum is allowing you, the builder, to create a simple set of rules that an adversarial group of players can use to work together. In this challenge, you create a decentralized application where users can coordinate a group funding effort. If the users cooperate, the money is collected in a second smart contract. If they defect, the worst that can happen is everyone gets their money back. The users only have to trust the code.

https://github.com/scaffold-eth/se-2-challenges/tree/challenge-1-decentralized-staking

🚩 Challenge 2: 🏵 Token Vendor

🤖 Smart contracts are kind of like "always on" vending machines that anyone can access. Let's make a decentralized, digital currency. Then, let's build an unstoppable vending machine that will buy and sell the currency. We'll learn about the "approve" pattern for ERC20s and how contract to contract interactions work.

https://github.com/scaffold-eth/se-2-challenges/tree/challenge-2-token-vendor

🚩 Challenge 3: 🎲 Dice Game

🎰 Randomness is tricky on a public deterministic blockchain. In this challenge you will explore creating random numbers using block hash and how that may be exploitable. Attack the dice game with your own contract by predicting the randomness ahead of time to always roll a winner!

https://github.com/scaffold-eth/se-2-challenges/tree/challenge-3-dice-game

🚩 Challenge 4: ⚖️ Build a DEX Challenge

💵 Build an exchange that swaps ETH to tokens and tokens to ETH. 💰 This is possible because the smart contract holds reserves of both assets and has a price function based on the ratio of the reserves. Liquidity providers are issued a token that represents their share of the reserves and fees...

DEX Telegram Channel: https://t.me/+_NeUIJ664Tc1MzIx

https://github.com/scaffold-eth/se-2-challenges/tree/challenge-4-dex

🎉 Checkpoint: Eligible to join 🏰️ BuidlGuidl

The BuidlGuidl is a curated group of Ethereum builders creating products, prototypes, and tutorials to enrich the web3 ecosystem. A place to show off your builds and meet other builders. Start crafting your Web3 portfolio by submitting your DEX, Multisig or SVG NFT build.

https://buidlguidl.com/

🚩 Challenge 5: 📺 State Channel Application Challenge

🛣️ The Ethereum blockchain has great decentralization & security properties but these properties come at a price: transaction throughput is low, and transactions can be expensive. This makes many traditional web applications infeasible on a blockchain... or does it? State channels look to solve these problems by allowing participants to securely transact off-chain while keeping interaction with Ethereum Mainnet at a minimum.

State Channels Telegram Channel: https://t.me/+k0eUYngV2H0zYWUx

https://github.com/scaffold-eth/se-2-challenges/tree/challenge-5-state-channels

💡 Contributing: Guide and Hints to create New Challenges

Check out already migrated Challenges to get a better idea of the structure and how to create new ones.

A quick start guide.

1. Branch from base-challenge-template

At base-challenge-template branch we will be adding the latest updates from Scaffold ETH 2. We'll also include the learnings we acquire during the Challenges we are adding, as well as the code that may be common to all the Challenges.

2. Edit pages/index.tsx

The main page should have a banner image (ask for it!) + the Challenge description.

{challengeHeroImage}

A {challengeDescription}.

🌟 The final deliverable is an app that {challengeDeliverable}. Deploy your contracts to a testnet then build and upload your app to a public web server. Submit the url on SpeedRunEthereum.com!

3. Implement the Challenge

  • Add the contract(s)
  • Add pages / components as you need (UI following the SpeedRunEthereum.com design vibe)
  • Create the test for the Smart Contract(s). The best starting point is to copy the tests from the SE1 Challenge you are migrating. The "envvar" logic there is used by the autograder, so don't remove them.

4. Adapt Header / MetaHeader component

Update the site title on Header.tsx and title and description of your challenge in MetaHeader.tsx.

5. Image assets for your Challenge

You will need to add the following image assets in packages/nextjs/public folder (ask the designers for it):

  • Thumbnail. thumbnail.png Will be shown in your link previews when shared to others in chat or in social media.
  • Hero image. hero.png It's a wider version of the Thumbnail with SRE logo at the bottom right. Used as README header, and as pages/index.tsx hero image.

6. Edit README adapting the base template

Adapt the base template README using the SE-1 version as a reference.

7. Create a PR against the challenge branch

We can iterate and test there.