From 79326cbbb9ca35336441bafdc6952d1b94f9d7dd Mon Sep 17 00:00:00 2001 From: Pablo Castellano Date: Wed, 13 Aug 2025 14:37:06 +0200 Subject: [PATCH] docs: show usage parameters and improve wording --- README.md | 25 +++++++++++++++++++++++++ src/args.rs | 4 ++-- 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f7e71a5..4d037ff 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,31 @@ The indexer for the [Blobscan](https://github.com/Blobscan/blobscan) explorer im Check out our [documentation website](https://docs.blobscan.com/docs/indexer). +``` +./blob-indexer --help +Blobscan's indexer for blob transactions (EIP-4844). + +Usage: blob-indexer [OPTIONS] + +Options: + -f, --from-slot + Slot to start indexing from + -t, --to-slot + Slot to stop indexing at + -n, --num-threads + Number of threads used for parallel indexing + -s, --slots-per-save + Amount of slots to be processed before saving latest slot in the database + -c, --disable-sync-checkpoint-save + Disable slot checkpoint saving when syncing + -d, --disable-sync-historical + Disable backfill indexing thread + -h, --help + Print help + -V, --version + Print version +``` + # Sponsors We extend our gratitude to each one of them. Thank you 🙏 diff --git a/src/args.rs b/src/args.rs index 6fb19db..215f580 100644 --- a/src/args.rs +++ b/src/args.rs @@ -2,7 +2,7 @@ use clap::{ArgAction, Parser}; use crate::clients::beacon::types::BlockId; -/// Blobscan's indexer for the EIP-4844 upgrade. +/// Blobscan's indexer for blob transactions (EIP-4844). #[derive(Parser, Debug)] #[command(author, version, about, long_about = None)] pub struct Args { @@ -26,7 +26,7 @@ pub struct Args { #[arg(short = 'c', long, action = ArgAction::SetTrue)] pub disable_sync_checkpoint_save: bool, - /// Disable historical synchronization + /// Disable backfill indexing thread #[arg(short = 'd', long, action = ArgAction::SetTrue)] pub disable_sync_historical: bool, }