docs: fix examples and sdk spec (#1819)

Author: JuArce

batcher/aligned-sdk/src/sdk.rs

@@ -196,7 +196,7 @@ async fn fetch_gas_price(
 
 /// Submits multiple proofs to the batcher to be verified in Aligned.
 /// # Arguments
-/// * `network` - The netork on which the verification will be done.
+/// * `network` - The network on which the verification will be done.
 /// * `verification_data` - An array of verification data of each proof.
 /// * `max_fees` - An array of the maximum fee that the submitter is willing to pay for each proof verification.
 /// * `wallet` - The wallet used to sign the proof.
@@ -367,7 +367,7 @@ pub async fn submit_and_wait_verification(
 
 /// Submits a proof to the batcher to be verified in Aligned.
 /// # Arguments
-/// * `chain` - The chain on which the verification will be done.
+/// * `network` - The network on which the verification will be done.
 /// * `verification_data` - The verification data of the proof.
 /// * `max_fee` - The maximum fee that the submitter is willing to pay for the verification.
 /// * `wallet` - The wallet used to sign the proof.

docs/3_guides/0_submitting_proofs.md

@@ -109,11 +109,14 @@ Proof submission is done via the `submit` command of the Aligned CLI. The argume
 * `proof`: The path of the proof associated to the computation to be verified.
 * `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.
 * `pub_input`: The path to the file with the public input associated with the proof.
-* `batcher_url`: The batcher websocket URL. Can be:
-  * mainnet: `wss://mainnet.batcher.alignedlayer.com`
-  * holesky: `wss://batcher.alignedlayer.com`
-  * devnet: `ws://localhost:8080`
-* `network` to specify the network to be used. Can be `devnet`, `holesky` or `mainnet`.
+* One of the following, to specify which Network to interact with:
+  - `--network <working_network_name>`: Network name to interact with.
+    - Default: `devnet`
+    - Possible values: `devnet`, `holesky`, `mainnet`
+  - For a custom Network, you must specify the following parameters:
+    - `--aligned_service_manager <aligned_service_manager_contract_address>`
+    - `--batcher_payment_service <batcher_payment_service_contract_address>`
+    - `--batcher_url <batcher_websocket_url>`
 * `rpc_url`: The RPC Ethereum node URL.
 * `proof_generator_addr`: An optional parameter that can be used in some applications to avoid front-running.
 * `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.
@@ -130,7 +133,6 @@ aligned submit \
 --proving_system SP1 \
 --proof <proof_file> \
 --vm_program <vm_program_file> \
---batcher_url wss://batcher.alignedlayer.com \
 --proof_generator_addr [proof_generator_addr] \
 --batch_inclusion_data_directory_path [batch_inclusion_data_directory_path] \
 --keystore_path <path_to_ecdsa_keystore> \
@@ -165,7 +167,6 @@ aligned submit \
 --proof <proof_file> \
 --vm_program <vm_program_file> \
 --pub_input <pub_input_file> \
---batcher_url wss://batcher.alignedlayer.com \
 --proof_generator_addr [proof_generator_addr] \
 --batch_inclusion_data_directory_path [batch_inclusion_data_directory_path] \
 --keystore_path <path_to_ecdsa_keystore> \

docs/3_guides/1.2_SDK_api_reference.md

@@ -8,7 +8,6 @@ Submits a proof to the batcher to be verified and returns an aligned verificatio
 
 ```rust
 pub async fn submit(
-    batcher_url: &str,
     network: Network,
     verification_data: &VerificationData,
     max_fee; U256,
@@ -19,10 +18,6 @@ pub async fn submit(
 
 #### Arguments
 
-- `batcher_url` - The url of the batcher to which the proof will be submitted:
-  - mainnet: `wss://mainnet.batcher.alignedlayer.com`
-  - holesky: `wss://batcher.alignedlayer.com`
-  - devnet: `ws://localhost:8080`
 - `network` - The network on which the proof will be submitted (`devnet | holesky | mainnet`)
 - `verification_data` - The verification data for the proof.
 - `max_fee` - The maximum fee that the submitter is willing to pay for the proof verification.
@@ -57,7 +52,6 @@ Submits multiple proofs to the batcher to be verified and returns an aligned ver
 
 ```rust
 pub async fn submit_multiple(
-    batcher_url: &str,
     network: Network,
     verification_data: &[VerificationData],
     max_fees: &[U256],
@@ -68,10 +62,6 @@ pub async fn submit_multiple(
 
 #### Arguments
 
-- `batcher_url` - The url of the batcher to which the proof will be submitted:
-  - mainnet: `wss://mainnet.batcher.alignedlayer.com`
-  - holesky: `wss://batcher.alignedlayer.com`
-  - devnet: `ws://localhost:8080`
 - `network` - The network on which the proof will be submitted (`devnet | holesky | mainnet`)
 - `verification_data` - A verification data array.
 - `max_fees` - A max fee array.
@@ -108,7 +98,6 @@ verification data struct.
 
 ```rust
 pub async fn submit_and_wait_verification(
-    batcher_url: &str,
     eth_rpc_url: &str,
     network: Network,
     verification_data: &VerificationData,
@@ -120,18 +109,12 @@ pub async fn submit_and_wait_verification(
 
 #### Arguments
 
-- `batcher_url` - The url of the batcher to which the proof will be submitted
-  - mainnet: `wss://mainnet.batcher.alignedlayer.com`
-  - holesky: `wss://batcher.alignedlayer.com`
-  - devnet: `ws://localhost:8080`
 - `eth_rpc_url` - The URL of the Ethereum RPC node.
 - `network` - The network on which the verification will be done (`devnet | holesky | mainnet`)
 - `verification_data` - The verification data for the proof.
 - `max_fee` - The maximum fee that the submitter is willing to pay for the proof verification.
 - `wallet` - The wallet used to sign the proof. Should be using correct chain id. See `get_chain_id`.
 - `nonce` - The nonce of the submitter address. See `get_nonce_from_ethereum`.
-- `payment_service_addr` - The address of the batcher payment service contract.
-- `NotAContract(address)` if you are trying to send to an address that is not a contract. This generally occurs if you have misconfigured the `environment` parameter.
 
 #### Returns
 
@@ -164,30 +147,23 @@ Submits multiple proofs to the batcher for verification, waits for verification
 
 ```rust
 pub async fn submit_multiple_and_wait_verification(
-    batcher_url: &str,
     eth_rpc_url: &str,
     network: Network,
     verification_data: &[VerificationData],
+    max_fee: U256,
     wallet: Wallet<SigningKey>,
-    nonce: U256,
-    payment_service_addr: &str,
+    nonce: U256
 ) -> Vec<Result<AlignedVerificationData, errors::SubmitError>>
 ```
 
 #### Arguments
 
-- `batcher_url` - The url of the batcher to which the proof will be submitted:
-  - mainnet: `wss://mainnet.batcher.alignedlayer.com`
-  - holesky: `wss://batcher.alignedlayer.com`
-  - devnet: `ws://localhost:8080`
 - `eth_rpc_url` - The URL of the Ethereum RPC node.
 - `network` - The network on which the verification will be done (`devnet | holesky | mainnet`)
 - `verification_data` - A verification data array.
-- `max_fees` - A max fee array.
+- `max_fee` - The maximum fee that the submitter is willing to pay for the proof verification.
 - `wallet` - The wallet used to sign the proof. Should be using correct chain id. See `get_chain_id`.
 - `nonce` - The nonce of the submitter address. See `get_nonce_from_ethereum`.
-- `payment_service_addr` - The address of the batcher payment service contract.
-- `NotAContract(address)` if you are trying to send to an address that is not a contract. This generally occurs if you have misconfigured the `environment` parameter.
 
 #### Returns
 
@@ -222,8 +198,7 @@ Checks if the proof has been verified with Aligned and is included in the batch
 pub async fn is_proof_verified(
     aligned_verification_data: AlignedVerificationData,
     network: Network,
-    eth_rpc_url: &str,
-    payment_service_addr: &str,
+    eth_rpc_url: &str
 ) -> Result<bool, errors::VerificationError>
 ```
 
@@ -232,7 +207,6 @@ pub async fn is_proof_verified(
 - `aligned_verification_data` - The aligned verification data obtained when submitting the proofs.
 - `network` - The network on which the verification will be done (`devnet | holesky | mainnet`)
 - `eth_rpc_url` - The URL of the Ethereum RPC node.
-- `payment_service_addr` - The address of the batcher payment service contract.
 
 #### Returns
 
@@ -245,24 +219,6 @@ pub async fn is_proof_verified(
 - `EthereumCallError` if there is an error in the Ethereum call.
 - `HexDecodingError` if there is an error decoding the Aligned service manager contract address.
 
-### `get_commitment`
-
-Generates a keccak256 hash commitment of the verification key.
-
-```rust
-pub fn get_commitment(
-    content: &[u8]
-) -> [u8; 32]
-```
-
-#### Arguments
-
-- `content` - A byte slice of the verification key.
-
-#### Returns
-
-- `[u8; 32]` - A 32-byte array representing the keccak256 hash of the verification key.
-
 ### `get_nonce_from_ethereum`
 
 Returns the nonce for a given address in Ethereum from aligned payment service contract.
@@ -301,17 +257,14 @@ as the batcher proofs might not yet be on ethereum, producing an out-of-sync non
 
 ```rust
 pub async fn get_nonce_from_batcher(
-    batcher_ws_url: &str,
+    network: Network,
     address: Address,
 ) -> Result<U256, GetNonceError> {
 ```
 #### Arguments
 
 
-- `batcher_url` - The batcher websocket url:
-  - mainnet: `wss://mainnet.batcher.alignedlayer.com`
-  - holesky: `wss://batcher.alignedlayer.com`
-  - devnet: `ws://localhost:8080`
+- `network` - The network from which the nonce will be retrieved.
 - `address` - The user address for which the nonce will be retrieved.
 
 #### Returns
@@ -353,15 +306,14 @@ priority the user wants to have in the batch, the `estimate` parameter can be se
 ```rust
 pub async fn estimate_fee(
     eth_rpc_url: &str,
-    estimate: PriceEstimate,
+    fee_estimation_type: FeeEstimationType,
 ) -> Result<U256, errors::MaxFeeEstimateError>
 ```
 
 #### Arguments
 
 - `eth_rpc_url` - The URL of the Ethereum RPC node.
-- `estimate` - The parameter to set the priority for the proof to be included in the batch. It can be one
-  of `Min`, `Default` or `Max`.
+- `estimate_type` - Enum specifying the type of price estimate:  Default, Instant. Custom(usize)
 
 #### Returns
 
@@ -372,33 +324,6 @@ pub async fn estimate_fee(
 - `EthereumProviderError` if there is an error in the connection with the RPC provider.
 - `EthereumCallError` if there is an error in the Ethereum call.
 
-### `compute_max_fee`
-
-Computes `max_fee` for a proof based on the number of proofs in a batch (`num_proofs_per_batch`) and number of proofs (`num_proofs`) in that batch the user would pay for i.e (`num_proofs` / `num_proofs_per_batch`).
-
-```rust
-pub async fn compute_max_fee(
-    eth_rpc_url: &str,
-    num_proofs: usize,
-    num_proofs_per_batch: usize,
-) -> Result<U256, errors::MaxFeeEstimateError>
-```
-
-#### Arguments
-
-- `eth_rpc_url` - The URL of the Ethereum RPC node.
-- `num_proofs` - The number of proofs in a batch the user would pay for.
-- `num_proofs_per_batch` - The number of proofs within a batch.
-
-#### Returns
-
-- `Result<U256, MaxFeeEstimateError>` - The calculated `max_fee` as a `U256`.
-
-#### Errors
-
-- `EthereumProviderError` if there is an error in the connection with the RPC provider.
-- `EthereumCallError` if there is an error in the Ethereum call.
-
 ### `fee_per_proof`
 
 Returns the `fee_per_proof` based on the current gas price for a batch compromised of `num_proofs_per_batch` i.e. (1 / `num_proofs_per_batch`).