Skip to content

Commit 79326cb

Browse files
docs: show usage parameters and improve wording
1 parent e00e67b commit 79326cb

File tree

2 files changed

+27
-2
lines changed

2 files changed

+27
-2
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,31 @@ The indexer for the [Blobscan](https://github.com/Blobscan/blobscan) explorer im
66

77
Check out our [documentation website](https://docs.blobscan.com/docs/indexer).
88

9+
```
10+
./blob-indexer --help
11+
Blobscan's indexer for blob transactions (EIP-4844).
12+
13+
Usage: blob-indexer [OPTIONS]
14+
15+
Options:
16+
-f, --from-slot <FROM_SLOT>
17+
Slot to start indexing from
18+
-t, --to-slot <TO_SLOT>
19+
Slot to stop indexing at
20+
-n, --num-threads <NUM_THREADS>
21+
Number of threads used for parallel indexing
22+
-s, --slots-per-save <SLOTS_PER_SAVE>
23+
Amount of slots to be processed before saving latest slot in the database
24+
-c, --disable-sync-checkpoint-save
25+
Disable slot checkpoint saving when syncing
26+
-d, --disable-sync-historical
27+
Disable backfill indexing thread
28+
-h, --help
29+
Print help
30+
-V, --version
31+
Print version
32+
```
33+
934
# Sponsors
1035

1136
We extend our gratitude to each one of them. Thank you 🙏

src/args.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ use clap::{ArgAction, Parser};
22

33
use crate::clients::beacon::types::BlockId;
44

5-
/// Blobscan's indexer for the EIP-4844 upgrade.
5+
/// Blobscan's indexer for blob transactions (EIP-4844).
66
#[derive(Parser, Debug)]
77
#[command(author, version, about, long_about = None)]
88
pub struct Args {
@@ -26,7 +26,7 @@ pub struct Args {
2626
#[arg(short = 'c', long, action = ArgAction::SetTrue)]
2727
pub disable_sync_checkpoint_save: bool,
2828

29-
/// Disable historical synchronization
29+
/// Disable backfill indexing thread
3030
#[arg(short = 'd', long, action = ArgAction::SetTrue)]
3131
pub disable_sync_historical: bool,
3232
}

0 commit comments

Comments
 (0)