Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): Add aligned-cli readme #1590

Open
wants to merge 3 commits into
base: staging
Choose a base branch
from
+133 −0
Open

feat(docs): Add aligned-cli readme #1590

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ee1a96
add cli doc
PatStiles Dec 6, 2024
113e844
nits
PatStiles Dec 10, 2024
835a62d
added docs to summary + added missing link in summary for Submitting …
PatStiles Dec 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 131 additions & 0 deletions docs/3_guides/9_aligned_cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
# Aligned CLI

The Aligned CLI serves as a interface for users to interact with and retrieve information from Alinged Layer. This document serves as a reference for commands of the Aligned CLI.

## Installation:

1. Download and install Aligned from the Aligned github repo `https://github.com/yetanotherco/aligned_layer`:

```bash
curl -L https://raw.githubusercontent.com/yetanotherco/aligned_layer/main/batcher/aligned/install_aligned.sh | bash
```

2. A source command will be printed in your terminal after installation. Execute that command to update your shell environment.

3. Verify that the installation was successful:
```bash
aligned --help
```

## Help:

To see the available commands run:
```bash
aligned --help
```

To see the usage of a command run:
```bash
aligned [COMMAND] --help
```

## Commands:
PatStiles marked this conversation as resolved.
Show resolved Hide resolved

- `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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add the common urls: holesky and mainnet

- **default**: `ws://localhost:8080` i.e. `devnet`
- `--rpc_url <Ethereum RPC provider connection address>`: User's Ethereum RPC Node URL.
- `--proving_system <Proving system>`: Proof system of the submitted proof.
- **possible values**: `GnarkPlonkBls12_381`, `GnarkPlonkBn254`, `Groth16Bn254`, `SP1`, `Risc0`
- `--proof <Proof file path>`: Path to the file the proof being submitted for verification is written.
- `--public_input <Public input file name>`: Path to a file where the public inputs of the proof being submitted for verification is written.
- `--vk <Verification key file name>`: Path to the file where the verification key of the proof being submitted for verification is written. Note, the following proof systems require a verification key to be supplied: `GnarkPlonkBls12_381`, `GnarkPlonkBn254`, `Groth16Bn254`
- `--vm_program <VM prgram code file name>`: Path to the file where the vm program code (ELF File) of the proof being submitted for verification is written. Note, the following proof systems require a vm program code (ELF File) to be supplied: `SP1`, `Risc0`.
- `--repetitions <Number of repetitions>`:
Number of repetitions of this proof to be submitted.
- **default**: 1
- `--proof_generator_addr <Proof generator address>`: An optional parameter that can be used in some applications to avoid front-running.
- **default**: `0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266`
- `--aligned_verification_data_path <Aligned verification data directory Path>`: Path to the location the verification data of the proof will be written after it is submitted.
- **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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add an example

- `--nonce <Nonce>`: Nonce of the proof.
- `--network <The working network's name>`: The Ethereum network of the Aligned Layer Network the user is submitting to.
- **default**: `devnet`
- **possible values**: `devnet`, `holesky`, `holesky-stage`, `mainnet`

- `verify-proof-onchain [OPTIONS] --aligned-verification-data <Aligned verification data>`: Verify the proof was included in a verified batch on Ethereum.

- Options:
- `--aligned-verification-data <Aligned verification data>`: Path to verification data file generated from proof submission with the Aligned CLI.
- `--rpc-url <Ethereum RPC provider address>`: User's Ethereum RPC node URL.
- `--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`
- `get-vk-commitment [OPTIONS] --verification_key_file <Verification key file path> --proving_system <Proving system>`: Computes the verification data commitment specifically [provingSystemAuxDataCommitment](../2_architecture/components/3_service_manager_contract.md#verify-batch-inclusion) from the verification data file generated from submitting a proof to the batcher.

- Options:
- `--verification_key_file <Verification key file path>`: Path to verification data file generated from proof submission with the Aligned CLI.
- `--proving_system <Proving system>`: Proof system of the supplied verification data file.
- **possible values**: `GnarkPlonkBls12_381`, `GnarkPlonkBn254`, `Groth16Bn254`, `SP1`, `Risc0`
- `--output <Output file>`: File path for output to be written to.

- `deposit-to-batcher [OPTIONS] --keystore_path <Path to local keystore> --amount <Amount to deposit>`: Deposits Ethereum into the Aligned Layer's `BatcherPaymentService.sol` contract to pay for users proof submission.

- Options:
- `--keystore_path <Path to local keystore>`: Path to the local keystore of the user's wallet.
- `--rpc-url <Ethereum RPC provider address>`: User's Ethereum RPC Node URL.
- `--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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add an example


- `get-user-balance [OPTIONS] --user_addr <The user's Ethereum address>`: Retrieves the user's current balance in Aligned Layer's `BatcherPaymentService.sol` contract.

- Options:
- `--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`
- `--rpc_url <Ethereum RPC provider address>`: User's Ethereum RPC Node URL.
- **default**: `http://localhost:8545`
- `--user_addr <The user's Ethereum address>`: User's Ethereum address on the provided network.

- `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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add possible values

- **default**: `ws://localhost:8080` i.e. `devnet`
- `--user_addr <The user's Ethereum address>`: User's Ethereum address on Ethereum Mainnet.

## Example:

An example workflow for using the Aligned CLI (Runnable from the root directory of the Aligned Layer Repository):

1. Deposit funds to the batcher.
```bash
aligned deposit-to-batcher --network holesky --amount 0.5ether --keystore_path <KEYSTORE_PATH>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing batcher_url

```

4. Verify that your proof has been found on chain.
```bash
aligned verify-proof-onchain --aligned-verification-data ./aligned_verification_data/<VERIFICATION_DATA_FILE> --network holesky
```

5. Check that the number of proofs you have submitted is incremented.
```bash
aligned get-user-nonce --user_addr <USER_ETH_ADDRESS> --batcher_url wss://holesky.batcher.alignedlayer.com
```