feat(protocol): PCR-2 iota-rest-api (#5276)

* iota-rest-api changes

* refactor(rest-api): use v2 of system state summary (#5455)

---------

Co-authored-by: Konstantinos Demartinos <[email protected]>

Author: 2 people

crates/iota-rest-api/openapi/openapi.json

@@ -1922,6 +1922,76 @@
               }
             }
           },
+          {
+            "type": "object",
+            "required": [
+              "computation_charge",
+              "computation_charge_burned",
+              "epoch",
+              "epoch_start_timestamp_ms",
+              "kind",
+              "non_refundable_storage_fee",
+              "protocol_version",
+              "storage_charge",
+              "storage_rebate",
+              "system_packages"
+            ],
+            "properties": {
+              "computation_charge": {
+                "description": "The total amount of gas charged for computation during the epoch.",
+                "type": "string",
+                "format": "u64"
+              },
+              "computation_charge_burned": {
+                "description": "The total amount of gas burned for computation during the epoch.",
+                "type": "string",
+                "format": "u64"
+              },
+              "epoch": {
+                "description": "The next (to become) epoch ID.",
+                "type": "string",
+                "format": "u64"
+              },
+              "epoch_start_timestamp_ms": {
+                "description": "Unix timestamp when epoch started",
+                "type": "string",
+                "format": "u64"
+              },
+              "kind": {
+                "type": "string",
+                "enum": [
+                  "change_epoch_v2"
+                ]
+              },
+              "non_refundable_storage_fee": {
+                "description": "The non-refundable storage fee.",
+                "type": "string",
+                "format": "u64"
+              },
+              "protocol_version": {
+                "description": "The protocol version in effect in the new epoch.",
+                "type": "string",
+                "format": "u64"
+              },
+              "storage_charge": {
+                "description": "The total amount of gas charged for storage during the epoch.",
+                "type": "string",
+                "format": "u64"
+              },
+              "storage_rebate": {
+                "description": "The amount of storage rebate refunded to the txn senders.",
+                "type": "string",
+                "format": "u64"
+              },
+              "system_packages": {
+                "description": "System packages (specifically framework and move stdlib) that are written before the new epoch starts. This tracks framework upgrades on chain. When executing the ChangeEpoch txn, the validator must write out the modules below.  Modules are provided with the version they will be upgraded to, their modules in serialized form (which include their package ID), and a list of their transitive dependencies.",
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/SystemPackage"
+                }
+              }
+            }
+          },
           {
             "type": "object",
             "required": [
@@ -3918,7 +3988,8 @@
           "protocol_version",
           "reference_gas_price",
           "safe_mode",
-          "safe_mode_computation_rewards",
+          "safe_mode_computation_charges",
+          "safe_mode_computation_charges_burned",
           "safe_mode_non_refundable_storage_fee",
           "safe_mode_storage_charges",
           "safe_mode_storage_rebates",
@@ -4054,8 +4125,13 @@
             "description": "Whether the system is running in a downgraded safe mode due to a non-recoverable bug. This is set whenever we failed to execute advance_epoch, and ended up executing advance_epoch_safe_mode. It can be reset once we are able to successfully execute advance_epoch.",
             "type": "boolean"
           },
-          "safe_mode_computation_rewards": {
-            "description": "Amount of computation rewards accumulated (and not yet distributed) during safe mode.",
+          "safe_mode_computation_charges": {
+            "description": "Amount of computation charges accumulated (and not yet distributed) during safe mode.",
+            "type": "string",
+            "format": "u64"
+          },
+          "safe_mode_computation_charges_burned": {
+            "description": "Amount of burned computation charges accumulated during safe mode.",
             "type": "string",
             "format": "u64"
           },

crates/iota-rest-api/src/reader.rs

@@ -55,13 +55,17 @@ impl StateReader {
     }
 
     pub fn get_system_state_summary(&self) -> Result<super::system::SystemStateSummary> {
-        use iota_types::iota_system_state::IotaSystemStateTrait;
+        use iota_types::iota_system_state::{
+            IotaSystemStateTrait, iota_system_state_summary::IotaSystemStateSummaryV2,
+        };
 
         let system_state = iota_types::iota_system_state::get_iota_system_state(self.inner())
             .map_err(StorageError::custom)?;
-        let summary = system_state.into_iota_system_state_summary().into();
+        let summary =
+            IotaSystemStateSummaryV2::try_from(system_state.into_iota_system_state_summary())
+                .map_err(StorageError::custom)?;
 
-        Ok(summary)
+        Ok(summary.into())
     }
 
     pub fn get_transaction(

crates/iota-rest-api/src/system.rs

@@ -117,11 +117,15 @@ pub struct SystemStateSummary {
     #[serde_as(as = "iota_types::iota_serde::BigInt<u64>")]
     #[schemars(with = "crate::_schemars::U64")]
     pub safe_mode_storage_charges: u64,
-    /// Amount of computation rewards accumulated (and not yet distributed)
+    /// Amount of computation charges accumulated (and not yet distributed)
     /// during safe mode.
     #[serde_as(as = "iota_types::iota_serde::BigInt<u64>")]
     #[schemars(with = "crate::_schemars::U64")]
-    pub safe_mode_computation_rewards: u64,
+    pub safe_mode_computation_charges: u64,
+    /// Amount of burned computation charges accumulated during safe mode.
+    #[serde_as(as = "iota_types::iota_serde::BigInt<u64>")]
+    #[schemars(with = "crate::_schemars::U64")]
+    pub safe_mode_computation_charges_burned: u64,
     /// Amount of storage rebates accumulated (and not yet burned) during safe
     /// mode.
     #[serde_as(as = "iota_types::iota_serde::BigInt<u64>")]
@@ -426,13 +430,13 @@ impl From<iota_types::iota_system_state::iota_system_state_summary::IotaValidato
     }
 }
 
-impl From<iota_types::iota_system_state::iota_system_state_summary::IotaSystemStateSummary>
+impl From<iota_types::iota_system_state::iota_system_state_summary::IotaSystemStateSummaryV2>
     for SystemStateSummary
 {
     fn from(
-        value: iota_types::iota_system_state::iota_system_state_summary::IotaSystemStateSummary,
+        value: iota_types::iota_system_state::iota_system_state_summary::IotaSystemStateSummaryV2,
     ) -> Self {
-        let iota_types::iota_system_state::iota_system_state_summary::IotaSystemStateSummary {
+        let iota_types::iota_system_state::iota_system_state_summary::IotaSystemStateSummaryV2 {
             epoch,
             protocol_version,
             system_state_version,
@@ -443,7 +447,8 @@ impl From<iota_types::iota_system_state::iota_system_state_summary::IotaSystemSt
             reference_gas_price,
             safe_mode,
             safe_mode_storage_charges,
-            safe_mode_computation_rewards,
+            safe_mode_computation_charges,
+            safe_mode_computation_charges_burned,
             safe_mode_storage_rebates,
             safe_mode_non_refundable_storage_fee,
             epoch_start_timestamp_ms,
@@ -480,7 +485,8 @@ impl From<iota_types::iota_system_state::iota_system_state_summary::IotaSystemSt
             reference_gas_price,
             safe_mode,
             safe_mode_storage_charges,
-            safe_mode_computation_rewards,
+            safe_mode_computation_charges,
+            safe_mode_computation_charges_burned,
             safe_mode_storage_rebates,
             safe_mode_non_refundable_storage_fee,
             epoch_start_timestamp_ms,