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

# Conflicts:
#	contracts/script/output/devnet/alignedlayer_deployment_output.json

Author: JuArce

.gitmodules

@@ -7,3 +7,9 @@
 [submodule "examples/verify/lib/forge-std"]
 	path = examples/verify/lib/forge-std
 	url = https://github.com/foundry-rs/forge-std
+[submodule "examples/zkquiz/contracts/lib/forge-std"]
+	path = examples/zkquiz/contracts/lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+[submodule "examples/zkquiz/contracts/lib/openzeppelin-contracts"]
+	path = examples/zkquiz/contracts/lib/openzeppelin-contracts
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts

Makefile

@@ -183,7 +183,7 @@ batcher_fund_service_manager_balance:
 
 batcher_start: ./batcher/aligned-batcher/.env batcher_fund_service_manager_balance
 	@echo "Starting Batcher..."
-	@cargo +nightly-2024-04-17 run --manifest-path ./batcher/aligned-batcher/Cargo.toml --release -- --config ./config-files/config.yaml --env-file ./batcher/aligned-batcher/.env
+	@cargo +nightly-2024-04-17 run --manifest-path ./batcher/aligned-batcher/Cargo.toml --release -- --config ./config-files/config-batcher.yaml --env-file ./batcher/aligned-batcher/.env
 
 install_batcher:
 	@cargo +nightly-2024-04-17 install --path batcher/aligned-batcher
@@ -530,7 +530,15 @@ upgrade_stake_registry: ## Upgrade Stake Registry
 deploy_verify_batch_inclusion_caller:
 	@echo "Deploying VerifyBatchInclusionCaller contract..."
 	@. examples/verify/.env && . examples/verify/scripts/deploy_verify_batch_inclusion_caller.sh
-	
+
+deploy_batcher_payment_service:
+	@echo "Deploying BatcherPayments contract..."
+	@. contracts/scripts/.env && . contracts/scripts/deploy_batcher_payment_service.sh
+
+upgrade_batcher_payment_service:
+	@echo "Upgrading BatcherPayments contract..."
+	@. contracts/scripts/.env && . contracts/scripts/upgrade_batcher_payment_service.sh
+
 build_aligned_contracts:
 	@cd contracts/src/core && forge build
 

README_BATCHER_PAYMENTS.md

@@ -0,0 +1,46 @@
+# Batcher Payments
+
+## Introduction
+
+To be able to use the batcher, a user must fund its transactions. For this, there is a simple Batcher Payment System.
+
+The Batcher has a Batcher Payments smart contract, which is in charge of recieving user's payments, and which guarantees the batcher can only spend this money to send users' proofs to Aligned.
+
+Users must first deposit into this contract, via a normal transfer to its address.
+
+Then, users can send proofs to the Batcher, the Batcher will preemptively check if the user has funds for this, and once accumulating the whole batch, the Batcher will call its smart contract with the data it has recieved from the users.
+
+The smart contract will then discount the corresponding amount of funds from each of the senders' balances, and create a new Task in Aligned, sending also the corresponding amount of tokens for the batch verification.
+
+Users are also allowed to withdraw extra funds deposited to the Batcher Payments smart contract.
+
+This way, the Batcher can only use User funds to fund the verification of the User's proofs.
+
+## Helpful commands
+
+If you are a User, and want to fund your Batcher so that he can include your proofs in its batch, you can send funds with the following command:
+
+```bash
+cast send <batcher_payments_smart_contract_address> --value <desired_amount_to_transfer> --rpc-url <your_rpc_url> --private-key <your_private_key>
+```
+
+For example:
+```bash
+cast send 0x7969c5eD335650692Bc04293B07F5BF2e7A673C0 --value 1ether --rpc-url http://localhost:8545 --private-key 0x2a871d0798f97d79848a013d4936a73bf4cc922c825d33c1cf7073dff6d409c6
+```
+
+After sending funds, you can check your current balance:
+```bash
+cast call 0x7969c5eD335650692Bc04293B07F5BF2e7A673C0 "UserBalances(address)(uint256)" 0xa0Ee7A142d267C1f36714E4a8F75612F20a79720
+```
+
+The Batcher will then call something similar to the following command, to submit the batch to Aligned:
+```bash
+cast send 0x7969c5eD335650692Bc04293B07F5BF2e7A673C0 "createNewTask(bytes32, string, address[], uint256)" 0xc1b2a3c3aec88bb41478922438b0698add6a9a6c57170176115bda61748df59a "http://storage.alignedlayer.com/c1b2a3c3aec88bb41478922438b0698add6a9a6c57170176115bda61748df59a.json" "[0xa0Ee7A142d267C1f36714E4a8F75612F20a79720]" 1000000000000000 --private-key 0x8b3a350cf5c34c9194ca85829a2df0ec3153be0318b5e2d3348e872092edffba
+```
+
+Finally, the User can extract excess funds from the smart contract if he desires, or he can leave them there to fund future proofs:
+
+```bash
+cast send 0x7969c5eD335650692Bc04293B07F5BF2e7A673C0 "withdraw(uint256)" 1000 --private-key 0x2a871d0798f97d79848a013d4936a73bf4cc922c825d33c1cf7073dff6d409c6
+```

