Skip to content

Commit b1b0bb4

Browse files
docs: modify readme to be clearer (#483)
1 parent 7ce49d4 commit b1b0bb4

File tree

1 file changed

+28
-40
lines changed

1 file changed

+28
-40
lines changed

README.md

Lines changed: 28 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -18,57 +18,26 @@
1818

1919
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.
2020

21-
## Operator Guide
22-
23-
If you want to run an operator, check our [Operator Guide](./README_OPERATOR.md)
24-
25-
## Aligned Infrastructure Guide
26-
27-
If you are developing in Aligned, or want to run your own devnet, check our [Infrastructure Guide](./README_INFRASTRUCTURE.md)
28-
2921
## How to use the testnet
3022

31-
### Contract Information
32-
33-
Testnet contract is deployed on Holesky on the address:
34-
35-
```0x58F280BeBE9B34c9939C3C39e0890C81f163B623```
36-
37-
### How to use the testnet
38-
39-
Download and install Aligned to send proofs in the testnet:
23+
1. Download and install Aligned to send proofs in the testnet:
4024

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

45-
Then run the ```source``` command that should appear in the shell
46-
47-
If you are experiencing issues, upgrade by running the same command.
48-
49-
The downloaded binaries require:
29+
2. Then run the ```source``` command that should appear in the shell
5030

51-
- MacOS Arm64 (M1 or higher)
52-
- Linux x86 with GLIBC_2.32 or superior (For example, Ubuntu 22.04 or higher)
5331

54-
If you don't meet these requirements, clone the repository, install rust, and then run:
55-
56-
```bash
57-
make uninstall_aligned
58-
make install_aligned_compiling
59-
```
60-
61-
### Try it!
62-
63-
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.
64-
65-
Download an example SP1 proof file with it's ELF file using:
32+
3. Download an example SP1 proof file with it's ELF file using:
6633

6734
```bash
6835
curl -L https://raw.githubusercontent.com/yetanotherco/aligned_layer/main/batcher/aligned/get_proof_test_files.sh | bash
6936
```
7037

71-
Send the proof with:
38+
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.
39+
40+
4. Send the proof with:
7241

7342
```bash
7443
rm -rf ~/.aligned/aligned_verification_data/ &&
@@ -80,7 +49,7 @@ aligned submit \
8049
--conn wss://batcher.alignedlayer.com
8150
```
8251

83-
You should get a response like this:
52+
5. You should get a response like this:
8453

8554
```bash
8655
[2024-06-17T22:06:03Z INFO aligned] Proof submitted to aligned. See the batch in the explorer:
@@ -90,7 +59,7 @@ You should get a response like this:
9059
https://explorer.alignedlayer.com/batches/0x8ea98526e48f72d4b49ad39902fb320020d3cf02e6506c444300eb3619db4c13```
9160
```
9261

93-
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:
62+
6. 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:
9463

9564
```bash
9665
aligned verify-proof-onchain \
@@ -99,7 +68,7 @@ aligned verify-proof-onchain \
9968
--chain holesky
10069
```
10170

102-
You should get this result:
71+
7. You should get this result:
10372

10473
```bash
10574
[2024-06-17T21:58:43Z INFO aligned] Your proof was verified in Aligned and included in the batch!
@@ -111,6 +80,17 @@ If the proof wasn't verified you should get this result:
11180
[2024-06-17T21:59:09Z INFO aligned] Your proof was not included in the batch.
11281
```
11382
83+
Aligned works in:
84+
- MacOS Arm64 (M1 or higher)
85+
- Linux x86 with GLIBC_2.32 or superior (For example, Ubuntu 22.04 or higher)
86+
If you don't meet these requirements, clone the repository, install rust, and then run:
87+
88+
```bash
89+
make uninstall_aligned
90+
make install_aligned_compiling
91+
```
92+
---
93+
11494
This is the same as running the following curl, with the proper CALL_DATA.
11595

11696
```bash
@@ -170,6 +150,14 @@ If you want to send more types of proofs, read our [send proofs guide](./README_
170150
171151
If you want to know more about Aligned, read our [docs](docs/README.md).
172152
153+
## Operator Guide
154+
155+
If you want to run an operator, check our [Operator Guide](./README_OPERATOR.md)
156+
157+
## Aligned Infrastructure Guide
158+
159+
If you are developing in Aligned, or want to run your own devnet, check our [Infrastructure Guide](./README_INFRASTRUCTURE.md)
160+
173161
## FAQ
174162
175163
## What is the objective of Aligned?

0 commit comments

Comments
 (0)