Now using minimum_pool_box_value

Author: robkorn

connectors/connector-lib/src/oracle_core.rs

@@ -42,7 +42,7 @@ pub struct PoolInfo {
     pub live_epoch_length: u64,
     pub epoch_prep_length: u64,
     pub outlier_range: f64,
-    pub number_of_oracles: u64,
+    pub minimum_pool_box_value: u64,
     pub oracle_pool_nft_id: String,
     pub oracle_pool_participant_token_id: String,
 }

connectors/erg-usd-connector/src/api.rs

@@ -89,11 +89,11 @@ pub fn prepare_frontend_data_json(oc: &OracleCore) -> Result<String> {
         pool_funded_percentage: pstatus.funded_percentage,
 
         // Summary Table
-        number_of_oracles: pinfo.number_of_oracles,
         posting_schedule_blocks: posting_sched_blocks,
 
 
         // Technical
+        minimum_pool_box_value: pinfo.minimum_pool_box_value,
         latest_datapoint: pstatus.latest_datapoint,
         live_epoch_address : pinfo.live_epoch_address,
         epoch_prep_address: pinfo.epoch_prep_address,

connectors/frontend-connector-lib/src/lib.rs

@@ -93,7 +93,7 @@ impl FrontendConnector {
             current_pool_stage: pstatus.current_pool_stage,
             pool_funded_percentage: pstatus.funded_percentage,
 
-            number_of_oracles: pinfo.number_of_oracles,
+            minimum_pool_box_value: pinfo.minimum_pool_box_value,
             posting_schedule_blocks: posting_sched_blocks,
 
 

docs/API-Endpoints.md

@@ -47,7 +47,7 @@ Example Response:
     "live_epoch_length": 5,
     "epoch_prep_length": 5,
     "outlier_range": 0.01,
-    "number_of_oracles": 4,
+    "minimum_pool_box_value": 100000000,
     "oracle_pool_nft_id": "b662db51cf2dc39f110a021c2a31c74f0a1a18ffffbf73e8a051a7b8c0f09ebc",
     "oracle_pool_participant_token_id": "12caaacb51c89646fac9a3786eb98d0113bd57d68223ccc11754a4f67281daed"
 }

oracle-config.yaml

@@ -34,8 +34,8 @@ pool_deposit_contract_address: "zLSQDVBaGXZTutz9snE4UBbRzmx7Juaj4R2KCsSVKhQqaupC
 base_fee: 1000000
 
 #### Oracle Pool Parameters ####
-# Number of oracles in pool
-number_of_oracles: 4
+# The minimum amount of Ergs required for the oracle pool to be considered funded.
+minimum_pool_box_value: 100000000
 # The payout in Ergs that a single oracle earns on successful datapoint posting
 oracle_payout_price: 2000000
 # Length of the oracle pool's live epoch in blocks

src/api.rs

@@ -125,7 +125,7 @@ pub fn start_get_api() {
             live_epoch_length: parameters.live_epoch_length,
             epoch_prep_length: parameters.epoch_preparation_length,
             outlier_range: parameters.outlier_range,
-            number_of_oracles: parameters.number_of_oracles,
+            minimum_pool_box_value: parameters.minimum_pool_box_value,
             oracle_pool_nft_id: op.oracle_pool_nft,
             oracle_pool_participant_token_id: op.oracle_pool_participant_token,
 
@@ -207,15 +207,13 @@ pub fn start_get_api() {
         let mut epoch_ends = 0;
         if let Ok(l) = op.get_live_epoch_state() {
             // The percentage that the pool is funded
-            funded_percentage =
-                (l.funds / (parameters.number_of_oracles * parameters.oracle_payout_price)) * 100;
+            funded_percentage = (l.funds / parameters.minimum_pool_box_value) * 100;
             latest_datapoint = l.latest_pool_datapoint;
             current_epoch_id = l.epoch_id;
             epoch_ends = l.epoch_ends;
         } else if let Ok(ep) = op.get_preparation_state() {
             // The percentage that the pool is funded
-            funded_percentage =
-                (ep.funds / (parameters.number_of_oracles * parameters.oracle_payout_price)) * 100;
+            funded_percentage = (ep.funds / parameters.minimum_pool_box_value) * 100;
             latest_datapoint = ep.latest_pool_datapoint;
             current_epoch_id = "Preparing Epoch Currently".to_string();
             epoch_ends = ep.next_epoch_ends;

src/main.rs

@@ -93,7 +93,7 @@ fn main() {
             }
 
             // Check epoch prep state
-            let is_funded = prep_state.funds >= parameters.max_pool_payout();
+            let is_funded = prep_state.funds >= parameters.minimum_pool_box_value;
             let epoch_prep_over =
                 height > prep_state.next_epoch_ends - parameters.live_epoch_length;
             let live_epoch_over = height >= prep_state.next_epoch_ends;

src/oracle_config.rs

@@ -4,7 +4,7 @@ use reqwest::header::HeaderValue;
 use yaml_rust::{Yaml, YamlLoader};
 
 pub struct PoolParameters {
-    pub number_of_oracles: u64,
+    pub minimum_pool_box_value: u64,
     pub oracle_payout_price: NanoErg,
     pub live_epoch_length: BlockDuration,
     pub epoch_preparation_length: BlockDuration,
@@ -36,14 +36,14 @@ impl PoolParameters {
         let price = config["oracle_payout_price"]
             .as_i64()
             .expect("No oracle_payout_price specified in config file.");
-        let num = config["number_of_oracles"]
+        let num = config["minimum_pool_box_value"]
             .as_i64()
-            .expect("No number_of_oracles specified in config file.");
+            .expect("No minimum_pool_box_value specified in config file.");
         let base_fee = config["base_fee"]
             .as_i64()
             .expect("No base_fee specified in config file.");
         PoolParameters {
-            number_of_oracles: num as u64,
+            minimum_pool_box_value: num as u64,
             oracle_payout_price: price as u64,
             live_epoch_length: lel as u64,
             epoch_preparation_length: epl as u64,
@@ -52,12 +52,6 @@ impl PoolParameters {
             base_fee: base_fee as u64,
         }
     }
-
-    /// Calculates the maximum total payout that the oracle pool will require
-    /// in order to payout all of the oracles + the collector.
-    pub fn max_pool_payout(&self) -> NanoErg {
-        self.oracle_payout_price * (self.number_of_oracles + 1)
-    }
 }
 
 /// Returns "core_api_port" from the config file
@@ -111,7 +105,7 @@ mod tests {
     #[test]
     fn pool_parameter_parsing_works() {
         let yaml_string = "
-            number_of_oracles: 4
+            minimum_pool_box_value: 10000000
             live_epoch_length: 20
             epoch_preparation_length: 10
             buffer_length: 4
@@ -124,7 +118,7 @@ mod tests {
         assert_eq!(pool_params.live_epoch_length, 20);
         assert_eq!(pool_params.epoch_preparation_length, 10);
         assert_eq!(pool_params.buffer_length, 4);
-        assert_eq!(pool_params.number_of_oracles, 4);
+        assert_eq!(pool_params.minimum_pool_box_value, 10000000);
         assert_eq!(pool_params.outlier_range, 10);
         assert_eq!(pool_params.oracle_payout_price, 1000000);
         assert_eq!(pool_params.base_fee, 1000000);