Feat/witnet randomness v2

README.md

@@ -1,12 +1,12 @@
 # witnet-solidity-bridge
 
-Open repository containing the smart contracts composing the **Witnet Solidity Bridge** framework. This framework enables Solidity developers and smart contracts operating in a long range of EVM-compatible chains to interact with the [Witnet Oracle Blockchain](https://witnet.io) for retrieving and aggregating offchain public data, and randomness.
+Solidity source code of the smart contracts composing the **Witnet EVM Bridge** framework. This framework enables smart contracts operating in a long range of EVM-compatible chains to interact with the [Witnet Oracle Blockchain](https://witnet.io) for retrieving and aggregating offchain public data, or as an entropy source for randomness generation.
 
 ## Install the package
 
 `$ pnpm install`
 
-## Deploy the whole WSB framework on a new chain
+## Deploying the Witnet EVM Bridge on a new chain
 
 ### Pre-assessment
 
@@ -29,7 +29,7 @@ Should any artifact require customized contract implementations:
 
 `$ pnpm run migrate <ecosytem>:<chain-name>`
 
-## Upgrade WSB components on an existing chain
+## Upgrding the Witnet EVM Bridge on an existing chain
 
 When modifying the existing source code, or the contents of `settings/artifacts` or `settings/specs`, you may need to upgrade some of the artifacts on certain networks. Just add the `--artifacts` parameter and a comma-separated list of the artifacts you need to upgrade. For instance:
 
@@ -44,8 +44,43 @@ Reasons for an upgrade to fail:
 - You're attempting to upgrade a contract with the same implementation logic as it currently has. 
 - The parameters passed to the upgrade call, as specified in `settings/specs` are not accepted for some reason (see actual revert message for further info).
 
-## Exported assets
-
-- [Deployed addresses.]("./migrations/addresses.json")
-- [Supported chains.]("./settings/networks/index.js")
+## Package exported modules
+
+### `require("witnet-solidity-bridge")`
+Javacript methods and resources:
+
+- List of supported EVM ecosystems:
+    - `supportedEcosystems()`
+- List of supported EVM chains:
+    - `supportedNetworks()`
+- WEB addresses at a given chain:
+    - `getAddresses(network)`
+- WEB artifacts:
+    - `assets.WitnetOracle`
+    - `assets.WitnetPriceFeeds`
+    - `assets.WitnetPriceRouteSolver`
+    - `assets.WitnetRequest`
+    - `assets.WitnetRequestBytecodes`
+    - `assets.WitnetRequestFactory`
+    - `assets.WitnetRequestTemplate`
+    - `assets.WitnetUpgrableBase`
+
+### `require("witnet-solidity-bridge/utils")`
+
+Javascript utils methods:
+
+- `fromAscii(str)`
+- `getRealmNetworkFromArgs()`
+- `getRealmNetworkFromString()`
+- `getWitnetArtifactsFromArgs()`
+- `getWitnetRequestMethodString(method)`
+- `isDryRun(network)`
+- `isNullAddress(addr)`
+- `padLeft(str, char, size)`
+- `prompt(text)`
+- `readJsonFromFile(filename)`
+- `overwriteJsonFile(filname, extra)`
+- `traceHeader(header)`
+- `traceTx(tx)`
+- `traceVerify(network, verifyArgs)`
 

contracts/apps/WitnetFeeds.sol → contracts/WitnetFeeds.sol

@@ -2,9 +2,9 @@
 
 pragma solidity >=0.7.0 <0.9.0;
 
-import "../interfaces/IFeeds.sol";
-import "../interfaces/IWitnetFeeds.sol";
-import "../interfaces/IWitnetFeedsAdmin.sol";
+import "./interfaces/IFeeds.sol";
+import "./interfaces/IWitnetFeeds.sol";
+import "./interfaces/IWitnetFeedsAdmin.sol";
 
 import "ado-contracts/contracts/interfaces/IERC2362.sol";
 

contracts/WitnetPriceFeeds.sol

@@ -2,7 +2,7 @@
 
 pragma solidity >=0.7.0 <0.9.0;
 
-import "./apps/WitnetFeeds.sol";
+import "./WitnetFeeds.sol";
 
 import "./interfaces/IWitnetPriceFeeds.sol";
 import "./interfaces/IWitnetPriceSolverDeployer.sol";

contracts/WitnetRandomness.sol

@@ -0,0 +1,15 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity >=0.8.0 <0.9.0;
+
+import "./interfaces/IWitnetOracleEvents.sol";
+import "./interfaces/IWitnetRandomness.sol";
+
+abstract contract WitnetRandomness
+    is
+        IWitnetOracleEvents,
+        IWitnetRandomness
+{
+    function class() virtual external view returns (string memory);
+    function specs() virtual external view returns (bytes4);
+}

contracts/apps/UsingWitnet.sol

@@ -23,7 +23,7 @@ abstract contract UsingWitnet
     /// @dev as to deal with volatility of evmGasPrice and evmWitPrice during the live time of 
     /// @dev a data request (since being posted until a result gets reported back), at both the EVM and 
     /// @dev the Witnet blockchain levels, respectivelly. 
-    uint16 private __witnetBaseFeeOverheadPercentage;
+    uint16 internal __witnetBaseFeeOverheadPercentage;
 
     /// @param _wrb Address of the WitnetOracle contract.
     constructor(WitnetOracle _wrb) {
@@ -71,7 +71,7 @@ abstract contract UsingWitnet
         returns (uint256)
     {
         return (
-            (100 + _witnetBaseFeeOverheadPercentage())
+            (100 + __witnetBaseFeeOverheadPercentage)
                 * __witnet.estimateBaseFee(tx.gasprice, _resultMaxSize) 
         ) / 100;
     }
@@ -89,12 +89,4 @@ abstract contract UsingWitnet
     {
         return __witnet.getQueryResultError(_witnetQueryId);
     }
-
-    function _witnetBaseFeeOverheadPercentage() virtual internal view returns (uint16) {
-        return __witnetBaseFeeOverheadPercentage;
-    }
-
-    function __witnetSetBaseFeeOverheadPercentage(uint16 _baseFeeOverheadPercentage) virtual internal {
-        __witnetBaseFeeOverheadPercentage = _baseFeeOverheadPercentage;
-    }
 }

contracts/apps/UsingWitnetRequest.sol

@@ -27,7 +27,7 @@ abstract contract UsingWitnetRequest
         dataRequest = _witnetRequest;
         __witnetQueryResultMaxSize = _witnetRequest.resultDataMaxSize();
         __witnetRequestRadHash = _witnetRequest.radHash();
-        __witnetSetBaseFeeOverheadPercentage(_baseFeeOverheadPercentage);
+        __witnetBaseFeeOverheadPercentage = _baseFeeOverheadPercentage;
     }
 
     function _witnetEstimateEvmReward()

contracts/apps/UsingWitnetRequestTemplate.sol

@@ -25,7 +25,7 @@ abstract contract UsingWitnetRequestTemplate
         );
         dataRequestTemplate = _witnetRequestTemplate;
         __witnetQueryResultMaxSize = _witnetRequestTemplate.resultDataMaxSize();
