From b7c87765438dffceb43058b08207241633b85a53 Mon Sep 17 00:00:00 2001 From: Jason Romero Date: Mon, 29 Nov 2021 10:59:19 -0500 Subject: [PATCH 1/3] start edits to readme --- README.md | 66 ++++++++++++++++--------------------------------------- 1 file changed, 19 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 58de1c447..2d4f88179 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,21 @@ -# ๐Ÿ— Scaffold-ETH +# ๐Ÿ— Scaffold-ETH | ๐Ÿฐ BuidlGuidl -> everything you need to build on Ethereum! ๐Ÿš€ +## ๐Ÿ‡ณ๐Ÿ‡ต Challenge 4: Oracles ๐Ÿ”ฎ, Price Feeds ๐Ÿค‘ and VRF ๐ŸŽฒ -๐Ÿงช Quickly experiment with Solidity using a frontend that adapts to your smart contract: -![image](https://user-images.githubusercontent.com/2653167/124158108-c14ca380-da56-11eb-967e-69cde37ca8eb.png) -# ๐Ÿ„โ€โ™‚๏ธ Quick Start +--- +### Checkpoint 0: ๐Ÿ“ฆ Install ๐Ÿ“š + +Prerequisites: +- [Node](https://nodejs.org/en/download/) +- [Yarn](https://classic.yarnpkg.com/en/docs/install/) +- [Git](https://git-scm.com/downloads) -Prerequisites: [Node](https://nodejs.org/en/download/) plus [Yarn](https://classic.yarnpkg.com/en/docs/install/) and [Git](https://git-scm.com/downloads) +(โš ๏ธ Don't install the linux package `yarn` make sure you install yarn with `npm i -g yarn`) -> clone/fork ๐Ÿ— scaffold-eth: +> clone/fork [๐Ÿ— challenge repository](https://github.com/scaffold-eth/scaffold-eth-challenges) ```bash git clone https://github.com/scaffold-eth/scaffold-eth-challenges.git challenge-4-oracle @@ -40,55 +44,23 @@ cd challenge-4-oracle 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 -# ๐Ÿ“š Documentation - -Documentation, tutorials, challenges, and many more resources, visit: [docs.scaffoldeth.io](https://docs.scaffoldeth.io) - -# ๐Ÿ”ญ Learning Solidity - -๐Ÿ“• Read the docs: https://docs.soliditylang.org - -๐Ÿ“š Go through each topic from [solidity by example](https://solidity-by-example.org) editing `YourContract.sol` in **๐Ÿ— scaffold-eth** - -- [Primitive Data Types](https://solidity-by-example.org/primitives/) -- [Mappings](https://solidity-by-example.org/mapping/) -- [Structs](https://solidity-by-example.org/structs/) -- [Modifiers](https://solidity-by-example.org/function-modifier/) -- [Events](https://solidity-by-example.org/events/) -- [Inheritance](https://solidity-by-example.org/inheritance/) -- [Payable](https://solidity-by-example.org/payable/) -- [Fallback](https://solidity-by-example.org/fallback/) +--- -๐Ÿ“ง Learn the [Solidity globals and units](https://solidity.readthedocs.io/en/v0.6.6/units-and-global-variables.html) +Checkpoint 1: -# ๐Ÿ›  Buidl -Check out all the [active branches](https://github.com/austintgriffith/scaffold-eth/branches/active), [open issues](https://github.com/austintgriffith/scaffold-eth/issues), and join/fund the ๐Ÿฐ [BuidlGuidl](https://BuidlGuidl.com)! +--- +Checkpoint 2: - - - ๐Ÿšค [Follow the full Ethereum Speed Run](https://medium.com/@austin_48503/%EF%B8%8Fethereum-dev-speed-run-bd72bcba6a4c) +--- +Checkpoint 3: - - ๐ŸŽŸ [Create your first NFT](https://github.com/austintgriffith/scaffold-eth/tree/simple-nft-example) - - ๐Ÿฅฉ [Build a staking smart contract](https://github.com/austintgriffith/scaffold-eth/tree/challenge-1-decentralized-staking) - - ๐Ÿต [Deploy a token and vendor](https://github.com/austintgriffith/scaffold-eth/tree/challenge-2-token-vendor) - - ๐ŸŽซ [Extend the NFT example to make a "buyer mints" marketplace](https://github.com/austintgriffith/scaffold-eth/tree/buyer-mints-nft) - - ๐ŸŽฒ [Learn about commit/reveal](https://github.com/austintgriffith/scaffold-eth/tree/commit-reveal-with-frontend) - - โœ๏ธ [Learn how ecrecover works](https://github.com/austintgriffith/scaffold-eth/tree/signature-recover) - - ๐Ÿ‘ฉโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ง [Build a multi-sig that uses off-chain signatures](https://github.com/austintgriffith/scaffold-eth/tree/meta-multi-sig) - - โณ [Extend the multi-sig to stream ETH](https://github.com/austintgriffith/scaffold-eth/tree/streaming-meta-multi-sig) - - โš–๏ธ [Learn how a simple DEX works](https://medium.com/@austin_48503/%EF%B8%8F-minimum-viable-exchange-d84f30bd0c90) - - ๐Ÿฆ [Ape into learning!](https://github.com/austintgriffith/scaffold-eth/tree/aave-ape) -# ๐Ÿ’ฌ Support Chat +--- +### ๐Ÿ’ฌ Support Chat Join the telegram [support chat ๐Ÿ’ฌ](https://t.me/joinchat/KByvmRe5wkR-8F_zz6AjpA) to ask questions and find others building with ๐Ÿ— scaffold-eth! From 354568538e333edc8559b3ecd2aa41349d72e606 Mon Sep 17 00:00:00 2001 From: Jason Romero Date: Mon, 29 Nov 2021 11:14:45 -0500 Subject: [PATCH 2/3] still building out checkpoints --- README.md | 43 +++++++++++++++++++++++++++++++++++++------ 1 file changed, 37 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2d4f88179..0b1ccb1b6 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@ # ๐Ÿ— Scaffold-ETH | ๐Ÿฐ BuidlGuidl -## ๐Ÿ‡ณ๐Ÿ‡ต Challenge 4: Oracles ๐Ÿ”ฎ, Price Feeds ๐Ÿค‘ and VRF ๐ŸŽฒ +# ๐Ÿ‡ณ๐Ÿ‡ต Challenge 4: Oracles ๐Ÿ”ฎ, Price Feeds ๐Ÿค‘ and VRF ๐ŸŽฒ --- -### Checkpoint 0: ๐Ÿ“ฆ Install ๐Ÿ“š +## Checkpoint 0: ๐Ÿ“ฆ Install ๐Ÿ“š Prerequisites: - [Node](https://nodejs.org/en/download/) - [Yarn](https://classic.yarnpkg.com/en/docs/install/) - [Git](https://git-scm.com/downloads) -(โš ๏ธ Don't install the linux package `yarn` make sure you install yarn with `npm i -g yarn`) +>(โš ๏ธ Don't install the linux package `yarn` make sure you install yarn with `npm i -g yarn`) > clone/fork [๐Ÿ— challenge repository](https://github.com/scaffold-eth/scaffold-eth-challenges) @@ -48,16 +48,47 @@ yarn deploy --- -Checkpoint 1: +### Checkpoint 1: โ›ฝ๏ธ Gas & Wallets ๐Ÿ‘› + +> โ›ฝ๏ธ You'll need to get some funds from the faucet for gas. + +![image](https://user-images.githubusercontent.com/2653167/142483294-ff4c305c-0f5e-4099-8c7d-11c142cb688c.png) + +> ๐ŸฆŠ At first, please **don't** connect MetaMask. If you already connected, please click **logout**: + +![image](https://user-images.githubusercontent.com/2653167/142484483-1439d925-8cef-4b1a-a4b2-0f022eebc0f6.png) + +> ๐Ÿ”ฅ We'll use **burner wallets** on localhost... + +> ๐Ÿ‘› Explore how **burner wallets** work in ๐Ÿ— scaffold-eth by opening a new *incognito* window and navigate it to http://localhost:3000. You'll notice it has a new wallet address in the top right. Copy the incognito browsers' address and send localhost test funds to it from your first browser: + +![image](https://user-images.githubusercontent.com/2653167/142483685-d5c6a153-da93-47fa-8caa-a425edba10c8.png) + +> ๐Ÿ‘จ๐Ÿปโ€๐Ÿš’ When you close the incognito window, the account is gone forever. Burner wallets are great for local development but you'll move to more permanent wallets when you interact with public networks. +--- +### Checkpoint 2: --- -Checkpoint 2: +### Checkpoint 3: --- -Checkpoint 3: +### Checkpoint 4: Deploy ๐Ÿ›ฐ +>๐Ÿ›ฐ Ready to deploy your contracts to kovan testnet? (we use kovan due to all the Chainlink contracts on kovan) + +```bash +yarn deploy --network kovan +``` + +### Checkpoint 5: Ship ๐Ÿšš +> ๐Ÿšš Ready to ship your dapp + +```bash +yarn surge --domain mydomain.surge.sh + +``` --- ### ๐Ÿ’ฌ Support Chat From 38f24ebeef451b95621a402aa8281daecd488c82 Mon Sep 17 00:00:00 2001 From: Jason Romero Date: Mon, 29 Nov 2021 11:21:09 -0500 Subject: [PATCH 3/3] need checkpoint 2 & 3 --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0b1ccb1b6..fb977716f 100644 --- a/README.md +++ b/README.md @@ -66,11 +66,13 @@ yarn deploy > ๐Ÿ‘จ๐Ÿปโ€๐Ÿš’ When you close the incognito window, the account is gone forever. Burner wallets are great for local development but you'll move to more permanent wallets when you interact with public networks. --- -### Checkpoint 2: +### Checkpoint 2: Adding a new Chainlink๐ŸงŠ price feed ๐Ÿ’ธ + --- -### Checkpoint 3: +### Checkpoint 3: Using randomness ๐ŸŽฒ + ---