Skip to main content

Custom Indexer

You can build custom indexers using the Sui micro-data ingestion framework. To create an indexer, you subscribe to a checkpoint stream with full checkpoint content. This stream can be one of the publicly available streams from Mysten Labs, one that you set up in your local environment, or a combination of the two.

Establishing a custom indexer helps improve latency, allows pruning the data of your Sui Full node, and provides efficient assemblage of checkpoint data.

Interface and data format​

To use the framework, implement a basic interface:

#[async_trait]
trait Worker: Send + Sync {
    async fn process_checkpoint(&self, checkpoint: CheckpointData) -> Result<()>;
}

In this example, the CheckpointData struct represents full checkpoint content. The struct contains checkpoint summary and contents, as well as detailed information about each individual transaction. The individual transaction data includes events and input/output objects. The full definition for this content is in the full_checkpoint_content.rs file of the sui-types crate.

tip

See the Source code for an implementation section for a complete code example.

Checkpoint stream sources​

Data ingestion for your indexer supports several checkpoint stream sources.

Remote reader​

The most straightforward stream source is to subscribe to a remote store of checkpoint contents. Mysten Labs provides the following buckets:

  • Testnet: https://checkpoints.testnet.sui.io
  • Mainnet: https://checkpoints.mainnet.sui.io

Local reader​

Colocate the data ingestion daemon with a Full node and enable checkpoint dumping on the latter to set up a local stream source. After enabling, the Full node starts dumping executed checkpoints as files to a local directory, and the data ingestion daemon subscribes to changes in the directory through an inotify-like mechanism. This approach allows minimizing ingestion latency (checkpoint are processed immediately after a checkpoint executor on a Full node) and getting rid of dependency on an externally managed bucket.

To enable, add the following to your Full node configuration file:

checkpoint-executor-config:
  checkpoint-execution-max-concurrency: 200
  local-execution-timeout-sec: 30
  data-ingestion-dir: <path to a local directory>

Hybrid mode​

Specify both a local and remote store as a fallback to ensure constant data flow. The framework always prioritizes locally available checkpoint data over remote data. It's useful when you want to start utilizing your own Full node for data ingestion but need to partially backfill historical data or just have a failover.

Examples​

The Sui data ingestion framework provides a helper function to quickly bootstrap an indexer workflow.

struct CustomWorker;

#[async_trait]
impl Worker for CustomWorker {
    async fn process_checkpoint(&self, checkpoint: CheckpointData) -> Result<()> {
        // custom processing logic
        ...
        Ok(())
    }
}

#[tokio::main]
async fn main() -> Result<()> {
    let (executor, term_sender) = setup_single_workflow(
        CustomWorker,
        "https://checkpoints.mainnet.sui.io".to_string(),
        0, /* initial checkpoint number */
        5, /* concurrency */
        None, /* extra reader options */
    ).await?;
    executor.await?;
    Ok(())
}

This is suitable for setups with a single ingestion pipeline where progress tracking is managed outside of the framework.

For more complex setups, refer to the following example:

struct CustomWorker;

#[async_trait]
impl Worker for CustomWorker {
    async fn process_checkpoint(&self, checkpoint: CheckpointData) -> Result<()> {
        // custom processing logic
        ...
        Ok(())
    }
}

#[tokio::main]
async fn main() -> Result<()> {
  let (exit_sender, exit_receiver) = oneshot::channel();
  let metrics = DataIngestionMetrics::new(&Registry::new());
  let progress_store = FileProgressStore::new("path_to_file");
  let mut executor = IndexerExecutor::new(progress_store, 1 /* number of workflow types */, metrics);
  let worker_pool = WorkerPool::new(CustomWorker, "custom worker", 100);
  executor.register(worker_pool).await?;
  executor.run(
      PathBuf::from("..."), // path to a local directory
      Some("https://checkpoints.mainnet.sui.io".to_string()),
      vec![], // optional remote store access options
      exit_receiver,
  ).await?;
  Ok(())
}

Let's highlight a couple lines of code:

let worker_pool = WorkerPool::new(CustomWorker, "custom worker", 100);
executor.register(worker_pool).await?;

The data ingestion executor can run multiple workflows simultaneously. For each workflow, you need to create a separate worker pool and register it in the executor. The WorkerPool requires an instance of the Worker trait, the name of the workflow (which is used for tracking the progress of the flow in the progress store and metrics), and concurrency.

The concurrency parameter specifies how many threads the workflow uses. Having a concurrency value greater than 1 is helpful when tasks are idempotent and can be processed in parallel and out of order. The executor only updates the progress/watermark to a certain checkpoint when all preceding checkpoints are processed.

Source code for an implementation​

Find the following source code in the Sui repo.

Manifest​

Code for the cargo.toml manifest file for the custom indexer.

Code to inject not found: examples/custom-indexer/rust/cargo.toml --> /vercel/path0/examples/custom-indexer/rust/cargo.toml

Rust source​

Code for the main.rs file that creates the custom indexer.

examples/custom-indexer/rust/main.rs
use anyhow::Result;
use async_trait::async_trait;
use sui_types::full_checkpoint_content::CheckpointData;
use sui_data_ingestion_core::{Worker, setup_single_workflow};

struct CustomWorker;

#[async_trait]
impl Worker for CustomWorker {
    async fn process_checkpoint(&self, checkpoint: CheckpointData) -> Result<()> {
        // custom processing logic
        // print out the checkpoint number
        println!("Processing checkpoint: {}", checkpoint.checkpoint_summary.to_string());
        Ok(())
    }
}
                    
#[tokio::main]
async fn main() -> Result<()> {
    let (executor, term_sender) = setup_single_workflow(
        CustomWorker,
        "https://checkpoints.testnet.sui.io".to_string(),
        0, /* initial checkpoint number */
        5, /* concurrency */
        None, /* extra reader options */
    ).await?;
    executor.await?;
    Ok(())
}