Update node reward table to compute XDR with penalties (#935)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
dfinity · Sep 17, 2024 · 751adf1 · 751adf1
1 parent 9a241c0
commit 751adf1
Show file tree

Hide file tree

Showing 7 changed files with 70 additions and 6 deletions.
diff --git a/Cargo.Bazel.lock b/Cargo.Bazel.lock
@@ -1,5 +1,5 @@
 {
-  "checksum": "ac1c7f35e7cd235485ebc4e9085ef127ba2881abba9deee4940ac3a40ac97b9a",
+  "checksum": "b56548df73e3611b6967660ea1984112a5afc5cc24a198a8386dba53f8a6106d",
   "crates": {
     "actix-codec 0.5.2": {
       "name": "actix-codec",
@@ -44044,6 +44044,10 @@
               "id": "ic-management-canister-types 0.9.0",
               "target": "ic_management_canister_types"
             },
+            {
+              "id": "ic-protobuf 0.9.0",
+              "target": "ic_protobuf"
+            },
             {
               "id": "ic-stable-structures 0.6.5",
               "target": "ic_stable_structures"

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/rs/dre-canisters/trustworthy-node-metrics/src/trustworthy-node-metrics-types/Cargo.toml b/rs/dre-canisters/trustworthy-node-metrics/src/trustworthy-node-metrics-types/Cargo.toml
@@ -22,3 +22,4 @@ serde_json = { workspace = true }
 dfn_core = { workspace = true }
 ic-management-canister-types = { workspace = true }
 ic-stable-structures = { workspace = true }
+ic-protobuf = { workspace = true }
diff --git a/rs/dre-canisters/trustworthy-node-metrics/src/trustworthy-node-metrics-types/src/types.rs b/rs/dre-canisters/trustworthy-node-metrics/src/trustworthy-node-metrics-types/src/types.rs
@@ -3,6 +3,7 @@ use std::{borrow::Cow, fmt};
 use candid::{CandidType, Decode, Deserialize, Encode, Principal};
 use dfn_core::api::PrincipalId;
 use ic_management_canister_types::NodeMetricsHistoryResponse;
+use ic_protobuf::registry::node_rewards::v2::NodeRewardRates;
 use ic_stable_structures::{storable::Bound, Storable};
 use serde::Serialize;
 
@@ -21,7 +22,7 @@ pub struct NodeMetricsStored {
     pub num_blocks_failed: u64,
 }
 
-const MAX_VALUE_SIZE_BYTES: u32 = 102;
+const MAX_VALUE_SIZE_BYTES_NODE_METRICS: u32 = 102;
 
 impl Storable for NodeMetricsStored {
     fn to_bytes(&self) -> std::borrow::Cow<[u8]> {
@@ -33,7 +34,29 @@ impl Storable for NodeMetricsStored {
     }
 
     const BOUND: Bound = Bound::Bounded {
-        max_size: MAX_VALUE_SIZE_BYTES,
+        max_size: MAX_VALUE_SIZE_BYTES_NODE_METRICS,
+        is_fixed_size: false,
+    };
+}
+
+#[derive(Debug, Deserialize, Serialize, CandidType, Clone)]
+pub struct NodeRewardRatesStored {
+    pub rewards_rates: NodeRewardRates,
+}
+
+const MAX_VALUE_SIZE_BYTES_REWARD_RATES: u32 = 133;
+
+impl Storable for NodeRewardRatesStored {
+    fn to_bytes(&self) -> std::borrow::Cow<[u8]> {
+        Cow::Owned(Encode!(self).unwrap())
+    }
+
+    fn from_bytes(bytes: std::borrow::Cow<[u8]>) -> Self {
+        Decode!(bytes.as_ref(), Self).unwrap()
+    }
+
+    const BOUND: Bound = Bound::Bounded {
+        max_size: MAX_VALUE_SIZE_BYTES_REWARD_RATES,
         is_fixed_size: false,
     };
 }
@@ -54,7 +77,7 @@ impl Storable for NodeMetadataStored {
     }
 
     const BOUND: Bound = Bound::Bounded {
-        max_size: MAX_VALUE_SIZE_BYTES,
+        max_size: MAX_VALUE_SIZE_BYTES_NODE_METRICS,
         is_fixed_size: false,
     };
 }

diff --git a/rs/dre-canisters/trustworthy-node-metrics/src/trustworthy-node-metrics/src/lib.rs b/rs/dre-canisters/trustworthy-node-metrics/src/trustworthy-node-metrics/src/lib.rs
@@ -23,6 +23,15 @@ async fn update_metrics_task() {
             ic_cdk::println!("Error updating metrics: {}", e);
         }
     }
+
+    match rewards_manager::update_node_rewards_table().await {
+        Ok(_) => {
+            ic_cdk::println!("Successfully updated node_rewards_table");
+        }
+        Err(e) => {
+            ic_cdk::println!("Error updating node_rewards_table: {}", e);
+        }
+    }
 }
 
 fn setup_timers() {

diff --git a/...re-canisters/trustworthy-node-metrics/src/trustworthy-node-metrics/src/rewards_manager.rs b/...re-canisters/trustworthy-node-metrics/src/trustworthy-node-metrics/src/rewards_manager.rs
@@ -1,10 +1,15 @@
+use ic_protobuf::registry::node_rewards::v2::NodeRewardsTable;
+use ic_registry_keys::NODE_REWARDS_TABLE_KEY;
 use itertools::Itertools;
 use num_traits::ToPrimitive;
 use rust_decimal::Decimal;
 use rust_decimal_macros::dec;
 use trustworthy_node_metrics_types::types::{DailyNodeMetrics, RewardsComputationResult};
 
-use crate::computation_logger::{ComputationLogger, Operation, OperationExecutor};
+use crate::{
+    computation_logger::{ComputationLogger, Operation, OperationExecutor},
+    stable_memory,
+};
 
 const MIN_FAILURE_RATE: Decimal = dec!(0.1);
 const MAX_FAILURE_RATE: Decimal = dec!(0.6);
@@ -115,6 +120,16 @@ pub fn compute_rewards_percent(daily_metrics: &[DailyNodeMetrics]) -> RewardsCom
     }
 }
 
+/// Update node rewards table
+pub async fn update_node_rewards_table() -> anyhow::Result<()> {
+    let (rewards_table, _): (NodeRewardsTable, _) = ic_nns_common::registry::get_value(NODE_REWARDS_TABLE_KEY.as_bytes(), None).await?;
+    for (area, rewards_rates) in rewards_table.table {
+        stable_memory::insert_rewards_rates(area, rewards_rates)
+    }
+
+    Ok(())
+}
+
 #[cfg(test)]
 mod tests {
     use candid::Principal;

diff --git a/rs/dre-canisters/trustworthy-node-metrics/src/trustworthy-node-metrics/src/stable_memory.rs b/rs/dre-canisters/trustworthy-node-metrics/src/trustworthy-node-metrics/src/stable_memory.rs
@@ -1,11 +1,14 @@
 use candid::Principal;
+use ic_protobuf::registry::node_rewards::v2::NodeRewardRates;
 use ic_stable_structures::memory_manager::{MemoryId, MemoryManager, VirtualMemory};
 use ic_stable_structures::{DefaultMemoryImpl, StableBTreeMap};
 use itertools::Itertools;
 use std::cell::RefCell;
 use std::collections::BTreeMap;
 
-use trustworthy_node_metrics_types::types::{NodeMetadata, NodeMetadataStored, NodeMetricsStored, NodeMetricsStoredKey, TimestampNanos};
+use trustworthy_node_metrics_types::types::{
+    NodeMetadata, NodeMetadataStored, NodeMetricsStored, NodeMetricsStoredKey, NodeRewardRatesStored, TimestampNanos,
+};
 
 type Memory = VirtualMemory<DefaultMemoryImpl>;
 
@@ -31,6 +34,10 @@ thread_local! {
         MEMORY_MANAGER.with(|m| m.borrow().get(MemoryId::new(3)))
     ));
 
+    static REWARDS_TABLE: RefCell<StableBTreeMap<String, NodeRewardRatesStored, Memory>> =
+        RefCell::new(StableBTreeMap::init(
+        MEMORY_MANAGER.with(|m| m.borrow().get(MemoryId::new(4)))
+    ));
 }
 
 pub fn insert_node_metrics(key: NodeMetricsStoredKey, value: NodeMetricsStored) {
@@ -120,3 +127,7 @@ pub fn nodes_metadata() -> Vec<NodeMetadata> {
             .collect_vec()
     })
 }
+
+pub fn insert_rewards_rates(area: String, rewards_rates: NodeRewardRates) {
+    REWARDS_TABLE.with_borrow_mut(|rewards_table| rewards_table.insert(area, NodeRewardRatesStored { rewards_rates }));
+}