fix(sdk): Partially verified batch should display results of processing #1675

PatStiles · 2024-12-21T00:55:51Z

Partially verified batch should display result of processing

Description

When submitting multiple proofs of the same max_fee there is a possible case that the user's balance in the BatcherPaymentService has some but not all of the needed balance to pay cover submission. In this case a InsufficientBalance error will be thrown and some proofs will be processed while over error. Currently this is not displayed to the user and this pr seeks to shown this information by modifying the sdk and error message.

Test Cases:

Start a local devnet and send proofs
fund the batcher with ~ 0.09 eth:

cast send --rpc-url http://localhost:8545 0x7bc06c482DEAd17c0e297aFbC32f6e63d3846650 --value 0.09ether --private-key <DEVNET_WALLET_PRIVATE_KEY>

aligned get-user-balance --user_addr <DEVNET_WALLET_PRIVATE_KEY>

cd batcher/aligned

Submit proofs with the relevant test cases and observe the results deascribed in the images below.

All Proofs Fails w/ InsufficientBalance:

cargo run --release -- submit \
--proving_system GnarkPlonkBn254 \
--proof ../../scripts/test_files/gnark_plonk_bn254_script/plonk.proof \
--public_input ../../scripts/test_files/gnark_plonk_bn254_script/plonk_pub_input.pub \
--vk ../../scripts/test_files/gnark_plonk_bn254_script/plonk.vk \
--batcher_url ws://localhost:8080 \
--private_key <DEVNET_PRIVATE_KEY> \
--network devnet \
--max_fee 1ether --repetitions 9

One Proof Fails w/ InsufficientBalance:

cargo run --release -- submit \
--proving_system GnarkPlonkBn254 \
--proof ../../scripts/test_files/gnark_plonk_bn254_script/plonk.proof \
--public_input ../../scripts/test_files/gnark_plonk_bn254_script/plonk_pub_input.pub \
--vk ../../scripts/test_files/gnark_plonk_bn254_script/plonk.vk \
--batcher_url ws://localhost:8080 \
--private_key <DEVNET_PRIVATE_KEY> \
--network devnet \
--max_fee 1ether --repetitions 1

All Proofs are processed:

cargo run --release -- submit \
--proving_system GnarkPlonkBn254 \
--proof ../../scripts/test_files/gnark_plonk_bn254_script/plonk.proof \
--public_input ../../scripts/test_files/gnark_plonk_bn254_script/plonk_pub_input.pub \
--vk ../../scripts/test_files/gnark_plonk_bn254_script/plonk.vk \
--batcher_url ws://localhost:8080 \
--private_key <DEVNET_PRIVATE_KEY> \
--network devnet \
--max_fee 0.01ether --repetitions 8

Some proofs fail with w/ InsufficientBalance:

cargo run --release -- submit \
--proving_system GnarkPlonkBn254 \
--proof ../../scripts/test_files/gnark_plonk_bn254_script/plonk.proof \
--public_input ../../scripts/test_files/gnark_plonk_bn254_script/plonk_pub_input.pub \
--vk ../../scripts/test_files/gnark_plonk_bn254_script/plonk.vk \
--batcher_url ws://localhost:8080 \
--private_key <DEVNET_PRIVATE_KEY> \
--network devnet \
--max_fee 0.01ether --repetitions 10

Type of change

Please delete options that are not relevant.

Bug fix

Checklist

JulianVentura

Didn't test, left you some comments

batcher/aligned-batcher/src/lib.rs

batcher/aligned-sdk/src/communication/messaging.rs

batcher/aligned-batcher/src/lib.rs

batcher/aligned-sdk/src/communication/messaging.rs

batcher/aligned-batcher/src/lib.rs

batcher/aligned-sdk/src/core/errors.rs

batcher/aligned-sdk/src/communication/messaging.rs

uri-99 · 2024-12-23T16:16:55Z

batcher/aligned-sdk/src/communication/messaging.rs

+                if let SubmitError::InsufficientBalance(_, last_valid_nonce) = e {
+                    aligned_submitted_data.push(Err(e));
+                    if last_valid_nonce < last_proof_nonce {
+                        last_proof_nonce = last_valid_nonce;
+                    }
+
+                    if last_proof_nonce < first_nonce {
+                        break;
+                    }
+
+                    continue;
+                }


this goes inside handle_batcher_response.

batcher/aligned-batcher/src/lib.rs

batcher/aligned-sdk/src/communication/messaging.rs

batcher/aligned/src/main.rs

PatStiles self-assigned this Dec 23, 2024

JulianVentura reviewed Dec 23, 2024

View reviewed changes

batcher/aligned-batcher/src/lib.rs Show resolved Hide resolved

batcher/aligned-sdk/src/communication/messaging.rs Outdated Show resolved Hide resolved

batcher/aligned-sdk/src/communication/messaging.rs Outdated Show resolved Hide resolved

uri-99 requested changes Dec 23, 2024

View reviewed changes

batcher/aligned-batcher/src/lib.rs Outdated Show resolved Hide resolved

batcher/aligned-sdk/src/communication/messaging.rs Outdated Show resolved Hide resolved

batcher/aligned-batcher/src/lib.rs Show resolved Hide resolved

batcher/aligned-sdk/src/core/errors.rs Show resolved Hide resolved