Feat/0.8.1: PoC Decentralized Bridge #2

.env_example

@@ -1 +1,6 @@
+ARBISCAN_API_KEY=
+ELASTOS_API_KEY=
+ETHERSCAN_API_KEY=
+MOONSCAN_API_KEY=
+POLYGONSCAN_API_KEY=
 WITNET_EVM_REALM=default

.gitignore

@@ -13,3 +13,4 @@ yarn-error.log
 package-lock.json
 
 *.tmp
+.old

README.md

@@ -267,9 +267,9 @@ Please, have a look at the [`witnet/truffle-box`](https://github.com/witnet/truf
 ·······································|···························|·············|·············|·············|··············|··············
 |  WitnetProxy                         ·  upgradeTo                ·          -  ·          -  ·     129653  ·           1  ·          -  │
 ·······································|···························|·············|·············|·············|··············|··············
-|  WitnetRandomness                    ·  clone                    ·          -  ·          -  ·     247765  ·           7  ·          -  │
+|  WitnetRandomnessProxiable                    ·  clone                    ·          -  ·          -  ·     247765  ·           7  ·          -  │
 ·······································|···························|·············|·············|·············|··············|··············
-|  WitnetRandomness                    ·  upgradeRandomizeFee      ·          -  ·          -  ·      28446  ·           1  ·          -  │
+|  WitnetRandomnessProxiable                    ·  upgradeRandomizeFee      ·          -  ·          -  ·      28446  ·           1  ·          -  │
 ·······································|···························|·············|·············|·············|··············|··············
 |  WitnetRequestBoardTrustableBoba     ·  deleteQuery              ·          -  ·          -  ·      59706  ·           3  ·          -  │
 ·······································|···························|·············|·············|·············|··············|··············

contracts/UsingWitnetV2.sol

@@ -0,0 +1,95 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity >=0.7.0 <0.9.0;
+pragma experimental ABIEncoderV2;
+
+import "./WitnetRequestBoardV2.sol";
+
+/// @title The UsingWitnetV2 contract
+/// @dev Witnet-aware contracts can inherit from this contract in order to interact with Witnet.
+/// @author The Witnet Foundation.
+abstract contract UsingWitnetV2 {
+
+    /// @dev Immutable address to the WitnetRequestBoardV2 contract.
+    WitnetRequestBoardV2 public immutable witnet;
+
+    /// @dev Include an address to specify the WitnetRequestBoard entry point address.
+    /// @param _wrb The WitnetRequestBoard entry point address.
+    constructor(WitnetRequestBoardV2 _wrb)
+    {
+        require(
+            _wrb.class() == type(WitnetRequestBoardV2).interfaceId,
+            "UsingWitnetV2: uncompliant request board"
+        );
+        witnet = _wrb;
+    }
+
+    /// @dev Provides a convenient way for client contracts extending this to block the execution of the main logic of the
+    /// @dev contract until a particular data query has been successfully solved and reported by Witnet,
+    /// @dev either with an error or successfully.
+    modifier witnetQueryInStatus(bytes32 _queryHash, WitnetV2.QueryStatus _queryStatus) {
+        require(
+            witnet.checkQueryStatus(_queryHash) == _queryStatus, 
+            "UsingWitnetV2: unexpected query status");
+        _;
+    }
+
+    /// @notice Returns EVM gas price within the context of current transaction.
+    function _getTxGasPrice() virtual internal view returns (uint256) {
+        return tx.gasprice;
+    }
+
+    /// @notice Estimate the minimum reward in EVM/wei required for posting the described Witnet data request.
+    /// @param _radHash The hash of the query's data request part (previously registered in `witnet.registry()`).
+    /// @param _slaParams The query's SLA parameters.
+    /// @param _witEvmPrice The price of 1 nanoWit in EVM/wei to be used when estimating query rewards.
+    /// @param _maxEvmGasPrice The maximum EVM gas price willing to pay upon result reporting.
+    function _witnetEstimateQueryReward(
+            bytes32 _radHash,
+            WitnetV2.RadonSLAv2 memory _slaParams,
+            uint256 _witEvmPrice,
+            uint256 _maxEvmGasPrice
+        )
+        internal view
+        returns (uint256)
+    {
+        return witnet.estimateQueryReward(_radHash, _slaParams, _witEvmPrice, _maxEvmGasPrice, 0);
+    }
+
+    /// @notice Post some data request to be eventually solved by the Witnet decentralized oracle network.
+    /// @dev Enough EVM coins need to be provided as to cover for the implicit cost and bridge rewarding.
+    /// @param _radHash The hash of the query's data request part (previously registered in `witnet.registry()`).
+    /// @param _slaParams The query's SLA parameters.
+    /// @param _witEvmPrice The price of 1 nanoWit in EVM/wei to be used when estimating query rewards.
+    /// @param _maxEvmGasPrice The maximum EVM gas price willing to pay upon result reporting.
+    /// @return _queryHash The unique identifier of the new data query.
+    /// @return _queryReward The actual amount escrowed into the WRB as query reward.
+    function _witnetPostQuery(
+            bytes32 _radHash, 
+            WitnetV2.RadonSLAv2 memory _slaParams,
+            uint256 _witEvmPrice,
+            uint256 _maxEvmGasPrice
+        )
+        virtual internal
+        returns (bytes32 _queryHash, uint256 _queryReward)
+    {
+        _queryReward = _witnetEstimateQueryReward(_radHash, _slaParams, _witEvmPrice, _maxEvmGasPrice);
+        require(_queryReward <= msg.value, "UsingWitnetV2: EVM reward too low");
+        _queryHash = witnet.postQuery{value: _queryReward}(_radHash, _slaParams);
+    }
+
+    /// @notice Post some data request to be eventually solved by the Witnet decentralized oracle network.
+    /// @dev Enough EVM coins need to be provided as to cover for the implicit cost and bridge rewarding.
+    /// @dev Implicitly sets `tx.gasprice` as the maximum EVM gas price expected to be paid upon result reporting.
+    /// @param _radHash The hash of the query's data request part (previously registered in `witnet.registry()`).
+    /// @param _slaParams The query's SLA parameters.
+    /// @param _witEvmPrice The price of 1 nanoWit in EVM/wei to be used when estimating query rewards.
+    /// @return _queryHash The unique identifier of the new data query.
+    /// @return _queryReward The actual amount escrowed into the WRB as query reward.
+    function _witnetPostQuery(bytes32 _radHash, WitnetV2.RadonSLAv2 memory _slaParams, uint256 _witEvmPrice)
+        virtual internal
+        returns (bytes32 _queryHash, uint256 _queryReward)
+    {
+        return _witnetPostQuery(_radHash, _slaParams, _witEvmPrice, _getTxGasPrice());
+    }
+}

contracts/WitnetBlocks.sol

@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity >=0.7.0 <0.9.0;
+pragma experimental ABIEncoderV2;
+
+import "./interfaces/V2/IWitnetBlocks.sol";
+
+abstract contract WitnetBlocks
+    is
+        IWitnetBlocks
+{}

contracts/WitnetPriceFeeds.sol

@@ -4,12 +4,14 @@ pragma solidity >=0.8.0 <0.9.0;
 
 import "ado-contracts/contracts/interfaces/IERC2362.sol";
 import "./interfaces/V2/IWitnetPriceFeeds.sol";
+import "./interfaces/V2/IWitnetPriceSolverDeployer.sol";
 import "./WitnetFeeds.sol";
 
 abstract contract WitnetPriceFeeds
     is
         IERC2362,
         IWitnetPriceFeeds,
+        IWitnetPriceSolverDeployer,
         WitnetFeeds
 {   
     constructor(WitnetRequestBoard _wrb)

contracts/WitnetRequestBoardV2.sol

@@ -0,0 +1,36 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity >=0.7.0 <0.9.0;
+pragma experimental ABIEncoderV2;
+
+import "./WitnetBlocks.sol";
+import "./WitnetBytecodes.sol";
+import "./WitnetRequestFactory.sol";
+
+/// @title Witnet Request Board V2 functionality base contract.
+/// @author The Witnet Foundation.
+abstract contract WitnetRequestBoardV2
+    is
+        IWitnetRequestBoardV2
+{
+    WitnetBlocks immutable public blocks;
+    WitnetRequestFactory immutable public factory;
+    WitnetBytecodes immutable public registry;
+    constructor (
+            WitnetBlocks _blocks,
+            WitnetRequestFactory _factory
+        )
+    {
+        require(
+            _blocks.class() == type(WitnetBlocks).interfaceId,
+            "WitnetRequestBoardV2: uncompliant blocks"
+        );
+        require(
+            _factory.class() == type(WitnetRequestFactory).interfaceId,
+            "WitnetRequestBoardV2: uncompliant factory"
+        );
+        blocks = _blocks;
+        factory = _factory;
+        registry = _factory.registry();
+    }
+}

contracts/data/WitnetBlocksData.sol

@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity >=0.8.0 <0.9.0;
+
+import "../libs/WitnetV2.sol";
+
+/// @title WitnetBlocks data model.
+/// @author The Witnet Foundation.
+abstract contract WitnetBlocksData {
+
+    bytes32 private constant _WITNET_BLOCKS_DATA_SLOTHASH =
+        /* keccak256("io.witnet.blocks.data") */
+        0x28b1d7e478138a94698f82768889fd6edf6b777bb6815c200552870d3e78ffb5;
+
+    struct Storage {
+        uint256 lastBeaconIndex;
+        uint256 nextBeaconIndex;
+        uint256 latestBeaconIndex;
+        mapping (/* beacon index */ uint256 => WitnetV2.Beacon) beacons;
+        mapping (/* beacon index */ uint256 => uint256) beaconSuccessorOf;
+        mapping (/* beacon index */ uint256 => BeaconTracks) beaconTracks;
+    }
+
+    struct BeaconTracks {
+        mapping (bytes32 => bool) disputed;
+        bytes32[] queries;
+        uint256 offset;
+    }
+
+    // ================================================================================================
+    // --- Internal functions -------------------------------------------------------------------------
+
+    /// @notice Returns storage pointer to where Storage data is located. 
+    function __blocks()
+      internal pure
+      returns (Storage storage _ptr)
+    {
+        assembly {
+            _ptr.slot := _WITNET_BLOCKS_DATA_SLOTHASH
+        }
+    }
+
+    function __tracks_(uint256 beaconIndex) internal view returns (BeaconTracks storage) {
+        return __blocks().beaconTracks[beaconIndex];
+    }
+
+}

contracts/data/WitnetRequestBoardV2Data.sol

@@ -0,0 +1,63 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity >=0.7.0 <0.9.0;
+
+import "../libs/WitnetV2.sol";
+import "../interfaces/V2/IWitnetBlocks.sol";
+
+/// @title Witnet Request Board base data model. 
+/// @author The Witnet Foundation.
+abstract contract WitnetRequestBoardV2Data {  
+
+    bytes32 internal constant _WITNET_BOARD_DATA_SLOTHASH =
+      /* keccak256("io.witnet.boards.data.v2") */
+      0xfeed002ff8a708dcba69bac2a8e829fd61fee551b9e9fc0317707d989cb0fe53;
+
+    struct Storage {
+      mapping (address => Escrow) escrows;
+      mapping (/* queryHash */ bytes32 => WitnetV2.Query) queries;
+      mapping (/* tallyHash */ bytes32 => Suitor) suitors;
+    }
+
+    struct Suitor {
+      uint256 index;
+      bytes32 queryHash;
+    }
+
+    struct Escrow {
+      uint256 atStake;
+      uint256 balance;
+    }
+
+    /// Asserts the given query was previously posted but not yet deleted.
+    modifier queryExists(bytes32 queryHash) {
+      require(__query_(queryHash).from != address(0), "WitnetRequestBoardV2Data: empty query");
+      _;
+    }
+
+
+    // ================================================================================================================
+    // --- Internal functions -----------------------------------------------------------------------------------------
+
+    /// Gets query storage by query id.
+    function __query_(bytes32 queryHash) internal view returns (WitnetV2.Query storage) {
+      return __storage().queries[queryHash];
+    }
+
+    /// Gets the Witnet.Request part of a given query.
+    function __request_(bytes32 queryHash) internal view returns (WitnetV2.QueryRequest storage) {
+        return __query_(queryHash).request;
+    }   
+
+    /// Gets the Witnet.Result part of a given query.
+    function __report_(bytes32 queryHash) internal view returns (WitnetV2.QueryReport storage) {
+        return __query_(queryHash).report;
+    }
+
+    /// Returns storage pointer to contents of 'WitnetBoardState' struct.
+    function __storage() internal pure returns (Storage storage _ptr) {
+        assembly {
+            _ptr.slot := _WITNET_BOARD_DATA_SLOTHASH
+        }
+    }
+}

contracts/impls/WitnetUpgradableBase.sol

@@ -43,6 +43,8 @@ abstract contract WitnetUpgradableBase
         revert("WitnetUpgradableBase: not implemented");
     }
 
+    function class() virtual external view returns (bytes4);
+
 
     // ================================================================================================================
     // --- Overrides IERC165 interface --------------------------------------------------------------------------------