Bridge/watch dog

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "witnet"
-version = "1.7.1"
+version = "2.0.0"
 authors = ["Witnet Foundation <[email protected]>"]
 publish = false
 repository = "witnet/witnet-rust"
@@ -35,6 +35,7 @@ lazy_static = "1.4.0"
 log = "0.4.8"
 num-format = "0.4.0"
 prettytable-rs = { version = "0.10.0", default-features = false }
+qrcode = "0.12"
 sentry = { version = "0.29.3", features = ["log"], optional = true }
 serde_json = "1.0.47"
 structopt = "0.3.9"

bridges/centralized-ethereum/.env.example

@@ -1,22 +1,27 @@
 # Sample env file
-# Note that the bridge does not read .env files, you need to import these variables into the environment using some external tool
-# adjustable params
-WITNET_CENTRALIZED_ETHEREUM_BRIDGE_ETH_ACCOUNT: "0x8c49CAfC4542D9EA9107D4E48412ACEd2A68aA77"
-WITNET_CENTRALIZED_ETHEREUM_BRIDGE_GAS_LIMITS: "report_result = 3_000_000"
-WITNET_CENTRALIZED_ETHEREUM_BRIDGE_NUM_CONFIRMATIONS: 8
-WITNET_CENTRALIZED_ETHEREUM_BRIDGE_WITNET_JSONRPC_ADDR: "10.5.1.4:21338"
-WITNET_CENTRALIZED_ETHEREUM_BRIDGE_WRB_CONTRACT_ADDR: "0x58D8ECe142c60f5707594a7C1D90e46eAE5AF431"
-WITNET_CENTRALIZED_ETHEREUM_BRIDGE_DR_FEE_NANOWITS: 10000
-# not-to-be-changed params
-WITNET_CENTRALIZED_ETHEREUM_BRIDGE_ETH_CLIENT_URL: "http://gateway:8535"
-WITNET_CENTRALIZED_ETHEREUM_BRIDGE_MAX_DR_VALUE_NANOWITS: 100000000000 # 1 WIT
-WITNET_CENTRALIZED_ETHEREUM_BRIDGE_MAX_RESULT_SIZE: 100 # 100 bytes
-WITNET_CENTRALIZED_ETHEREUM_BRIDGE_REQUEST_EXAMPLE_CONTRACT_ADDR: "0xEaA9e7Ea612b169f5b41cfF86dA6322f57264a19"
-WITNET_CENTRALIZED_ETHEREUM_BRIDGE_STORAGE: "db_path = \"data/polygon_goerli\""
+# Note that the bridge does not read .env files, you need to import these variables 
+# into the environment using some external tool
+
+WITNET_CENTRALIZED_ETHEREUM_BRIDGE_ETH_FROM: "0x8c49CAfC4542D9EA9107D4E48412ACEd2A68aA77"
+WITNET_CENTRALIZED_ETHEREUM_BRIDGE_ETH_FROM_BALANCE_THRESHOLD: 100000000000000000 # 0.1 ETH
+WITNET_CENTRALIZED_ETHEREUM_BRIDGE_ETH_GAS_LIMITS: "report_result = 3_000_000" # (optional)
+WITNET_CENTRALIZED_ETHEREUM_BRIDGE_ETH_JSONRPC_URL: "http://gateway:8535"
+WITNET_CENTRALIZED_ETHEREUM_BRIDGE_ETH_MAX_BATCH_SIZE: 64
+WITNET_CENTRALIZED_ETHEREUM_BRIDGE_ETH_NANOWIT_WEI_PRICE: 10000 # Price of nanoWIT in WEI (optional)
+WITNET_CENTRALIZED_ETHEREUM_BRIDGE_ETH_NEW_DRS_POLLING_RATE_MS: 30000 # 30 secs, not less than average EVM's block period
+WITNET_CENTRALIZED_ETHEREUM_BRIDGE_ETH_TXS_CONFIRMATIONS: 2
+WITNET_CENTRALIZED_ETHEREUM_BRIDGE_ETH_TXS_TIMEOUT_MS: 900000 # 15 min 
+WITNET_CENTRALIZED_ETHEREUM_BRIDGE_ETH_WITNET_ORACLE: "0x58D8ECe142c60f5707594a7C1D90e46eAE5AF431"
+
+WITNET_CENTRALIZED_ETHEREUM_BRIDGE_WITNET_DR_MIN_COLLATERAL_NANOWITS: 20000000000 # 20 WIT
+WITNET_CENTRALIZED_ETHEREUM_BRIDGE_WITNET_DR_MAX_FEE_NANOWITS: 100000 # 0.1 milliWIT
+WITNET_CENTRALIZED_ETHEREUM_BRIDGE_WITNET_DR_MAX_RESULT_SIZE: 64 # 64 bytes
+WITNET_CENTRALIZED_ETHEREUM_BRIDGE_WITNET_DR_MAX_VALUE_NANOWITS: 100000000000 # 1 WIT
+WITNET_CENTRALIZED_ETHEREUM_BRIDGE_WITNET_DR_TXS_POLLING_RATE_MS: 45000 # 45 secs
+WITNET_CENTRALIZED_ETHEREUM_BRIDGE_WITNET_DR_TXS_TIMEOUT_MS: 600000 # 10 min
+
+WITNET_CENTRALIZED_ETHEREUM_BRIDGE_WITNET_JSONRPC_SOCKET: "10.5.1.4:21338"
 WITNET_CENTRALIZED_ETHEREUM_BRIDGE_WITNET_TESTNET: "false"