-        __witnetSetBaseFeeOverheadPercentage(_baseFeeOverheadPercentage);
+        __witnetBaseFeeOverheadPercentage = _baseFeeOverheadPercentage;
     }
 
     function _witnetBuildRadHash(string[][] memory _witnetRequestArgs)

contracts/apps/WitnetConsumer.sol

@@ -43,7 +43,7 @@ abstract contract WitnetConsumer
 
     function _witnetEstimateEvmReward() virtual internal view returns (uint256) {
         return (
-            (100 + _witnetBaseFeeOverheadPercentage())
+            (100 + __witnetBaseFeeOverheadPercentage)
                 * __witnet.estimateBaseFeeWithCallback(
                     tx.gasprice,
                     _witnetCallbackGasLimit()
@@ -67,7 +67,7 @@ abstract contract WitnetConsumer
         returns (uint256)
     {
         return (
-            (100 + _witnetBaseFeeOverheadPercentage())
+            (100 + __witnetBaseFeeOverheadPercentage)
                 * __witnet.estimateBaseFeeWithCallback(
                     tx.gasprice, 
                     _callbackGasLimit

contracts/apps/UsingWitnetRandomness.sol → contracts/apps/WitnetRandomnessConsumer.sol

@@ -6,7 +6,7 @@ pragma experimental ABIEncoderV2;
 import "./WitnetConsumer.sol";
 import "../WitnetRequest.sol";
 
-abstract contract UsingWitnetRandomness
+abstract contract WitnetRandomnessConsumer
     is
         WitnetConsumer
 {
@@ -30,12 +30,11 @@ abstract contract UsingWitnetRandomness
     {
         // On-chain building of the Witnet Randomness Request:
         {
-            WitnetRequestFactory _factory = witnet().factory();
             WitnetRequestBytecodes _registry = witnet().registry();
             // Build own Witnet Randomness Request:
             bytes32[] memory _retrievals = new bytes32[](1);
             _retrievals[0] = _registry.verifyRadonRetrieval(
-                Witnet.RadonDataRequestMethods.Rng,
+                Witnet.RadonDataRequestMethods.RNG,
                 "", // no url
                 "", // no body
                 new string[2][](0), // no headers
@@ -50,17 +49,15 @@ abstract contract UsingWitnetRandomness
                 opcode: Witnet.RadonReducerOpcodes.ConcatenateAndHash,
                 filters: _filters // no filters
             }));
-            WitnetRequestTemplate _template = WitnetRequestTemplate(_factory.buildRequestTemplate(
+            __witnetRandomnessRadHash = _registry.verifyRadonRequest(
                 _retrievals,
                 _aggregator,
                 _tally,
-                32 // 256 bits of pure entropy ;-)
-            ));
-            __witnetRandomnessRadHash = WitnetRequest(
-                _template.buildRequest(new string[][](_retrievals.length))
-            ).radHash();
+                32, // 256 bits of pure entropy ;-)
+                new string[][](_retrievals.length)
+            );
         }
-        __witnetSetBaseFeeOverheadPercentage(_baseFeeOverheadPercentage);
+        __witnetBaseFeeOverheadPercentage = _baseFeeOverheadPercentage;
     }
 
     function _witnetEstimateEvmReward() virtual override internal view returns (uint256) {