feat(sidecar): commit-boost integration

namn-grg commented 1 month ago

partially solves #201

Note - This is not e2e tested with commit-boost

Summary by CodeRabbit

New Features
- Introduced new configuration options for commit boosting, including an API endpoint and JWT for authentication.
- Added a new client type, CommitBoostSigner, to the public interface.
Improvements
- Enhanced BLS signing functionality with support for different signer types and improved type safety.
- Updated the SidecarDriver to streamline the signing process and support asynchronous operations.
- Improved the flexibility and security of the configuration management system.
Bug Fixes
- Simplified error handling in the signature request process and enhanced the clarity of the commit_and_sign method.
Chores
- Removed unnecessary dependencies to improve project requirements.

namn-grg commented 1 month ago

@coderabbitai review

coderabbitai[bot] commented 1 month ago

Walkthrough

Ahoy there! The changes to the bolt-sidecar project bring forth new configuration variables for commit boosting, refine the management of dependencies, and enhance the signing functionalities. The CommitBoostClient now sails with a SignerClient for handling requests, while the configuration structures have been updated to embrace new JWT settings. The code's overall structure has been streamlined for better clarity and maintainability, savvy?

Changes

Files	Change Summary
`bolt-sidecar/.env.example`	Added `BOLT_SIDECAR_COMMIT_BOOST_URL` and `BOLT_SIDECAR_COMMIT_BOOST_JWT_HEX` for commit boosting.
`bolt-sidecar/Cargo.toml`	Updated `cb-common` dependency with a specific revision; removed `cb-crypto`.
`bolt-sidecar/src/client/commit_boost.rs`	Refactored to use `CommitBoostSigner` with a focus on signing operations.
`bolt-sidecar/src/config/mod.rs`	Renamed `commit_boost_url` to `commit_boost_address` and added `commit_boost_jwt_hex`.
`bolt-sidecar/src/config/signing.rs`	Introduced `commit_boost_jwt_hex` field to `SigningOpts` structure.
`bolt-sidecar/src/crypto/bls.rs`	Updated signing methods to use fixed-size arrays for better performance.
`bolt-sidecar/src/driver.rs`	Simplified `SidecarDriver` struct; updated signing process to accommodate new signer types.
`bolt-sidecar/src/lib.rs`	Added `CommitBoostSigner` to the public interface.
`bolt-sidecar/src/primitives/commitment.rs`	Modified `commit_and_sign` to require `SignerECDSAAsync` and updated error handling.
`bolt-sidecar/src/test_util.rs`	Changed `TestSignableData` to use fixed-size arrays for data handling.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant CommitBoostSigner
    participant SignerClient

    Client->>CommitBoostSigner: Request to sign data
    CommitBoostSigner->>SignerClient: Forward signing request
    SignerClient-->>CommitBoostSigner: Return signed data
    CommitBoostSigner-->>Client: Send signed data

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?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

namn-grg commented 1 month ago

@coderabbitai review

namn-grg commented 1 month ago

Just working on a mock test

chainbound / bolt