-# timing params
-WITNET_CENTRALIZED_ETHEREUM_BRIDGE_DR_TX_UNRESOLVED_TIMEOUT_MS: 600000  # 10 min
-WITNET_CENTRALIZED_ETHEREUM_BRIDGE_ETH_CONFIRMATION_TIMEOUT_MS: 900000  # 15 min 
-WITNET_CENTRALIZED_ETHEREUM_BRIDGE_ETH_NEW_DR_POLLING_RATE_MS: 45000    # 45 secs
-WITNET_CENTRALIZED_ETHEREUM_BRIDGE_WIT_TALLY_POLLING_RATE_MS: 45000     # 45 secs
-WITNET_CENTRALIZED_ETHEREUM_BRIDGE_WIT_DR_SENDER_POLLING_RATE_MS: 45000 # 45 secs
+
+WITNET_CENTRALIZED_ETHEREUM_BRIDGE_STORAGE: "db_path = \"data/storage\""
+WITNET_CENTRALIZED_ETHEREUM_BRIDGE_STORAGE_SKIP_FIRST: 0

bridges/centralized-ethereum/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "witnet-centralized-ethereum-bridge"
-version = "1.7.1"
+version = "2.0.0"
 authors = ["Witnet Foundation <[email protected]>"]
 edition = "2018"
 
@@ -25,3 +25,4 @@ witnet_net = { path = "../../net" }
 witnet_node = { path = "../../node" }
 witnet_util = { path = "../../util" }
 witnet_validations = { path = "../../validations" }
+web3-unit-converter = "0.1.1"

bridges/centralized-ethereum/README.md

@@ -103,11 +103,11 @@ We need to modify the configuration file that the bridge will use to establish c
 
 There are some key fields that need to be edited here to make the bridge connect properly to your Ethereum/Witnet nodes. These are:
 
-- *witnet_jsonrpc_addr*: make sure this address is identical to the jsonRPC address of your Witnet node.
-- *eth_client_url*: make sure this field points to address where your ethereum client is running.
-- *wrb_contract_addr*: this field should contain the address of the WitnetRequestsBoard contract you wish your node to connect to.
+- *witnet_jsonrpc_socket*: make sure this address is identical to the jsonRPC address of your Witnet node.
+- *eth_jsonrpc_url*: make sure this field points to address where your ethereum client is running.
+- *eth_witnet_oracle*: this field should contain the address of the WitnetRequestsBoard contract you wish your node to connect to.
 - *block_relay_contract_add*: this field should contain the address of the BlockRelay contract you wish your node to connect to.
