feat(protocol): PCR-2 iota-json-rpc* and iota-open-rpc (#5277)

cyberphysic4l · kodemartin · alexsporn · commit 2e612ddbbea2 · 2025-02-20T12:52:56.000+01:00
* iota-json-rpc* and iota-open-rpc changes * refactor(protocol): pcr2 more base changes (#5448) * feat: implement conversions between v1 and v2 for system-state summary * refactor(types): add non_exhaustive attribute to IotaSystemStateSummary * refactor(core): use system-state summary v2 * doc(type): fix typo in system-state summary v2 doc * refactor(json-rpc): support new system state summary (#5449) * feat(json-rpc-api): support all versions of system-state summary * refactor(json-rpc): support v2 of system-state summary * chore(open-rpc): update specification --------- Co-authored-by: Konstantinos Demartinos <konstantinos.demartinos@iota.org>
diff --git a/crates/iota-core/src/authority.rs b/crates/iota-core/src/authority.rs
@@ -68,7 +68,7 @@ use iota_types::{
         TransactionEvents, VerifiedCertifiedTransactionEffects, VerifiedSignedTransactionEffects,
     },
     error::{ExecutionError, IotaError, IotaResult, UserInputError},
-    event::{Event, EventID, SystemEpochInfoEvent, SystemEpochInfoEventV1, SystemEpochInfoEventV2},
+    event::{Event, EventID, SystemEpochInfoEvent},
     executable_transaction::VerifiedExecutableTransaction,
     execution_config_utils::to_binary_config,
     execution_status::ExecutionStatus,
@@ -4714,9 +4714,9 @@ impl AuthorityState {
         let system_epoch_info_event = temporary_store
             .events
             .data
-            .iter()
+            .into_iter()
             .find(|event| event.is_system_epoch_info_event())
-            .map(|event| SystemEpochInfoEvent::from(event));
+            .map(SystemEpochInfoEvent::from);
         // The system epoch info event can be `None` in case if the `advance_epoch`
         // Move function call failed and was executed in the safe mode.
         assert!(system_epoch_info_event.is_some() || system_obj.safe_mode());
diff --git a/crates/iota-core/src/authority/authority_store.rs b/crates/iota-core/src/authority/authority_store.rs
@@ -19,7 +19,9 @@ use iota_types::{
     error::UserInputError,
     execution::TypeLayoutStore,
     fp_bail, fp_ensure,
-    iota_system_state::get_iota_system_state,
+    iota_system_state::{
+        get_iota_system_state, iota_system_state_summary::IotaSystemStateSummaryV2,
+    },
     message_envelope::Message,
     storage::{
         BackingPackageStore, MarkerValue, ObjectKey, ObjectOrTombstone, ObjectStore, get_module,
@@ -1592,10 +1594,11 @@ impl AuthorityStore {
 
         // It is safe to call this function because we are in the middle of
         // reconfiguration.
-        let system_state = self
+        let system_state: IotaSystemStateSummaryV2 = self
             .get_iota_system_state_object_unsafe()
             .expect("Reading iota system state object cannot fail")
-            .into_iota_system_state_summary();
+            .into_iota_system_state_summary()
+            .try_into()?;
         let storage_fund_balance = system_state.storage_fund_total_object_storage_rebates;
         info!(
             "Total IOTA amount in the network: {}, storage fund balance: {}, total storage rebate: {} at beginning of epoch {}",
diff --git a/crates/iota-json-rpc-api/src/governance.rs b/crates/iota-json-rpc-api/src/governance.rs
@@ -7,7 +7,9 @@ use iota_open_rpc_macros::open_rpc;
 use iota_types::{
     base_types::{IotaAddress, ObjectID},
     iota_serde::BigInt,
-    iota_system_state::iota_system_state_summary::IotaSystemStateSummary,
+    iota_system_state::iota_system_state_summary::{
+        IotaSystemStateSummaryV1, IotaSystemStateSummaryV2,
+    },
 };
 use jsonrpsee::{core::RpcResult, proc_macros::rpc};
 
@@ -53,7 +55,13 @@ pub trait GovernanceReadApi {
 
     /// Return the latest IOTA system state object on-chain.
     #[method(name = "getLatestIotaSystemState")]
-    async fn get_latest_iota_system_state(&self) -> RpcResult<IotaSystemStateSummary>;
+    async fn get_latest_iota_system_state(&self) -> RpcResult<IotaSystemStateSummaryV2>;
+
+    /// Return the latest IOTA system state object on-chain (version 1).
+    /// Requires the `client-target-api-version` header to be set into
+    /// a value `< 0.11` during requests.
+    #[method(name = "getLatestIotaSystemState", version <= "0.10.99")]
+    async fn get_latest_iota_system_state_v1(&self) -> RpcResult<IotaSystemStateSummaryV1>;
 
     /// Return the reference gas price for the network
     #[method(name = "getReferenceGasPrice")]
diff --git a/crates/iota-json-rpc-types/src/iota_transaction.rs b/crates/iota-json-rpc-types/src/iota_transaction.rs
@@ -35,8 +35,8 @@ use iota_types::{
     signature::GenericSignature,
     storage::{DeleteKind, WriteKind},
     transaction::{
-        Argument, CallArg, ChangeEpoch, Command, EndOfEpochTransactionKind, GenesisObject,
-        InputObjectKind, ObjectArg, ProgrammableMoveCall, ProgrammableTransaction,
+        Argument, CallArg, ChangeEpoch, ChangeEpochV2, Command, EndOfEpochTransactionKind,
+        GenesisObject, InputObjectKind, ObjectArg, ProgrammableMoveCall, ProgrammableTransaction,
         SenderSignedData, TransactionData, TransactionDataAPI, TransactionKind,
     },
 };
@@ -517,6 +517,9 @@ impl IotaTransactionBlockKind {
                             EndOfEpochTransactionKind::ChangeEpoch(e) => {
                                 IotaEndOfEpochTransactionKind::ChangeEpoch(e.into())
                             }
+                            EndOfEpochTransactionKind::ChangeEpochV2(e) => {
+                                IotaEndOfEpochTransactionKind::ChangeEpochV2(e.into())
+                            }
                             EndOfEpochTransactionKind::AuthenticatorStateCreate => {
                                 IotaEndOfEpochTransactionKind::AuthenticatorStateCreate
                             }
@@ -603,6 +606,9 @@ impl IotaTransactionBlockKind {
                             EndOfEpochTransactionKind::ChangeEpoch(e) => {
                                 IotaEndOfEpochTransactionKind::ChangeEpoch(e.into())
                             }
+                            EndOfEpochTransactionKind::ChangeEpochV2(e) => {
+                                IotaEndOfEpochTransactionKind::ChangeEpochV2(e.into())
+                            }
                             EndOfEpochTransactionKind::AuthenticatorStateCreate => {
                                 IotaEndOfEpochTransactionKind::AuthenticatorStateCreate
                             }
@@ -679,6 +685,42 @@ impl From<ChangeEpoch> for IotaChangeEpoch {
     }
 }
 
+#[serde_as]
+#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
+pub struct IotaChangeEpochV2 {
+    #[schemars(with = "BigInt<u64>")]
+    #[serde_as(as = "BigInt<u64>")]
+    pub epoch: EpochId,
+    #[schemars(with = "BigInt<u64>")]
+    #[serde_as(as = "BigInt<u64>")]
+    pub storage_charge: u64,
+    #[schemars(with = "BigInt<u64>")]
+    #[serde_as(as = "BigInt<u64>")]
+    pub computation_charge: u64,
+    #[schemars(with = "BigInt<u64>")]
+    #[serde_as(as = "BigInt<u64>")]
+    pub computation_charge_burned: u64,
+    #[schemars(with = "BigInt<u64>")]
+    #[serde_as(as = "BigInt<u64>")]
+    pub storage_rebate: u64,
+    #[schemars(with = "BigInt<u64>")]
+    #[serde_as(as = "BigInt<u64>")]
+    pub epoch_start_timestamp_ms: u64,
+}
+
+impl From<ChangeEpochV2> for IotaChangeEpochV2 {
+    fn from(e: ChangeEpochV2) -> Self {
+        Self {
+            epoch: e.epoch,
+            storage_charge: e.storage_charge,
+            computation_charge: e.computation_charge,
+            computation_charge_burned: e.computation_charge_burned,
+            storage_rebate: e.storage_rebate,
+            epoch_start_timestamp_ms: e.epoch_start_timestamp_ms,
+        }
+    }
+}
+
 #[derive(Debug, Deserialize, Serialize, JsonSchema, Clone, PartialEq, Eq)]
 #[enum_dispatch(IotaTransactionBlockEffectsAPI)]
 #[serde(
@@ -1035,10 +1077,12 @@ impl Display for IotaTransactionBlockEffects {
             "Gas Cost Summary:\n   \
              Storage Cost: {} NANOS\n   \
              Computation Cost: {} NANOS\n   \
+             Computation Cost Burned: {} NANOS\n   \
              Storage Rebate: {} NANOS\n   \
              Non-refundable Storage Fee: {} NANOS",
             gas_cost_summary.storage_cost,
             gas_cost_summary.computation_cost,
+            gas_cost_summary.computation_cost_burned,
             gas_cost_summary.storage_rebate,
             gas_cost_summary.non_refundable_storage_fee,
         )]);
@@ -1622,6 +1666,7 @@ pub struct IotaEndOfEpochTransaction {
 #[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
 pub enum IotaEndOfEpochTransactionKind {
     ChangeEpoch(IotaChangeEpoch),
+    ChangeEpochV2(IotaChangeEpochV2),
     AuthenticatorStateCreate,
     AuthenticatorStateExpire(IotaAuthenticatorStateExpire),
     BridgeStateCreate(CheckpointDigest),
diff --git a/crates/iota-json-rpc/src/coin_api.rs b/crates/iota-json-rpc/src/coin_api.rs
@@ -18,7 +18,9 @@ use iota_types::{
     coin::{CoinMetadata, TreasuryCap},
     effects::TransactionEffectsAPI,
     gas_coin::GAS,
-    iota_system_state::IotaSystemStateTrait,
+    iota_system_state::{
+        IotaSystemStateTrait, iota_system_state_summary::IotaSystemStateSummaryV2,
+    },
     object::Object,
     parse_iota_struct_tag,
 };
@@ -224,11 +226,12 @@ impl CoinReadApiServer for CoinReadApi {
         async move {
             let coin_struct = parse_to_struct_tag(&coin_type)?;
             Ok(if GAS::is_gas(&coin_struct) {
-                let system_state_summary = self
-                    .internal
-                    .get_state()
-                    .get_system_state()?
-                    .into_iota_system_state_summary();
+                let system_state_summary = IotaSystemStateSummaryV2::try_from(
+                    self.internal
+                        .get_state()
+                        .get_system_state()?
+                        .into_iota_system_state_summary(),
+                )?;
                 Supply {
                     value: system_state_summary.iota_total_supply,
                 }
@@ -1287,9 +1290,8 @@ mod tests {
             id::UID,
             iota_system_state::{
                 IotaSystemState,
-                iota_system_state_inner_v1::{
-                    IotaSystemStateV1, StorageFundV1, SystemParametersV1, ValidatorSetV1,
-                },
+                iota_system_state_inner_v1::{StorageFundV1, SystemParametersV1, ValidatorSetV1},
+                iota_system_state_inner_v2::IotaSystemStateV2,
             },
         };
         use mockall::predicate;
@@ -1305,7 +1307,7 @@ mod tests {
                 let mut state = default_system_state();
                 state.iota_treasury_cap.inner.total_supply.value = 42;
 
-                Ok(IotaSystemState::V1(state))
+                Ok(IotaSystemState::V2(state))
             });
 
             let coin_read_api = CoinReadApi::new_for_tests(Arc::new(mock_state), None);
@@ -1415,8 +1417,8 @@ mod tests {
             expected.assert_eq(error_result.message());
         }
 
-        fn default_system_state() -> IotaSystemStateV1 {
-            IotaSystemStateV1 {
+        fn default_system_state() -> IotaSystemStateV2 {
+            IotaSystemStateV2 {
                 epoch: Default::default(),
                 protocol_version: Default::default(),
                 system_state_version: Default::default(),
@@ -1464,7 +1466,8 @@ mod tests {
                 },
                 safe_mode: Default::default(),
                 safe_mode_storage_charges: iota_types::balance::Balance::new(Default::default()),
-                safe_mode_computation_rewards: iota_types::balance::Balance::new(Default::default()),
+                safe_mode_computation_charges: iota_types::balance::Balance::new(Default::default()),
+                safe_mode_computation_charges_burned: Default::default(),
                 safe_mode_storage_rebates: Default::default(),
                 safe_mode_non_refundable_storage_fee: Default::default(),
                 epoch_start_timestamp_ms: Default::default(),
diff --git a/crates/iota-json-rpc/src/governance_api.rs b/crates/iota-json-rpc/src/governance_api.rs
@@ -27,7 +27,7 @@ use iota_types::{
     iota_serde::BigInt,
     iota_system_state::{
         IotaSystemState, IotaSystemStateTrait, PoolTokenExchangeRate, get_validator_from_table,
-        iota_system_state_summary::IotaSystemStateSummary,
+        iota_system_state_summary::{IotaSystemStateSummaryV1, IotaSystemStateSummaryV2},
     },
     object::{Object, ObjectRead},
     timelock::timelocked_staked_iota::TimelockedStakedIota,
@@ -198,7 +198,9 @@ impl GovernanceReadApi {
         );
 
         let system_state = self.get_system_state()?;
-        let system_state_summary = system_state.clone().into_iota_system_state_summary();
+        let system_state_summary = IotaSystemStateSummaryV2::try_from(
+            system_state.clone().into_iota_system_state_summary(),
+        )?;
 
         let rates = exchange_rates(&self.state, system_state_summary.epoch)
             .await?
@@ -264,8 +266,9 @@ impl GovernanceReadApi {
         );
 
         let system_state = self.get_system_state()?;
-        let system_state_summary: IotaSystemStateSummary =
-            system_state.clone().into_iota_system_state_summary();
+        let system_state_summary = IotaSystemStateSummaryV2::try_from(
+            system_state.clone().into_iota_system_state_summary(),
+        )?;
 
         let rates = exchange_rates(&self.state, system_state_summary.epoch)
             .await?
@@ -400,13 +403,26 @@ impl GovernanceReadApiServer for GovernanceReadApi {
     }
 
     #[instrument(skip(self))]
-    async fn get_latest_iota_system_state(&self) -> RpcResult<IotaSystemStateSummary> {
+    async fn get_latest_iota_system_state(&self) -> RpcResult<IotaSystemStateSummaryV2> {
         async move {
             Ok(self
                 .state
-                .get_system_state()
-                .map_err(Error::from)?
-                .into_iota_system_state_summary())
+                .get_system_state()?
+                .into_iota_system_state_summary()
+                .try_into()?)
+        }
+        .trace()
+        .await
+    }
+
+    #[instrument(skip(self))]
+    async fn get_latest_iota_system_state_v1(&self) -> RpcResult<IotaSystemStateSummaryV1> {
+        async move {
+            Ok(self
+                .state
+                .get_system_state()?
+                .into_iota_system_state_summary()
+                .try_into()?)
         }
         .trace()
         .await
@@ -425,8 +441,7 @@ impl GovernanceReadApiServer for GovernanceReadApi {
     #[instrument(skip(self))]
     async fn get_validators_apy(&self) -> RpcResult<ValidatorApys> {
         info!("get_validator_apy");
-        let system_state_summary: IotaSystemStateSummary =
-            self.get_latest_iota_system_state().await?;
+        let system_state_summary = self.get_latest_iota_system_state().await?;
 
         let exchange_rate_table = exchange_rates(&self.state, system_state_summary.epoch)
             .await
@@ -592,7 +607,9 @@ fn validator_exchange_rates(
 fn active_validators_exchange_rates(
     state: &Arc<dyn StateRead>,
 ) -> RpcInterimResult<Vec<ValidatorExchangeRates>> {
-    let system_state_summary = state.get_system_state()?.into_iota_system_state_summary();
+    let system_state_summary = IotaSystemStateSummaryV2::try_from(
+        state.get_system_state()?.into_iota_system_state_summary(),
+    )?;
 
     let tables = system_state_summary
         .active_validators
@@ -615,7 +632,9 @@ fn active_validators_exchange_rates(
 fn inactive_validators_exchange_rates(
     state: &Arc<dyn StateRead>,
 ) -> RpcInterimResult<Vec<ValidatorExchangeRates>> {
-    let system_state_summary = state.get_system_state()?.into_iota_system_state_summary();
+    let system_state_summary = IotaSystemStateSummaryV2::try_from(
+        state.get_system_state()?.into_iota_system_state_summary(),
+    )?;
 
     let tables = validator_summary_from_system_state(
         state,
@@ -664,7 +683,9 @@ fn pending_validators_exchange_rate(
 fn candidate_validators_exchange_rate(
     state: &Arc<dyn StateRead>,
 ) -> RpcInterimResult<Vec<ValidatorExchangeRates>> {
-    let system_state_summary = state.get_system_state()?.into_iota_system_state_summary();
+    let system_state_summary = IotaSystemStateSummaryV2::try_from(
+        state.get_system_state()?.into_iota_system_state_summary(),
+    )?;
 
     // From validator_candidates_id table get validator info using as key its
     // IotaAddress
diff --git a/crates/iota-open-rpc/spec/openrpc.json b/crates/iota-open-rpc/spec/openrpc.json
diff --git a/crates/iota-types/src/iota_system_state/iota_system_state_summary.rs b/crates/iota-types/src/iota_system_state/iota_system_state_summary.rs
