coderabbitai[bot]
commented
3 months ago Walkthrough
The changes across the files primarily focus on enhancing the commitment and constraint handling logic within the Bolt Sidecar project. Significant updates include the introduction of parameters for ExecutionState initialization, refactoring of commitment validation, updated signing processes, caching of pre-confirmations until the commitment deadline, and gas-related transaction adjustments. New functionalities such as fetching the blob base fee and generating random Ethereum transactions were added, along with the introduction of new dependencies and configuration changes.
Changes
| Files / Grouped Files | Summary of Changes |
|---|---|
bolt-sidecar/bin/sidecar.rs |
Added parameter for ExecutionState initialization, updated commitment validation and signing, integrated constraints, enhanced retry logic, gas adjustments. |
bolt-sidecar/src/api/builder.rs |
Refactored BuilderProxyServer struct, updated error handling and logging, managed local payload caching, gas adjustments. |
bolt-sidecar/src/builder/mod.rs |
Refactored build_new_local_payload method, gas adjustments, enhanced payload construction logic. |
bolt-sidecar/src/builder/template.rs |
Transitioned to managing constraints within block template, gas adjustments, enhanced constraint handling logic. |
bolt-sidecar/src/client/rpc.rs |
Refined error handling for get_chain_id, added get_blob_basefee method, gas adjustments. |
bolt-sidecar/src/common.rs |
Updated function signatures to use PooledTransactionsElement, refined imports, introduced TransactionExt, gas adjustments. |
bolt-sidecar/src/json_rpc/api.rs |
Modified handling of CommitmentRequest, introduced gas adjustments, enhanced commitment request processing logic. |
bolt-sidecar/src/primitives/commitment.rs |
Shifted transaction handling to PooledTransactionsElement, updated serialization and deserialization functions. |
bolt-sidecar/src/primitives/constraint.rs |
Imported Address and PooledTransactionsElement, added sender field to Constraint, adjusted functions for sender, gas adjustments. |
bolt-sidecar/src/primitives/mod.rs |
Modified AccountState, GetPayloadResponse, added TransactionExt trait, gas adjustments. |
bolt-sidecar/src/state/execution.rs |
Reorganized imports, added error variants for fee validation, introduced max_commitments_per_slot, updated method signatures, gas adjustments. |
bolt-sidecar/src/state/fetcher.rs |
Added get_blob_basefee method to StateFetcher trait and its implementation, gas adjustments. |
bolt-sidecar/src/state/mod.rs |
Refactored test module, gas adjustments, streamlined test suite organization. |
bolt-spammer/.gitignore |
Added .env file to the list of ignored files. |
bolt-spammer/Cargo.toml |
Removed ethers, added new dependencies like rand, beacon-api-client, dotenvy, alloy, url, updated clap with new features. |
bolt-spammer/README.md |
Introduced a pre-confirmation spammer for the Helder testnet, including functionality and instructions for setting environment variables. |
bolt-spammer/rustfmt.toml |
Introduced configuration options for Rust code formatting, specifying settings for import ordering, comments, code style, and documentation comments. |
bolt-spammer/src/constants.rs |
Introduced public constants defining values such as slots per epoch, gas price, dead address string, and chain ID. |
builder/builder/builder.go |
Introduced constraintsCache, utilized within Builder methods, refined constraint handling logic. |
builder/builder/eth_service.go |
Added shardmap import, modified BuildBlock method signatures to include constraintsCache, updated implementations. |
bolt-spammer/src/utils.rs |
Introduced functions for generating random Ethereum transactions, preparing RPC requests, and retrieving current slot using Beacon API client. |
Sequence Diagrams
Old Flow (Commitment Submission)
sequenceDiagram
participant User
participant Sidecar
participant MEVBoost
participant Builder
User->>Sidecar: Send transaction
Sidecar->>MEVBoost: Submit constraints
MEVBoost->>Builder: Forward constraints
Builder->>MEVBoost: Validate and respond
MEVBoost->>Sidecar: Receive validation
Sidecar->>User: Acknowledge receiptNew Flow (Commitment Submission After Deadline)
sequenceDiagram
participant User
participant Sidecar
participant MEVBoost
participant Builder
User->>Sidecar: Send transaction
Sidecar->>Sidecar: Cache constraints
Sidecar->>MEVBoost: After deadline, submit constraints
MEVBoost->>Builder: Forward constraints
Builder->>MEVBoost: Validate and respond
MEVBoost->>Sidecar: Receive validation
Sidecar->>User: Acknowledge receiptAssessment against linked issues
| Objective (Issue #) | Addressed | Explanation |
|---|---|---|
| Submit constraints only after the commitment deadline (#109) | ✅ | |
| Check user balance and nonce before sending commitments (#102) | ✅ | |
| Invalidate past state (#125) | ✅ |
These validations ensure that the changes align with the primary objectives of the issues by adjusting the submission timing of constraints, checking balances and nonces before commitments, and clearing past states appropriately.
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
This PR refactors the block template by using the signed constraints list instead of the transactions signed. This allows a more granular control over the current state of the pre-confirmations accepted, by dropping an entire set of constraints in case some of its pre-confirmed transactions have been invalidated.
Summary by CodeRabbit
New Features
Enhancements
Bug Fixes
Chores
.envto.gitignoreto exclude sensitive information from version control.Cargo.tomlto reflect new project requirements.Documentation
README.mdto provide instructions for running the new pre-confirmation spammer.rustfmt.tomlfor consistent code formatting.