Skip to content

Commit 1ebb705

Browse files
avilagaston9JuArceuri-99
authored
fix(docs): batcher and explorer urls (#1688)
Co-authored-by: Julian Arce <[email protected]> Co-authored-by: Uriel Mihura <[email protected]>
1 parent 82ba4a7 commit 1ebb705

File tree

3 files changed

+38
-16
lines changed

3 files changed

+38
-16
lines changed

docs/3_guides/0_submitting_proofs.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Make sure you have Aligned installed as specified [here](../1_introduction/1_try
44

55
If you run the examples below, make sure you are in Aligned's repository root.
66

7+
You can check your submitted proofs on [Mainnet Explorer](https://explorer.alignedlayer.com) and [Holesky Explorer](https://holesky.explorer.alignedlayer.com).
8+
79
## Supported Verifiers
810

911
The following is the list of the verifiers currently supported by Aligned:
@@ -77,7 +79,7 @@ aligned deposit-to-batcher \
7779
This command allows the usage of the following flags:
7880

7981
- `--rpc_url` to specify the rpc url to be used.
80-
- `--network` to specify the netowrk to be used. Can be `devnet`, `holesky-stage` or `holesky`.
82+
- `--network` to specify the network to be used. Can be `devnet`, `holesky` or `mainnet`.
8183
- `--keystore_path` the path to the keystore.
8284
- `--amount` the number of ethers to transfer to the Batcher.
8385
- Note: `--amount` flag parameter must be with the shown format, `XX.XXether`.
@@ -94,21 +96,24 @@ aligned get-user-balance \
9496
These commands allow the usage of the following flags:
9597

9698
- `--rpc_url` to specify the rpc url to be used.
97-
- `--network` to specify the netowrk to be used. Can be `devnet`, `holesky-stage` or `holesky`.
99+
- `--network` to specify the network to be used. Can be `devnet`, `holesky` or `mainnet`.
98100
- `--user_addr` the address of the user that funded the Batcher.
99101

100102
## 3. Submit your proof to the batcher
101103

102-
This guide will focus on how to submit proofs using the Aligned CLI. To integrate the proof submission process into your application, check the [First Aligned Application tutorial](../3_guides/2_build_your_first_aligned_application.md#app) where we explain how to generate and submit a proof using the Aligned SDK.
104+
This guide will focus on how to submit proofs using the Aligned CLI. To integrate the proof submission process into your application, check the [First Aligned Application tutorial](../3_guides/2_build_your_first_aligned_application.md) where we explain how to generate and submit a proof using the Aligned SDK.
103105

104106
Proof submission is done via the `submit` command of the Aligned CLI. The arguments for the submit command are:
105107

106108
* `proving_system`: The proving system corresponding to the proof you want to submit.
107109
* `proof`: The path of the proof associated to the computation to be verified.
108110
* `vm_program`: When the proving system involves the execution of a program in a zkVM, this argument is associated with the compiled program or some other identifier of the program.
109111
* `pub_input`: The path to the file with the public input associated with the proof.
110-
* `batcher_url`: The batcher websocket URL.
111-
* `network` to specify the netowrk to be used. Can be `devnet`, `holesky-stage` or `holesky`.
112+
* `batcher_url`: The batcher websocket URL. Can be:
113+
* mainnet: `wss://mainnet.batcher.alignedlayer.com`
114+
* holesky: `wss://batcher.alignedlayer.com`
115+
* devnet: `ws://localhost:8080`
116+
* `network` to specify the network to be used. Can be `devnet`, `holesky` or `mainnet`.
112117
* `rpc_url`: The RPC Ethereum node URL.
113118
* `proof_generator_addr`: An optional parameter that can be used in some applications to avoid front-running.
114119
* `batch_inclusion_data_directory_path`: An optional parameter indicating the directory where to store the batcher response data. If not provided, the folder with the responses will be created in the current directory.
@@ -252,5 +257,5 @@ aligned submit \
252257
--batcher_url wss://batcher.alignedlayer.com \
253258
--keystore_path ~/.aligned_keystore/keystore0 \
254259
--network holesky \
255-
--rpc_url https://ethereum-holesky-rpc.publicnode.com
260+
--rpc_url https://ethereum-holesky-rpc.publicnode.com
256261
```

docs/3_guides/1.2_SDK_api_reference.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,11 @@ pub async fn submit(
1919

2020
#### Arguments
2121

22-
- `batcher_url` - The url of the batcher to which the proof will be submitted.
23-
- `network` - The network on which the proof will be submitted (`devnet | holesky-stage | holesky`)
22+
- `batcher_url` - The url of the batcher to which the proof will be submitted:
23+
- mainnet: `wss://mainnet.batcher.alignedlayer.com`
24+
- holesky: `wss://batcher.alignedlayer.com`
25+
- devnet: `ws://localhost:8080`
26+
- `network` - The network on which the proof will be submitted (`devnet | holesky | mainnet`)
2427
- `verification_data` - The verification data for the proof.
2528
- `max_fee` - The maximum fee that the submitter is willing to pay for the proof verification.
2629
- `wallet` - The wallet used to sign the proof. Should be using correct chain id. See `get_chain_id`.
@@ -65,8 +68,11 @@ pub async fn submit_multiple(
6568

6669
#### Arguments
6770

68-
- `batcher_url` - The url of the batcher to which the proof will be submitted.
69-
- `network` - The network on which the proof will be submitted (`devnet | holesky-stage | holesky`)
71+
- `batcher_url` - The url of the batcher to which the proof will be submitted:
72+
- mainnet: `wss://mainnet.batcher.alignedlayer.com`
73+
- holesky: `wss://batcher.alignedlayer.com`
74+
- devnet: `ws://localhost:8080`
75+
- `network` - The network on which the proof will be submitted (`devnet | holesky | mainnet`)
7076
- `verification_data` - A verification data array.
7177
- `max_fees` - A max fee array.
7278
- `wallet` - The wallet used to sign the proof. Should be using correct chain id. See `get_chain_id`.
@@ -114,9 +120,12 @@ pub async fn submit_and_wait_verification(
114120

115121
#### Arguments
116122

117-
- `batcher_url` - The url of the batcher to which the proof will be submitted.
123+
- `batcher_url` - The url of the batcher to which the proof will be submitted
124+
- mainnet: `wss://mainnet.batcher.alignedlayer.com`
125+
- holesky: `wss://batcher.alignedlayer.com`
126+
- devnet: `ws://localhost:8080`
118127
- `eth_rpc_url` - The URL of the Ethereum RPC node.
119-
- `network` - The network on which the verification will be done (`devnet | holesky-stage | holesky`)
128+
- `network` - The network on which the verification will be done (`devnet | holesky | mainnet`)
120129
- `verification_data` - The verification data for the proof.
121130
- `max_fee` - The maximum fee that the submitter is willing to pay for the proof verification.
122131
- `wallet` - The wallet used to sign the proof. Should be using correct chain id. See `get_chain_id`.
@@ -167,9 +176,12 @@ pub async fn submit_multiple_and_wait_verification(
167176

168177
#### Arguments
169178

170-
- `batcher_url` - The url of the batcher to which the proof will be submitted.
179+
- `batcher_url` - The url of the batcher to which the proof will be submitted:
180+
- mainnet: `wss://mainnet.batcher.alignedlayer.com`
181+
- holesky: `wss://batcher.alignedlayer.com`
182+
- devnet: `ws://localhost:8080`
171183
- `eth_rpc_url` - The URL of the Ethereum RPC node.
172-
- `network` - The network on which the verification will be done (`devnet | holesky-stage | holesky`)
184+
- `network` - The network on which the verification will be done (`devnet | holesky | mainnet`)
173185
- `verification_data` - A verification data array.
174186
- `max_fees` - A max fee array.
175187
- `wallet` - The wallet used to sign the proof. Should be using correct chain id. See `get_chain_id`.
@@ -218,7 +230,7 @@ pub async fn is_proof_verified(
218230
#### Arguments
219231

220232
- `aligned_verification_data` - The aligned verification data obtained when submitting the proofs.
221-
- `network` - The network on which the verification will be done (`devnet | holesky-stage | holesky`)
233+
- `network` - The network on which the verification will be done (`devnet | holesky | mainnet`)
222234
- `eth_rpc_url` - The URL of the Ethereum RPC node.
223235
- `payment_service_addr` - The address of the batcher payment service contract.
224236

@@ -296,7 +308,10 @@ pub async fn get_nonce_from_batcher(
296308
#### Arguments
297309

298310

299-
- `batcher_url` - The batcher websocket url.
311+
- `batcher_url` - The batcher websocket url:
312+
- mainnet: `wss://mainnet.batcher.alignedlayer.com`
313+
- holesky: `wss://batcher.alignedlayer.com`
314+
- devnet: `ws://localhost:8080`
300315
- `address` - The user address for which the nonce will be retrieved.
301316

302317
#### Returns

docs/SUMMARY.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@
4545

4646
## Useful links
4747

48+
* [Mainnet Explorer](https://explorer.alignedlayer.com)
49+
* [Holesky Explorer](https://holesky.explorer.alignedlayer.com)
4850
* [All the proof aggregation solutions will use RISC-V zkvms](https://blog.alignedlayer.com/all-the-proof-aggregation-solutions-will-use-risc-v-zkvms/)
4951
* [Manifesto](https://blog.alignedlayer.com/aligned-manifesto/)
5052

0 commit comments

Comments
 (0)