feat: rust sdk (#459)

Co-authored-by: Mariano Nicolini <mariano.nicolini.91@gmail.com>
Co-authored-by: MauroFab <maurotoscano2@gmail.com>
Co-authored-by: Santos Rosati <rosatisantos@gmail.com>
Co-authored-by: JuArce <52429267+JuArce@users.noreply.github.com>
Co-authored-by: Nicolas Rampoldi <58613770+NicolasRampoldi@users.noreply.github.com>

Author: 6 people

batcher/Cargo.lock

@@ -1,7 +1,7 @@
 [workspace]
 members = [
     "aligned-batcher",
-    "aligned-batcher-lib",
+    "aligned-sdk",
     "aligned"
 ]
 resolver = "2"

batcher/Cargo.toml

@@ -29,4 +29,4 @@ halo2_backend = { git = "https://github.com/yetanotherco/yet-another-halo2-fork.
 halo2_proofs = { git = "https://github.com/yetanotherco/yet-another-halo2-fork.git", branch = "feat/serde_constraint_system" }
 lazy_static = "1.4.0"
 bincode = "1.3.3"
-aligned-batcher-lib = { path = "../aligned-batcher-lib"}
+aligned-sdk = { path = "../aligned-sdk"}

batcher/aligned-batcher-lib/src/lib.rs

@@ -1,4 +1,4 @@
-use aligned_batcher_lib::types::ProvingSystemId;
+use aligned_sdk::types::ProvingSystemId;
 
 #[derive(Copy, Clone, Debug)]
 #[repr(C)]

batcher/aligned-batcher/Cargo.toml

@@ -5,7 +5,13 @@ use std::net::SocketAddr;
 use std::sync::Arc;
 use std::time::Duration;
 
+use crate::eth::BatchVerifiedEventStream;
+use aligned_sdk::types::{
+    BatchInclusionData, ClientMessage, VerificationCommitmentBatch, VerificationData,
+    VerificationDataCommitment,
+};
 use aws_sdk_s3::client::Client as S3Client;
+use eth::{BatchVerifiedFilter, BatcherPaymentService};
 use ethers::prelude::{Middleware, Provider};
 use ethers::providers::Ws;
 use ethers::types::{Address, U256};
@@ -20,18 +26,11 @@ use tokio_tungstenite::tungstenite::error::ProtocolError;
 use tokio_tungstenite::tungstenite::protocol::{frame::coding::CloseCode, CloseFrame};
 use tokio_tungstenite::tungstenite::{Error, Message};
 use tokio_tungstenite::WebSocketStream;
-
-use aligned_batcher_lib::types::{
-    BatchInclusionData, ClientMessage, VerificationCommitmentBatch, VerificationData,
-    VerificationDataCommitment,
-};
-use eth::{BatchVerifiedFilter, BatcherPaymentService};
 use types::batch_queue::BatchQueue;
 use types::errors::BatcherError;
 
 use crate::config::{ConfigFromYaml, ContractDeploymentOutput, NonPayingConfig};
 use crate::eth::AlignedLayerServiceManager;
-use crate::eth::BatchVerifiedEventStream;
 
 mod config;
 mod eth;
@@ -45,8 +44,6 @@ mod zk_utils;
 
 const S3_BUCKET_NAME: &str = "storage.alignedlayer.com";
 
-const PROTOCOL_VERSION: u16 = 0;
-
 pub struct Batcher {
     s3_client: S3Client,
     eth_ws_provider: Provider<Ws>,
@@ -59,7 +56,6 @@ pub struct Batcher {
     max_batch_size: usize,
     last_uploaded_batch_block: Mutex<u64>,
     pre_verification_is_enabled: bool,
-    protocol_version: u16,
     non_paying_config: Option<NonPayingConfig>,
 }
 
@@ -121,7 +117,6 @@ impl Batcher {
             max_batch_size: config.batcher.max_batch_size,
             last_uploaded_batch_block: Mutex::new(last_uploaded_batch_block),
             pre_verification_is_enabled: config.batcher.pre_verification_is_enabled,
-            protocol_version: PROTOCOL_VERSION,
             non_paying_config: config.batcher.non_paying,
         }
     }
@@ -172,7 +167,11 @@ impl Batcher {
         let outgoing = Arc::new(RwLock::new(outgoing));
 
         // Send the protocol version to the client
-        let protocol_version_msg = Message::binary(self.protocol_version.to_be_bytes().to_vec());
+        let protocol_version_msg = Message::binary(
+            aligned_sdk::sdk::CURRENT_PROTOCOL_VERSION
+                .to_be_bytes()
+                .to_vec(),
+        );
 
         outgoing
             .write()

batcher/aligned-batcher/src/gnark/mod.rs

@@ -5,7 +5,7 @@ use futures_util::stream::SplitSink;
 use tokio::{net::TcpStream, sync::RwLock};
 use tokio_tungstenite::{tungstenite::Message, WebSocketStream};
 
-use aligned_batcher_lib::types::{VerificationData, VerificationDataCommitment};
+use aligned_sdk::types::{VerificationData, VerificationDataCommitment};
 
 pub(crate) type BatchQueueEntry = (
     VerificationData,

batcher/aligned-batcher/src/lib.rs

@@ -3,7 +3,7 @@ use crate::halo2::ipa::verify_halo2_ipa;
 use crate::halo2::kzg::verify_halo2_kzg;
 use crate::risc_zero::verify_risc_zero_proof;
 use crate::sp1::verify_sp1_proof;
-use aligned_batcher_lib::types::{ProvingSystemId, VerificationData};
+use aligned_sdk::types::{ProvingSystemId, VerificationData};
 use log::{debug, warn};
 
 pub(crate) fn verify(verification_data: &VerificationData) -> bool {

batcher/aligned-batcher/src/types/batch_queue.rs

@@ -1,14 +1,17 @@
 [package]
-name = "aligned-batcher-lib"
+name = "aligned-sdk"
 version = "0.1.0"
 edition = "2021"
 
 [dependencies]
 ethers = { tag = "v2.0.15-fix-reconnections", features = ["ws", "rustls"], git = "https://github.com/yetanotherco/ethers-rs.git" }
-anyhow = "1.0.83"
 log = { version = "0.4.21"}
+serde_json = "1.0.117"
+tokio-tungstenite = { version = "0.23.1", features = ["native-tls"] }
+futures-util = "0.3.30"
+tokio = { version = "1.37.0", features = ["io-std", "time", "macros", "rt", "rt-multi-thread", "sync"] }
+lambdaworks-crypto = { version = "0.7.0", features = ["serde"] }
 serde = { version = "1.0.201", features = ["derive"] }
 sha3 = { version = "0.10.8"}
-lambdaworks-crypto = { version = "0.7.0", features = ["serde"] }
+url = "2.5.0"
 hex = "0.4.3"
-serde_json = "1.0.117"

batcher/aligned-batcher/src/zk_utils/mod.rs

@@ -0,0 +1,92 @@
+# Aligned Verification SDK
+
+The Aligned Verification SDK facilitates the submission and verification of proofs through the Aligned batcher and checks the inclusion of these verified proofs on-chain. This README provides an overview of the SDK, its installation, usage, and API details.
+
+## Table of Contents
+- [Aligned Verification SDK](#aligned-verification-sdk)
+  - [Table of Contents](#table-of-contents)
+  - [Installation](#installation)
+  - [API Reference](#api-reference)
+
+## Installation
+
+To use this SDK in your Rust project, add the following to your `Cargo.toml`:
+
+```toml
+[dependencies]
+aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer" }
+```
+
+## API Reference
+
+### submit
+
+Submits a proof to the batcher to be verified and returns an aligned verification data struct.
+
+#### Arguments
+
+- `batcher_addr` - The address of the batcher to which the proof will be submitted.
+- `verification_data` - The verification data for the proof.
+- `wallet` - The wallet used to sign the proof.
+
+#### Returns
+
+- `Result<Option<AlignedVerificationData>>, SubmitError>` - An aligned verification data or an error.
+
+#### Errors
+
+- `MissingParameter` if the verification data vector is empty.
+- `SerdeError` if there is an error serializing the verification data.
+- `ConnectionError` if there is an error sending the message to the websocket.
+
+### submit_multiple
+
+Submits mulitple proofs to the batcher to be verified and returns an aligned verification data array.
+
+#### Arguments
+
+- `batcher_addr` - The address of the batcher to which the proof will be submitted.
+- `verification_data` - A verification data array.
+- `wallet` - The wallet used to sign the proof.
+
+#### Returns
+
+- `Result<Option<Vec<AlignedVerificationData>>>, SubmitError>` - An aligned verification data array or an error.
+
+#### Errors
+
+- `MissingParameter` if the verification data vector is empty.
+- `SerdeError` if there is an error serializing the verification data.
+- `ConnectionError` if there is an error sending the message to the websocket.
+
+### verify_proof_onchain
+
+Checks if the proof has been verified with Aligned and is included in the batch on-chain.
+
+#### Arguments
+
+- `aligned_verification_data` - The aligned verification data obtained when submitting the proofs.
+- `chain` - The chain on which the verification will be done.
+- `eth_rpc_url` - The URL of the Ethereum RPC node.
+
+#### Returns
+
+- `Result<bool, VerificationError>` - A boolean indicating whether the proof was verified on-chain and is included in the batch or an error.
+
+#### Errors
+
+- `EthError` if there is an error creating the rpc provider.
+- `ParsingError` if there is an error parsing the address of the contract.
+- `EthError` if there is an error verifying the proof on-chain.
+
+### get_verification_key_commitment
+
+Generates a keccak256 hash commitment of the verification key.
+
+#### Arguments
+
+- `content` - A byte slice of the verification key.
+
+#### Returns
+
+- `[u8; 32]` - A 32-byte array representing the keccak256 hash of the verification key.