From df616c43027dbda223207ce9af7194653ede367f Mon Sep 17 00:00:00 2001 From: Konrad Stepniak Date: Wed, 6 Nov 2024 21:40:13 +0100 Subject: [PATCH] docs(polka-storage-provider-client): PoRep command clarification (#519) --- cli/polka-storage-provider/client/src/commands/proofs.rs | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/cli/polka-storage-provider/client/src/commands/proofs.rs b/cli/polka-storage-provider/client/src/commands/proofs.rs index 162086207..744baabba 100644 --- a/cli/polka-storage-provider/client/src/commands/proofs.rs +++ b/cli/polka-storage-provider/client/src/commands/proofs.rs @@ -39,9 +39,14 @@ pub enum ProofsCommand { #[arg(short, long)] output_path: Option, }, - /// **DEMO COMMAND** IT SHOULD NOT BE USED IN PRODUCTION AND ITS FLOW IS SKEWED! - /// Generates PoRep for a piece file. + /// DEMO COMMAND - Generates PoRep for a piece file. + /// /// Takes a piece file (in a CARv2 archive, unpadded), puts it into a sector (temp file), seals and proves it. + /// + /// When you run the command for the first time on a clean `cache_directory` it will fail, + /// because `rust-fil-proofs` tries to validate cache based on https://github.com/filecoin-project/rust-fil-proofs/blob/5a0523ae1ddb73b415ce2fa819367c7989aaf73f/storage-proofs-porep/parent_cache.json. + /// + /// When you run the command for the second time, the cache is recreated and there are no verification issues. #[clap(name = "porep")] PoRep { /// Key of the entity generating the proof.