injective-ts icon indicating copy to clipboard operation
injective-ts copied to clipboard

feat: integrate FoxWallet

Open ljunb opened this issue 1 year ago • 1 comments

Hello, we are the FoxWallet team, we hope to add FoxWalelt strategy to wallet-ts, you can learn more about our team at here.

This pull request includes the following features:

  1. Support enabling users to interact with Cosmos-based chains directly from the app
  2. Support getting account addresses, signing transactions, and sending transactions
  3. Note: Currently only Cosmos addresses are supported, Ethereum addresses are not yet supported

Summary by CodeRabbit

  • New Features

    • Introduced support for FoxWallet, allowing users to create and manage this new wallet type.
    • Added enhanced wallet management capabilities for FoxWallet with transaction signing and broadcasting features.
  • Bug Fixes

    • Improved wallet detection and installation checks for FoxWallet within the Cosmos ecosystem.
  • Documentation

    • Updated wallet strategy documentation to include details about the new FoxWallet functionality.
  • Chores

    • Streamlined module imports for better code organization and maintainability.

ljunb avatar Aug 12 '24 14:08 ljunb

Walkthrough

The recent updates to the wallet strategy implementation introduce the FoxWallet, enhancing the Cosmos wallet ecosystem. This includes the addition of a dedicated Fox class for wallet interactions, updates to recognize the new wallet type across existing functionalities, and improved error handling. These changes expand wallet options and streamline user transactions, ensuring a better integration experience with the Cosmos blockchain.

Changes

File Path Change Summary
.../CosmosWalletStrategy.ts Added Wallet.FoxWallet; updated createWallet function to handle it.
.../strategies/wallet-strategy/strategies/Fox.ts Introduced Fox class extending BaseConcreteStrategy for wallet interactions.
.../WalletStrategy.ts Integrated Fox strategy into createStrategy function.
.../types/enums.ts Added FoxWallet to Wallet enum.
.../utils/wallets/cosmos/utils.ts Updated functions to recognize Wallet.FoxWallet.
.../utils/wallets/fox-wallet/FoxWallet.ts New class for interacting with FoxWallet; defined essential wallet operations.
.../utils/wallets/fox-wallet/index.ts Exported all functionalities from the FoxWallet module.
.../utils/wallets/index.ts Added export statement for fox-wallet module.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant WalletStrategy
    participant FoxWallet
    User->>WalletStrategy: Select Wallet.FoxWallet
    WalletStrategy->>FoxWallet: Create Fox Wallet instance
    FoxWallet->>FoxWallet: Initialize with chainId
    FoxWallet-->>WalletStrategy: Return Wallet Instance
    WalletStrategy-->>User: Present FoxWallet options

🐰 In the meadow, bright and wide,
A new wallet takes a ride!
FoxWallet hops with ease and grace,
In Cosmos land, it finds its place.
With transactions flying high,
A happy rabbit waves goodbye! 🌟


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
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>.
    • 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 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.

coderabbitai[bot] avatar Aug 12 '24 14:08 coderabbitai[bot]

Hey, we are doing some refactors on the wallet-ts package and will ping you here once the refactor is done.

billyjacoby avatar Oct 10 '24 17:10 billyjacoby

Hey @ljunb - our wallet refactor should be complete now. It looks like you were adding this as a cosmos wallet, so you should be able to add that to our new wallet-cosmos package. Have a look here and feel to to open a PR here and I'll be closing this one in the mean time.

billyjacoby avatar Nov 06 '24 01:11 billyjacoby

So if I want to use FoxWallet as a cosmos wallet, should I add it to the wallets directory as an independent package, such as wallets/wallet-foxwallet?

ljunb avatar Nov 06 '24 07:11 ljunb

Preferably in the wallet-cosmos package itself if it matches the same implementation as cosmos wallets and doesn't include any new dependencies. If this would require new dependencies then yeah creating a new wallet package would be the desired path. Take a look at how the wallet-cosmos package includes support for Leap, Keplr, and Ninji and see if that would work for you.

billyjacoby avatar Nov 06 '24 18:11 billyjacoby

Forgive me forgot how I tested it before. Is there an example that can quickly test the newly added wallet?

ljunb avatar Nov 07 '24 02:11 ljunb

You can find an example of the current cosmos wallet integration here. I would suggest to use that as a jumping off point after cloning the repo and running locally

billyjacoby avatar Nov 07 '24 02:11 billyjacoby

FoxWallet is a multi-chain wallet that not only supports the Cosmos ecosystem network. What do you think is the appropriate way to add it to this package😄?

ljunb avatar Nov 12 '24 06:11 ljunb