Enum forest_filecoin::tool::subcommands::snapshot_cmd::SnapshotCommands

pub enum SnapshotCommands {
    Fetch {
        directory: PathBuf,
        chain: NetworkChain,
        vendor: TrustedVendor,
    },
    ValidateDiffs {
        check_links: u32,
        check_network: Option<NetworkChain>,
        check_stateroots: u32,
        snapshot_files: Vec<PathBuf>,
    },
    Validate {
        check_links: u32,
        check_network: Option<NetworkChain>,
        check_stateroots: u32,
        snapshot_files: Vec<PathBuf>,
        fail_fast: bool,
    },
    Compress {
        source: PathBuf,
        output_path: PathBuf,
        compression_level: u16,
        frame_size: usize,
        force: bool,
    },
    ComputeState {
        snapshot: PathBuf,
        epoch: i64,
        json: bool,
    },
}

Variants

Fetch

Fetches the most recent snapshot from a trusted, pre-defined location.

Fields

directory: PathBuf

chain: NetworkChain

Network chain the snapshot will belong to

vendor: TrustedVendor

Vendor to fetch the snapshot from

ValidateDiffs

Validate the provided snapshots as a whole.

Fields

check_links: u32

Number of recent epochs to scan for broken links

check_network: Option<NetworkChain>

Assert the snapshot belongs to this network. If left blank, the network will be inferred before executing messages.

check_stateroots: u32

Number of recent epochs to scan for bad messages/transactions

snapshot_files: Vec<PathBuf>

Path to a snapshot CAR, which may be zstd compressed

Validate

Validate the snapshots individually.

Fields

check_links: u32

Number of recent epochs to scan for broken links

check_network: Option<NetworkChain>

Assert the snapshot belongs to this network. If left blank, the network will be inferred before executing messages.

check_stateroots: u32

Number of recent epochs to scan for bad messages/transactions

snapshot_files: Vec<PathBuf>

Path to a snapshot CAR, which may be zstd compressed

fail_fast: bool

Fail at the first invalid snapshot

Compress

Make this snapshot suitable for use as a compressed car-backed blockstore.

Fields

source: PathBuf

Input CAR file, in .car, .car.zst, or .forest.car.zst format.

output_path: PathBuf

Output file, will be in .forest.car.zst format.

Will reuse the source name (with new extension) if pointed to a directory.

compression_level: u16

frame_size: usize

End zstd frames after they exceed this length

force: bool

Overwrite output file without prompting.

ComputeState

Filecoin keeps track of “the state of the world”, including: wallets and their balances; storage providers and their deals; etc…

It does this by (essentially) hashing the state of the world.

The world can change when new blocks are mined and transmitted. A block may contain a message to e.g transfer FIL between two parties. Blocks are ordered by “epoch”, which can be thought of as a timestamp.

Snapshots contain (among other things) these messages.

The command calculates the state of the world at EPOCH-1, applies all the messages at EPOCH, and prints the resulting hash of the state of the world.

If –json is supplied, details about each message execution will printed.

Fields

snapshot: PathBuf

Path to a snapshot CAR, which may be zstd compressed

epoch: i64

Which epoch to compute the state transition for

json: bool

Generate JSON output

Implementations

impl SnapshotCommands

pub async fn run(self) -> Result<()>

Trait Implementations

impl Debug for SnapshotCommands

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for SnapshotCommands

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for SnapshotCommands

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand