Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: remove wallet restriction on getCosmosWallet #531

Merged

Conversation

ThomasRalee
Copy link
Collaborator

@ThomasRalee ThomasRalee commented Dec 23, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced gas check flexibility for multiple wallet types in the broadcasting process.
    • Simplified access to the getCosmosWallet method, allowing use with any supported wallet type.
  • Bug Fixes

    • Improved error handling in wallet strategy to prevent unnecessary exceptions for unsupported wallet types.

Copy link

coderabbitai bot commented Dec 23, 2024

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/wallets/wallet-core/src/broadcaster/MsgBroadcaster.ts

Oops! Something went wrong! :(

ESLint: 7.32.0

Error: Error while loading rule 'jest/unbound-method': You have used a rule which requires parserServices to be generated. You must therefore provide a value for the "parserOptions.project" property for @typescript-eslint/parser.
Occurred while linting /packages/wallets/wallet-core/src/broadcaster/MsgBroadcaster.ts
at throwError (/node_modules/@typescript-eslint/utils/dist/eslint-utils/getParserServices.js:39:11)
at getParserServices (/node_modules/@typescript-eslint/utils/dist/eslint-utils/getParserServices.js:31:9)
at create (/node_modules/@typescript-eslint/eslint-plugin/dist/rules/unbound-method.js:116:55)
at Object.create (/node_modules/@typescript-eslint/utils/dist/eslint-utils/RuleCreator.js:38:20)
at create (/node_modules/eslint-plugin-jest/lib/rules/unbound-method.js:47:88)
at Object.create (/node_modules/eslint-plugin-jest/node_modules/@typescript-eslint/utils/dist/eslint-utils/RuleCreator.js:41:20)
at createRuleListeners (/node_modules/eslint/lib/linter/linter.js:765:21)
at /node_modules/eslint/lib/linter/linter.js:937:31
at Array.forEach ()
at runRules (/node_modules/eslint/lib/linter/linter.js:882:34)

Walkthrough

The pull request introduces modifications to the wallet core functionality, specifically in the MsgBroadcaster and BaseWalletStrategy classes. The changes focus on enhancing the flexibility of wallet type handling and gas check mechanisms. The broadcastCosmosWithFeeDelegation method now uses a more generalized approach to determine gas check behavior, while the getCosmosWallet method in BaseWalletStrategy removes previous wallet type restrictions, allowing for broader wallet compatibility.

Changes

File Change Summary
packages/wallets/wallet-core/src/broadcaster/MsgBroadcaster.ts Added canDisableCosmosGasCheck constant to determine gas check disabling based on wallet type
packages/wallets/wallet-core/src/strategy/BaseWalletStrategy.ts Removed wallet type check in getCosmosWallet method, allowing more flexible wallet access

Sequence Diagram

sequenceDiagram
    participant Wallet
    participant MsgBroadcaster
    participant Strategy
    
    Wallet->>Strategy: Request Cosmos Wallet
    Strategy-->>Wallet: Return Cosmos Wallet
    Wallet->>MsgBroadcaster: Broadcast Transaction
    MsgBroadcaster->>MsgBroadcaster: Check Gas Conditions
    MsgBroadcaster-->>Wallet: Broadcast Result
Loading

Poem

🐰 A Rabbit's Ode to Wallet Flexibility 🌈

Hop, hop, through wallet's gate,
No more checks to hesitate!
Gas checks dance with gentle grace,
Keplr, OWallet find their space.
Freedom rings in code's embrace! 🚀

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (3)
packages/wallets/wallet-core/src/broadcaster/MsgBroadcaster.ts (3)

841-843: Validate or centralize wallet conditional checks.

Currently, you check if the wallet is either Keplr or OWallet to set canDisableCosmosGasCheck. For future scalability, consider centralizing this condition in a helper function or a configuration map, so you can easily manage additional wallet types in one place without scattering logic across the codebase.


894-894: Guard against repeated disableGasCheck calls.

The condition checks both canDisableCosmosGasCheck and whether cosmosWallet.disableGasCheck is defined. As a minor enhancement, ensure you handle scenarios where disabling the gas check might already be in effect or might fail. Logging or handling potential errors can improve observability.


919-919: Ensure consistent re-enabling logic.

After disabling the gas check, re-enabling is essential, but consider confirming or logging that the gas check was indeed disabled before calling enableGasCheck. This can safeguard against unexpected states if new wallet features or behaviors are introduced in the future.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 21427a5 and 76a155f.

📒 Files selected for processing (2)
  • packages/wallets/wallet-core/src/broadcaster/MsgBroadcaster.ts (3 hunks)
  • packages/wallets/wallet-core/src/strategy/BaseWalletStrategy.ts (0 hunks)
💤 Files with no reviewable changes (1)
  • packages/wallets/wallet-core/src/strategy/BaseWalletStrategy.ts

@bangjelkoski bangjelkoski merged commit 16bfc2d into dev Dec 23, 2024
3 checks passed
@bangjelkoski bangjelkoski deleted the chore/remove-wallet-restriction-on-getCosmosWallet branch December 23, 2024 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants