diff --git a/README.md b/README.md index aa7c823f..a441c68c 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,14 @@ $ ./generation/generation \ -outputFile [OUTPUT_FILE_PATH] \ -chainID [CHAIN_ID] ``` +Here is a breakdown of the inputs here: +- “Command” aka the type of proof being generated +- “oracleBlockHeaderFile” is the path to the oracle block header file, that we are proving all of this against +- “stateFile” is the consensus state from that slot, containing the validator information +- “validatorIndex” is the index of the validator being proven inside state.validators +- “outtputFile” - setting this will write the proofs to a json file +- “chainID” this parameter allows certain constants to be set depending on whether the proof is being generated for a goerli or mainnet state. + Here is an example of running this command with the sample state/block files in the `/data` folder ```bash ./generation/generation \ @@ -102,6 +110,14 @@ $ ./generation/generation \ -outputFile [OUTPUT_FILE_PATH] \ -chainID [CHAIN_ID] ``` +Here is a breakdown of the inputs here: +- “Command” aka the type of proof being generated +- “oracleBlockHeaderFile” is the path to the oracle block header file, that we are proving all of this against +- “stateFile” is the consensus state from that slot, containing the validator information +- “validatorIndex” is the index of the validator being proven inside state.validators +- “outtputFile” - setting this will write the proofs to a json file +- “chainID” this parameter allows certain constants to be set depending on whether the proof is being generated for a goerli or mainnet state. + Here is an example of running this command with the sample state/block files in the `/data` folder: ```bash ./generation/generation \