@venusprotocol/oracle 1.6.10 → 1.6.11-dev.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +11 -0
- package/README.md +140 -0
- package/artifacts/@chainlink/contracts/src/v0.8/interfaces/AggregatorInterface.sol/AggregatorInterface.dbg.json +1 -1
- package/artifacts/@chainlink/contracts/src/v0.8/interfaces/AggregatorV2V3Interface.sol/AggregatorV2V3Interface.dbg.json +1 -1
- package/artifacts/@chainlink/contracts/src/v0.8/interfaces/AggregatorV3Interface.sol/AggregatorV3Interface.dbg.json +1 -1
- package/artifacts/@openzeppelin/contracts/access/AccessControl.sol/AccessControl.dbg.json +1 -1
- package/artifacts/@openzeppelin/contracts/access/IAccessControl.sol/IAccessControl.dbg.json +1 -1
- package/artifacts/@openzeppelin/contracts/token/ERC20/ERC20.sol/ERC20.dbg.json +1 -1
- package/artifacts/@openzeppelin/contracts/token/ERC20/ERC20.sol/ERC20.json +2 -2
- package/artifacts/@openzeppelin/contracts/token/ERC20/IERC20.sol/IERC20.dbg.json +1 -1
- package/artifacts/@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol/IERC20Metadata.dbg.json +1 -1
- package/artifacts/@openzeppelin/contracts/utils/Context.sol/Context.dbg.json +1 -1
- package/artifacts/@openzeppelin/contracts/utils/Strings.sol/Strings.dbg.json +1 -1
- package/artifacts/@openzeppelin/contracts/utils/Strings.sol/Strings.json +2 -2
- package/artifacts/@openzeppelin/contracts/utils/introspection/ERC165.sol/ERC165.dbg.json +1 -1
- package/artifacts/@openzeppelin/contracts/utils/introspection/IERC165.sol/IERC165.dbg.json +1 -1
- package/artifacts/@openzeppelin/contracts/utils/math/Math.sol/Math.dbg.json +1 -1
- package/artifacts/@openzeppelin/contracts/utils/math/Math.sol/Math.json +2 -2
- package/artifacts/@openzeppelin/contracts/utils/math/SafeCast.sol/SafeCast.dbg.json +1 -1
- package/artifacts/@openzeppelin/contracts/utils/math/SafeCast.sol/SafeCast.json +2 -2
- package/artifacts/@openzeppelin/contracts/utils/math/SignedMath.sol/SignedMath.dbg.json +1 -1
- package/artifacts/@openzeppelin/contracts/utils/math/SignedMath.sol/SignedMath.json +2 -2
- package/artifacts/@openzeppelin/contracts-upgradeable/access/Ownable2StepUpgradeable.sol/Ownable2StepUpgradeable.dbg.json +1 -1
- package/artifacts/@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol/OwnableUpgradeable.dbg.json +1 -1
- package/artifacts/@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol/Initializable.dbg.json +1 -1
- package/artifacts/@openzeppelin/contracts-upgradeable/security/PausableUpgradeable.sol/PausableUpgradeable.dbg.json +1 -1
- package/artifacts/@openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol/AddressUpgradeable.dbg.json +1 -1
- package/artifacts/@openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol/AddressUpgradeable.json +2 -2
- package/artifacts/@openzeppelin/contracts-upgradeable/utils/ContextUpgradeable.sol/ContextUpgradeable.dbg.json +1 -1
- package/artifacts/@venusprotocol/governance-contracts/contracts/Governance/AccessControlManager.sol/AccessControlManager.dbg.json +4 -0
- package/artifacts/@venusprotocol/governance-contracts/contracts/Governance/AccessControlManager.sol/AccessControlManager.json +369 -0
- package/artifacts/@venusprotocol/governance-contracts/contracts/Governance/AccessControlledV8.sol/AccessControlledV8.dbg.json +4 -0
- package/artifacts/{contracts/Governance/AccessControlled.sol/AccessControlled.json → @venusprotocol/governance-contracts/contracts/Governance/AccessControlledV8.sol/AccessControlledV8.json} +3 -3
- package/artifacts/@venusprotocol/governance-contracts/contracts/Governance/IAccessControlManagerV8.sol/IAccessControlManagerV8.dbg.json +4 -0
- package/artifacts/{contracts/Governance/IAccessControlManager.sol/IAccessControlManager.json → @venusprotocol/governance-contracts/contracts/Governance/IAccessControlManagerV8.sol/IAccessControlManagerV8.json} +2 -2
- package/artifacts/build-info/2f9bd32d7afaff51cf1627ed4903b445.json +1 -0
- package/artifacts/contracts/ResilientOracle.sol/ResilientOracle.dbg.json +1 -1
- package/artifacts/contracts/ResilientOracle.sol/ResilientOracle.json +8 -8
- package/artifacts/contracts/interfaces/FeedRegistryInterface.sol/FeedRegistryInterface.dbg.json +1 -1
- package/artifacts/contracts/interfaces/OracleInterface.sol/BoundValidatorInterface.dbg.json +1 -1
- package/artifacts/contracts/interfaces/OracleInterface.sol/OracleInterface.dbg.json +1 -1
- package/artifacts/contracts/interfaces/OracleInterface.sol/ResilientOracleInterface.dbg.json +1 -1
- package/artifacts/contracts/interfaces/OracleInterface.sol/TwapInterface.dbg.json +1 -1
- package/artifacts/contracts/interfaces/PublicResolverInterface.sol/PublicResolverInterface.dbg.json +1 -1
- package/artifacts/contracts/interfaces/PythInterface.sol/AbstractPyth.dbg.json +1 -1
- package/artifacts/contracts/interfaces/PythInterface.sol/IPyth.dbg.json +1 -1
- package/artifacts/contracts/interfaces/PythInterface.sol/PythStructs.dbg.json +1 -1
- package/artifacts/contracts/interfaces/PythInterface.sol/PythStructs.json +2 -2
- package/artifacts/contracts/interfaces/SIDRegistryInterface.sol/SIDRegistryInterface.dbg.json +1 -1
- package/artifacts/contracts/interfaces/VBep20Interface.sol/VBep20Interface.dbg.json +1 -1
- package/artifacts/contracts/libraries/PancakeLibrary.sol/FixedPoint.dbg.json +1 -1
- package/artifacts/contracts/libraries/PancakeLibrary.sol/FixedPoint.json +2 -2
- package/artifacts/contracts/libraries/PancakeLibrary.sol/IPancakePair.dbg.json +1 -1
- package/artifacts/contracts/libraries/PancakeLibrary.sol/PancakeOracleLibrary.dbg.json +1 -1
- package/artifacts/contracts/libraries/PancakeLibrary.sol/PancakeOracleLibrary.json +2 -2
- package/artifacts/contracts/oracles/BinanceOracle.sol/BinanceOracle.dbg.json +1 -1
- package/artifacts/contracts/oracles/BinanceOracle.sol/BinanceOracle.json +221 -3
- package/artifacts/contracts/oracles/BoundValidator.sol/BoundValidator.dbg.json +1 -1
- package/artifacts/contracts/oracles/BoundValidator.sol/BoundValidator.json +5 -5
- package/artifacts/contracts/oracles/ChainlinkOracle.sol/ChainlinkOracle.dbg.json +1 -1
- package/artifacts/contracts/oracles/ChainlinkOracle.sol/ChainlinkOracle.json +7 -13
- package/artifacts/contracts/oracles/PythOracle.sol/PythOracle.dbg.json +1 -1
- package/artifacts/contracts/oracles/PythOracle.sol/PythOracle.json +11 -5
- package/artifacts/contracts/oracles/TwapOracle.sol/TwapOracle.dbg.json +1 -1
- package/artifacts/contracts/oracles/TwapOracle.sol/TwapOracle.json +24 -37
- package/artifacts/contracts/oracles/mocks/MockBinanceFeedRegistry.sol/MockBinanceFeedRegistry.dbg.json +1 -1
- package/artifacts/contracts/oracles/mocks/MockBinanceFeedRegistry.sol/MockBinanceFeedRegistry.json +2 -2
- package/artifacts/contracts/oracles/mocks/MockBinanceOracle.sol/MockBinanceOracle.dbg.json +1 -1
- package/artifacts/contracts/oracles/mocks/MockBinanceOracle.sol/MockBinanceOracle.json +3 -22
- package/artifacts/contracts/oracles/mocks/MockChainlinkOracle.sol/MockChainlinkOracle.dbg.json +1 -1
- package/artifacts/contracts/oracles/mocks/MockChainlinkOracle.sol/MockChainlinkOracle.json +2 -2
- package/artifacts/contracts/oracles/mocks/MockPythOracle.sol/MockPythOracle.dbg.json +1 -1
- package/artifacts/contracts/oracles/mocks/MockPythOracle.sol/MockPythOracle.json +2 -2
- package/artifacts/contracts/oracles/mocks/MockTwapOracle.sol/MockTwapOracle.dbg.json +1 -1
- package/artifacts/contracts/oracles/mocks/MockTwapOracle.sol/MockTwapOracle.json +2 -2
- package/artifacts/contracts/test/AccessControlManager.sol/AccessControlManagerScenario.dbg.json +4 -0
- package/artifacts/contracts/test/AccessControlManager.sol/AccessControlManagerScenario.json +364 -0
- package/artifacts/contracts/test/BEP20Harness.sol/BEP20Harness.dbg.json +1 -1
- package/artifacts/contracts/test/BEP20Harness.sol/BEP20Harness.json +15 -2
- package/artifacts/contracts/test/MockPyth.sol/MockPyth.dbg.json +1 -1
- package/artifacts/contracts/test/MockPyth.sol/MockPyth.json +2 -2
- package/artifacts/contracts/test/MockSimpleOracle.sol/MockBoundValidator.dbg.json +1 -1
- package/artifacts/contracts/test/MockSimpleOracle.sol/MockBoundValidator.json +2 -2
- package/artifacts/contracts/test/MockSimpleOracle.sol/MockSimpleOracle.dbg.json +1 -1
- package/artifacts/contracts/test/MockSimpleOracle.sol/MockSimpleOracle.json +2 -2
- package/artifacts/contracts/test/MockV3Aggregator.sol/MockV3Aggregator.dbg.json +1 -1
- package/artifacts/contracts/test/MockV3Aggregator.sol/MockV3Aggregator.json +2 -2
- package/artifacts/contracts/test/PancakePairHarness.sol/Math.dbg.json +1 -1
- package/artifacts/contracts/test/PancakePairHarness.sol/Math.json +2 -2
- package/artifacts/contracts/test/PancakePairHarness.sol/PancakePairHarness.dbg.json +1 -1
- package/artifacts/contracts/test/PancakePairHarness.sol/PancakePairHarness.json +2 -2
- package/artifacts/contracts/test/PancakePairHarness.sol/UQ112x112.dbg.json +1 -1
- package/artifacts/contracts/test/PancakePairHarness.sol/UQ112x112.json +2 -2
- package/artifacts/contracts/test/VBEP20Harness.sol/VBEP20Harness.dbg.json +1 -1
- package/artifacts/contracts/test/VBEP20Harness.sol/VBEP20Harness.json +15 -2
- package/contracts/ResilientOracle.sol +45 -37
- package/contracts/interfaces/PythInterface.sol +4 -1
- package/contracts/oracles/BinanceOracle.sol +65 -24
- package/contracts/oracles/BoundValidator.sol +51 -54
- package/contracts/oracles/ChainlinkOracle.sol +54 -54
- package/contracts/oracles/PythOracle.sol +48 -47
- package/contracts/oracles/TwapOracle.sol +85 -83
- package/contracts/oracles/mocks/MockBinanceFeedRegistry.sol +1 -1
- package/contracts/oracles/mocks/MockBinanceOracle.sol +1 -7
- package/contracts/oracles/mocks/MockPythOracle.sol +1 -1
- package/contracts/oracles/mocks/MockTwapOracle.sol +1 -1
- package/contracts/test/AccessControlManager.sol +6 -0
- package/contracts/test/BEP20Harness.sol +4 -0
- package/contracts/test/MockPyth.sol +9 -2
- package/deployments/bscmainnet/.chainId +1 -0
- package/deployments/bscmainnet/BinanceOracle.json +571 -0
- package/deployments/bscmainnet/BinanceOracle_Implementation.json +629 -0
- package/deployments/bscmainnet/BinanceOracle_Proxy.json +251 -0
- package/deployments/bscmainnet/BoundValidator.json +621 -0
- package/deployments/bscmainnet/BoundValidator_Implementation.json +706 -0
- package/deployments/bscmainnet/BoundValidator_Proxy.json +251 -0
- package/deployments/bscmainnet/ChainlinkOracle.json +691 -0
- package/deployments/bscmainnet/ChainlinkOracle_Implementation.json +820 -0
- package/deployments/bscmainnet/ChainlinkOracle_Proxy.json +251 -0
- package/deployments/bscmainnet/DefaultProxyAdmin.json +257 -0
- package/deployments/bscmainnet/PythOracle.json +688 -0
- package/deployments/bscmainnet/PythOracle_Implementation.json +804 -0
- package/deployments/bscmainnet/PythOracle_Proxy.json +265 -0
- package/deployments/bscmainnet/ResilientOracle.json +841 -0
- package/deployments/bscmainnet/ResilientOracle_Implementation.json +1044 -0
- package/deployments/bscmainnet/ResilientOracle_Proxy.json +251 -0
- package/deployments/bscmainnet/TwapOracle.json +887 -0
- package/deployments/bscmainnet/TwapOracle_Implementation.json +1111 -0
- package/deployments/bscmainnet/TwapOracle_Proxy.json +251 -0
- package/deployments/bscmainnet/solcInputs/0e89febeebc7444140de8e67c9067d2c.json +78 -0
- package/deployments/bscmainnet/solcInputs/aae9f1601b873a5a4704ede73ede10cb.json +135 -0
- package/deployments/bsctestnet/BinanceOracle.json +273 -31
- package/deployments/bsctestnet/BinanceOracle_Implementation.json +398 -28
- package/deployments/bsctestnet/BinanceOracle_Proxy.json +52 -28
- package/deployments/bsctestnet/BoundValidator.json +40 -40
- package/deployments/bsctestnet/BoundValidator_Implementation.json +43 -51
- package/deployments/bsctestnet/BoundValidator_Proxy.json +35 -35
- package/deployments/bsctestnet/ChainlinkOracle.json +57 -49
- package/deployments/bsctestnet/ChainlinkOracle_Implementation.json +46 -52
- package/deployments/bsctestnet/ChainlinkOracle_Proxy.json +50 -36
- package/deployments/bsctestnet/DefaultProxyAdmin.json +18 -18
- package/deployments/bsctestnet/PythOracle.json +52 -45
- package/deployments/bsctestnet/PythOracle_Implementation.json +53 -47
- package/deployments/bsctestnet/PythOracle_Proxy.json +41 -40
- package/deployments/bsctestnet/ResilientOracle.json +51 -42
- package/deployments/bsctestnet/ResilientOracle_Implementation.json +65 -68
- package/deployments/bsctestnet/ResilientOracle_Proxy.json +48 -34
- package/deployments/bsctestnet/TwapOracle.json +70 -83
- package/deployments/bsctestnet/TwapOracle_Implementation.json +84 -97
- package/deployments/bsctestnet/TwapOracle_Proxy.json +46 -46
- package/deployments/bsctestnet/solcInputs/131f58942628e21632de19506977a910.json +120 -0
- package/deployments/bsctestnet/solcInputs/144b49e8aec3add79553ba273ea32d00.json +72 -0
- package/deployments/bsctestnet/solcInputs/503f2e4e766f3be923fadf8030a5470f.json +78 -0
- package/deployments/bsctestnet/solcInputs/b39d33092f7dd383ae3a042566194132.json +75 -0
- package/dist/deploy/1-deploy-oracles.d.ts +5 -0
- package/dist/deploy/1-deploy-oracles.d.ts.map +1 -0
- package/{deploy → dist/deploy}/1-deploy-oracles.js +66 -24
- package/dist/deploy/1-deploy-oracles.js.map +1 -0
- package/dist/deploy/2-configure-feeds.d.ts +15 -0
- package/dist/deploy/2-configure-feeds.d.ts.map +1 -0
- package/{deploy → dist/deploy}/2-configure-feeds.js +139 -16
- package/dist/deploy/2-configure-feeds.js.map +1 -0
- package/dist/hardhat.config.d.ts +13 -0
- package/dist/hardhat.config.d.ts.map +1 -0
- package/dist/hardhat.config.js +158 -0
- package/dist/hardhat.config.js.map +1 -0
- package/package.json +26 -19
- package/artifacts/@openzeppelin/contracts/utils/math/SafeMath.sol/SafeMath.dbg.json +0 -4
- package/artifacts/@openzeppelin/contracts/utils/math/SafeMath.sol/SafeMath.json +0 -10
- package/artifacts/build-info/a47a69a8f108d3e7113faf89771988ff.json +0 -1
- package/artifacts/build-info/cc300b55b814df48229058e829c7c3c6.json +0 -1
- package/artifacts/build-info/de79b2637546f6f7d38c8f655549d9e2.json +0 -1
- package/artifacts/contracts/Governance/AccessControlManager.sol/AccessControlManager.dbg.json +0 -4
- package/artifacts/contracts/Governance/AccessControlManager.sol/AccessControlManager.json +0 -369
- package/artifacts/contracts/Governance/AccessControlled.sol/AccessControlled.dbg.json +0 -4
- package/artifacts/contracts/Governance/IAccessControlManager.sol/IAccessControlManager.dbg.json +0 -4
- package/artifacts/contracts/PriceOracle.sol/PriceOracle.dbg.json +0 -4
- package/artifacts/contracts/PriceOracle.sol/PriceOracle.json +0 -43
- package/contracts/Governance/AccessControlManager.sol +0 -99
- package/contracts/Governance/AccessControlled.sol +0 -75
- package/contracts/Governance/IAccessControlManager.sol +0 -22
- package/contracts/PriceOracle.sol +0 -16
- package/deploy/1-deploy-oracles.d.ts +0 -2
- package/deploy/1-deploy-oracles.d.ts.map +0 -1
- package/deploy/1-deploy-oracles.js.map +0 -1
- package/deploy/2-configure-feeds.d.ts +0 -2
- package/deploy/2-configure-feeds.d.ts.map +0 -1
- package/deploy/2-configure-feeds.js.map +0 -1
- package/deployments/bsctestnet/AccessControlManager.json +0 -563
- package/deployments/bsctestnet/solcInputs/30f2cb3e89e183b8669f05bddf9426d9.json +0 -183
package/LICENSE
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
Copyright 2022 Venus Protocol.
|
|
2
|
+
|
|
3
|
+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
|
4
|
+
|
|
5
|
+
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
|
6
|
+
|
|
7
|
+
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
|
8
|
+
|
|
9
|
+
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
|
10
|
+
|
|
11
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
package/README.md
ADDED
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
# Resilient Price Feeds
|
|
2
|
+
|
|
3
|
+
Resilient Price Feeds is a set of smart contracts that uses multiple oracles and a price validation algorithm to fetch asset prices for the [Venus Protocol](https://app.venus.io).
|
|
4
|
+
|
|
5
|
+
DeFi protocols are vulnerable to incorrectly reported prices which can lead to lost money. A price oracle can be manipulated,fail, or suffer other attacks depending on the type of price oracle. It creates a single point of failure, opening attack vectors to the protocol if not mitigated.
|
|
6
|
+
|
|
7
|
+
The Resilient Price Feeds uses multiple oracle sources and fallback mechanisms to return accurate prices and protect from oracle failures. Currently, it includes integrations with Chainlink, Pyth, Binance Oracle and TWAP (Time-Weighted Average Price) oracles. TWAP uses PancakeSwap as the on-chain price source.
|
|
8
|
+
|
|
9
|
+
## Details
|
|
10
|
+
|
|
11
|
+
The Resilient Price Feeds configures a main, pivot and fallback oracle for every asset. The main oracle is the most trustworthy price source, the pivot oracle is used as a loose sanity checker and the fallback oracle is used as a backup price source.
|
|
12
|
+
|
|
13
|
+

|
|
14
|
+
|
|
15
|
+
Oracle prices are validated using an **upper** and **lower** bound ratio, which is set for every market. The **upper bound ratio** represents the **deviation** between the **reported price** (price from oracle that’s being validated) and anchor price (price from oracle we are validating against) beyond which the reported price will be invalidated. The **lower bound ratio** presents the **deviation** between **reported price and anchor price** below which the reported price will be invalidated. For an oracle price to be considered valid the below statement should be true:
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
anchorRatio = anchorPrice/reporterPrice
|
|
19
|
+
isValid = anchorRatio <= upperBoundAnchorRatio && anchorRatio >= lowerBoundAnchorRatio
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
The default configuration uses Chainlink as the main oracle, TWAP or Pyth oracle as pivot oracle depending on which supports the given market and Binance oracle as the fallback oracle. For some markets we may use Pyth as the main oracle if the token price is not supported by Chainlink or Binance oracles.
|
|
23
|
+
|
|
24
|
+
When fetching an oracle price, for the price to be valid it must be positive and not stagnant. If the price is invalid or stagnant it is ignored and a fallback oracle is used.
|
|
25
|
+
|
|
26
|
+
# Development
|
|
27
|
+
|
|
28
|
+
## Prerequisites
|
|
29
|
+
|
|
30
|
+
- NodeJS - 14.x
|
|
31
|
+
|
|
32
|
+
- Solc - v0.8.13 (https://github.com/ethereum/solidity/releases/tag/v0.8.13)
|
|
33
|
+
|
|
34
|
+
## Installing
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
yarn install
|
|
39
|
+
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Linting and code formatting
|
|
43
|
+
|
|
44
|
+
Linting is done using eslint for typescript and solhint for solidity. Prettier is used to format solidity and typescript files.
|
|
45
|
+
|
|
46
|
+
To check linting and formatting on all files run:
|
|
47
|
+
|
|
48
|
+
```sh
|
|
49
|
+
$ yarn lint
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Linting command can be run with the fix flag to fix eligible errors automatically
|
|
53
|
+
|
|
54
|
+
```sh
|
|
55
|
+
$ yarn lint:sol --fix
|
|
56
|
+
$ yarn lint:ts --fix
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
To pretty all files run:
|
|
60
|
+
|
|
61
|
+
```sh
|
|
62
|
+
$ yarn prettier
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Run Tests
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
npx hardhat test
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
- To run fork tests add FORK_MAINNET=true PRIVATE_KEY and QUICK_NODE_KEY in the .env file.
|
|
74
|
+
|
|
75
|
+
## Releases and Versioning
|
|
76
|
+
|
|
77
|
+
Releases are automatically managed using semantic-release and commit messages.
|
|
78
|
+
|
|
79
|
+
## Deployment
|
|
80
|
+
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
npx hardhat deploy
|
|
84
|
+
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
- This command will execute all the deployment scripts in `./deploy` directory
|
|
88
|
+
- The default network will be `hardhat`
|
|
89
|
+
- Deployment to another network: - Make sure the desired network is configured in `hardhat.config.ts` - Add `PRIVATE_KEY` variable in `.env` file - Execute deploy command by adding `--network <network_name>` in the deploy command above - E.g. `npx hardhat deploy --network bsctestnet`
|
|
90
|
+
- Execution of single or custom set of scripts is possible, if:
|
|
91
|
+
- In the deployment scripts you have added `tags` for example: - `func.tags = ["MockTokens"];`
|
|
92
|
+
- Once this is done, adding `--tags "<tag_name>,<tag_name>..."` to the deployment command will execute only the scripts containing the tags.
|
|
93
|
+
|
|
94
|
+
## Verify Contracts
|
|
95
|
+
|
|
96
|
+
```
|
|
97
|
+
npx hardhat etherscan-verify --network <network-name>
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Hardhat Commands
|
|
101
|
+
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
npx hardhat accounts
|
|
105
|
+
|
|
106
|
+
npx hardhat compile
|
|
107
|
+
|
|
108
|
+
npx hardhat clean
|
|
109
|
+
|
|
110
|
+
npx hardhat test
|
|
111
|
+
|
|
112
|
+
npx hardhat node
|
|
113
|
+
|
|
114
|
+
npx hardhat help
|
|
115
|
+
|
|
116
|
+
REPORT_GAS=true npx hardhat test
|
|
117
|
+
|
|
118
|
+
npx hardhat coverage
|
|
119
|
+
|
|
120
|
+
TS_NODE_FILES=true npx ts-node scripts/deploy.ts
|
|
121
|
+
|
|
122
|
+
npx eslint '**/*.{js,ts}'
|
|
123
|
+
|
|
124
|
+
npx eslint '**/*.{js,ts}' --fix
|
|
125
|
+
|
|
126
|
+
npx prettier '**/*.{json,sol,md}' --check
|
|
127
|
+
|
|
128
|
+
npx prettier '**/*.{json,sol,md}' --write
|
|
129
|
+
|
|
130
|
+
npx solhint 'contracts/**/*.sol'
|
|
131
|
+
|
|
132
|
+
npx solhint 'contracts/**/*.sol' --fix
|
|
133
|
+
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
## Documentation
|
|
137
|
+
|
|
138
|
+
Documentation is autogenerated using [solidity-docgen](https://github.com/OpenZeppelin/solidity-docgen).
|
|
139
|
+
|
|
140
|
+
They can be generated by running `yarn docgen`
|
|
@@ -290,8 +290,8 @@
|
|
|
290
290
|
"type": "function"
|
|
291
291
|
}
|
|
292
292
|
],
|
|
293
|
-
"bytecode": "
|
|
294
|
-
"deployedBytecode": "
|
|
293
|
+
"bytecode": "0x60806040523480156200001157600080fd5b5060405162000cd638038062000cd683398101604081905262000034916200024b565b81516200004990600390602085019062000068565b5080516200005f90600490602084019062000068565b5050506200030b565b8280546200007690620002db565b90600052602060002090601f0160209004810192826200009a5760008555620000e5565b82601f10620000b557805160ff1916838001178555620000e5565b82800160010185558215620000e5579182015b82811115620000e5578251825591602001919060010190620000c8565b50620000f3929150620000f7565b5090565b5b80821115620000f35760008155600101620000f8565b634e487b7160e01b600052604160045260246000fd5b601f19601f83011681018181106001600160401b03821117156200014c576200014c6200010e565b6040525050565b60006200015f60405190565b90506200016d828262000124565b919050565b60006001600160401b038211156200018e576200018e6200010e565b601f19601f83011660200192915050565b60005b83811015620001bc578181015183820152602001620001a2565b83811115620001cc576000848401525b50505050565b6000620001e9620001e38462000172565b62000153565b905082815260208101848484011115620002065762000206600080fd5b620002138482856200019f565b509392505050565b600082601f830112620002315762000231600080fd5b815162000243848260208601620001d2565b949350505050565b60008060408385031215620002635762000263600080fd5b82516001600160401b038111156200027e576200027e600080fd5b6200028c858286016200021b565b92505060208301516001600160401b03811115620002ad57620002ad600080fd5b620002bb858286016200021b565b9150509250929050565b634e487b7160e01b600052602260045260246000fd5b600281046001821680620002f057607f821691505b602082108103620003055762000305620002c5565b50919050565b6109bb806200031b6000396000f3fe608060405234801561001057600080fd5b50600436106100a95760003560e01c80633950935111610071578063395093511461011f57806370a082311461013257806395d89b411461015b578063a457c2d714610163578063a9059cbb14610176578063dd62ed3e1461018957600080fd5b806306fdde03146100ae578063095ea7b3146100cc57806318160ddd146100ec57806323b872dd146100fd578063313ce56714610110575b600080fd5b6100b661019c565b6040516100c39190610568565b60405180910390f35b6100df6100da3660046105c4565b61022e565b6040516100c3919061060b565b6002545b6040516100c3919061061f565b6100df61010b36600461062d565b610248565b60126040516100c39190610686565b6100df61012d3660046105c4565b61026c565b6100f0610140366004610694565b6001600160a01b031660009081526020819052604090205490565b6100b661028e565b6100df6101713660046105c4565b61029d565b6100df6101843660046105c4565b6102e3565b6100f06101973660046106bd565b6102f1565b6060600380546101ab90610706565b80601f01602080910402602001604051908101604052809291908181526020018280546101d790610706565b80156102245780601f106101f957610100808354040283529160200191610224565b820191906000526020600020905b81548152906001019060200180831161020757829003601f168201915b5050505050905090565b60003361023c81858561031c565b60019150505b92915050565b6000336102568582856103d0565b61026185858561041a565b506001949350505050565b60003361023c81858561027f83836102f1565b6102899190610748565b61031c565b6060600480546101ab90610706565b600033816102ab82866102f1565b9050838110156102d65760405162461bcd60e51b81526004016102cd906107a5565b60405180910390fd5b610261828686840361031c565b60003361023c81858561041a565b6001600160a01b03918216600090815260016020908152604080832093909416825291909152205490565b6001600160a01b0383166103425760405162461bcd60e51b81526004016102cd906107f6565b6001600160a01b0382166103685760405162461bcd60e51b81526004016102cd90610845565b6001600160a01b0380841660008181526001602090815260408083209487168084529490915290819020849055517f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925906103c390859061061f565b60405180910390a3505050565b60006103dc84846102f1565b9050600019811461041457818110156104075760405162461bcd60e51b81526004016102cd90610855565b610414848484840361031c565b50505050565b6001600160a01b0383166104405760405162461bcd60e51b81526004016102cd906108d2565b6001600160a01b0382166104665760405162461bcd60e51b81526004016102cd90610922565b6001600160a01b0383166000908152602081905260409020548181101561049f5760405162461bcd60e51b81526004016102cd90610975565b6001600160a01b0380851660008181526020819052604080822086860390559286168082529083902080548601905591517fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef906104fd90869061061f565b60405180910390a3610414565b60005b8381101561052557818101518382015260200161050d565b838111156104145750506000910152565b6000610540825190565b80845260208401935061055781856020860161050a565b601f01601f19169290920192915050565b602080825281016105798184610536565b9392505050565b60006001600160a01b038216610242565b61059a81610580565b81146105a557600080fd5b50565b803561024281610591565b8061059a565b8035610242816105b3565b600080604083850312156105da576105da600080fd5b60006105e685856105a8565b92505060206105f7858286016105b9565b9150509250929050565b8015155b82525050565b602081016102428284610601565b80610605565b602081016102428284610619565b60008060006060848603121561064557610645600080fd5b600061065186866105a8565b9350506020610662868287016105a8565b9250506040610673868287016105b9565b9150509250925092565b60ff8116610605565b60208101610242828461067d565b6000602082840312156106a9576106a9600080fd5b60006106b584846105a8565b949350505050565b600080604083850312156106d3576106d3600080fd5b60006106df85856105a8565b92505060206105f7858286016105a8565b634e487b7160e01b600052602260045260246000fd5b60028104600182168061071a57607f821691505b60208210810361072c5761072c6106f0565b50919050565b634e487b7160e01b600052601160045260246000fd5b6000821982111561075b5761075b610732565b500190565b602581526000602082017f45524332303a2064656372656173656420616c6c6f77616e63652062656c6f77815264207a65726f60d81b602082015291505b5060400190565b6020808252810161024281610760565b602481526000602082017f45524332303a20617070726f76652066726f6d20746865207a65726f206164648152637265737360e01b6020820152915061079e565b60208082528101610242816107b5565b602281526000602082017f45524332303a20617070726f766520746f20746865207a65726f206164647265815261737360f01b6020820152915061079e565b6020808252810161024281610806565b6020808252810161024281601d81527f45524332303a20696e73756666696369656e7420616c6c6f77616e6365000000602082015260400190565b602581526000602082017f45524332303a207472616e736665722066726f6d20746865207a65726f206164815264647265737360d81b6020820152915061079e565b6020808252810161024281610890565b602381526000602082017f45524332303a207472616e7366657220746f20746865207a65726f206164647281526265737360e81b6020820152915061079e565b60208082528101610242816108e2565b602681526000602082017f45524332303a207472616e7366657220616d6f756e7420657863656564732062815265616c616e636560d01b6020820152915061079e565b602080825281016102428161093256fea2646970667358221220aa276a1ccac71e87b052d79b665c4e0b6ae0e1700c89aeb45c3f618e322d19a164736f6c634300080d0033",
|
|
294
|
+
"deployedBytecode": "0x608060405234801561001057600080fd5b50600436106100a95760003560e01c80633950935111610071578063395093511461011f57806370a082311461013257806395d89b411461015b578063a457c2d714610163578063a9059cbb14610176578063dd62ed3e1461018957600080fd5b806306fdde03146100ae578063095ea7b3146100cc57806318160ddd146100ec57806323b872dd146100fd578063313ce56714610110575b600080fd5b6100b661019c565b6040516100c39190610568565b60405180910390f35b6100df6100da3660046105c4565b61022e565b6040516100c3919061060b565b6002545b6040516100c3919061061f565b6100df61010b36600461062d565b610248565b60126040516100c39190610686565b6100df61012d3660046105c4565b61026c565b6100f0610140366004610694565b6001600160a01b031660009081526020819052604090205490565b6100b661028e565b6100df6101713660046105c4565b61029d565b6100df6101843660046105c4565b6102e3565b6100f06101973660046106bd565b6102f1565b6060600380546101ab90610706565b80601f01602080910402602001604051908101604052809291908181526020018280546101d790610706565b80156102245780601f106101f957610100808354040283529160200191610224565b820191906000526020600020905b81548152906001019060200180831161020757829003601f168201915b5050505050905090565b60003361023c81858561031c565b60019150505b92915050565b6000336102568582856103d0565b61026185858561041a565b506001949350505050565b60003361023c81858561027f83836102f1565b6102899190610748565b61031c565b6060600480546101ab90610706565b600033816102ab82866102f1565b9050838110156102d65760405162461bcd60e51b81526004016102cd906107a5565b60405180910390fd5b610261828686840361031c565b60003361023c81858561041a565b6001600160a01b03918216600090815260016020908152604080832093909416825291909152205490565b6001600160a01b0383166103425760405162461bcd60e51b81526004016102cd906107f6565b6001600160a01b0382166103685760405162461bcd60e51b81526004016102cd90610845565b6001600160a01b0380841660008181526001602090815260408083209487168084529490915290819020849055517f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925906103c390859061061f565b60405180910390a3505050565b60006103dc84846102f1565b9050600019811461041457818110156104075760405162461bcd60e51b81526004016102cd90610855565b610414848484840361031c565b50505050565b6001600160a01b0383166104405760405162461bcd60e51b81526004016102cd906108d2565b6001600160a01b0382166104665760405162461bcd60e51b81526004016102cd90610922565b6001600160a01b0383166000908152602081905260409020548181101561049f5760405162461bcd60e51b81526004016102cd90610975565b6001600160a01b0380851660008181526020819052604080822086860390559286168082529083902080548601905591517fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef906104fd90869061061f565b60405180910390a3610414565b60005b8381101561052557818101518382015260200161050d565b838111156104145750506000910152565b6000610540825190565b80845260208401935061055781856020860161050a565b601f01601f19169290920192915050565b602080825281016105798184610536565b9392505050565b60006001600160a01b038216610242565b61059a81610580565b81146105a557600080fd5b50565b803561024281610591565b8061059a565b8035610242816105b3565b600080604083850312156105da576105da600080fd5b60006105e685856105a8565b92505060206105f7858286016105b9565b9150509250929050565b8015155b82525050565b602081016102428284610601565b80610605565b602081016102428284610619565b60008060006060848603121561064557610645600080fd5b600061065186866105a8565b9350506020610662868287016105a8565b9250506040610673868287016105b9565b9150509250925092565b60ff8116610605565b60208101610242828461067d565b6000602082840312156106a9576106a9600080fd5b60006106b584846105a8565b949350505050565b600080604083850312156106d3576106d3600080fd5b60006106df85856105a8565b92505060206105f7858286016105a8565b634e487b7160e01b600052602260045260246000fd5b60028104600182168061071a57607f821691505b60208210810361072c5761072c6106f0565b50919050565b634e487b7160e01b600052601160045260246000fd5b6000821982111561075b5761075b610732565b500190565b602581526000602082017f45524332303a2064656372656173656420616c6c6f77616e63652062656c6f77815264207a65726f60d81b602082015291505b5060400190565b6020808252810161024281610760565b602481526000602082017f45524332303a20617070726f76652066726f6d20746865207a65726f206164648152637265737360e01b6020820152915061079e565b60208082528101610242816107b5565b602281526000602082017f45524332303a20617070726f766520746f20746865207a65726f206164647265815261737360f01b6020820152915061079e565b6020808252810161024281610806565b6020808252810161024281601d81527f45524332303a20696e73756666696369656e7420616c6c6f77616e6365000000602082015260400190565b602581526000602082017f45524332303a207472616e736665722066726f6d20746865207a65726f206164815264647265737360d81b6020820152915061079e565b6020808252810161024281610890565b602381526000602082017f45524332303a207472616e7366657220746f20746865207a65726f206164647281526265737360e81b6020820152915061079e565b60208082528101610242816108e2565b602681526000602082017f45524332303a207472616e7366657220616d6f756e7420657863656564732062815265616c616e636560d01b6020820152915061079e565b602080825281016102428161093256fea2646970667358221220aa276a1ccac71e87b052d79b665c4e0b6ae0e1700c89aeb45c3f618e322d19a164736f6c634300080d0033",
|
|
295
295
|
"linkReferences": {},
|
|
296
296
|
"deployedLinkReferences": {}
|
|
297
297
|
}
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
"contractName": "Strings",
|
|
4
4
|
"sourceName": "@openzeppelin/contracts/utils/Strings.sol",
|
|
5
5
|
"abi": [],
|
|
6
|
-
"bytecode": "
|
|
7
|
-
"deployedBytecode": "
|
|
6
|
+
"bytecode": "0x60566037600b82828239805160001a607314602a57634e487b7160e01b600052600060045260246000fd5b30600052607381538281f3fe73000000000000000000000000000000000000000030146080604052600080fdfea26469706673582212206476b648ce1dca05883d3e4d1edb2dc2c34bcd738b33e4cf2c40c109ee583bf764736f6c634300080d0033",
|
|
7
|
+
"deployedBytecode": "0x73000000000000000000000000000000000000000030146080604052600080fdfea26469706673582212206476b648ce1dca05883d3e4d1edb2dc2c34bcd738b33e4cf2c40c109ee583bf764736f6c634300080d0033",
|
|
8
8
|
"linkReferences": {},
|
|
9
9
|
"deployedLinkReferences": {}
|
|
10
10
|
}
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
"contractName": "Math",
|
|
4
4
|
"sourceName": "@openzeppelin/contracts/utils/math/Math.sol",
|
|
5
5
|
"abi": [],
|
|
6
|
-
"bytecode": "
|
|
7
|
-
"deployedBytecode": "
|
|
6
|
+
"bytecode": "0x60566037600b82828239805160001a607314602a57634e487b7160e01b600052600060045260246000fd5b30600052607381538281f3fe73000000000000000000000000000000000000000030146080604052600080fdfea2646970667358221220a4f8a91985d01b96049b1a25940bdf0f058223ba5029ea943be10d329823684b64736f6c634300080d0033",
|
|
7
|
+
"deployedBytecode": "0x73000000000000000000000000000000000000000030146080604052600080fdfea2646970667358221220a4f8a91985d01b96049b1a25940bdf0f058223ba5029ea943be10d329823684b64736f6c634300080d0033",
|
|
8
8
|
"linkReferences": {},
|
|
9
9
|
"deployedLinkReferences": {}
|
|
10
10
|
}
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
"contractName": "SafeCast",
|
|
4
4
|
"sourceName": "@openzeppelin/contracts/utils/math/SafeCast.sol",
|
|
5
5
|
"abi": [],
|
|
6
|
-
"bytecode": "
|
|
7
|
-
"deployedBytecode": "
|
|
6
|
+
"bytecode": "0x60566037600b82828239805160001a607314602a57634e487b7160e01b600052600060045260246000fd5b30600052607381538281f3fe73000000000000000000000000000000000000000030146080604052600080fdfea264697066735822122020254a42b3fddcd4f33a5b60fd1d712d8757fb6d6b32fa1370cd6f0af25761a764736f6c634300080d0033",
|
|
7
|
+
"deployedBytecode": "0x73000000000000000000000000000000000000000030146080604052600080fdfea264697066735822122020254a42b3fddcd4f33a5b60fd1d712d8757fb6d6b32fa1370cd6f0af25761a764736f6c634300080d0033",
|
|
8
8
|
"linkReferences": {},
|
|
9
9
|
"deployedLinkReferences": {}
|
|
10
10
|
}
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
"contractName": "SignedMath",
|
|
4
4
|
"sourceName": "@openzeppelin/contracts/utils/math/SignedMath.sol",
|
|
5
5
|
"abi": [],
|
|
6
|
-
"bytecode": "
|
|
7
|
-
"deployedBytecode": "
|
|
6
|
+
"bytecode": "0x60566037600b82828239805160001a607314602a57634e487b7160e01b600052600060045260246000fd5b30600052607381538281f3fe73000000000000000000000000000000000000000030146080604052600080fdfea264697066735822122058b12c37abec34016e580b5e683765b232587443394efc8d0847382edfd3b80f64736f6c634300080d0033",
|
|
7
|
+
"deployedBytecode": "0x73000000000000000000000000000000000000000030146080604052600080fdfea264697066735822122058b12c37abec34016e580b5e683765b232587443394efc8d0847382edfd3b80f64736f6c634300080d0033",
|
|
8
8
|
"linkReferences": {},
|
|
9
9
|
"deployedLinkReferences": {}
|
|
10
10
|
}
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
"contractName": "AddressUpgradeable",
|
|
4
4
|
"sourceName": "@openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol",
|
|
5
5
|
"abi": [],
|
|
6
|
-
"bytecode": "
|
|
7
|
-
"deployedBytecode": "
|
|
6
|
+
"bytecode": "0x60566037600b82828239805160001a607314602a57634e487b7160e01b600052600060045260246000fd5b30600052607381538281f3fe73000000000000000000000000000000000000000030146080604052600080fdfea264697066735822122074bb6b9464f24caf26cf60a0f15993d6991f5d1ef91ec769ef567c12e0e4762c64736f6c634300080d0033",
|
|
7
|
+
"deployedBytecode": "0x73000000000000000000000000000000000000000030146080604052600080fdfea264697066735822122074bb6b9464f24caf26cf60a0f15993d6991f5d1ef91ec769ef567c12e0e4762c64736f6c634300080d0033",
|
|
8
8
|
"linkReferences": {},
|
|
9
9
|
"deployedLinkReferences": {}
|
|
10
10
|
}
|