search

PeggyJV / steward

Eth Contract Monitor
Apache License 2.0
31 stars 18 forks source link

Encoding Server, Go Request builder package, client example #262

Closed cbrit closed 4 months ago

cbrit commented 4 months ago

Adds an server that can be run with steward encode start to submit contract call data params in the form of protos and get back the hex-encoded call data.

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The changes encompass various updates and additions across multiple files, focusing on enhanced functionalities related to gRPC interactions, encoding services, and client-side operations. Key enhancements include new Go modules for building gRPC schedule requests, TLS authentication, encoding services, and better integration testing setups alongside expanded documentation and improved proto definitions.

Changes

File / Directory Change Summary
README.md Updated installation instructions emphasizing building from source with Rust and Git.
client_example/adaptor_call.go Added logic for making multiple function calls with Uniswap V1 adaptors, defining several new structures.
client_example/main.go Introduced functions for establishing gRPC connections with TLS encryption and building clients.
client_example/schedule_request.go Added functionalities to build Uniswap V3 schedule requests and perform swaps with the Uniswap V3 adaptor.
docs/00-TableOfContents.md Added a new section "Steward for Strategists."
docs/06-StewardForStrategists.md Introduced the gRPC server encode mode for testing contract call data encoding.
hash_proto Made modifications related to content integrity; no alterations to public entities.
proto/steward/v4/steward.proto Introduced EncodingService, EncodeRequest, and EncodeResponse for contract call encoding.
src/commands.rs Added Encode module and EncodeCmd command to StewardCmd enum.
src/commands/encode.rs Defined EncodeCmd command and start module.
src/encode.rs Implemented EncodingHandler struct and different function call encoding methods.
src/lib.rs Added a new encode module.
src/server.rs Added functions for encoding services setup and error handling.
src/cork.rs Updated id_hash function by removing the reference from the encoded_call argument.
go/builder/cellar_call.go Introduced methods for building function calls for CellarV2_5 in CellarCallBuilder.
go/builder/request.go Added ScheduleRequestBuilder for constructing ScheduleRequest objects with validation logic.
go/client_example/main.go (new change) Implemented a Go client application demonstrating two-way TLS authentication and gRPC server interaction using steward_proto.
integration_tests/proposal_test.go Reformatted the code for better readability without altering the logic or control flow.
integration_tests/setup_test.go Adjusted indentation and formatting for the configuration declaration for improved readability.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Client Application
    participant GRPC Server as gRPC Server
    participant TLS as TLS Service
    participant Encoding as Encoding Service
    participant Builder as Builder Service

    Client->>TLS: buildCredentials()
    TLS-->>Client: TransportCredentials

    Client->>GRPC Server: getConnection(TransportCredentials)
    GRPC Server-->>Client: ClientConn

    Client->>Builder: buildScheduleRequest()
    Builder-->>Client: ScheduleRequest

    Client->>GRPC Server: SendRequest(ScheduleRequest)
    GRPC Server->>Encoding: EncodeRequest(CallData)
    Encoding-->>GRPC Server: EncodeResponse(EncodedCall)
    GRPC Server-->>Client: Response(EncodedCall)
Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 6d78889adb0850ca1530f5979a39a836d29bf817 and 35f0a78b4724bbe62f0ef6222cfdfb3b2bc3b542.
Files selected for processing (1) * go/client_example/main.go (1 hunks)
Files skipped from review as they are similar to previous changes (1) * go/client_example/main.go
--- 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): > :bangbang: **IMPORTANT** > Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged. - 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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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.