chore: improve the inspect query for front-end

gsk967 commented 5 months ago

Description

added two new fields two the existed inspect query response

base_denom -> base denom of coin (Ex: uumee for UMEE , ibc/XXX for remaining tokens )
base_amount -> base amount of coin without convert to SYMBOL Denom value

Query response

{
  "borrowers": [
    {
      "address": "umee1y6xz2ggfc0pcsmyjlekh0j9pxh6hk87ymc9due",
      "analysis": {
        "Borrowed": 1.22,
        "Liquidation": 1.74,
        "Value": 3.49
      },
      "position": {
        "collateral": [
          {
            "denom": "UMEE",
            "base_denom": "uumee",
            "amount": "2000.000001773465256000",
            "base_amount": "2000000000"
          }
        ],
        "borrowed": [
          {
            "denom": "UMEE",
            "base_denom": "uumee",
            "amount": "700.000004000000000000",
            "base_amount": "700000004"
          }
        ]
      },
      "info": ""
    }
  ],
  "failures": []
}

Summary by CodeRabbit

Enhancements
- Improved inspect account response in the leverage module, providing more detailed and clear information on collateral and borrowed positions.
- Enhanced descriptions and titles for properties related to token positions in the API documentation to aid understanding.
Bug Fixes
- Addressed issues with sorting and calculating token amounts in the inspect functionality.
Refactor
- Updated internal data structures to better represent token positions, including the addition of fields for base denominations and exchange rates.

coderabbitai[bot] commented 5 months ago

Walkthrough

The changes in Pull Request 2562 enhance the x/leverage module of the Umee network by refining how account data is inspected and represented. This involves updates to protocol buffer definitions, Swagger documentation, test cases, and implementation logic, particularly focusing on the introduction and usage of a new PositionBalance type to improve clarity and functionality in representing token balances and their base amounts.

Changes

File	Change Summary
`proto/umee/leverage/v1/query.proto`	Added `cosmos.proto` import, renamed `DecCoin` to `PositionBalance`, updated fields in `DecBalances` message, and introduced `PositionBalance`.
`swagger/swagger.yaml`	Added `title` and updated `description` for properties in `PositionBalance`, `Collateral`, and `Borrowed`.
`x/leverage/keeper/grpc_query_test.go`	Added `convertToPositionBalances` function for constructing `PositionBalance` instances.
`x/leverage/keeper/inspector.go`	Modified structures and functions to incorporate `baseDenom` field and the new `PositionBalance` type; updated logic in `Inspect`, `InspectAccount`, and `symbolDecCoins` functions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Frontend
    participant Backend
    participant Database

    User ->> Frontend: Request Account Details
    Frontend ->> Backend: API Call /inspect_account
    Backend ->> Database: Query Account Balances
    Database -->> Backend: Retrieve Balances
    Backend ->> Backend: Convert to PositionBalances
    Backend -->> Frontend: Account Details Response
    Frontend -->> User: Display Account Info

Poem

Amidst the code, a change took place,
Balances gained a clearer face.
With PositionBalance, precise and neat,
Inspecting tokens, a tidy feat.
Now Umee's leverage, snug and grand,
Secure and clear, just as planned.
Bravo to code, that stance so true,
In the realm of bytes, we bid it adieu.

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.

codecov[bot] commented 5 months ago

Codecov Report

Attention: Patch coverage is 70.37037% with 8 lines in your changes missing coverage. Please review.

Project coverage is 62.77%. Comparing base (7f05ad4) to head (06b96aa). Report is 507 commits behind head on main.

Additional details and impacted files

[![Impacted file tree graph](https://app.codecov.io/gh/umee-network/umee/pull/2562/graphs/tree.svg?width=650&height=150&src=pr&token=26MOHDPL5B&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=umee-network)](https://app.codecov.io/gh/umee-network/umee/pull/2562?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=umee-network) ```diff @@ Coverage Diff @@ ## main #2562 +/- ## =========================================== - Coverage 75.38% 62.77% -12.62% =========================================== Files 100 275 +175 Lines 8025 15979 +7954 =========================================== + Hits 6050 10031 +3981 - Misses 1589 5175 +3586 - Partials 386 773 +387 ``` | [Files](https://app.codecov.io/gh/umee-network/umee/pull/2562?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=umee-network) | Coverage Δ | | |---|---|---| | [x/leverage/keeper/inspector.go](https://app.codecov.io/gh/umee-network/umee/pull/2562?src=pr&el=tree&filepath=x%2Fleverage%2Fkeeper%2Finspector.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=umee-network#diff-eC9sZXZlcmFnZS9rZWVwZXIvaW5zcGVjdG9yLmdv) | `62.91% <70.37%> (ø)` | | ... and [238 files with indirect coverage changes](https://app.codecov.io/gh/umee-network/umee/pull/2562/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=umee-network)

umee-network / umee