warden-protocol / wardenprotocol

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

x/intent: add unified MsgNewAction tx for creating new actions #321

Closed Pitasi closed 4 months ago

Pitasi commented 4 months ago

closes #261

Big PR, sorry. I suggest reviewing this commit by commit.

rationale: this has several benefits. First of all, we don't leak x/intent concepts such as "btl" (now renamed to TimeoutHeight) into other modules. Then, we also have a single point where Action are created and a single point where Action are executed, this will make it possible to implement things such as cronjobs.

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago
Walkthrough ## Walkthrough The recent changes introduce a new `MsgNewAction` transaction to the Warden protocol, allowing users to create actions generically. This reduces boilerplate code and enhances flexibility. Key modifications include the addition of new message types, changes to existing RPC methods, and updates to message handling logic to support the new transaction. The `MsgActionCreated` message has been removed, and various functions and structures have been updated to support the new `timeout_height` field and intent handling. ## Changes | File(s) | Change Summary | |-------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------| | `proto/warden/intent/action.proto` | Renamed `btl` to `timeout_height` in `Action` message; removed `MsgActionCreated`. | | `proto/warden/intent/tx.proto` | Added `NewAction` RPC method; defined `MsgNewAction` and `MsgNewActionResponse`. | | `proto/warden/warden/v1beta2/tx.proto` | Updated RPC methods to return specific response messages; renamed `creator` to `authority`. | | `warden/app/wasm-interop/custom_msg.go` | Added imports; updated message encoding logic; introduced `MsgNewAction`. | | `warden/testutil/keeper/intent.go` | Added `intentRegistry` initialization; updated `keeper.NewKeeper` call. | | `warden/testutil/keeper/warden.go` | Added `intentAuthority` initialization. | | `warden/x/intent/keeper/actions.go` | Updated `ExecuteAction` function; added new functions for message handling and validation. | | `warden/x/intent/module/module.go` | Added `Router` and `IntentRegistry` fields to `ModuleInputs` and `ModuleOutputs`. | | `warden/x/intent/types/action.go` | Removed `NewMsgActionCreated` function; updated `NewApprover` function. | | `warden/x/intent/types/codec.go` | Registered `MsgNewAction`. | | `warden/x/intent/types/errors.go` | Added `ErrInvalidActionMsgSigner`. | | `warden/x/intent/types/registry.go` | Introduced `IntentsRegistry` for managing intents. | | `warden/x/warden/keeper/intents.go` | Added functions for registering and handling intents. | | `warden/x/warden/keeper/keeper.go` | Added `intentAuthority` field; updated `NewKeeper` function; added `GetIntentAuthority` method. | | `warden/x/warden/keeper/msg_server.go` | Simplified `NewMsgServerImpl` function. | | `warden/x/warden/keeper/msg_server_add_space_owner.go` | Updated `AddSpaceOwner` function signature; added authority check. | | `warden/x/intent/keeper/keeper.go` | Added `router` and `intentsRegistry` fields to `Keeper`; updated `NewKeeper` function. | ## Sequence Diagram(s) (Beta) ```mermaid sequenceDiagram participant User participant MsgService participant IntentKeeper participant Router participant ModuleAccount User->>MsgService: Send MsgNewAction MsgService->>IntentKeeper: Create Action IntentKeeper->>Router: Route Message Router->>ModuleAccount: Execute Message ModuleAccount-->>Router: Execution Result Router-->>IntentKeeper: Execution Result IntentKeeper-->>MsgService: Action Created MsgService-->>User: MsgNewActionResponse ``` ## Assessment against linked issues | Objective (Issue #261) | Addressed | Explanation | |--------------------------------------------------------------|-----------|-------------| | Add `MsgNewAction` transaction | ✅ | | | Expose a generic `MsgCreateAction` | ✅ | | | Ensure only `x/intents` module can execute these messages | ✅ | | | Reduce duplicated boilerplate | ✅ | |

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.
github-actions[bot] commented 4 months ago

Hey @Pitasi and thank you for opening this pull request! 👋🏼

It looks like you forgot to add a changelog entry for your changes. Make sure to add a changelog entry in the 'CHANGELOG.md' file.

Overseven commented 4 months ago

How do I run integration tests? I tried to execute just test from tests dir, but got an error: warden node never became running. I'm also tried this instructions

Pitasi commented 4 months ago

How do I run integration tests? I tried to execute just test from tests dir, but got an error: warden node never became running. I'm also tried this instructions

just test should be enough, but maybe we have some timing issues inside the tests that makes them flaky 🤔

Overseven commented 4 months ago

just test should be enough, but maybe we have some timing issues inside the tests that makes them flaky 🤔

A new issue has been created