feat(protocol): PCR-2 iota-indexer (#5278)

cyberphysic4l · kodemartin · Thoralf-M · alexsporn · commit 1b98c13c77a4 · 2025-02-21T15:10:53.000+01:00
* iota-indexer changes * refactor(indexer): use new system state summary (#5477) * refactor(indexer): add burned computation cost to schema * refactor(indexer)!: use new system-state summary type * Update crates/iota-indexer/src/handlers/checkpoint_handler.rs Co-authored-by: Thoralf-M <46689931+Thoralf-M@users.noreply.github.com> --------- Co-authored-by: Konstantinos Demartinos <konstantinos.demartinos@iota.org> Co-authored-by: Thoralf-M <46689931+Thoralf-M@users.noreply.github.com>
diff --git a/crates/iota-indexer/migrations/pg/2025-02-18-124652_checkpoints-add-computation-cost-burned/down.sql b/crates/iota-indexer/migrations/pg/2025-02-18-124652_checkpoints-add-computation-cost-burned/down.sql
@@ -0,0 +1,2 @@
+ALTER TABLE checkpoints
+DROP COLUMN computation_cost_burned;
diff --git a/crates/iota-indexer/migrations/pg/2025-02-18-124652_checkpoints-add-computation-cost-burned/up.sql b/crates/iota-indexer/migrations/pg/2025-02-18-124652_checkpoints-add-computation-cost-burned/up.sql
@@ -0,0 +1,3 @@
+-- Your SQL goes here
+ALTER TABLE checkpoints
+ADD COLUMN computation_cost_burned BIGINT;
diff --git a/crates/iota-indexer/src/apis/coin_api.rs b/crates/iota-indexer/src/apis/coin_api.rs
@@ -17,7 +17,7 @@ use iota_types::{
 };
 use jsonrpsee::{RpcModule, core::RpcResult};
 
-use crate::indexer_reader::IndexerReader;
+use crate::{indexer_reader::IndexerReader, types::IotaSystemStateSummaryView};
 
 pub(crate) struct CoinReadApi {
     inner: IndexerReader,
@@ -142,7 +142,7 @@ impl CoinReadApiServer for CoinReadApi {
                     .inner
                     .spawn_blocking(|this| this.get_latest_iota_system_state())
                     .await?
-                    .iota_total_supply,
+                    .iota_total_supply(),
             })
         } else {
             self.inner
diff --git a/crates/iota-indexer/src/apis/governance_api.rs b/crates/iota-indexer/src/apis/governance_api.rs
@@ -21,14 +21,21 @@ use iota_types::{
     governance::StakedIota,
     id::ID,
     iota_serde::BigInt,
-    iota_system_state::{PoolTokenExchangeRate, iota_system_state_summary::IotaSystemStateSummary},
+    iota_system_state::{
+        PoolTokenExchangeRate,
+        iota_system_state_summary::{
+            IotaSystemStateSummary, IotaSystemStateSummaryV1, IotaSystemStateSummaryV2,
+        },
+    },
     timelock::timelocked_staked_iota::TimelockedStakedIota,
 };
 use jsonrpsee::{RpcModule, core::RpcResult};
 use serde::{Serialize, de::DeserializeOwned};
 use tokio::sync::Mutex;
 
-use crate::{errors::IndexerError, indexer_reader::IndexerReader};
+use crate::{
+    errors::IndexerError, indexer_reader::IndexerReader, types::IotaSystemStateSummaryView,
+};
 
 /// Maximum amount of staked objects for querying.
 const MAX_QUERY_STAKED_OBJECTS: usize = 1000;
@@ -63,9 +70,8 @@ impl GovernanceReadApi {
     }
 
     async fn get_validators_apy(&self) -> Result<ValidatorApys, IndexerError> {
-        let system_state_summary: IotaSystemStateSummary =
-            self.get_latest_iota_system_state().await?;
-        let epoch = system_state_summary.epoch;
+        let system_state_summary = self.get_latest_iota_system_state().await?;
+        let epoch = system_state_summary.epoch();
 
         let exchange_rate_table = self.exchange_rates(&system_state_summary).await?;
 
@@ -170,7 +176,7 @@ impl GovernanceReadApi {
             });
 
         let system_state_summary = self.get_latest_iota_system_state().await?;
-        let epoch = system_state_summary.epoch;
+        let epoch = system_state_summary.epoch();
 
         let (candidate_rates, pending_rates) = tokio::try_join!(
             self.candidate_validators_exchange_rate(&system_state_summary),
@@ -236,7 +242,7 @@ impl GovernanceReadApi {
             });
 
         let system_state_summary = self.get_latest_iota_system_state().await?;
-        let epoch = system_state_summary.epoch;
+        let epoch = system_state_summary.epoch();
 
         let rates = self
             .exchange_rates(&system_state_summary)
@@ -359,7 +365,7 @@ impl GovernanceReadApi {
         &self,
         system_state_summary: &IotaSystemStateSummary,
     ) -> Result<Vec<ValidatorExchangeRates>, IndexerError> {
-        let epoch = system_state_summary.epoch;
+        let epoch = system_state_summary.epoch();
 
         let mut cache = self.exchange_rates_cache.lock().await;
 
@@ -399,7 +405,7 @@ impl GovernanceReadApi {
         system_state_summary: &IotaSystemStateSummary,
     ) -> Result<Vec<ValidatorExchangeRates>, IndexerError> {
         let tables = system_state_summary
-            .active_validators
+            .active_validators()
             .iter()
             .map(|validator| {
                 (
@@ -422,8 +428,8 @@ impl GovernanceReadApi {
     ) -> Result<Vec<ValidatorExchangeRates>, IndexerError> {
         let tables = self
             .validator_summary_from_system_state(
-                system_state_summary.inactive_pools_id,
-                system_state_summary.inactive_pools_size,
+                system_state_summary.inactive_pools_id(),
+                system_state_summary.inactive_pools_size(),
                 |df| bcs::from_bytes::<ID>(&df.bcs_name).map_err(Into::into),
             )
             .await?;
@@ -470,8 +476,8 @@ impl GovernanceReadApi {
     ) -> Result<Vec<ValidatorExchangeRates>, IndexerError> {
         let tables = self
             .validator_summary_from_system_state(
-                system_state_summary.validator_candidates_id,
-                system_state_summary.validator_candidates_size,
+                system_state_summary.validator_candidates_id(),
+                system_state_summary.validator_candidates_size(),
                 |df| bcs::from_bytes::<IotaAddress>(&df.bcs_name).map_err(Into::into),
             )
             .await?;
@@ -502,9 +508,9 @@ impl GovernanceReadApi {
     /// let system_state_summary = self.get_latest_iota_system_state().await?;
     /// let _ = self.validator_summary_from_system_state(
     ///        // ID of the object that maps from a staking pool ID to the inactive validator that has that pool as its staking pool
-    ///        system_state_summary.inactive_pools_id,
+    ///        system_state_summary.inactive_pools_id(),
     ///        // Number of inactive staking pools
-    ///        system_state_summary.inactive_pools_size,
+    ///        system_state_summary.inactive_pools_size(),
     ///        // Extract the `ID` of the `Inactive` validator from the `DynamicFieldInfo` in the `system_state_summary.inactive_pools_id` table
     ///        |df| bcs::from_bytes::<ID>(&df.bcs_name).map_err(Into::into),
     /// ).await?;
@@ -517,9 +523,9 @@ impl GovernanceReadApi {
     /// let system_state_summary = self.get_latest_iota_system_state().await?;
     /// let _ = self.validator_summary_from_system_state(
     ///        // ID of the object that stores preactive validators, mapping their addresses to their Validator structs
-    ///        system_state_summary.validator_candidates_id,
+    ///        system_state_summary.validator_candidates_id(),
     ///        // Number of preactive validators
-    ///        system_state_summary.validator_candidates_size,
+    ///        system_state_summary.validator_candidates_size(),
     ///        // Extract the `IotaAddress` of the `Candidate` validator from the `DynamicFieldInfo` in the `system_state_summary.validator_candidates_id` table
     ///        |df| bcs::from_bytes::<IotaAddress>(&df.bcs_name).map_err(Into::into),
     /// ).await?;
@@ -683,10 +689,20 @@ impl GovernanceReadApiServer for GovernanceReadApi {
         Ok(epoch.committee().map_err(IndexerError::from)?.into())
     }
 
-    async fn get_latest_iota_system_state(&self) -> RpcResult<IotaSystemStateSummary> {
-        self.get_latest_iota_system_state()
-            .await
-            .map_err(Into::into)
+    async fn get_latest_iota_system_state(&self) -> RpcResult<IotaSystemStateSummaryV2> {
+        Ok(self
+            .get_latest_iota_system_state()
+            .await?
+            .try_into()
+            .map_err(IndexerError::from)?)
+    }
+
+    async fn get_latest_iota_system_state_v1(&self) -> RpcResult<IotaSystemStateSummaryV1> {
+        Ok(self
+            .get_latest_iota_system_state()
+            .await?
+            .try_into()
+            .map_err(IndexerError::from)?)
     }
 
     async fn get_reference_gas_price(&self) -> RpcResult<BigInt<u64>> {
diff --git a/crates/iota-indexer/src/handlers/checkpoint_handler.rs b/crates/iota-indexer/src/handlers/checkpoint_handler.rs
@@ -18,11 +18,8 @@ use iota_types::{
     base_types::ObjectID,
     dynamic_field::{DynamicFieldInfo, DynamicFieldName, DynamicFieldType},
     effects::TransactionEffectsAPI,
-    event::SystemEpochInfoEventV1,
-    iota_system_state::{
-        IotaSystemStateTrait, get_iota_system_state,
-        iota_system_state_summary::IotaSystemStateSummary,
-    },
+    event::{SystemEpochInfoEvent, SystemEpochInfoEventV1, SystemEpochInfoEventV2},
+    iota_system_state::{IotaSystemStateTrait, get_iota_system_state},
     messages_checkpoint::{
         CertifiedCheckpointSummary, CheckpointContents, CheckpointSequenceNumber,
     },
@@ -55,7 +52,8 @@ use crate::{
     },
     types::{
         EventIndex, IndexedCheckpoint, IndexedDeletedObject, IndexedEpochInfo, IndexedEvent,
-        IndexedObject, IndexedPackage, IndexedTransaction, IndexerResult, TransactionKind, TxIndex,
+        IndexedObject, IndexedPackage, IndexedTransaction, IndexerResult,
+        IotaSystemStateSummaryView, TransactionKind, TxIndex,
     },
 };
 
@@ -205,14 +203,14 @@ impl CheckpointHandler {
         } = data;
 
         // Genesis epoch
+        let system_state =
+            get_iota_system_state(&checkpoint_object_store)?.into_iota_system_state_summary();
         if *checkpoint_summary.sequence_number() == 0 {
             info!("Processing genesis epoch");
-            let system_state: IotaSystemStateSummary =
-                get_iota_system_state(&checkpoint_object_store)?.into_iota_system_state_summary();
             return Ok(Some(EpochToCommit {
                 last_epoch: None,
                 new_epoch: IndexedEpochInfo::from_new_system_state_summary(
-                    system_state,
+                    &system_state,
                     0, // first_checkpoint_id
                     None,
                 ),
@@ -225,23 +223,33 @@ impl CheckpointHandler {
             return Ok(None);
         }
 
-        let system_state: IotaSystemStateSummary =
-            get_iota_system_state(&checkpoint_object_store)?.into_iota_system_state_summary();
-
-        let epoch_event = transactions
+        let event = transactions
             .iter()
             .flat_map(|t| t.events.as_ref().map(|e| &e.data))
             .flatten()
-            .find(|ev| ev.is_system_epoch_info_event())
+            .find(|ev| ev.is_system_epoch_info_event_v1() || ev.is_system_epoch_info_event_v2())
+            .map(|ev| {
+                if ev.is_system_epoch_info_event_v2() {
+                    SystemEpochInfoEvent::V2(
+                        bcs::from_bytes::<SystemEpochInfoEventV2>(&ev.contents).expect(
+                            "event deserialization should succeed as type was pre-validated",
+                        ),
+                    )
+                } else {
+                    SystemEpochInfoEvent::V1(
+                        bcs::from_bytes::<SystemEpochInfoEventV1>(&ev.contents).expect(
+                            "event deserialization should succeed as type was pre-validated",
+                        ),
+                    )
+                }
+            })
             .unwrap_or_else(|| {
                 panic!(
-                    "Can't find SystemEpochInfoEventV1 in epoch end checkpoint {}",
+                    "Can't find SystemEpochInfoEvent in epoch end checkpoint {}",
                     checkpoint_summary.sequence_number()
                 )
             });
 
-        let event = bcs::from_bytes::<SystemEpochInfoEventV1>(&epoch_event.contents)?;
-
         // Now we just entered epoch X, we want to calculate the diff between
         // TotalTransactionsByEndOfEpoch(X-1) and TotalTransactionsByEndOfEpoch(X-2).
         // Note that on the indexer's chain-reading side, this is not guaranteed
@@ -250,11 +258,12 @@ impl CheckpointHandler {
         // guarantee that the previous epoch's checkpoints have been written to
         // db.
 
-        let network_tx_count_prev_epoch = match system_state.epoch {
+        let epoch = system_state.epoch();
+        let network_tx_count_prev_epoch = match epoch {
             // If first epoch change, this number is 0
             1 => Ok(0),
             _ => {
-                let last_epoch = system_state.epoch - 2;
+                let last_epoch = epoch - 2;
                 state
                     .get_network_total_transactions_by_end_of_epoch(last_epoch)
                     .await
@@ -269,7 +278,7 @@ impl CheckpointHandler {
                 network_tx_count_prev_epoch,
             )),
             new_epoch: IndexedEpochInfo::from_new_system_state_summary(
-                system_state,
+                &system_state,
                 checkpoint_summary.sequence_number + 1, // first_checkpoint_id
                 Some(&event),
             ),
diff --git a/crates/iota-indexer/src/models/checkpoints.rs b/crates/iota-indexer/src/models/checkpoints.rs
@@ -39,6 +39,7 @@ pub struct StoredCheckpoint {
     pub end_of_epoch_data: Option<Vec<u8>>,
     pub min_tx_sequence_number: Option<i64>,
     pub max_tx_sequence_number: Option<i64>,
+    pub computation_cost_burned: Option<i64>,
 }
 
 impl From<&IndexedCheckpoint> for StoredCheckpoint {
@@ -60,6 +61,7 @@ impl From<&IndexedCheckpoint> for StoredCheckpoint {
             timestamp_ms: c.timestamp_ms as i64,
             total_gas_cost: c.total_gas_cost,
             computation_cost: c.computation_cost as i64,
+            computation_cost_burned: Some(c.computation_cost_burned as i64),
             storage_cost: c.storage_cost as i64,
             storage_rebate: c.storage_rebate as i64,
             non_refundable_storage_fee: c.non_refundable_storage_fee as i64,
@@ -147,6 +149,9 @@ impl TryFrom<StoredCheckpoint> for RpcCheckpoint {
             })
             .transpose()?;
 
+        let computation_cost_burned = checkpoint
+            .computation_cost_burned
+            .unwrap_or(checkpoint.computation_cost) as u64;
         Ok(RpcCheckpoint {
             epoch: checkpoint.epoch as u64,
             sequence_number: checkpoint.sequence_number as u64,
@@ -155,9 +160,7 @@ impl TryFrom<StoredCheckpoint> for RpcCheckpoint {
             end_of_epoch_data,
             epoch_rolling_gas_cost_summary: GasCostSummary {
                 computation_cost: checkpoint.computation_cost as u64,
-                // TODO_FIXED_BASE_FEE: update computation cost burned in checkpoint to be used
-                // here in issue #3122
-                computation_cost_burned: checkpoint.computation_cost as u64,
+                computation_cost_burned,
                 storage_cost: checkpoint.storage_cost as u64,
                 storage_rebate: checkpoint.storage_rebate as u64,
                 non_refundable_storage_fee: checkpoint.non_refundable_storage_fee as u64,
diff --git a/crates/iota-indexer/src/models/epoch.rs b/crates/iota-indexer/src/models/epoch.rs
@@ -9,7 +9,7 @@ use iota_types::iota_system_state::iota_system_state_summary::IotaSystemStateSum
 use crate::{
     errors::IndexerError,
     schema::{epochs, feature_flags, protocol_configs},
-    types::IndexedEpochInfo,
+    types::{IndexedEpochInfo, IotaSystemStateSummaryView},
 };
 
 #[derive(Queryable, Insertable, Debug, Clone, Default)]
@@ -165,7 +165,7 @@ impl TryFrom<StoredEpochInfo> for EpochInfo {
         Ok(EpochInfo {
             epoch: value.epoch as u64,
             validators: system_state
-                .map(|s| s.active_validators)
+                .map(|s| s.active_validators().to_vec())
                 .unwrap_or_default(),
             epoch_total_transactions: value.epoch_total_transactions.unwrap_or(0) as u64,
             first_checkpoint_id: value.first_checkpoint_id as u64,
diff --git a/crates/iota-indexer/src/schema.rs b/crates/iota-indexer/src/schema.rs
@@ -60,6 +60,7 @@ diesel::table! {
         end_of_epoch_data -> Nullable<Bytea>,
         min_tx_sequence_number -> Nullable<Int8>,
         max_tx_sequence_number -> Nullable<Int8>,
+        computation_cost_burned -> Nullable<Int8>,
     }
 }
 
diff --git a/crates/iota-indexer/src/types.rs b/crates/iota-indexer/src/types.rs

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+ALTER TABLE checkpoints`
	`2`	`+DROP COLUMN computation_cost_burned;`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+-- Your SQL goes here`
	`2`	`+ALTER TABLE checkpoints`
	`3`	`+ADD COLUMN computation_cost_burned BIGINT;`
Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,7 @@ diesel::table! {`
`60`	`60`	`end_of_epoch_data -> Nullable<Bytea>,`
`61`	`61`	`min_tx_sequence_number -> Nullable<Int8>,`
`62`	`62`	`max_tx_sequence_number -> Nullable<Int8>,`
	`63`	`+ computation_cost_burned -> Nullable<Int8>,`
`63`	`64`	`}`
`64`	`65`	`}`
`65`	`66`