📘
Old Faithful
  • Introduction
    • Content Identifiers
    • Indexes
  • Usage & Installation
    • Looking up CIDs
    • Retrieving from Filecoin
    • gRPC Methods
    • RPC Methods
    • RPC server
      • Local file system
      • HTTP
      • Filecoin v1 retrievals
      • Filecoin v2 retrievals
    • Accessing OF1 from old-faithful.net
    • Geyser
    • Software integrations
  • Generating
    • Historical blocks
    • Warehouse nodes
    • Creating indexes
  • Hosting
    • Making a local copy
    • Filecoin
  • Validation
    • Reproducibility
    • Epoch 208
Powered by GitBook
On this page
  • Examples
  • Flags:
  1. Generating

Creating indexes

Once the radiance tooling has been used to prepare a car file (or if you have downloaded a car file externally), you can generate indexes from this car file by using the faithful-cli:

NAME:
   faithful CLI index - Create various kinds of indexes for CAR files.

USAGE:
   faithful CLI index command [command options] [arguments...]

DESCRIPTION:
   Create various kinds of indexes for CAR files.

COMMANDS:
   cid-to-offset  
   slot-to-cid    
   sig-to-cid     
   all            Create all the necessary indexes for a Solana epoch.
   gsfa           
   sig-exists     
   help, h        Shows a list of commands or help for one command

OPTIONS:
   --help, -h  show help

Examples

  • faithful-cli index all <car-file> <output-dir>: Generate all required indexes for a CAR file.

  • faithful-cli index gsfa <car-file> <output-dir>: Generate the gsfa index for a CAR file.

NOTES:

  • You need to have the CAR file available locally.

  • The cid_to_offset_and_size index has an older version, which you can specify with cid_to_offsetinstead of cid_to_offset_and_size.

Flags:

  • --tmp-dir=/path/to/tmp/dir: Where to store temporary files. Defaults to the system temp dir. (optional)

  • --verify: Verify the indexes after generation. (optional)

  • --network=<network>: Network to use for the gsfa index. Defaults to mainnet (other options: testnet, devnet). (optional)

PreviousWarehouse nodesNextHosting

Last updated 10 months ago