fix(indexer): fix event detection with different packages (#1036)

Thoralf-M · thibault-martinez · web-flow · commit 361a435c4293 · 2026-01-09T13:20:47.000+01:00
* fix(indexer): fix and future proof event detection with different packages

* clippy

* clippy

* address review comments

* cleanup

* typos: allow packageid

* log checkpoint for events only once

* add check that event package ids aren't empty, cleanup

* Update .typos.toml

* Update indexer/src/config.rs

---------

Co-authored-by: Thibault Martinez &lt;thibault@iota.org&gt;
diff --git a/.typos.toml b/.typos.toml
@@ -9,6 +9,7 @@ extend-ignore-identifiers-re = [
   "^[a-zA-Z0-9_]{47}$",
   "^[a-zA-Z0-9_]{49}$",
   "^[a-zA-Z0-9_]{56,}$",
+  "^packageid$",
 ]
 
 [files]
diff --git a/indexer/README.md b/indexer/README.md
@@ -12,7 +12,10 @@ Run the following commands also from the root directory.
 ### Set the environment variables
 
 ```bash
-cd scripts && pnpm ts-node utils/envs.ts localnet > ../indexer/docker/.env && cd ..
+# localnet
+cd scripts && pnpm run envsForIndexer localnet ../indexer/docker/.env && cd ..
+# testnet
+cd scripts && pnpm run envsForIndexer testnet ../indexer/docker/.env && cd ..
 ```
 
 ### Build the indexer image
diff --git a/indexer/docker/docker-compose.yml b/indexer/docker/docker-compose.yml
@@ -1,9 +1,6 @@
 services:
   iota-names-indexer:
     container_name: iota-names-indexer
-    depends_on:
-      prometheus:
-        condition: service_started
     build:
       context: ..
       dockerfile: docker/Dockerfile
@@ -40,6 +37,7 @@ services:
       - IOTA_NAMES_SUBNAMES_PACKAGE_ADDRESS=${IOTA_NAMES_SUBNAMES_PACKAGE_ADDRESS}
       - IOTA_NAMES_TEMP_SUBNAME_PROXY_PACKAGE_ADDRESS=${IOTA_NAMES_TEMP_SUBNAME_PROXY_PACKAGE_ADDRESS}
       - IOTA_NAMES_AUCTION_HOUSE_OBJECT_ID=${IOTA_NAMES_AUCTION_HOUSE_OBJECT_ID}
+      - EVENT_PACKAGE_IDS=${EVENT_PACKAGE_IDS}
     extra_hosts:
       - "host.docker.internal:host-gateway"
     command:
diff --git a/indexer/docker/update_progress.sh b/indexer/docker/update_progress.sh
@@ -0,0 +1,33 @@
+#!/bin/bash
+
+# This script updates the progress_store file for the iota-names-indexer.
+# It can be used for testing by skipping syncing large parts of the history
+# and testing only from specific checkpoints, allowing faster test runs.
+
+# Testnet checkpoints for reference:
+# Name bought with package id v2 161879819 https://explorer.iota.org/txblock/HkK2osCd8Wj8jh7dsTBB1xTVZmHJbFm7Y27XTuGncws8?network=testnet
+# ./indexer/docker/update_progress.sh 161879819 
+
+if [ $# -ne 1 ]; then
+  echo "Usage: $0 <new_progress_value>"
+  exit 1
+fi
+
+NEW_VALUE=$1
+
+cd "$(dirname "$0")"
+
+echo "Stopping the iota-names-indexer container..."
+docker-compose down
+
+echo "Updating progress_store to $NEW_VALUE..."
+sudo rm -f /tmp/progress_store
+sudo sh -c "echo '{\"iota_names_reader\": $NEW_VALUE}' > /tmp/progress_store"
+
+echo "Copying updated file to volume..."
+sudo cp /tmp/progress_store /var/lib/docker/volumes/docker_indexer_progress/_data/progress_store
+
+echo "Restarting the container..."
+
+docker-compose up
+
diff --git a/indexer/src/config.rs b/indexer/src/config.rs
@@ -1,7 +1,7 @@
 // Copyright (c) 2025 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
-use std::str::FromStr;
+use std::{collections::HashSet, str::FromStr};
 
 use iota_names::config::IotaNamesConfig;
 use iota_protocol_config::Chain;
@@ -21,6 +21,9 @@ pub struct IotaNamesExtendedConfig {
     pub subname_proxy_package_address: IotaAddress,
     /// ID of the `AuctionHouse` object.
     pub auction_house_id: ObjectID,
+    /// List of package addresses for events. Not strictly defined to support
+    /// new versions.
+    pub event_package_ids: HashSet<IotaAddress>,
     pub iota_names_config: IotaNamesConfig,
 }
 
@@ -38,6 +41,7 @@ impl IotaNamesExtendedConfig {
         subnames_package_address: IotaAddress,
         subname_proxy_package_address: IotaAddress,
         auction_house_id: ObjectID,
+        event_package_ids: HashSet<IotaAddress>,
         iota_names_config: IotaNamesConfig,
     ) -> Self {
         Self {
@@ -46,19 +50,25 @@ impl IotaNamesExtendedConfig {
             subnames_package_address,
             subname_proxy_package_address,
             auction_house_id,
+            event_package_ids,
             iota_names_config,
         }
     }
 
     pub fn from_env() -> anyhow::Result<Self> {
         let iota_names_config = IotaNamesConfig::from_env()?;
 
+        let event_package_ids: HashSet<IotaAddress> = serde_json::from_str(
+            &std::env::var("EVENT_PACKAGE_IDS").unwrap_or_else(|_| "[]".to_string()),
+        )?;
+
         Ok(Self::new(
             std::env::var("IOTA_NAMES_AUCTION_PACKAGE_ADDRESS")?.parse()?,
             std::env::var("IOTA_NAMES_COUPONS_PACKAGE_ADDRESS")?.parse()?,
             std::env::var("IOTA_NAMES_SUBNAMES_PACKAGE_ADDRESS")?.parse()?,
             std::env::var("IOTA_NAMES_TEMP_SUBNAME_PROXY_PACKAGE_ADDRESS")?.parse()?,
             std::env::var("IOTA_NAMES_AUCTION_HOUSE_OBJECT_ID")?.parse()?,
+            event_package_ids,
             iota_names_config,
         ))
     }
@@ -94,13 +104,24 @@ impl IotaNamesExtendedConfig {
             IotaAddress::from_str(TEMP_SUBNAME_PROXY_PACKAGE_ADDRESS).unwrap();
         let auction_house_id = ObjectID::from_str(AUCTION_HOUSE_ID).unwrap();
 
+        let iota_names_config = IotaNamesConfig::testnet();
+        let event_package_ids = HashSet::from([
+            auction_package_address,
+            coupons_package_address,
+            subnames_package_address,
+            subname_proxy_package_address,
+            iota_names_config.package_address,
+            iota_names_config.payments_package_address,
+        ]);
+
         Self::new(
             auction_package_address,
             coupons_package_address,
             subnames_package_address,
             subname_proxy_package_address,
             auction_house_id,
-            IotaNamesConfig::testnet(),
+            event_package_ids,
+            iota_names_config,
         )
     }
 
@@ -124,25 +145,31 @@ impl IotaNamesExtendedConfig {
             IotaAddress::from_str(TEMP_SUBNAME_PROXY_PACKAGE_ADDRESS).unwrap();
         let auction_house_id = ObjectID::from_str(AUCTION_HOUSE_ID).unwrap();
 
+        let iota_names_config = IotaNamesConfig::devnet();
+        let event_package_ids = HashSet::from([
+            auction_package_address,
+            coupons_package_address,
+            subnames_package_address,
+            subname_proxy_package_address,
+            iota_names_config.package_address,
+            iota_names_config.payments_package_address,
+        ]);
+
         Self::new(
             auction_package_address,
             coupons_package_address,
             subnames_package_address,
             subname_proxy_package_address,
             auction_house_id,
-            IotaNamesConfig::devnet(),
+            event_package_ids,
+            iota_names_config,
         )
     }
 
     /// Checks whether the given package address is an IOTA-Names one.
     pub fn is_iota_names_package(&self, package_address: impl Into<IotaAddress>) -> bool {
         let package_address = package_address.into();
 
-        package_address == self.auction_package_address
-            || package_address == self.coupons_package_address
-            || package_address == self.iota_names_config.package_address
-            || package_address == self.iota_names_config.payments_package_address
-            || package_address == self.subnames_package_address
-            || package_address == self.subname_proxy_package_address
+        self.event_package_ids.contains(&package_address)
     }
 }
diff --git a/indexer/src/events.rs b/indexer/src/events.rs
@@ -7,6 +7,7 @@ use serde::{Deserialize, Serialize};
 
 use crate::config::IotaNamesExtendedConfig;
 
+#[derive(Debug)]
 pub(crate) enum IotaNamesEvent {
     // `auctions`
     AuctionStarted(AuctionStartedEvent),
@@ -36,7 +37,7 @@ impl IotaNamesEvent {
         event: &Event,
         config: &IotaNamesExtendedConfig,
     ) -> anyhow::Result<Option<Self>> {
-        if !config.is_iota_names_package(event.package_id) {
+        if !config.is_iota_names_package(event.type_.address) {
             return Ok(None);
         }
 
@@ -77,7 +78,7 @@ impl IotaNamesEvent {
 
 // `auctions`
 
-#[derive(Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize)]
 pub(crate) struct AuctionStartedEvent {
     pub name: Name,
     pub start_timestamp_ms: u64,
@@ -86,20 +87,20 @@ pub(crate) struct AuctionStartedEvent {
     pub bidder: IotaAddress,
 }
 
-#[derive(Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize)]
 pub(crate) struct AuctionBidEvent {
     pub name: Name,
     pub bid: u64,
     pub bidder: IotaAddress,
 }
 
-#[derive(Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize)]
 pub(crate) struct AuctionExtendedEvent {
     pub name: Name,
     pub end_timestamp_ms: u64,
 }
 
-#[derive(Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize)]
 pub(crate) struct AuctionFinalizedEvent {
     pub name: Name,
     pub start_timestamp_ms: u64,
@@ -110,63 +111,63 @@ pub(crate) struct AuctionFinalizedEvent {
 
 // `coupons`
 
-#[derive(Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize)]
 #[repr(u8)]
 pub enum CouponKind {
     Percentage = 0,
     Fixed = 1,
 }
 
-#[derive(Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize)]
 pub struct CouponAppliedEvent {
     pub kind: CouponKind,
     pub discount: u64,
 }
 
 // `iota-names`
 
-#[derive(Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize)]
 pub(crate) struct NameRecordAddedEvent {
     pub name: Name,
     pub name_record: NameRecord,
 }
 
-#[derive(Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize)]
 pub(crate) struct NameRecordRemovedEvent {
     pub name: Name,
 }
 
-#[derive(Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize)]
 pub(crate) struct TargetAddressSetEvent {
     pub name: Name,
     pub target_address: Option<IotaAddress>,
 }
 
-#[derive(Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize)]
 pub(crate) struct ReverseLookupSetEvent {
     pub default_address: IotaAddress,
     pub default_name: Name,
 }
 
-#[derive(Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize)]
 pub(crate) struct ReverseLookupUnsetEvent {
     pub default_address: IotaAddress,
     pub default_name: Name,
 }
 
-#[derive(Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize)]
 pub(crate) struct UserDataSetEvent {
     pub key: String,
     pub value: String,
     pub new: bool,
 }
 
-#[derive(Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize)]
 pub(crate) struct UserDataUnsetEvent {
     pub key: String,
 }
 
-#[derive(Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize)]
 pub(crate) struct TransactionEvent {
     pub app: String,
     pub name: Name,
@@ -181,26 +182,26 @@ pub(crate) struct TransactionEvent {
 
 // `subnames`
 
-#[derive(Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize)]
 pub struct NodeSubnameCreatedEvent {
     pub name: Name,
     pub expiration_timestamp_ms: u64,
     pub allow_creation: bool,
     pub allow_time_extension: bool,
 }
 
-#[derive(Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize)]
 pub struct NodeSubnameBurnedEvent {
     pub name: Name,
 }
 
-#[derive(Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize)]
 pub struct LeafSubnameCreatedEvent {
     pub name: Name,
     pub target: IotaAddress,
 }
 
-#[derive(Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize)]
 pub struct LeafSubnameRemovedEvent {
     pub name: Name,
 }
diff --git a/indexer/src/main.rs b/indexer/src/main.rs
@@ -143,6 +143,9 @@ impl Command {
                         IotaNamesExtendedConfig::from_chain(&chain)
                     }
                 };
+                if iota_names_config.event_package_ids.is_empty() {
+                    panic!("No EVENT_PACKAGE_IDS provided in the environment variables");
+                }
                 info!("Starting with IOTA-Names config: {iota_names_config:#?}");
                 tasks.spawn(async move {
                     let worker = IotaNamesWorker::new(
diff --git a/indexer/src/worker.rs b/indexer/src/worker.rs
diff --git a/scripts/package.json b/scripts/package.json
diff --git a/scripts/utils/envsForIndexer.ts b/scripts/utils/envsForIndexer.ts

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ extend-ignore-identifiers-re = [`
`9`	`9`	`"^[a-zA-Z0-9_]{47}$",`
`10`	`10`	`"^[a-zA-Z0-9_]{49}$",`
`11`	`11`	`"^[a-zA-Z0-9_]{56,}$",`
	`12`	`+ "^packageid$",`
`12`	`13`	`]`
`13`	`14`
`14`	`15`	`[files]`