Merge branch 'main' into 480-chore-implement-pausable-in-servicemanager

Author: JuArce

README.md

@@ -16,59 +16,30 @@
 
 ## The Project
 
-Aligned works with EigenLayer to leverage Ethereum consensus mechanism for ZK proof verification. Working outside the EVM, this allows for cheap verification of any proving system. This enables the usage of cutting edge algorithms, that may use new techniques to prove even faster. Even more, proving systems that reduce the proving overhead and add verifier overhead, now become economically feasible to verify thanks to Aligned.
+Aligned is a decentralized network of nodes that verifies Zero-Knowledge and Validity proofs and post the results in Ethereum. 
 
-## Operator Guide
-
-If you want to run an operator, check our [Operator Guide](./README_OPERATOR.md)
-
-## Aligned Infrastructure Guide
-
-If you are developing in Aligned, or want to run your own devnet, check our [Infrastructure Guide](./README_INFRASTRUCTURE.md)
+These proofs can be generated and used for a tenth of the price and very low latency, allowing novel types of applications that weren't possible before in Ethereum.
 
 ## How to use the testnet
 
-### Contract Information
-
-Testnet contract is deployed on Holesky on the address:
-
- ```0x58F280BeBE9B34c9939C3C39e0890C81f163B623```
-
-### How to use the testnet
-
-Download and install Aligned to send proofs in the 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
 ```
 
-Then run the ```source``` command that should appear in the shell
-
-If you are experiencing issues, upgrade by running the same command.
-
-The downloaded binaries require:
-
-- 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, clone the repository, install rust, and then run:
-
-```bash
-make uninstall_aligned
-make install_aligned_compiling
-```
-
-### Try it!
+2. Then run the ```source``` command that should appear in the shell
 
-We are going to download a proof previously generated, send it to Aligned, and retrieve the results from Ethereum Holesky testnet. Aligned is using EigenLayer to do a fast and cheap verification of more than one thousand proofs per second.
 
-Download an example SP1 proof file with it's ELF file using:
+3. Download an example SP1 proof file with it's ELF file using:
 
 ```bash
 curl -L https://raw.githubusercontent.com/yetanotherco/aligned_layer/main/batcher/aligned/get_proof_test_files.sh | bash
 ```
 
-Send the proof with:
+We are downloading a proof previously generated, sending it to Aligned, and retrieving the results from Ethereum Holesky testnet. Aligned is using EigenLayer to do a fast and cheap verification of more than one thousand proofs per second.
+
+4. Let's send the proof to be verified in Aligned:
 
 ```bash
 rm -rf ~/.aligned/aligned_verification_data/ &&
@@ -80,7 +51,7 @@ aligned submit \
 --conn wss://batcher.alignedlayer.com
 ```
 
-You should get a response like this:
+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:
@@ -90,7 +61,9 @@ You should get a response like this:
 https://explorer.alignedlayer.com/batches/0x8ea98526e48f72d4b49ad39902fb320020d3cf02e6506c444300eb3619db4c13```
 ```
 
-You can use the link to the explorer to check the status of your transaction. Then after three blocks, you can check if it has been verified with:
+You can use the link to the explorer to check the status of your transaction. 
+
+6. After three Ethereum blocks, you can check if it has been verified with:
 
 ```bash
 aligned verify-proof-onchain \
@@ -99,7 +72,9 @@ aligned verify-proof-onchain \
 --chain holesky
 ```
 
-You should get this result:
+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!
@@ -111,15 +86,33 @@ If the proof wasn't verified you should get this result:
 [2024-06-17T21:59:09Z INFO  aligned] Your proof was not included in the batch.
 ```
 
-This is the same as running the following curl, with the proper CALL_DATA.
+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, clone the repository, install rust, and then run:
+
+```bash
+make uninstall_aligned
+make install_aligned_compiling
+```
+
+### Reading the results of proof verification in Ethereum
+
+
+#### Using CURL and an Ethereum RPC
+In step 6 of the previous section, we used the `aligned verify-proof-onchain` to check that our proof was verified in Aligned.
+
+Internally, this is making a call to our Aligned contract, verifying commitments are right, and that the proof is included in the batch.
+
+That command is doing the same as the following `curl` to an Ethereum node.
 
 ```bash
 curl -H "Content-Type: application/json" \
     --data '{"jsonrpc":"2.0","method":"eth_call","id":1, "params":[{"to": "0x58F280BeBE9B34c9939C3C39e0890C81f163B623", "data": "<CALL_DATA>"}]}' \
     -X POST https://ethereum-holesky-rpc.publicnode.com
 ```
 
-This returns a 0x1 if the proof and it's associated data is correct and verified in Aligned, and 0x0 if not.
+This will return 0x1 if the proof and it's associated data is correct and verified in Aligned, and 0x0 if not.
 
 For example, this a correct calldata for a verified proof:
 
@@ -129,23 +122,28 @@ curl -H "Content-Type: application/json" \
   -X POST https://ethereum-holesky-rpc.publicnode.com
 ```
 
-To get the call data for yours, you can use the ```encode_verification_data.py```:
+To generate the calldata yourself, follow these steps:
 
-To use it, first clone then repository, then move to the repository folder, and install the dependencies with a python venv:
+1. Clone the repository and move into it
+2. Create a Python virtual environment and install the dependencies with
 
 ```bash
 python3 -m venv .aligned_venv
 source .aligned_venv/bin/activate
 python3 -m pip install -r examples/verify/requirements.txt
 ```
 
-Then:
+3. Encode your proof verification data with
 
 ```bash
 python3 examples/verify/encode_verification_data.py --aligned-verification-data ~/.aligned/aligned_verification_data/*.json
 ```
+ 
+If your verification data is in another path, just change the `--aligned-verification-data` parameter.
+
+#### Using a caller contract 
 
-If you want to verify your proof in your own contract, use a static call to the Aligned contract. You can use the following [Caller Contract](examples/verify/src/VerifyBatchInclusionCaller.sol) as an example. The code will look like this:
+To verify a proof in your own contract, use a static call to the Aligned contract. You can use the following [Caller Contract](examples/verify/src/VerifyBatchInclusionCaller.sol) as an example. The code will look like this:
 
 ```solidity
 (bool callWasSuccessfull, bytes memory proofIsIncluded) = targetContract.staticcall(
@@ -163,12 +161,13 @@ If you want to verify your proof in your own contract, use a static call to the
 require(callWasSuccessfull, "static_call failed");
 ```
 
-If you want to learn more about how to check if your proof was verified in aligned, 
-check the [Guide](./examples/verify/README.md).
+## Operator Guide
 
-If you want to send more types of proofs, read our [send proofs guide](./README_SEND_PROOFS.md).
+If you want to run an operator, check our [Operator Guide](./README_OPERATOR.md)
 
-If you want to know more about Aligned, read our [docs](docs/README.md).
+## Aligned Infrastructure Guide
+
+If you are developing in Aligned, or want to run your own devnet, check our [Infrastructure Guide](./README_INFRASTRUCTURE.md)
 
 ## FAQ