Skip to content

Commit 3849930

Browse files
authored
Update README.md
1 parent b203dbe commit 3849930

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# 🏃 Speedrun Chainlink
22

3-
A beginner's guide to implimenting chainlink products in your smart contracts. Learn about how to get price feeds on chain, how to get a varifiably random number (VRF) on chain, and how to set up chainlink automation so that keeper nodes trigger your contract.
3+
A beginner's guide to implimenting chainlink products with smart contracts. Dive into simplified examples that will teach you how to:
4+
- Access price quotes for a variety of assets on a wide range of networks
5+
- Generate veriably random numbers using the VRF Coordinator
6+
- Configure Chainlink automation to execute transactions based on time intervals or conditional logic
47

58
## Table of Contents
69

@@ -33,7 +36,7 @@ yarn start
3336

3437
## 📈 Price Feeds
3538

36-
Chainlink price feeds offer a decentralized data source that provides price information for a range of assets pairs depending on the network. The price feeds are powered by a decentralized network of independent, security-reviewed, and Sybil-resistant oracle nodes. The `AggregatorV3Interface` is fixed to the price feed address used during instantiation, but the `FeedRegistry` is more flexible although it is only avaible on mainnet.
39+
Chainlink price feeds bring off chain price quotes on chain using a decentralized network of oracles. The `FeedRegistry` contract is only avaible on mainnet, but the price feed addresses that power the `AggregatorV3Interface` are available on a wide range of networks.
3740

3841
### Steps
3942

@@ -45,19 +48,18 @@ Chainlink price feeds offer a decentralized data source that provides price info
4548

4649
### Details
4750

48-
- The price returned by the price feed contract has a specified number of decimals that can be fetched from the price feed contract using the `decimals()` method
49-
- The answer returned by the price feed contract is only updated if the price deviates beyond a specified threshold or if a certain amount of time has passed since the last update
50-
- `FeedRegistry` is only available on Ethereum Mainnet, but `AggregatorV3Interface` is available on a variety of networks.
51+
- The quote returned by the price feed contract has a specified number of decimals
52+
- The quote returned by the price feed contract is only updated if the price deviates beyond a specified threshold or if a certain amount of time has passed since the last update
5153

5254
## 🎲 VRF (Verifiable Random Function)
5355

54-
Chainlink VRF provides access verifiably random numbers on chain. Each request for a random number costs LINK and the reponse is delivered on chain after requestConfirmations number of blocks. The VRFConsumer example uses the Direct Funding method, but you may prefer the Subscription method depending on your use case.
56+
Chainlink VRF provides access to verifiably random numbers on chain. Each request for a random number costs LINK and the reponse is delivered after requestConfirmations number of blocks. The VRFConsumer example uses the Direct Funding method, but you may prefer the Subscription method depending on your use case.
5557

5658
### Steps
5759

5860
1. Set up your contract to inherit VRFV2WrapperConsumerBase
59-
2. Impliment a function that triggers request for random number by calling the requestRandomness function which is inhereted from VRFV2WrapperConsumerBase
60-
3. You must override the fullFillrandomWords function
61+
2. Impliment a function that triggers request for random number by calling the requestRandomness function inhereted from VRFV2WrapperConsumerBase
62+
3. You must override the fullFillrandomWords function inhereted from VRFV2WrapperConsumerBase
6163

6264
### Details
6365

@@ -67,13 +69,13 @@ Chainlink VRF provides access verifiably random numbers on chain. Each request f
6769

6870
## 🤖 Automation
6971

70-
Chainlink Automation calls a smart contract function if a specified set of criteria are met. The time-based trigger calls a target function on a target contract every specified interval. The custom logic trigger allows your contract to use on-chain state to determine when to call a target function. The log trigger allows your contract to use event log data as both a trigger and an input.
72+
Chainlink Automation calls a smart contract function if a specified set of criteria are met. The time-based trigger calls a target function on a target contract every specified interval. The custom logic trigger allows your contract to use on-chain state to determine when to call a target function. The log trigger allows your contract to use event log data as both a trigger and an input
7173

7274
### Steps
7375

7476
1. Decide which trigger fits best for your use case
75-
2. Register a new upkeep with chainlink
76-
3. Provide your target contract and target function
77+
2. Import the appropriate interface and override the checkUpkeep and performUpkeep functions inhereted from the interface
78+
3. Register a new upkeep with chainlink by providing your target contract address and depositing LINK tokens
7779

7880
### Details
7981

0 commit comments

Comments
 (0)