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

feat: fetch data for "Portfolio by asset type" donut chart #920

Draft
wants to merge 3 commits into
base: testnet
Choose a base branch
from

Conversation

kfastov
Copy link

@kfastov kfastov commented Oct 31, 2024

Pull Request type

Please add the labels corresponding to the type of changes your PR introduces:

  • Feature

Resolves: #879

Other information

Very inefficient but works.

Example for Nico.strk:
image

Huge thanks to @joeperpetua who already did all the heavy work in #912 creating the charts and the Argent API service

Copy link

vercel bot commented Oct 31, 2024

@kfastov is attempting to deploy a commit to the LFG Labs Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Oct 31, 2024

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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

@kfastov
Copy link
Author

kfastov commented Oct 31, 2024

I'll do optimizations and some tests (on different accounts) today and then mark as ready

@joeperpetua
Copy link
Contributor

Hey @kfastov , thanks for the mention!

If I may say, looking at the API behavior, all the protocol pair tokens for a given protocol share the same symbol.

This are all the count of tokens that use the same symbol filtering by name containing "pair" (ci):

  • CairoFi-P: 11
  • JEDI-P: 795
  • LPT: 31 ( this would be the only exception, as it is used by 10kSwap, ProtossSwap and StarkEx )
  • LYN: 1
  • SSS-P: 8
  • sSTARKD-P: 30
  • vSFN-P: 1
  • vSTARKD-P: 189
  • ven-P: 50

One approach would be displaying a sum of all the tokens for a given protocol under the same symbol (as they are listed in the API). This would make the chart more aligned to the actual portfolio data, as ignoring them altogether would kinda defeat the purpose of the chart.

This should be achievable using a map with the symbol as a key and incrementing the balance on each encounter of a userToken with the same symbol.

What do you think? @Marchand-Nicolas

PD: you can also use my account to test the chart (0x06F17c9e19D91900ac039f60344cECC6494297CBd37BbB9B3618B048a2Ed3633)

@kfastov
Copy link
Author

kfastov commented Oct 31, 2024

What I aim now is just matching the Argent logic. It seems that Argent portfolio just shows the "free" undeposited tokens, but I agree that it may be counter-intuitive.
@Marchand-Nicolas Do you think we should show ETH and STRK here that are locked in the protocol like zkLend or Ekubo?

@Marchand-Nicolas
Copy link
Collaborator

@kfastov Hey, if that is doable, I think that indeed it would be better to take in account tokens that are locked in protocols such as zklend or ekubo

@Marchand-Nicolas
Copy link
Collaborator

Hey @kfastov , thanks for the mention!

If I may say, looking at the API behavior, all the protocol pair tokens for a given protocol share the same symbol.

This are all the count of tokens that use the same symbol filtering by name containing "pair" (ci):

  • CairoFi-P: 11
  • JEDI-P: 795
  • LPT: 31 ( this would be the only exception, as it is used by 10kSwap, ProtossSwap and StarkEx )
  • LYN: 1
  • SSS-P: 8
  • sSTARKD-P: 30
  • vSFN-P: 1
  • vSTARKD-P: 189
  • ven-P: 50

One approach would be displaying a sum of all the tokens for a given protocol under the same symbol (as they are listed in the API). This would make the chart more aligned to the actual portfolio data, as ignoring them altogether would kinda defeat the purpose of the chart.

This should be achievable using a map with the symbol as a key and incrementing the balance on each encounter of a userToken with the same symbol.

What do you think? @Marchand-Nicolas

PD: you can also use my account to test the chart (0x06F17c9e19D91900ac039f60344cECC6494297CBd37BbB9B3618B048a2Ed3633)

Thanks for the help, it seems perfectly appropriate to me

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.

Add "Portfolio by asset type" section with a donut chart
3 participants