-- *eth_account*: this is the account you are using in your ethereum client. 
+- *eth_from*: this is the account you are using in your ethereum client. 
     - **NOTE**: In the case of using ganache-cli, this needs to be the first account, since currently the only account that can relay Witnet blocks to Ethereum is the one that
     deployed the BlockRelay contract, which by default is the first account.
 

bridges/centralized-ethereum/src/actors/dr_database.rs

@@ -53,17 +53,20 @@ pub struct DrInfoBridge {
 }
 
 /// Data request state
-#[derive(Clone, Default, Serialize, Deserialize)]
+#[derive(Clone, Copy, Default, Serialize, Deserialize)]
 pub enum DrState {
-    /// New: the data request has just been posted to the smart contract.
+    /// New: a new query was detected on the Witnet Oracle contract,
+    /// but has not yet been attended.
     #[default]
     New,
-    /// Pending: the data request has been created and broadcast to witnet, but it has not been
-    /// included in a witnet block yet.
+    /// Pending: a data request transaction was broadcasted to the Witnet blockchain,
+    /// but has not yet been resolved.
     Pending,
-    /// Finished: data request has been resolved in witnet and the result is in the smart
-    /// contract.
+    /// Finished: the data request result was reported back to the Witnet Oracle contract.
     Finished,
+    /// Dismissed: the data request result cannot be reported back to the Witnet Oracle contract,
+    /// or was already reported by another bridge instance.
+    Dismissed,
 }
 
 impl fmt::Display for DrState {
@@ -72,24 +75,24 @@ impl fmt::Display for DrState {
             DrState::New => "New",
             DrState::Pending => "Pending",
             DrState::Finished => "Finished",
+            DrState::Dismissed => "Dismissed",
         };
 
         f.write_str(s)
     }
 }
 
