feat: refactor config and add ChainConfig #108
Conversation
There was a problem hiding this comment.
this is made to work like before: we have default values for all chains, and CLI arguments "slot_time_in_seconds" and "commitment_deadline" are optional and override the defaults.
merklefruit
added
C: bolt-sidecar
| /// The slot time duration in seconds. If provided, | ||
| /// it overrides the default for the selected [Chain]. | ||
| #[clap(short = 's', long, default_value_t = DEFAULT_SLOT_TIME_IN_SECONDS)] | ||
| slot_time_in_seconds: u64, |
There was a problem hiding this comment.
Let's just do slot_time and add a description saying it's in seconds!
| #[clap(short = 'k', long)] | ||
| pub(super) private_key: Option<String>, | ||
| /// URL for the commit-boost sidecar | ||
| #[clap(short = 'C', long, conflicts_with("private_key"))] |
There was a problem hiding this comment.
Didn't know conflicts_with, sick!
There was a problem hiding this comment.
just ported over, work of @thedevbirb :)
|
@coderabbitai review |
Actions performedReview triggered.
|
WalkthroughThe changes refactor the Changes
Assessment against linked issues
Poem
Tip AI model upgrade
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (2)
bolt-sidecar/src/config/signing.rs (1)
1-16: Ensure consistency in documentation comments.The documentation comments for the fields
private_keyandcommit_boost_urlare clear and concise. Ensure that similar comments are consistently used throughout the codebase for better readability and maintainability.bolt-sidecar/src/config/chain.rs (1)
1-31: Ensure consistency in documentation comments.The documentation comments for constants and fields are clear and concise. Ensure that similar comments are consistently used throughout the codebase for better readability and maintainability.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (7)
- bolt-sidecar/bin/sidecar.rs (1 hunks)
- bolt-sidecar/src/builder/mod.rs (2 hunks)
- bolt-sidecar/src/builder/signature.rs (3 hunks)
- bolt-sidecar/src/config/chain.rs (1 hunks)
- bolt-sidecar/src/config/mod.rs (7 hunks)
- bolt-sidecar/src/config/signing.rs (1 hunks)
- bolt-sidecar/src/lib.rs (1 hunks)
Additional comments not posted (15)
bolt-sidecar/src/lib.rs (1)
28-28: LGTM! Ensure consistency in imports and exports.The export statement has been updated correctly to export
ChainConfiginstead ofChain.bolt-sidecar/src/config/chain.rs (5)
32-47: LGTM! Ensure default values are correctly documented.The
ChainConfigstruct and its fields are well-defined with appropriate default values. The documentation comments are clear and concise.
48-57: LGTM! Default implementation is correct.The
Defaultimplementation forChainConfigis correct and aligns with the defined default values.
58-68: LGTM! Enum definition is clear.The
Chainenum is well-defined and uses theValueEnumtrait for command-line argument parsing.
70-119: LGTM! Methods forChainConfigare well-defined.The methods for
ChainConfigare well-defined and provide necessary functionality for chain-specific configurations.
122-152: LGTM! Test functions are well-defined.The test functions for different chain configurations are well-defined and ensure the correctness of the
ChainConfigmethods.bolt-sidecar/src/builder/signature.rs (2)
10-18: LGTM! Ensure consistency in function signatures.The function signature for
sign_builder_messagehas been updated correctly to useChainConfig.
36-36: LGTM! Ensure consistency in function signatures.The function signature for
verify_signed_builder_messagehas been updated correctly to useChainConfig.bolt-sidecar/src/builder/mod.rs (1)
16-16: LGTM! Ensure consistency in struct definitions.The
LocalBuilderstruct has been updated correctly to useChainConfiginstead ofChain.bolt-sidecar/bin/sidecar.rs (1)
41-41: Ensure the newcommitment_deadlinemethod is correctly implemented.The
commitment_deadlineis now accessed throughconfig.chain.commitment_deadline(). Verify that this method returns the expected value.Verification successful
The
commitment_deadlinemethod is correctly implemented.The
commitment_deadlinemethod inChainConfigreturns aDurationderived from thecommitment_deadlinefield, which is properly defined and initialized.
bolt-sidecar/src/config/chain.rs: pub fn commitment_deadline(&self) -> Durationbolt-sidecar/src/config/chain.rs: commitment_deadline: u64Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the implementation of the `commitment_deadline` method in the `ChainConfig` struct. # Test: Search for the `commitment_deadline` method definition. Expect: A method that returns the commitment deadline. rg --type rust $'fn commitment_deadline' --context 5Length of output: 676
Script:
#!/bin/bash # Description: Verify the definition and initialization of `commitment_deadline` within the `ChainConfig` struct. # Test: Search for the `commitment_deadline` field in the `ChainConfig` struct. rg --type rust 'commitment_deadline' --context 5Length of output: 10655
bolt-sidecar/src/config/mod.rs (5)
7-9: LGTM! TheChainConfigmodule is correctly introduced and used.The
ChainConfigmodule is correctly introduced and used in theOptsandConfigstructs.
10-11: LGTM! TheSigningOptsmodule is correctly introduced and used.The
SigningOptsmodule is correctly introduced and used in theOptsstruct.
59-61: LGTM! TheChainConfigis correctly used in theOptsstruct.The
ChainConfigis correctly used in theOptsstruct.
98-98: LGTM! TheChainConfigis correctly used in theConfigstruct.The
ChainConfigis correctly used in theConfigstruct.
203-204: LGTM! TheChainConfigis correctly assigned in thetry_fromimplementation.The
ChainConfigis correctly assigned in thetry_fromimplementation for theConfigstruct.
configmodule #106Summary by CodeRabbit
New Features
ChainConfigfor enhanced chain configuration management, providing defaults for commitment deadlines and slot times.Refactor
ChaintoChainConfigacross various modules for better clarity and organization.ChainConfig.Chores
commitment_deadline.SigningOptsstruct for signing configurations.