Docs 25 6 (#487)

Co-authored-by: Mariano Nicolini <[email protected]>

Author: MauroToscano

README.md

@@ -163,7 +163,7 @@ require(callWasSuccessfull, "static_call failed");
 
 ## Operator Guide
 
-If you want to run an operator, check our [Operator Guide](./README_OPERATOR.md)
+If you want to run an operator, check our [Operator Guide](./docs/guides/1_operator_guide.md)
 
 ## Aligned Infrastructure Guide
 

docs/README.md

@@ -1,18 +1,28 @@
-# Summary
+# Introduction
 
-* [Aligned](README.md)
+* [What is Aligned?](introduction/0_what_is_aligned.md)
+* [Getting started](introduction/1_getting_started.md)
+* [FAQ](introduction/2_fq.md)
+* Core concepts
+* Use cases
 
-## About Aligned
+# Guides
 
-* [Features](about_aligned/features.md)
-* [Use cases](about_aligned/use_cases.md)
-* [Modular approach](about_aligned/modular_approach.md)
-* [Role of EigenLayer](about_aligned/role_of_eigenlayer.md)
-* [How does Aligned work?](about_aligned/how_does_aligned_work.md)
-* [Learning Resources](about_aligned/learning_resources.md)
-* [FAQ](about_aligned/FAQ.md)
+* [Submitting with every proving system](guides/0_proving_systems.md)
+* [Operators guide](guides/1_operator_guide.md)
+* Making your own app with Aligned
 
-## Links
+# Architecture
+
+* Fast mode
+* Aggregation mode
+
+# Useful links 
+
+* [All the proof aggregation solutions will use RISC-V zkvms](https://blog.alignedlayer.com/all-the-proof-aggregation-solutions-will-use-risc-v-zkvms/)
+* [Manifesto](https://blog.alignedlayer.com/aligned_manifesto/)
+
+# Contacts
 
 * [Telegram Group](https://t.me/aligned_layer)
 * [Twitter/X](https://twitter.com/alignedlayer)

docs/SUMMARY.md

@@ -0,0 +1,92 @@
+# Supported Proving Systems
+
+Currently, Aligned supports:
+
+:white_check_mark: Gnark - Groth16 (with BN254)
+:white_check_mark: Gnark - Plonk (with BN254 and BLS12-381)
+:white_check_mark: SP1
+:white_check_mark: Halo2 - Plonk/KZG
+:white_check_mark: Halo2 - Plonk/IPA
+
+The following proving systems are going to be added soon:
+:black_square_button: Risc0
+:black_square_button: Kimchi
+
+## SP1 proof
+
+The SP1 proving system needs the proof file and the vm program file,
+
+```bash
+rm -rf ./aligned_verification_data/ &&
+aligned submit \
+--proving_system <SP1|GnarkPlonkBn254|GnarkPlonkBls12_381|Groth16Bn254> \
+--proof <proof_file> \
+--vm_program <vm_program_file> \
+--conn wss://batcher.alignedlayer.com \
+--proof_generator_addr [proof_generator_addr] \
+--batch_inclusion_data_directory_path [batch_inclusion_data_directory_path]
+```
+
+**Example**
+
+```bash
+rm -rf ./aligned_verification_data/ &&
+aligned submit \
+--proving_system SP1 \
+--proof ./batcher/aligned/test_files/sp1/sp1_fibonacci.proof \
+--vm_program ./batcher/aligned/test_files/sp1/sp1_fibonacci-elf \
+--conn wss://batcher.alignedlayer.com
+```
+
+## GnarkPlonkBn254, GnarkPlonkBls12_381 and Groth16Bn254
+
+GnarkPlonkBn254, GnarkPlonkBls12_381 and Groth16Bn254 proving systems need the proof file, the public input file and the verification key file.
+
+```bash
+rm -rf ./aligned_verification_data/ &&
+aligned submit \
+--proving_system <SP1|GnarkPlonkBn254|GnarkPlonkBls12_381|Groth16Bn254> \
+--proof <proof_file> \
+--public_input <public_input_file> \
+--vk <verification_key_file> \
+--conn wss://batcher.alignedlayer.com \
+--proof_generator_addr [proof_generator_addr] \
+--batch_inclusion_data_directory_path [batch_inclusion_data_directory_path]
+```
+
+**Plonk BN254 example**:
+
+```bash
+rm -rf ./aligned_verification_data/ &&
+aligned submit \
+--proving_system GnarkPlonkBn254 \
+--proof ./batcher/aligned/test_files/plonk_bn254/plonk.proof \
+--public_input ./batcher/aligned/test_files/plonk_bn254/plonk_pub_input.pub \
+--vk ./batcher/aligned/test_files/plonk_bn254/plonk.vk \
+--conn wss://batcher.alignedlayer.com
+```
+
+
+**Plonk BLS12-381 example**:
+
+```bash
+rm -rf ./aligned_verification_data/ &&
+aligned submit \
+--proving_system GnarkPlonkBls12_381 \
+--proof ./batcher/aligned/test_files/plonk_bls12_381/plonk.proof \
+--public_input ./batcher/aligned/test_files/plonk_bls12_381/plonk_pub_input.pub \
+--vk ./batcher/aligned/test_files/plonk_bls12_381/plonk.vk \
+--conn wss://batcher.alignedlayer.com
+```
+
+**Groth16 BN254 example**:
+
+```bash
+rm -rf ./aligned_verification_data/ &&
+aligned submit \
+--proving_system Groth16Bn254 \
+--proof ./batcher/aligned/test_files/groth16/ineq_1_groth16.proof \
+--public_input ./batcher/aligned/test_files/groth16/ineq_1_groth16.pub \
+--vk ./batcher/aligned/test_files/groth16/ineq_1_groth16.vk \
+--conn wss://batcher.alignedlayer.com
+```

docs/guides/0_proving_systems.md

@@ -1,11 +1,11 @@
 
 # Register as an Aligned operator in testnet
 
-## Requirements
-
 > [!NOTE]
 > You must be whitelisted to become an Aligned operator.
 
+## Requirements
+
 This guide assumes you are already [registered as an operator with EigenLayer](https://docs.eigenlayer.xyz/eigenlayer/operator-guides/operator-installation).
 
 ## Hardware Requirements
@@ -19,7 +19,16 @@ Minimum hardware requirements:
 | **Bandwidth** | 1 Gbps            |
 | **Storage**   | 256 GB disk space |
 
-## Building from Source (Recommended)
+
+## Step 1 - Clone the repo
+To start with, clone the Aligned repository and move inside it
+
+```bash
+git clone https://github.com/yetanotherco/aligned_layer.git
+cd aligned_layer
+```
+
+## Step 2 - Building the Operator
 
 We recommend building from source whenever possible. If using the docker image, these steps can be skipped.
 
@@ -64,9 +73,7 @@ To see the operator version, run:
 
 This will display the current version of the operator binary.
 
-## Configuration
-
-## When building from source
+## Step 3 - Update the configuration for your specific Operator
 
 Update the following placeholders in `./config-files/config-operator.yaml`:
 
@@ -80,42 +87,18 @@ Update the following placeholders in `./config-files/config-operator.yaml`:
 `"<ecdsa_key_store_location_path>"` and `"<bls_key_store_location_path>"` are the paths to your keys generated with the EigenLayer CLI, `"<operator_address>"` and `"<earnings_receiver_address>"` can be found in the `operator.yaml` file created in the EigenLayer registration process.
 The keys are stored by default in the `~/.eigenlayer/operator_keys/` directory, so for example `<ecdsa_key_store_location_path>` could be `/path/to/home/.eigenlayer/operator_keys/some_key.ecdsa.key.json` and for `<bls_key_store_location_path>` it could be `/path/to/home/.eigenlayer/operator_keys/some_key.bls.key.json`.
 
-
-## When using docker
-
-Update the following placeholders in `./config-files/config-operator.docker.yaml`:
-
-- `"<operator_address>"`
-- `"<earnings_receiver_address>"`
-- `"<ecdsa_key_store_password>"`
-- `"<bls_key_store_password>"`
-
-Make sure not to update the `ecdsa_key_store_location_path` and `bls_key_store_location_path`
-as they are already set to the correct path.
-
-Then create a .env file in `operator/docker/.env`.
-An example of the file can be found in `operator/docker/.env.example`.
-
-The file should contain the following variables:
-
-| Variable Name               | Description                                                                                                   |
-|-----------------------------|---------------------------------------------------------------------------------------------------------------|
-| `ECDSA_KEY_FILE_HOST`       | Absolute path to the ECDSA key file. If generated from Eigen cli it should be in ~/.eigenlayer/operator_keys/ |
-| `BLS_KEY_FILE_HOST`         | Absolute path to the BLS key file. If generated from Eigen cli it should be in ~/.eigenlayer/operator_keys/   |
-| `OPERATOR_CONFIG_FILE_HOST` | Absolute path to the operator config file. It should be path to config-files/config-operator.docker.yaml      |
-
-## Deposit Strategy Tokens
+## Step 4: Deposit Strategy Tokens
 
 We are using [WETH](https://holesky.eigenlayer.xyz/restake/WETH) as the strategy token.
 
 To do so there are 2 options, either doing it through EigenLayer's website, and following their guide, or running the commands specified by us below.
 
 You will need to stake a minimum of a 1000 Wei in WETH. We recommend to stake a maximum amount of 10 WETH. If you are staking more than 10 WETH please unstake any surplus over 10.
 
-## Option 1:
+### Option 1:
 EigenLayer's guide can be found [here](https://docs.eigenlayer.xyz/eigenlayer/restaking-guides/restaking-user-guide/liquid-restaking/restake-lsts).
 
-## Option 2:
+### Option 2:
 If you have ETH and need to convert it to WETH you can use the following command, that will convert 1 Eth to WETH.
 Make sure to have [foundry](https://book.getfoundry.sh/getting-started/installation) installed.
 Change the parameter in ```---value``` if you want to wrap a different amount:
@@ -145,33 +128,17 @@ If you don't have Holesky Eth, these are some useful faucets:
 - [Google Cloud for Web3 Holesky Faucet](https://cloud.google.com/application/web3/faucet/ethereum/holesky)
 - [Holesky PoW Faucet](https://holesky-faucet.pk910.de/)
 
-## Start the operator
-
-## From Source (Recommended)
-
+## Step 5 - Start the operator
 ```
 ./operator/build/aligned-operator start --config ./config-files/config-operator.yaml
 ```
 
-## Using Docker
-
-Ensure you have the following installed:
-
-- [Docker](https://docs.docker.com/get-docker/)
-- [Docker Compose](https://docs.docker.com/compose/install/)
-
-Then run:
-
-```bash
-make operator_start_docker
-```
-
-## Unregister the operator from Aligned
+## Unregistering the operator
 
 To unregister the Aligned operator, run:
 
 ```bash
 cast send --rpc-url https://ethereum-holesky-rpc.publicnode.com --private-key <private_key> 0x3aD77134c986193c9ef98e55e800B71e72835b62 'deregisterOperator(bytes)' 0x00
  ```
 
- `<private_key>` is the one specified in the output when generating your keys with the EigenLayer CLI.
+ `<private_key>` is the one specified in the output when generating your keys with the EigenLayer CLI.

README_OPERATOR.md docs/guides/1_operator_guide.mdREADME_OPERATOR.md renamed to docs/guides/1_operator_guide.md

@@ -0,0 +1,73 @@
+# Getting started!
+
+## Quickstart
+We will download a proviously generated SP1 proof, send it to Aligned, and retrieve the results from Ethereum Holesky testnet.
+
+1. Download and install Aligned to send proofs in the testnet:
+
+```bash
+curl -L https://raw.githubusercontent.com/yetanotherco/aligned_layer/main/batcher/aligned/install_aligned.sh | bash
+```
+
+2. Run the ```source``` command that should appear in the shell
+
+3. Download the example SP1 proof file together with the ELF file of the proved program using:
+
+```bash
+curl -L https://raw.githubusercontent.com/yetanotherco/aligned_layer/main/batcher/aligned/get_proof_test_files.sh | bash
+```
+
+4. Send the proof to be verified in Aligned with 
+
+```bash
+rm -rf ~/.aligned/aligned_verification_data/ &&
+aligned submit \
+--proving_system SP1 \
+--proof ~/.aligned/test_files/sp1_fibonacci.proof \
+--vm_program ~/.aligned/test_files/sp1_fibonacci-elf \
+--aligned_verification_data_path ~/.aligned/aligned_verification_data \
+--conn wss://batcher.alignedlayer.com
+```
+
+5. You should get a response like this:
+
+```bash
+[2024-06-17T22:06:03Z INFO  aligned] Proof submitted to aligned. See the batch in the explorer:
+    https://explorer.alignedlayer.com/batches/0x8ea98526e48f72d4b49ad39902fb320020d3cf02e6506c444300eb3619db4c13
+[2024-06-17T22:06:03Z INFO  aligned] Batch inclusion data written into /Users/maurofab/aligned_verification_data/8ea98526e48f72d4b49ad39902fb320020d3cf02e6506c444300eb3619db4c13_225.json
+[2024-06-17T22:06:03Z INFO  aligned] All messages responded. Closing connection...
+https://explorer.alignedlayer.com/batches/0x8ea98526e48f72d4b49ad39902fb320020d3cf02e6506c444300eb3619db4c13```
+```
+
+Use the link in the response to check the status of your transaction in the Aligned explorer.
+
+6. After three Ethereum blocks, you should be able to check if it has been verified with the CLI using
+
+```bash
+aligned verify-proof-onchain \
+--aligned-verification-data ~/.aligned/aligned_verification_data/*.json \
+--rpc https://ethereum-holesky-rpc.publicnode.com \
+--chain holesky
+```
+
+This is reading the result of the verification of the proof in Ethereum.
+
+7. You should get this result:
+
+```bash
+[2024-06-17T21:58:43Z INFO  aligned] Your proof was verified in Aligned and included in the batch!
+```
+
+If the proof wasn't verified you should get this result:
+
+```bash
+[2024-06-17T21:59:09Z INFO  aligned] Your proof was not included in the batch.
+```
+
+Aligned works in:
+- MacOS Arm64 (M1 or higher)
+- Linux x86 with GLIBC_2.32 or superior (For example, Ubuntu 22.04 or higher)
+
+If you don't meet these requirements, you can compile the binaries yourself following the [README](https://github.com/yetanotherco/aligned_layer)
+
+To try Aligned with other proving systems, check the [this]() guide