README_SEND_PROOFS.md

@@ -4,6 +4,37 @@ Make sure you have Aligned installed as specified [here](./README.md#how-to-use-
 
 If you run the examples below, make sure you are in Aligned's repository root.
 
+## 1. Import/Create Keystore file
+
+If you already have a keystore file, you can ignore this section and start sending proofs. We give two examples of how to generate one. The first one using Foundry, and the second one using EigenLayerCLI
+
+### Alternative 1: With foundry
+
+Install foundry following this guide:
+
+Install [Foundry](https://book.getfoundry.sh/getting-started/installation):
+
+- If you are creating a new account. Create a private key with:
+
+```bash
+cast wallet new-mnemonic --words 12
+```
+
+If you are using this wallet outside testnet, write down the mnemonic phrase given by anvil
+
+- Import the wallet using the private key previously generated, or whichever you want to use, and write a password to use it.
+
+```bash
+mkdir -p ~/.aligned_keystore/
+cast wallet import --private-key <YOUR_ECDSA_PRIVATE_KEY>  ~/.aligned_keystore/keystore0
+```
+
+This will create the ECDSA keystore file in `~/.aligned_keystore/keystore0`
+
+### Alternative 2: With EigenlayerCLI
+
+- If you have the EigenLayer CLI installed, the keystore can be generated following [this](https://docs.eigenlayer.xyz/eigenlayer/operator-guides/operator-installation#import-keys) instructions. The key will be stored into `~/.eigenlayer/operator_keys`.
+
 ## SP1 proof
 
 The SP1 proof needs the proof file and the vm program file.
@@ -16,7 +47,8 @@ aligned submit \
 --vm_program <vm_program_file> \
 --conn wss://batcher.alignedlayer.com \
 --proof_generator_addr [proof_generator_addr] \
---batch_inclusion_data_directory_path [batch_inclusion_data_directory_path]
+--batch_inclusion_data_directory_path [batch_inclusion_data_directory_path] \
+--keystore_path <path_yo_ecdsa_keystore> 
 ```
 
 **Example**
@@ -27,7 +59,8 @@ aligned submit \
 --proving_system SP1 \
 --proof ./batcher/aligned/test_files/sp1/sp1_fibonacci.proof \
 --vm_program ./batcher/aligned/test_files/sp1/sp1_fibonacci-elf \
---conn wss://batcher.alignedlayer.com
+--conn wss://batcher.alignedlayer.com \
+--keystore_path ~/.aligned_keystore/keystore0
 ```
 
 ## Risc0 proof
@@ -42,7 +75,8 @@ aligned submit \
 --vm_program <vm_program_file> \
 --conn wss://batcher.alignedlayer.com \
 --proof_generator_addr [proof_generator_addr] \
---batch_inclusion_data_directory_path [batch_inclusion_data_directory_path]
+--batch_inclusion_data_directory_path [batch_inclusion_data_directory_path] \
+--keystore_path <path_yo_ecdsa_keystore>
 ```
 
 **Example**
@@ -53,7 +87,8 @@ aligned submit \
 --proving_system Risc0 \
 --proof ./batcher/aligned/test_files/risc_zero/risc_zero_fibonacci.proof \
 --vm_program ./batcher/aligned/test_files/risc_zero/fibonacci_id.bin \
---aligned_verification_data_path ~/.aligned/aligned_verification_data
+--aligned_verification_data_path ~/.aligned/aligned_verification_data \
+--keystore_path ~/.aligned_keystore/keystore0
 ```
 
 ## GnarkPlonkBn254, GnarkPlonkBls12_381 and Groth16Bn254
@@ -69,7 +104,8 @@ aligned submit \
 --vk <verification_key_file> \
 --conn wss://batcher.alignedlayer.com \
 --proof_generator_addr [proof_generator_addr] \
---batch_inclusion_data_directory_path [batch_inclusion_data_directory_path]
+--batch_inclusion_data_directory_path [batch_inclusion_data_directory_path] \
+--keystore_path <path_yo_ecdsa_keystore>
 ```
 
 **Examples**:
@@ -81,7 +117,8 @@ aligned submit \
 --proof ./batcher/aligned/test_files/plonk_bn254/plonk.proof \
 --public_input ./batcher/aligned/test_files/plonk_bn254/plonk_pub_input.pub \
 --vk ./batcher/aligned/test_files/plonk_bn254/plonk.vk \
---conn wss://batcher.alignedlayer.com
+--conn wss://batcher.alignedlayer.com \
+--keystore_path ~/.aligned_keystore/keystore0
 ```
 
 ```bash
@@ -91,7 +128,8 @@ aligned submit \
 --proof ./batcher/aligned/test_files/plonk_bls12_381/plonk.proof \
 --public_input ./batcher/aligned/test_files/plonk_bls12_381/plonk_pub_input.pub \
 --vk ./batcher/aligned/test_files/plonk_bls12_381/plonk.vk \
---conn wss://batcher.alignedlayer.com
+--conn wss://batcher.alignedlayer.com \
+--keystore_path ~/.aligned_keystore/keystore0
 ```
 
 ```bash
@@ -101,5 +139,6 @@ aligned submit \
 --proof ./batcher/aligned/test_files/groth16/ineq_1_groth16.proof \
 --public_input ./batcher/aligned/test_files/groth16/ineq_1_groth16.pub \
 --vk ./batcher/aligned/test_files/groth16/ineq_1_groth16.vk \
---conn wss://batcher.alignedlayer.com
+--conn wss://batcher.alignedlayer.com \
+--keystore_path ~/.aligned_keystore/keystore0
 ```

batcher/Cargo.lock

@@ -11,3 +11,4 @@ serde = { version = "1.0.201", features = ["derive"] }
 sha3 = { version = "0.10.8"}
 lambdaworks-crypto = { version = "0.7.0", features = ["serde"] }
 hex = "0.4.3"
+serde_json = "1.0.117"

batcher/aligned-batcher-lib/Cargo.toml

@@ -1,4 +1,9 @@
+use ethers::core::k256::ecdsa::SigningKey;
+use ethers::signers::Signer;
+use ethers::signers::Wallet;
 use ethers::types::Address;
+use ethers::types::Signature;
+use ethers::types::SignatureError;
 use lambdaworks_crypto::merkle_tree::{
     merkle::MerkleTree, proof::Proof, traits::IsMerkleTreeBackend,
 };
@@ -17,7 +22,7 @@ pub enum ProvingSystemId {
     Risc0,
 }
 
-#[derive(Debug, Serialize, Deserialize, Default, Clone)]
+#[derive(Debug, Serialize, Deserialize, Clone)]
 pub struct VerificationData {
     pub proving_system: ProvingSystemId,
     pub proof: Vec<u8>,
@@ -122,31 +127,39 @@ impl BatchInclusionData {
             .unwrap();
 
         BatchInclusionData {
-            batch_merkle_root: batch_merkle_tree.root.clone(),
+            batch_merkle_root: batch_merkle_tree.root,
             batch_inclusion_proof,
             index_in_batch: verification_data_batch_index,
         }
     }
 }
 
-#[cfg(test)]
-mod test {
-    use super::*;
-
-    #[test]
-    fn hash_new_parent_is_correct() {
-        let mut hasher = Keccak256::new();
-        hasher.update(vec![1u8]);
-        let child_1 = hasher.finalize_reset().into();
-        hasher.update(vec![2u8]);
-        let child_2 = hasher.finalize().into();
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct ClientMessage {
+    pub verification_data: VerificationData,
+    pub signature: Signature,
+}
 
-        let parent = VerificationCommitmentBatch::hash_new_parent(&child_1, &child_2);
+impl ClientMessage {
+    /// Client message is a wrap around verification data and its signature.
+    /// The signature is obtained by calculating the commitments and then hashing them.
+    pub async fn new(verification_data: VerificationData, wallet: Wallet<SigningKey>) -> Self {
+        let hashed_leaf = VerificationCommitmentBatch::hash_data(&verification_data.clone().into());
+        let signature = wallet.sign_message(hashed_leaf).await.unwrap();
 
-        // This value is built using Openzeppelin's module for Merkle Trees, in particular using
-        // the SimpleMerkleTree. For more details see the openzeppelin_merkle_tree/merkle_tree.js script.
-        let expected_parent = "71d8979cbfae9b197a4fbcc7d387b1fae9560e2f284d30b4e90c80f6bc074f57";
+        ClientMessage {
+            verification_data,
+            signature,
+        }
+    }
 
-        assert_eq!(hex::encode(parent), expected_parent)
+    /// The signature of the message is verified, and when it correct, the
+    /// recovered address from the signature is returned.
+    pub fn verify_signature(&self) -> Result<Address, SignatureError> {
+        let hashed_leaf =
+            VerificationCommitmentBatch::hash_data(&self.verification_data.clone().into());
+        let recovered = self.signature.recover(hashed_leaf)?;
+        self.signature.verify(hashed_leaf, recovered)?;
+        Ok(recovered)
     }
 }