search

warden-protocol / wardenprotocol

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

feat(x/intent): emit some events #410

Closed Pitasi closed 1 week ago

Pitasi commented 2 weeks ago

See CHANGELOG.md for the list of emitted events.

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks 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 24 minutes and 3 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 b3d31c689418f10f883af4e2cefc6e324309fa48 and 277759f7744f8559c9fbb2b9c8c1422be671707b.

Walkthrough

This update introduces multiple new event messages related to intents and actions, specifically EventCreateIntent, EventUpdateIntent, EventCreateAction, EventApproveAction, and EventActionStateChange. Additionally, it modifies how statuses and results are managed within actions, emphasizing method calls and context passing over direct assignments. These changes ensure more robust event handling and state management within the system.

Changes

File Change Summary
CHANGELOG.md Updated summary of changes including new events and adjustments for specific parties to update SignatureRequest.
proto/warden/intent/events.proto Added new protobuf messages for intent and action events: EventCreateIntent, EventUpdateIntent, EventCreateAction, EventApproveAction, EventActionStateChange.
warden/x/intent/keeper/actions.go Changed methods to use SetStatus, SetResult, and AddApprover with context.
warden/x/intent/keeper/msg_server_approve_action.go Updated ApproveAction method to use SetStatus and AddApprover methods with context.
warden/x/intent/keeper/msg_server_new_action.go Added emission of EventCreateAction using sdkCtx.EventManager().EmitTypedEvent.
warden/x/intent/keeper/msg_server_new_intent.go Added emission of EventCreateIntent in NewIntent function.
warden/x/intent/keeper/msg_server_revoke_action.go Updated RevokeAction to set status using SetStatus method with context.
warden/x/intent/keeper/msg_server_update_intent.go Added emission of EventUpdateIntent during the UpdateIntent function.
warden/x/intent/types/action.go Updated SetResult, added SetStatus, and modified AddApprover methods to handle context and emit events.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MsgServer
    participant Keeper
    participant SDKContext
    participant EventManager

    User ->> MsgServer: NewIntent(request)
    MsgServer ->> SDKContext: UnwrapContext()
    MsgServer ->> Keeper: CreateIntent(ctx, request)
    Keeper -->> MsgServer: Response(id)
    MsgServer ->> EventManager: EmitTypedEvent(EventCreateIntent)
    MsgServer -->> User: Response(id)

    User ->> MsgServer: ApproveAction(request)
    MsgServer ->> SDKContext: UnwrapContext()
    MsgServer ->> Keeper: GetAction(ctx, id)
    Keeper -->> MsgServer: Action
    MsgServer ->> Keeper: SetStatus(ctx, ActionStatus)
    Keeper -->> MsgServer: Status Set
    MsgServer ->> Keeper: AddApprover(ctx, approver, timestamp)
    Keeper -->> MsgServer: Approver Added
    MsgServer ->> EventManager: EmitTypedEvent(EventApproveAction)
    MsgServer -->> User: Response(success)

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.