search

warden-protocol / wardenprotocol

Monorepo for the Warden Protocol.
https://wardenprotocol.org
Apache License 2.0
1.09k stars 96 forks source link

Rename UpdateKeyRequest->FulfilKeyRequest and SignatureRequest->SignRequest #460

Closed Pitasi closed 4 days ago

Pitasi commented 4 days ago

Some renames to make everything more consistent.

They might be breaking changes but if we don't do these now we'll never do :)

Summary by CodeRabbit

coderabbitai[bot] commented 4 days ago

[!WARNING]

Rate limit exceeded

@Pitasi has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 33 minutes and 9 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 20068f8bb9f0beba9cf7670969192cf7b7c30894 and 7aeb887e92176655fb7edeae21a3fdbb6f25f417.

Walkthrough

The recent changes primarily involve renaming various entities, functions, and variables to enhance consistency and clarity within the codebase. This includes updating terms related to signature requests and fulfillment, specifically changing Signature to Sign across numerous files. Additionally, the updates introduce some new features such as events related to keys, keychains, and sign requests, as well as fixing and improving existing functionalities, including handling sign requests and integrating new technologies.

Changes

Files/Paths Change Summaries
CHANGELOG.md Updated terminology for various request-related fields and documented overall changes.
docs/.spelling, docs/docs/developers/... Renamed terminology related to sign requests and fulfillment across documentations.
docs/docs/learn/keychains/..., docs/static/openapi.yml Updated terminologies for keychain operations and API endpoints in the OpenAPI spec.
go-client/query_client_warden.go, go-client/tx_warden.go Renamed request methods and associated message types/functions in the Go client.
keychain-sdk/sign_requests.go Updated function names and references related to pending sign requests.
proto/warden/warden/v1beta2/... Renamed various message types and fields related to sign requests in multiple protobuf files.
spaceward/src/components/..., spaceward/src/features/..., spaceward/src/hooks/... Renamed components and states related to signature requests in the spaceward application.
tests/cases/keychain_writers.go Updated test cases related to sign requests and their identifiers.
warden/x/warden/keeper/keeper.go, warden/x/warden/keeper/msg_server_fulfil_sign_request.go Renamed collections and methods associated with sign requests in the Warden keeper logic.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Node
    participant Keychain

    Client->>+Node: MsgNewSignRequest
    Node-->>Client: Acknowledge SignRequest
    Node->>Keychain: Broadcast SignRequest
    Keychain-->>Node: Awaiting Approval
    Node->>Client: Status: Awaiting Approval

    Client->>+Node: QuerySignRequests
    Node-->>Client: Send List of SignRequests
    Client->>+Node: MsgFulfilSignRequest
    Node-->>Client: Acknowledge FulfilRequest

    Note over Node, Keychain: Processing Signature Fulfillment
    Keychain-->>Node: Signature Fulfilled
    Node->>Client: Status: Signature Fulfilled

This diagram highlights the interaction flow between the Client, Node, and Keychain for handling new sign requests and fulfilling them, showcasing the updated terminology in the process.

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 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.