Skip to content

refactor(batcher): error types and messages #2015

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
MarcosNicolau wants to merge 3 commits into from
Closed

refactor(batcher): error types and messages #2015

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
881a5b8
refactor: batcher errors
MarcosNicolau Jul 7, 2025
b68cdf9
refactor: better org of errs and print messages
MarcosNicolau Jul 7, 2025
865ba17
fix: update comments
JuArce Jul 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
341 changes: 113 additions & 228 deletions crates/batcher/src/lib.rs
View file
Open in desktop

Large diffs are not rendered by default.

13 changes: 10 additions & 3 deletions crates/batcher/src/types/batch_state.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ impl BatchState {
pub(crate) fn replacement_entry_is_valid(
&mut self,
replacement_entry: &BatchQueueEntry,
) -> bool {
) -> Result<(), (U256, U256)> {
let replacement_max_fee = replacement_entry.nonced_verification_data.max_fee;
let nonce = replacement_entry.nonced_verification_data.nonce;
let sender = replacement_entry.sender;
Expand All @@ -214,11 +214,18 @@ impl BatchState {
);

// it is a valid entry only if there is no entry with the same sender, lower nonce and a lower fee
!self.batch_queue.iter().any(|(entry, _)| {
if let Some((entry, _)) = self.batch_queue.iter().find(|(entry, _)| {
entry.sender == sender
&& entry.nonced_verification_data.nonce < nonce
&& entry.nonced_verification_data.max_fee < replacement_max_fee
})
}) {
Err((
entry.nonced_verification_data.nonce,
entry.nonced_verification_data.max_fee,
))
} else {
Ok(())
}
}

/// Updates or removes a user's state when their latest proof entry is removed from the batch queue.
Expand Down
47 changes: 15 additions & 32 deletions crates/cli/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,7 @@ async fn main() -> Result<(), AlignedError> {
PathBuf::from(&submit_args.batch_inclusion_data_directory_path);

std::fs::create_dir_all(&batch_inclusion_data_directory_path).map_err(|e| {
SubmitError::IoError(batch_inclusion_data_directory_path.clone(), e)
SubmitError::IoError(batch_inclusion_data_directory_path.clone(), e.to_string())
})?;

let eth_rpc_url = submit_args.eth_rpc_url.clone();
Expand Down Expand Up @@ -542,22 +542,22 @@ async fn main() -> Result<(), AlignedError> {
wallet = wallet.with_chain_id(chain_id);

let nonce = match &submit_args.nonce {
Some(nonce) => U256::from_dec_str(nonce).map_err(|_| SubmitError::InvalidNonce)?,
Some(nonce) => U256::from_dec_str(nonce).expect("A valid nonce number"),
None => {
get_nonce_from_batcher(submit_args.network.clone().into(), wallet.address())
.await
.map_err(|e| match e {
aligned_sdk::common::errors::GetNonceError::EthRpcError(e) => {
SubmitError::GetNonceError(e)
SubmitError::EthereumProviderError(e)
}
aligned_sdk::common::errors::GetNonceError::ConnectionFailed(e) => {
SubmitError::GenericError(e)
SubmitError::WebSocketConnectionError(e)
}
aligned_sdk::common::errors::GetNonceError::InvalidRequest(e) => {
SubmitError::GenericError(e)
}
aligned_sdk::common::errors::GetNonceError::SerializationError(e) => {
SubmitError::GenericError(e)
SubmitError::SerializationError(e)
}
aligned_sdk::common::errors::GetNonceError::ProtocolMismatch {
current,
Expand Down Expand Up @@ -612,8 +612,7 @@ async fn main() -> Result<(), AlignedError> {
.insert(aligned_verification_data.batch_merkle_root);
}
Err(e) => {
warn!("Error while submitting proof: {:?}", e);
handle_submit_err(e).await;
warn!("Error while submitting proof: {}", e);
return Ok(());
}
};
Expand Down Expand Up @@ -646,13 +645,16 @@ async fn main() -> Result<(), AlignedError> {
VerifyProofOnchain(verify_inclusion_args) => {
let batch_inclusion_file =
File::open(verify_inclusion_args.batch_inclusion_data.clone()).map_err(|e| {
SubmitError::IoError(verify_inclusion_args.batch_inclusion_data.clone(), e)
SubmitError::IoError(
verify_inclusion_args.batch_inclusion_data.clone(),
e.to_string(),
)
})?;

let reader = BufReader::new(batch_inclusion_file);

let aligned_verification_data: AlignedVerificationData =
cbor_deserialize(reader).map_err(SubmitError::SerializationError)?;
let aligned_verification_data: AlignedVerificationData = cbor_deserialize(reader)
.map_err(|e| SubmitError::SerializationError(e.to_string()))?;

info!("Verifying response data matches sent proof data...");
let response = verification_layer::is_proof_verified(
Expand All @@ -677,10 +679,10 @@ async fn main() -> Result<(), AlignedError> {
info!("Commitment: {}", hex::encode(vk_commitment));
if let Some(output_file) = args.output_file {
let mut file = File::create(output_file.clone())
.map_err(|e| SubmitError::IoError(output_file.clone(), e))?;
.map_err(|e| SubmitError::IoError(output_file.clone(), e.to_string()))?;

file.write_all(hex::encode(vk_commitment).as_bytes())
.map_err(|e| SubmitError::IoError(output_file.clone(), e))?;
.map_err(|e| SubmitError::IoError(output_file.clone(), e.to_string()))?;
}
}
DepositToBatcher(deposit_to_batcher_args) => {
Expand Down Expand Up @@ -940,27 +942,8 @@ fn verification_data_from_args(args: &SubmitArgs) -> Result<VerificationData, Su
})
}

async fn handle_submit_err(err: SubmitError) {
match err {
SubmitError::InvalidNonce => {
error!("Invalid nonce. try again");
}
SubmitError::ProofQueueFlushed => {
error!("Batch was reset. try resubmitting the proof");
}
SubmitError::InvalidProof(reason) => error!("Submitted proof is invalid: {}", reason),
SubmitError::InsufficientBalance(sender_address) => {
error!(
"Insufficient balance to pay for the transaction, address: {}",
sender_address
)
}
_ => {}
}
}

fn read_file(file_name: PathBuf) -> Result<Vec<u8>, SubmitError> {
std::fs::read(&file_name).map_err(|e| SubmitError::IoError(file_name, e))
std::fs::read(&file_name).map_err(|e| SubmitError::IoError(file_name, e.to_string()))
}

fn read_file_option(param_name: &str, file_name: Option<PathBuf>) -> Result<Vec<u8>, SubmitError> {
Expand Down
Loading
Loading