From 61dc132b7d627304c1cc65dcb4046f3df7c16154 Mon Sep 17 00:00:00 2001 From: Ge Gao <106119108+gegaowp@users.noreply.github.com> Date: Tue, 20 Aug 2024 22:08:06 -0400 Subject: [PATCH] indexer:add experimental warning (#18890) --- crates/sui-indexer/README.md | 2 ++ crates/sui-indexer/src/main.rs | 3 ++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/crates/sui-indexer/README.md b/crates/sui-indexer/README.md index cce84ca39feba..d81a7f2e89910 100644 --- a/crates/sui-indexer/README.md +++ b/crates/sui-indexer/README.md @@ -1,5 +1,7 @@ Sui indexer is an off-fullnode service to serve data from Sui protocol, including both data directly generated from chain and derivative data. +⚠ **Warning:** Sui indexer is still experimental and we expect occasional breaking changes that require backfills. + ## Architecture ![enhanced_FN](https://user-images.githubusercontent.com/106119108/221022505-a1d873c6-60e2-45f1-b2aa-e50192c4dfbb.png) diff --git a/crates/sui-indexer/src/main.rs b/crates/sui-indexer/src/main.rs index 02a92f7a507b2..dbb95bbc991a6 100644 --- a/crates/sui-indexer/src/main.rs +++ b/crates/sui-indexer/src/main.rs @@ -2,7 +2,7 @@ // SPDX-License-Identifier: Apache-2.0 use clap::Parser; -use tracing::info; +use tracing::{info, warn}; use sui_indexer::errors::IndexerError; use sui_indexer::metrics::start_prometheus_server; @@ -14,6 +14,7 @@ async fn main() -> Result<(), IndexerError> { let _guard = telemetry_subscribers::TelemetryConfig::new() .with_env() .init(); + warn!("WARNING: Sui indexer is still experimental and we expect occasional breaking changes that require backfills."); let mut indexer_config = IndexerConfig::parse(); // TODO: remove. Temporary safeguard to migrate to `rpc_client_url` usage