README.md

🏗 scaffold-eth | 🏰 BuidlGuidl

🚩 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.

🏦 Build a Staker.sol contract that collects ETH from numerous addresses using a payable stake() function and keeps track of balances. After some deadline if it has at least some threshold of ETH, it sends it to an ExampleExternalContract and triggers the complete() action sending the full balance. If not enough ETH is collected, allow users to withdraw().

🎛 Building the frontend to display the information and UI is just as important as writing the contract. The goal is to deploy the contract and the app to allow anyone to stake using your app. Use a Stake(address,uint256) event to all stakes.

🌟 The final deliverable is deploying a Dapp that lets users send ether to a contract and stake if the conditions are met, then yarn build and yarn surge your app to a public webserver. Submit the url on SpeedRunEthereum.com!

💬 Meet other builders working on this challenge and get help in the Challenge 1 telegram!

🧫 Everything starts by ✏️ Editing Staker.sol in packages/hardhat/contracts

---

Checkpoint 0: 📦 install 📚

Want a fresh cloud environment? Click this to open a gitpod workspace, then skip to Checkpoint 1 after the tasks are complete.

git clone https://github.com/scaffold-eth/scaffold-eth-challenges.git challenge-1-decentralized-staking

cd challenge-1-decentralized-staking

git checkout challenge-1-decentralized-staking

yarn install

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

---

Checkpoint 1: 🔭 Environment 📺

You'll have three terminals up for:

yarn start   (react app frontend)
yarn chain   (hardhat backend)
yarn deploy  (to compile, deploy, and publish your contracts to the frontend)

💻 View your frontend at http://localhost:3000/

👩‍💻 Rerun yarn deploy --reset whenever you want to deploy new contracts to the frontend.

---

Checkpoint 2: 🥩 Staking 💵

You'll need to track individual balances using a mapping:

mapping ( address => uint256 ) public balances;

And also track a constant threshold at 1 ether

uint256 public constant threshold = 1 ether;

👩‍💻 Write your stake() function and test it with the Debug Contracts tab in the frontend

💸 Need more funds from the faucet? Enter your frontend address into the wallet to get as much as you need!

✏ Need to troubleshoot your code? If you import hardhat/console.sol to your contract, you can call console.log() right in your Solidity code. The output will appear in your yarn chain terminal.

🥅 Goals

• Do you see the balance of the Staker contract go up when you stake()?
• Is your balance correctly tracked?
• Do you see the events in the Staker UI tab?

---

Checkpoint 3: 🔬 State Machine / Timing ⏱

⚙️ Think of your smart contract like a state machine. First, there is a stake period. Then, if you have gathered the threshold worth of ETH, there is a success state. Or, we go into a withdraw state to let users withdraw their funds.

Set a deadline of block.timestamp + 30 seconds

uint256 public deadline = block.timestamp + 30 seconds;

👨‍🏫 Smart contracts can't execute automatically, you always need to have a transaction execute to change state. Because of this, you will need to have an execute() function that anyone can call, just once, after the deadline has expired.

👩‍💻 Write your execute() function and test it with the Debug Contracts tab

Check the ExampleExternalContract.sol for the bool you can use to test if it has been completed or not. But do not edit the ExampleExternalContract.sol as it can slow the auto grading.

If the address(this).balance of the contract is over the threshold by the deadline, you will want to call: exampleExternalContract.complete{value: address(this).balance}()

If the balance is less than the threshold, you want to set a openForWithdraw bool to true and allow users to withdraw() their funds.

(You'll have 30 seconds after deploying until the deadline is reached, you can adjust this in the contract.)

👩‍💻 Create a timeLeft() function including public view returns (uint256) that returns how much time is left.

⚠️ Be careful! if block.timestamp >= deadline you want to return 0;

⏳ The time will only update if a transaction occurs. You can see the time update by getting funds from the faucet just to trigger a new block.

👩‍💻 You can call yarn deploy --reset any time you want a fresh contract

🥅 Goals

• Can you see timeLeft counting down in the Staker UI tab when you trigger a transaction with the faucet?
• If you stake() enough ETH before the deadline, does it call complete()?
• If you don't stake() enough can you withdraw() your funds?

---

Checkpoint 4: 💵 Receive Function / UX 🙎

🎀 To improve the user experience, set your contract up so it accepts ETH sent to it and calls stake(). You will use what is called the receive() function.

Use the receive() function in solidity to "catch" ETH sent to the contract and call stake() to update balances.

---

🥅 Goals

• If you send ETH directly to the contract address does it update your balance?

---

⚔️ Side Quests

• Can execute get called more than once, and is that okay?
• Can you stake and withdraw freely after the deadline, and is that okay?
• What are other implications of anyone being able to withdraw for someone?

---

🐸 It's a trap!

• Make sure funds can't get trapped in the contract! Try sending funds after you have executed! What happens?
• Try to create a modifier called notCompleted. It will check that ExampleExternalContract is not completed yet. Use it to protect your execute and withdraw functions.

---

⚠️ Test it!

• Now is a good time to run yarn test to run the automated testing function. It will test that you hit the core checkpoints. You are looking for all green checkmarks and passing tests!

---

Checkpoint 5: 🚢 Ship it 🚁

📡 Edit the defaultNetwork to your choice of public EVM networks in packages/hardhat/hardhat.config.js

👩‍🚀 You will want to run yarn account to see if you have a deployer address

🔐 If you don't have one, run yarn generate to create a mnemonic and save it locally for deploying.

⛽️ You will need to send ETH to your deployer address with your wallet.

📝 If you plan on submitting this challenge, be sure to set your deadline to at least block.timestamp + 72 hours

🚀 Run yarn deploy to deploy your smart contract to a public network (selected in hardhat.config.js)

---

Checkpoint 6: 🎚 Frontend 🧘‍♀️

📝 Edit the targetNetwork in App.jsx (in packages/react-app/src) to be the public network where you deployed your smart contract.

💻 View your frontend at http://localhost:3000/

📡 When you are ready to ship the frontend app...

📦 Run yarn build to package up your frontend.

💽 Upload your app to surge with yarn surge (you could also yarn s3 or maybe even yarn ipfs?)

😬 Windows users beware! You may have to change the surge code in packages/react-app/package.json to just "surge": "surge ./build",

⚙ If you get a permissions error yarn surge again until you get a unique URL, or customize it in the command line.

📝 you will use this deploy URL to submit to SpeedRunEthereum.com.

🚔 Traffic to your url might break the Infura rate limit, edit your key: constants.js in packages/ract-app/src.

---

Checkpoint 7: 📜 Contract Verification

Update the api-key in packages/hardhat/package.json file. You can get your key here.

Now you are ready to run the yarn verify --network your_network command to verify your contracts on etherscan 🛰

---

🏃 Head to your next challenge here.

💬 Problems, questions, comments on the stack? Post them to the 🏗 scaffold-eth developers chat