Skip to content

Commit ab27561

Browse files
authored
docs: fix aligned submit command (yetanotherco#723)
1 parent 9e5ac9d commit ab27561

5 files changed

Lines changed: 49 additions & 22 deletions

File tree

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
## The Project
1616

17-
Aligned is a decentralized network of nodes that verifies Zero-Knowledge and Validity proofs, and post the results in Ethereum.
17+
Aligned is a decentralized network of nodes that verifies Zero-Knowledge and Validity proofs, and post the results in Ethereum.
1818

1919
These proofs can be generated and used for a tenth of the price, and with extremely low latency, allowing novel types of applications that weren't possible before in Ethereum.
2020

@@ -46,7 +46,9 @@ aligned submit \
4646
--proof ~/.aligned/test_files/sp1_fibonacci.proof \
4747
--vm_program ~/.aligned/test_files/sp1_fibonacci.elf \
4848
--aligned_verification_data_path ~/.aligned/aligned_verification_data \
49-
--conn wss://batcher.alignedlayer.com
49+
--conn wss://batcher.alignedlayer.com \
50+
--rpc https://ethereum-holesky-rpc.publicnode.com \
51+
--batcher_addr 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
5052
```
5153

5254
5. You should get a response like this:
@@ -59,7 +61,7 @@ aligned submit \
5961
[2024-07-01T19:19:18Z INFO aligned] https://explorer.alignedlayer.com/batches/0xe367d76e832edec893d3a9027b3c231b2e3994c47acfac2e67197c13c9be0c4c
6062
```
6163
62-
You can use the link to the explorer to check the status of your transaction.
64+
You can use the link to the explorer to check the status of your transaction.
6365
6466
6. After three Ethereum blocks, you can check if it has been verified with:
6567
@@ -136,10 +138,10 @@ python3 -m pip install -r examples/verify/requirements.txt
136138
```bash
137139
python3 examples/verify/encode_verification_data.py --aligned-verification-data ~/.aligned/aligned_verification_data/*.json
138140
```
139-
141+
140142
If your verification data is in another path, just change the `--aligned-verification-data` parameter.
141143
142-
#### Using a caller contract
144+
#### Using a caller contract
143145
144146
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:
145147

docs/guides/0_submitting_proofs.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,9 @@ aligned submit \
116116
--conn wss://batcher.alignedlayer.com \
117117
--proof_generator_addr [proof_generator_addr] \
118118
--batch_inclusion_data_directory_path [batch_inclusion_data_directory_path] \
119-
--keystore_path <path_to_ecdsa_keystore>
119+
--keystore_path <path_to_ecdsa_keystore> \
120+
--rpc https://ethereum-holesky-rpc.publicnode.com \
121+
--batcher_addr 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
120122
```
121123

122124
**Example**
@@ -128,7 +130,9 @@ aligned submit \
128130
--proof ./scripts/test_files/sp1/sp1_fibonacci.proof \
129131
--vm_program ./scripts/test_files/sp1/sp1_fibonacci.elf \
130132
--conn wss://batcher.alignedlayer.com \
131-
--keystore_path ~/.aligned_keystore/keystore0
133+
--keystore_path ~/.aligned_keystore/keystore0 \
134+
--rpc https://ethereum-holesky-rpc.publicnode.com \
135+
--batcher_addr 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
132136
```
133137

134138
### Risc0 proof
@@ -147,7 +151,9 @@ aligned submit \
147151
--conn wss://batcher.alignedlayer.com \
148152
--proof_generator_addr [proof_generator_addr] \
149153
--batch_inclusion_data_directory_path [batch_inclusion_data_directory_path] \
150-
--keystore_path <path_to_ecdsa_keystore>
154+
--keystore_path <path_to_ecdsa_keystore> \
155+
--rpc https://ethereum-holesky-rpc.publicnode.com \
156+
--batcher_addr 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
151157
```
152158

153159
**Example**
@@ -161,7 +167,9 @@ aligned submit \
161167
--public_input ./scripts/test_files/risc_zero/fibonacci_proof_generator/risc_zero_fibonacci.pub \
162168
--conn wss://batcher.alignedlayer.com \
163169
--aligned_verification_data_path ~/.aligned/aligned_verification_data \
164-
--keystore_path ~/.aligned_keystore/keystore0
170+
--keystore_path ~/.aligned_keystore/keystore0 \
171+
--rpc https://ethereum-holesky-rpc.publicnode.com \
172+
--batcher_addr 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
165173
```
166174

167175
### GnarkPlonkBn254, GnarkPlonkBls12_381 and Groth16Bn254
@@ -178,7 +186,9 @@ aligned submit \
178186
--conn wss://batcher.alignedlayer.com \
179187
--proof_generator_addr [proof_generator_addr] \
180188
--batch_inclusion_data_directory_path [batch_inclusion_data_directory_path] \
181-
--keystore_path <path_to_ecdsa_keystore>
189+
--keystore_path <path_to_ecdsa_keystore> \
190+
--rpc https://ethereum-holesky-rpc.publicnode.com \
191+
--batcher_addr 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
182192
```
183193

184194
**Examples**:
@@ -191,7 +201,9 @@ aligned submit \
191201
--public_input ./scripts/test_files/gnark_plonk_bn254_script/plonk_pub_input.pub \
192202
--vk ./scripts/test_files/gnark_plonk_bn254_script/plonk.vk \
193203
--conn wss://batcher.alignedlayer.com \
194-
--keystore_path ~/.aligned_keystore/keystore0
204+
--keystore_path ~/.aligned_keystore/keystore0 \
205+
--rpc https://ethereum-holesky-rpc.publicnode.com \
206+
--batcher_addr 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
195207
```
196208

197209
```bash
@@ -202,7 +214,9 @@ aligned submit \
202214
--public_input ./scripts/test_files/gnark_plonk_bls12_381_script/plonk_pub_input.pub \
203215
--vk ./scripts/test_files/gnark_plonk_bls12_381_script/plonk.vk \
204216
--conn wss://batcher.alignedlayer.com \
205-
--keystore_path ~/.aligned_keystore/keystore0
217+
--keystore_path ~/.aligned_keystore/keystore0 \
218+
--rpc https://ethereum-holesky-rpc.publicnode.com \
219+
--batcher_addr 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
206220
```
207221

208222
```bash
@@ -213,5 +227,7 @@ aligned submit \
213227
--public_input ./scripts/test_files/gnark_groth16_bn254_infinite_script/infinite_proofs/ineq_1_groth16.pub \
214228
--vk ./scripts/test_files/gnark_groth16_bn254_infinite_script/infinite_proofs/ineq_1_groth16.vk \
215229
--conn wss://batcher.alignedlayer.com \
216-
--keystore_path ~/.aligned_keystore/keystore0
230+
--keystore_path ~/.aligned_keystore/keystore0 \
231+
--rpc https://ethereum-holesky-rpc.publicnode.com \
232+
--batcher_addr 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
217233
```

docs/guides/3_generating_proofs.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,9 @@ aligned submit \
4040
--proof <proof_path> \
4141
--vm_program <vm_program_path> \
4242
--conn wss://batcher.alignedlayer.com \
43-
--proof_generator_addr <proof_generator_addr>
44-
```
43+
--proof_generator_addr <proof_generator_addr\
44+
--rpc https://ethereum-holesky-rpc.publicnode.com \
45+
--batcher_addr 0x815aeCA64a974297942D2Bbf034ABEe22a38A003``
4546

4647
Where `proof_path` is the path to the proof file and vm program path is the path to the elf file.
4748

@@ -88,7 +89,9 @@ aligned submit \
8889
--public_input <public_input_path>
8990
--vk <verification_key_path> \
9091
--conn wss://batcher.alignedlayer.com \
91-
--proof_generator_addr <proof_generator_addr>
92+
--proof_generator_addr <proof_generator_addr> \
93+
--rpc https://ethereum-holesky-rpc.publicnode.com \
94+
--batcher_addr 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
9295
```
9396
9497
Where proof path is the path to the proof file, `public_input_path` is the path to the public input file,
@@ -113,12 +116,12 @@ First, open the risc0 host file and add the following code to export image id &
113116
```rust
114117
fn main() {
115118
// your code here
116-
119+
117120
// <METHOD_ID> is the method id of the function you want to prove
118121
// <method_id_file_path> is the path where the method id will be saved
119122
std::fs::write("<method_id_file_path>", convert(&<METHOD_ID>))
120123
.expect("Failed to write method_id file");
121-
124+
122125
// <pub_input_file_path> is the path where the public input will be saved
123126
std::fs::write("<pub_input_file_path>", receipt.journal.bytes)
124127
.expect("Failed to write pub_input file");
@@ -160,7 +163,9 @@ aligned submit \
160163
--vm_program <method_id_file_path> \
161164
--public_input <pub_input_file_path> \
162165
--conn wss://batcher.alignedlayer.com \
163-
--proof_generator_addr <proof_generator_addr>
166+
--proof_generator_addr <proof_generator_addr> \
167+
--rpc https://ethereum-holesky-rpc.publicnode.com \
168+
--batcher_addr 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
164169
```
165170
166171
For more instructions on how to submit proofs, check the [Submitting proofs guide](../guides/0_submitting_proofs.md).

docs/guides/5_setup_aligned.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -516,7 +516,9 @@ aligned submit \
516516
--pub_input <pub_input_file> \
517517
--proof_generator_addr [proof_generator_addr] \
518518
--batch_inclusion_data_directory_path [batch_inclusion_data_directory_path] \
519-
--keystore_path [path_to_ecdsa_keystore]
519+
--keystore_path [path_to_ecdsa_keystore] \
520+
--rpc https://ethereum-holesky-rpc.publicnode.com \
521+
--batcher_addr 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
520522
```
521523
522524
</details>

docs/introduction/1_getting_started.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ curl -L https://raw.githubusercontent.com/yetanotherco/aligned_layer/main/batche
1919
curl -L https://raw.githubusercontent.com/yetanotherco/aligned_layer/main/batcher/aligned/get_proof_test_files.sh | bash
2020
```
2121

22-
4. Send the proof to be verified in Aligned with
22+
4. Send the proof to be verified in Aligned with
2323

2424
```bash
2525
rm -rf ~/.aligned/aligned_verification_data/ &&
@@ -28,7 +28,9 @@ aligned submit \
2828
--proof ~/.aligned/test_files/sp1_fibonacci.proof \
2929
--vm_program ~/.aligned/test_files/sp1_fibonacci.elf \
3030
--aligned_verification_data_path ~/.aligned/aligned_verification_data \
31-
--conn wss://batcher.alignedlayer.com
31+
--conn wss://batcher.alignedlayer.com \
32+
--rpc https://ethereum-holesky-rpc.publicnode.com \
33+
--batcher_addr 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
3234
```
3335

3436
5. You should get a response like this:

0 commit comments

Comments
 (0)