feat(docs): Add aligned-cli readme #1590
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
PatStiles
changed the title
JuArce
requested changes
Dec 10, 2024
…Batch without batcher
Cambio! @JuArce I also added a missing link for |
JuArce
requested changes
Dec 23, 2024
| - `submit [OPTIONS] --proving_system <Proving system> --proof <Proof file path>`: Submit a proof or (repetitions of a proof) to the Aligned Layer batcher. | ||
|
|
||
| - Options: | ||
| - `--batcher_url <Batcher connection address>`: Websocket URL for the Aligned Layer batcher. |
There was a problem hiding this comment.
Add the common urls: holesky and mainnet
| - **default**: `./aligned_verification_data/` | ||
| - `--keystore_path <Path to local keystore>`: Path to the local keystore of the user's wallet. | ||
| - `--private_key <Private key>`: User's wallet private key. | ||
| - `--max_fee <Max Fee (ether)>`: Amount of Ethereum in Wei to deposit into the `BatcherPaymentService.sol` contract to pay for proof submission. |
| - `--network <The working network's name>`: The Ethereum network of the Aligned Layer Network the user is querying their balance on. | ||
| - **default**: `devnet` | ||
| - **possible values**: `devnet`, `holesky`, `holesky-stage`, `mainnet` | ||
| - `--amount <Amount to deposit>`: Amount of Ethereum in Wei to deposit into the `BatcherPaymentService.sol` contract to pay for proof submission. |
| - `get-user-nonce [OPTIONS] --user_addr <The user's Ethereum address>`: Retrieves the user's current nonce from the batcher. | ||
|
|
||
| - Options: | ||
| - `--batcher_url <Batcher connection address>`: Websocket URL for the Aligned Layer batcher. |
|
|
||
| 1. Deposit funds to the batcher. | ||
| ```bash | ||
| aligned deposit-to-batcher --network holesky --amount 0.5ether --keystore_path <KEYSTORE_PATH> |
There was a problem hiding this comment.
deposit to batcher spec is in wei and it is using ether. Check which one is correct
|
|
||
| 2. Check your balance in the aligned batcher. | ||
| ```bash | ||
| aligned get-user-balance --user_addr <WALLET_ADDRESS> --network holesky |
There was a problem hiding this comment.
It says holesky, but does not specify the batcher_url
|
|
||
| 3. Submit a Proof. | ||
| ```bash | ||
| aligned submit --proving_system Risc0 --proof ./scripts/test_files/risc_zero/fibonacci_proof_generator/risc_zero_fibonacci.proof --vm_program ./scripts/test_files/risc_zero/fibonacci_proof_generator/fibonacci_id.bin --public_input ./scripts/test_files/risc_zero/fibonacci_proof_generator/risc_zero_fibonacci.pub --repetitions <BURST_SIZE> --keystore_path <KEYSTORE_PATH> --network holesky --max_fee 1300000000 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Aligned CLI readme
Description
Adds an readme for the aligned CLI that displays and describes all its flags and parameters. This is intended to be used in alongside the other examples within the documentation for usage.
A separate PR should be done to make the naming conventions throughout the repo consistent. ref: #1589 . It would be recommended to do this in parts as it may introduce breaking changes.
Type of change
Please delete options that are not relevant.
Checklist
testnet, everything else tostaging