search

warden-protocol / wardenprotocol

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

Cleanup x/warden #422

Closed Pitasi closed 2 weeks ago

Pitasi commented 2 weeks ago

I bundled together a few cleanups and minor things affecting the x/warden module. See the list of commits to see what changed.

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 14 minutes and 28 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 9da8075bd8018b24520769783510b71f57c389a3 and 24c580713130e94b6ab7b5113ad601670b2261db.

Walkthrough

The updates span multiple modules with a focus on renaming for clarity, removing unused fields, and improving fee management flexibility. The changes emphasize consistency and clear terminology, mainly replacing "parties" with "writers" across the codebase. Additionally, enhancements have been made to key creation and signature flow handling, as well as updates to message and service definitions in Protobuf files.

Changes

File/Module Change Summary
CHANGELOG.md Updated type annotations, removed unused fields, renamed entities.
cmd/wardend/cmd/gen-keychains.go Replaced Parties with Writers in Keychain struct.
keychain-sdk/config.go Updated comments and variables for derivation path and mnemonic to reflect their use for writers.
keychain-sdk/keychain.go Updated log message to refer to "writer identity" instead of "party identity".
proto/.../key.proto Added explicit state transitions and detailed comments in KeyRequest and Key messages.
proto/.../keychain.proto Introduced writers field, removed unused fields, and updated fee structure in Keychain message.
proto/.../query.proto Improved comment clarity and consistency across various query operations.
proto/.../signature.proto Defined state transitions and updated fields in SignRequest message for better encapsulation.
proto/.../space.proto Added fields for unique ID, creator, and owners in Space message; updated related operations.
proto/.../tx.proto Renamed and clarified entity names and operations related to spaces, keychains, writers, and requests.
warden/.../client/cli/tx.go Updated transaction role requirements to check "writer" instead of "party" for keychains.
warden/.../keeper/intents.go Removed keychain activity status check before processing intents.
warden/.../keeper/msg_server_add_keychain_writer.go Renamed functions and parameters from Party to Writer; updated error messages accordingly.
warden/.../keeper/msg_server_fulfil_signature_request.go Updated validations to check for Writer role instead of keychain activity status.
warden/.../keeper/msg_server_new_key_request.go Modified fee construction to directly use keychain.Fees.KeyReq.
warden/.../keeper/msg_server_new_keychain.go Removed assignments for AdminIntentId and IsActive in NewKeychain method.
warden/.../keeper/msg_server_new_signature_request.go Modified fee construction to directly use keychain.Fees.SigReq.
warden/.../keeper/msg_server_update_key_request.go Updated role checks from IsParty to IsWriter.
warden/.../keeper/msg_server_update_keychain.go Removed the line setting keychain status (IsActive).

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

I think we do not need the explicit conversion here:

https://github.com/warden-protocol/wardenprotocol/blob/698a5c137ece9d2b63dd3b57c8b2da5a4c6ff006/warden/x/warden/types/v1beta2/keychain.go#L13

Looks like this code is not used anywhere:

https://github.com/warden-protocol/wardenprotocol/blob/698a5c137ece9d2b63dd3b57c8b2da5a4c6ff006/warden/x/warden/types/v1beta2/keys.go#L11

https://github.com/warden-protocol/wardenprotocol/blob/698a5c137ece9d2b63dd3b57c8b2da5a4c6ff006/warden/x/warden/types/v1beta2/keys.go#L18

https://github.com/warden-protocol/wardenprotocol/blob/698a5c137ece9d2b63dd3b57c8b2da5a4c6ff006/warden/x/warden/types/v1beta2/params.go#L10

https://github.com/warden-protocol/wardenprotocol/blob/698a5c137ece9d2b63dd3b57c8b2da5a4c6ff006/warden/x/warden/types/v1beta2/errors.go#L12

Pitasi commented 2 weeks ago

I think we do not need the explicit conversion here:

https://github.com/warden-protocol/wardenprotocol/blob/698a5c137ece9d2b63dd3b57c8b2da5a4c6ff006/warden/x/warden/types/v1beta2/keychain.go#L13

Looks like this code is not used anywhere:

https://github.com/warden-protocol/wardenprotocol/blob/698a5c137ece9d2b63dd3b57c8b2da5a4c6ff006/warden/x/warden/types/v1beta2/keys.go#L11

https://github.com/warden-protocol/wardenprotocol/blob/698a5c137ece9d2b63dd3b57c8b2da5a4c6ff006/warden/x/warden/types/v1beta2/keys.go#L18

https://github.com/warden-protocol/wardenprotocol/blob/698a5c137ece9d2b63dd3b57c8b2da5a4c6ff006/warden/x/warden/types/v1beta2/params.go#L10

https://github.com/warden-protocol/wardenprotocol/blob/698a5c137ece9d2b63dd3b57c8b2da5a4c6ff006/warden/x/warden/types/v1beta2/errors.go#L12

fixed them all, thanks :)