-/// Data request states in Witnet Request Board contract
+/// Possible query states in the Witnet Oracle contract
 #[derive(Serialize, Deserialize, Clone)]
 pub enum WitnetQueryStatus {
-    /// Unknown: the data request does not exist.
+    /// Unknown: the query does not exist, or got eventually deleted.
     Unknown,
-    /// Posted: the data request has just been posted to the smart contract.
+    /// Posted: the query exists, but has not yet been reported.
     Posted,
-    /// Reported: the data request has been resolved in witnet and the result is in the smart
-    /// contract.
+    /// Reported: some query result got stored into the WitnetOracle, although not yet finalized.
     Reported,
-    /// Deleted: the data request has been resolved in witnet but the result was deleted.
-    Deleted,
+    /// Finalized: the query was reported, and considered to be final.
+    Finalized,
 }
 
 impl WitnetQueryStatus {
@@ -98,7 +101,7 @@ impl WitnetQueryStatus {
         match i {
             1 => WitnetQueryStatus::Posted,
             2 => WitnetQueryStatus::Reported,
-            3 => WitnetQueryStatus::Deleted,
+            3 => WitnetQueryStatus::Finalized,
             _ => WitnetQueryStatus::Unknown,
         }
     }
@@ -119,7 +122,7 @@ impl Actor for DrDatabase {
                 |dr_database_from_storage, act, _| match dr_database_from_storage {
                     Ok(dr_database_from_storage) => {
                         if let Some(mut dr_database_from_storage) = dr_database_from_storage {
-                            log::info!("Load database from storage");
+                            log::info!("Database loaded from storage");
                             act.dr = std::mem::take(&mut dr_database_from_storage.dr);
                             act.max_dr_id = dr_database_from_storage.max_dr_id;
                         } else {
@@ -164,22 +167,31 @@ impl Message for GetLastDrId {
     type Result = Result<DrId, ()>;
 }
 
-/// Set data request id as "finished"
-pub struct SetFinished {
-    /// Data Request Id
+/// Set state of given data request id
+pub struct SetDrState {
+    /// Data Request id
     pub dr_id: DrId,
+    /// Data Request new state
+    pub dr_state: DrState,
 }
 
-impl Message for SetFinished {
+impl Message for SetDrState {
     type Result = Result<(), ()>;
 }
 
+/// Count number of data requests in given state
+pub struct CountDrsPerState;
+
+impl Message for CountDrsPerState {
+    type Result = Result<(u64, u64, u64, u64), ()>;
+}
+
 impl Handler<SetDrInfoBridge> for DrDatabase {
     type Result = ();
 
     fn handle(&mut self, msg: SetDrInfoBridge, ctx: &mut Self::Context) -> Self::Result {
         let SetDrInfoBridge(dr_id, dr_info) = msg;
-        let dr_state = dr_info.dr_state.clone();
+        let dr_state = dr_info.dr_state;
         self.dr.insert(dr_id, dr_info);
 
         self.max_dr_id = cmp::max(self.max_dr_id, dr_id);
@@ -239,32 +251,24 @@ impl Handler<GetLastDrId> for DrDatabase {
     }
 }
 
-impl Handler<SetFinished> for DrDatabase {
+impl Handler<SetDrState> for DrDatabase {
     type Result = Result<(), ()>;
 
-    fn handle(&mut self, msg: SetFinished, ctx: &mut Self::Context) -> Self::Result {
-        let SetFinished { dr_id } = msg;
+    fn handle(&mut self, msg: SetDrState, ctx: &mut Self::Context) -> Self::Result {
+        let SetDrState { dr_id, dr_state } = msg;
         match self.dr.entry(dr_id) {
             Entry::Occupied(entry) => {
                 entry.into_mut().dr_state = DrState::Finished;
-                log::debug!(
-                    "Data request #{} updated to state {}",
-                    dr_id,
-                    DrState::Finished
-                );
+                log::debug!("Data request #{} updated to state {}", dr_id, dr_state,);
             }
             Entry::Vacant(entry) => {
                 entry.insert(DrInfoBridge {
                     dr_bytes: vec![],
-                    dr_state: DrState::Finished,
+                    dr_state,
                     dr_tx_hash: None,
                     dr_tx_creation_timestamp: None,
                 });
-                log::debug!(
-                    "Data request #{} inserted with state {}",
-                    dr_id,
-                    DrState::Finished
-                );
+                log::debug!("Data request #{} inserted with state {}", dr_id, dr_state,);
             }
         }
 
@@ -277,6 +281,28 @@ impl Handler<SetFinished> for DrDatabase {
     }
 }
 
+impl Handler<CountDrsPerState> for DrDatabase {
+    type Result = Result<(u64, u64, u64, u64), ()>;
+
+    fn handle(&mut self, _msg: CountDrsPerState, _ctx: &mut Self::Context) -> Self::Result {
+        let mut drs_new = u64::default();
+        let mut drs_pending = u64::default();
+        let mut drs_finished = u64::default();
+        let mut drs_dismissed = u64::default();
+
+        self.dr.iter().for_each(|(_dr_id, dr_info)| {
+            match dr_info.dr_state {
+                DrState::New => drs_new += 1,
+                DrState::Pending => drs_pending += 1,
+                DrState::Finished => drs_finished += 1,
+                DrState::Dismissed => drs_dismissed += 1,
+            };
+        });
+
+        Ok((drs_new, drs_pending, drs_finished, drs_dismissed))
+    }
+}
+
 /// Required trait for being able to retrieve DrDatabase address from system registry
 impl actix::Supervised for DrDatabase {}