Open Oracle

The Open Oracle is a standard and SDK allowing reporters to sign key-value pairs (e.g. a price feed) that interested users can post to the blockchain. The system has a built-in view system that allows clients to easily share data and build aggregates (e.g. the median price from several sources).

Contents

• Install
• Deploy
• Verify
  • Manual Verification
• Transfer Ownership
• Common Issues

Install

1. Clone the repo
2. Install dependencies

yarn install

3. Copy the contents of .env.example to .env

cp .env.example .env

4. Edit .env with your values

Compiling & Testing

1. To compile:

yarn run compile

2. To run tests:

yarn run test

3. To run test coverage:

yarn run coverage

Deploy

The UAV is deployed using constructor parameters defined in ./configuration/parameters.js. If new markets need to be added, they should be added to this file first. Read more about how to add new markets in the configuration README.

1. Configure constructor params in ./configuration/parameters.js
2. Test in a local fork of mainnet:

yarn deploy-test

3. Deploy the UAV to mainnet:

yarn deploy

This will output the address where the UAV was deployed. Keep this to verify on Etherscan.

Verify

Use the address from the previous step as a positional parameter in the following command:

yarn verify <UAV_ADDRESS>

Manual Verification

A known issue is that the Etherscan API has a limit on the amount of data it accepts. You may see an error like this:

hardhat-etherscan constructor arguments exceeds max accepted (10k chars) length

If so, it means verification must be performed through the UI manually:

1. Generate Standard JSON Input by running:

yarn verify-manual

This will create a file in this project at ./etherscan/verify.json

2. Navigate to the contract in your browser https://etherscan.io/address/<UAV_ADDRESS>
3. Click Contract tab, then click Verify and Publish
4. In the form, the address should already be filled. Fill in the following, and submit:
5. Compiler type: Solidity (Standard-Json-Input)
6. Compiler Version: v0.8.7+...
7. License: GNU GPLv3
8. Upload etherscan/verify.json and submit.

Transfer Ownership

Use the UAV address as a positional parameter in the same way as the verify step. The COMP_MULTISIG address from .env will be the new proposed owner. Run the following command:

yarn transfer <UAV_ADDRESS>

Verify Proposed UAV Prices

We need to verify that the newly deployed UAV is functioning correctly before a new proposal is submitted to upgrade the existing UAV. A simple way to do this is to verify that both the existing and new UAVs returns the same price when the getUnderlyingPrice function is called for each of the configured cTokens. This verification can be done by running the following command.

yarn verify-uav --production PRODUCTION_UAV_ADDR --proposed PROPOSED_UAV_ADDR

e.g
yarn verify-uav --production 0x65c816077c29b557bee980ae3cc2dce80204a0c5 --proposed 0x50ce56A3239671Ab62f185704Caedf626352741e

Sample successful verification output

Comparing prices for cToken cETH with address 0x4Ddc2D193948926D02f9B1fE9e1daa0718270ED5
Underlying prices for cETH match.
Comparing prices for cToken cDAI with address 0x5d3a536E4D6DbD6114cc1Ead35777bAB948E3643
Underlying prices for cDAI match.
Comparing prices for cToken cUSDC with address 0x39AA39c021dfbaE8faC545936693aC917d5E7563
Underlying prices for cUSDC match.
Comparing prices for cToken cUSDT with address 0xf650C3d88D12dB855b8bf7D11Be6C55A4e07dCC9
Underlying prices for cUSDT match.
Comparing prices for cToken cWBTC with address 0xccF4429DB6322D5C611ee964527D42E5d685DD6a
Underlying prices for cWBTC match.
Comparing prices for cToken cBAT with address 0x6C8c6b02E7b2BE14d4fA6022Dfd6d75921D90E4E
Underlying prices for cBAT match.
Comparing prices for cToken cZRX with address 0xB3319f5D18Bc0D84dD1b4825Dcde5d5f7266d407
Underlying prices for cZRX match.
Comparing prices for cToken cREP with address 0x158079Ee67Fce2f58472A96584A73C7Ab9AC95c1
Underlying prices for cREP match.
Comparing prices for cToken cDAI with address 0xF5DCe57282A584D2746FaF1593d3121Fcac444dC
Underlying prices for cDAI match.
Comparing prices for cToken cUNI with address 0x35A18000230DA775CAc24873d00Ff85BccdeD550
Underlying prices for cUNI match.
Comparing prices for cToken cCOMP with address 0x70e36f6BF80a52b3B46b3aF8e106CC0ed743E8e4
Underlying prices for cCOMP match.
Comparing prices for cToken cLINK with address 0xFAce851a4921ce59e912d19329929CE6da6EB0c7
Underlying prices for cLINK match.
Comparing prices for cToken cTUSD with address 0x12392F67bdf24faE0AF363c24aC620a2f67DAd86
Underlying prices for cTUSD match.
Comparing prices for cToken cAAVE with address 0xe65cdB6479BaC1e22340E4E755fAE7E509EcD06c
Underlying prices for cAAVE match.
Comparing prices for cToken cSUSHI with address 0x4B0181102A0112A2ef11AbEE5563bb4a3176c9d7
Underlying prices for cSUSHI match.
Comparing prices for cToken cMKR with address 0x95b4eF2869eBD94BEb4eEE400a99824BF5DC325b
Underlying prices for cMKR match.
Comparing prices for cToken cYFI with address 0x80a2AE356fc9ef4305676f7a3E2Ed04e12C33946
Underlying prices for cYFI match.
Comparing prices for cToken cWBTC with address 0xC11b1268C1A384e55C48c2391d8d480264A3A7F4
Underlying prices for cWBTC match.
Comparing prices for cToken cUSDP with address 0x041171993284df560249B57358F931D9eB7b925D
Underlying prices for cUSDP match.
Comparing prices for cToken cFEI with address 0x7713DD9Ca933848F6819F38B8352D9A15EA73F67
Underlying prices for cFEI match.
Proposed UAV at 0x50ce56A3239671Ab62f185704Caedf626352741e passed all checks with the production UAV at 0x65c816077c29b557bee980ae3cc2dce80204a0c5!

The script will fail if the proposed UAV contract either reverts or returns a different price from the production UAV contract.

Common Issues

Failure to deploy

If deployment fails with an unhelpful GAS error, it usually means that something failed during the UAV's complex construction. The most common problem is incorrect uniswap config. If the uniswapMarket address is not a Uniswap V2 pool, construction will fail. Double check the address, and whether the pool needs to be reversed. More info on this in the configuration README.

Reporter SDK

This repository contains a set of SDKs for reporters to easily sign "reporter" data in any supported languages. We currently support the following languages:

• JavaScript (in TypeScript)
• Elixir

Poster

The poster is a simple application that reads from a given feed (or set of feeds) and posts...

Contributing

Note: all code contributed to this repository must be licensed under each of 1. MIT, 2. BSD-3, and 3. GPLv3. By contributing code to this repository, you accept that your code is allowed to be released under any or all of these licenses or licenses in substantially similar form to these listed above.

Please submit an issue (or create a pull request) for any issues or contributions to the project. Make sure that all test cases pass, including the integration tests in the root of this project.