docs: create feeds-registry.md; misc editing

Author: jamesondh

README.md

@@ -1,8 +1,10 @@
 # Flux - First-Party Price Feeds for EVM
 
-This repository contains contracts for first-party price feeds for EVM chains, using [OpenZeppelin](https://docs.openzeppelin.com/contracts/4.x/api/access#AccessControl) for access control. Those with a validator role can post numeric data to deployed contracts at any interval. `FluxPriceFeed` contracts are compatible with Chainlink's V2 and V3 aggregator interface, and `FluxPriceFeedFactory` is EIP-2362 compatible.
+This repository contains contracts for first-party price feeds for EVM chains, using [OpenZeppelin](https://docs.openzeppelin.com/contracts/4.x/api/access#AccessControl) for access control. Those with a validator role can post numeric data to deployed contracts at any interval. `FluxPriceFeed` contracts are compatible with Chainlink's V2 and V3 aggregator interface, and the `FluxPriceFeedFactory` contract is EIP-2362 compatible.
 
-If you are a smart contract developer looking to utilize Flux price feeds, check out the [live pairs](https://docs.fluxprotocol.org/docs/live-data-feeds/live-pairs) on the documentation and copy the interface file `contracts/interface/CLV2V3Interface.sol` to use within your project so your contracts know how to query a price feed contract. If you are interested in becoming a first-party data provider, deploy a price feed factory or individual price feed using the instructions in this repository and post data to it using the [fpo-node](https://github.com/fluxprotocol/fpo-node).
+If you are a smart contract developer looking to utilize Flux price feeds, check out the [live pairs](https://docs.fluxprotocol.org/docs/live-data-feeds/fpo-live-networks-and-pairs) on the documentation and copy the interface file `contracts/interface/CLV2V3Interface.sol` to use within your contracts. The contracts `ExamplePriceFeedConsumer` and `RelayerOracleConsumer` demonstrate how to use a price feed within a smart contract.
+
+If you are interested in becoming a first-party data provider, deploy a price feed factory or individual price feed using the instructions in this repository and post data to it using the [fpo-node](https://github.com/fluxprotocol/fpo-node).
 
 See the `docs/` directory for more information on using the contracts.
 
@@ -25,8 +27,6 @@ Next, compile the smart contracts with Hardhat:
 $ yarn compile
 ```
 
----
-
 ### TypeChain
 
 Compile the smart contracts and generate TypeChain artifacts:

docs/feeds-registry.md

@@ -0,0 +1,15 @@
+## Feeds registry
+
+`FeedsRegistry.sol` mimicks the [Chainlink Feed Registry](https://blog.chain.link/introducing-the-chainlink-feed-registry/) interface to query the latest value from price feeds by only providing a pair of asset and denomination addresses, without needing to know each feed’s contract address.
+
+### Deploy
+
+Deploy a feed registry (e.g. to Aurora):
+
+```bash
+$ yarn deployFeedsRegistry --network aurora
+```
+
+Save the deployed contract address outputted by the command above.
+
+Optionally include `--admin "0xMyAddress"` to grant a specific address the initial validator role rather than the deployer.

docs/price-feed.md

@@ -12,8 +12,6 @@ Save the deployed contract address outputted by the command above.
 
 Optionally include `--validator "0xMyAddress"` to grant a specific address the initial validator role rather than the deployer.
 
-_Note: We deployed a price feed contract on Aurora at address `0x8BAac7F07c86895cd017C8a2c7d3C72cF9f1051F` with all role-based permissions removed. Feel free to try posting and fetching data on this contract without deploying your own!_
-
 ### Update answer
 
 Using the mnemonic of the validator in the `.env` file, update the value on a deployed contract:
@@ -29,19 +27,3 @@ $ yarn latestAnswer --contract "0xContractAddress" --network aurora
 
 4200000000
 ```
-
-## Feeds registry
-
-`FeedsRegistry.sol` mimicks the [Chainlink Feed Registry](https://blog.chain.link/introducing-the-chainlink-feed-registry/) interface to query the latest value from price feeds by only providing a pair of asset and denomination addresses, without needing to know each feed’s contract address.
-
-### Deploy
-
-Deploy a feed registry (e.g. to Aurora):
-
-```bash
-$ yarn deployFeedsRegistry --network aurora
-```
-
-Save the deployed contract address outputted by the command above.
-
-Optionally include `--admin "0xMyAddress"` to grant a specific address the initial validator role rather than the deployer.

docs/relayer.md

@@ -1,6 +1,6 @@
 ## Relayer model
 
-For increased redundancy, we encourage protocols to implement a relayer price feed to verify against a main price feed. The contract `RelayerPriceFeedConsumer` demonstrates an example of how a relayer oracle might be used:
+For increased redundancy, protocols are encouraged to implement a relayer price feed to verify against a main price feed. The contract `RelayerPriceFeedConsumer` demonstrates an example of how a relayer oracle might be used:
 
 ```solidity
 (, int256 price, , uint256 timestamp, ) = priceFeed.latestRoundData();
@@ -19,4 +19,4 @@ return price;
 
 In this example, if the relayer oracle reports too large of a deviation from the main oracle or the maximum delay is exceeded, the transaction will be reverted.
 
-The maximum delay and maximum deviation percentage depend on the price feeds being used. It is recommended to test with different values before deploying to production.
+The maximum delay and maximum deviation percentage depend on the price feeds being used (for example, stablecoins will require a smaller maximum deviation percentage than volatile assets). It is recommended to test with different values before deploying to production.