Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sidu28 authored Feb 2, 2024
1 parent 4e02dfe commit bbcddec
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down Expand Up @@ -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 \
Expand Down

0 comments on commit bbcddec

Please sign in to comment.