search

warden-protocol / wardenprotocol

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

chore(x/intent): cleanup dead code #413

Closed Pitasi closed 2 weeks ago

Pitasi commented 2 weeks ago

Remove ActionType, ActionHandler, and cleanup a couple functions.

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago
Walkthrough ## Walkthrough Recent updates to the Warden module include the removal and reordering of fields in `MsgApproveAction` and `MsgRevokeAction` messages, refactoring and renaming of key functions in the Keeper, and the removal or integration of various utilities and handlers. These modifications collectively improve the code organization, enhance functionality, and streamline the execution flow of actions within the Warden system. ## Changes | Files & Changes | Summary | |--------------------------------------------------------------|------------------------------------------------------------------------------------------------------| | `proto/warden/intent/tx.proto` | Removed `action_type` field from `MsgApproveAction` and `MsgRevokeAction`; adjusted field order. | | `warden/x/intent/keeper/actions.go` | Renamed and refactored `CheckActionReady` to `TryExecuteAction` and introduced new helper functions. | | `warden/x/intent/keeper/intents.go` | Renamed `freezeIntent` to `preprocessIntent`; adjusted functionality. | | `warden/x/intent/keeper/keeper.go` | Added comment for `shieldExpanderFunc`; removed `actionHandlers` map. | | `warden/x/intent/keeper/msg_server_approve_action.go` | Refactored `ApproveAction` method to use `TryExecuteAction` directly. | | `go.mod` | Added `github.com/iancoleman/strcase` v0.3.0 as direct requirement; removed indirect dependency. | | `warden/x/intent/types/action.go` | Removed `GetActionMessage` function from `Action` type. | | `warden/x/intent/types/params.go` | Removed `ParamKeyTable` function; integrated its functionality into `NewParams`. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant Client participant Keeper participant DB as Database participant ActionModule Note over Client,Keeper: Old Flow of Action Execution Client->>Keeper: ApproveAction Keeper->>Keeper: CheckActionReady alt Action is Ready Keeper->>ActionModule: ExecuteAction ActionModule-->>Keeper: Execution Result else Action is Not Ready Keeper-->>Client: Action Not Ready end Note over Client,Keeper: New Flow of Action Execution Client->>Keeper: ApproveAction Keeper->>Keeper: TryExecuteAction alt Action is Ready Keeper->>ActionModule: ExecuteAction ActionModule-->>Keeper: Execution Result else Action is Not Ready Keeper-->>Client: Action Not Ready end ```

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.
artur-abliazimov commented 2 weeks ago

Do we use these keys anywhere?

https://github.com/warden-protocol/wardenprotocol/blob/1afd42af26a86325934803677d04075637376097/warden/x/intent/types/keys.go#L11C2-L11C13

https://github.com/warden-protocol/wardenprotocol/blob/1afd42af26a86325934803677d04075637376097/warden/x/intent/types/keys.go#L14

https://github.com/warden-protocol/wardenprotocol/blob/1afd42af26a86325934803677d04075637376097/warden/x/intent/types/keys.go#L17

artur-abliazimov commented 2 weeks ago

These functions are not used anywhere. Do we need them?

Functions: https://github.com/warden-protocol/wardenprotocol/blob/1afd42af26a86325934803677d04075637376097/warden/x/intent/types/action.go#L45

https://github.com/warden-protocol/wardenprotocol/blob/1afd42af26a86325934803677d04075637376097/warden/x/intent/types/params.go#L10

Errors: https://github.com/warden-protocol/wardenprotocol/blob/1afd42af26a86325934803677d04075637376097/warden/x/intent/types/errors.go#L12C2-L12C11

Pitasi commented 2 weeks ago

These functions are not used anywhere. Do we need them?

Functions:

https://github.com/warden-protocol/wardenprotocol/blob/1afd42af26a86325934803677d04075637376097/warden/x/intent/types/action.go#L45

https://github.com/warden-protocol/wardenprotocol/blob/1afd42af26a86325934803677d04075637376097/warden/x/intent/types/params.go#L10

thanks, removed!

Errors: https://github.com/warden-protocol/wardenprotocol/blob/1afd42af26a86325934803677d04075637376097/warden/x/intent/types/errors.go#L12C2-L12C11

I'll leave this as part of #353