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: add supply metric #78

Merged
merged 2 commits into from
Jul 28, 2024
Merged

feat: add supply metric #78

merged 2 commits into from
Jul 28, 2024

Conversation

freak12techno
Copy link
Collaborator

@freak12techno freak12techno commented Jul 28, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a JSON structure for token supply management.
    • Added SupplyFetcher and SupplyGenerator for enhanced fetching and metric generation of supply data across blockchain chains.
    • Implemented a new RPC function to fetch total token supply.
  • Bug Fixes

    • Improved error handling in tests to prevent runtime issues.
  • Tests

    • Added comprehensive unit tests for SupplyFetcher and SupplyGenerator to ensure robust functionality and error handling.
  • Documentation

    • Updated definitions for new data structures and constants related to supply.

@freak12techno freak12techno merged commit 492c69e into main Jul 28, 2024
6 checks passed
Copy link
Contributor

coderabbitai bot commented Jul 28, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

This update introduces a comprehensive token supply management system, encompassing the creation of new fetchers and generators, enhanced error handling, and detailed testing. Key components include a structured JSON representation of token supply, new functionality to fetch and generate supply metrics, and robust testing to ensure reliability across multiple scenarios.

Changes

Files Change Summary
assets/supply.json New JSON structure for token supply with denomination and pagination metadata.
pkg/app.go, pkg/fetchers/supply.go, pkg/generators/supply.go Introduced NewSupplyFetcher and NewSupplyGenerator for handling supply data in the application.
pkg/app_test.go Added nil check for request body in health check test to prevent runtime panic.
pkg/constants/constants.go Introduced FetcherNameSupply constant for unified fetcher naming.
pkg/fetchers/supply.go Implemented SupplyFetcher struct for concurrent fetching of supply data from multiple chains.
pkg/fetchers/supply_test.go Added unit tests for SupplyFetcher covering various scenarios like success, errors, and disabled queries.
pkg/generators/supply.go Created SupplyGenerator for generating Prometheus metrics related to supply data.
pkg/generators/supply_test.go Unit tests for SupplyGenerator, validating behavior with empty and populated states.
pkg/tendermint/rpc.go Introduced GetTotalSupply method in RPC struct to fetch total token supply.
pkg/types/tendermint.go Added SupplyResponse struct to represent supply-related data responses.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant SupplyFetcher
    participant RPC

    User->>App: Request Supply Data
    App->>SupplyFetcher: Fetch Supply Data
    SupplyFetcher->>RPC: GetTotalSupply()
    RPC-->>SupplyFetcher: Return Supply Data
    SupplyFetcher-->>App: Supply Data
    App-->>User: Supply Data
Loading

🐰💖 "In fields of code where bunnies hop,
New features bloom, our hearts won't stop!
Fetchers and generators, all in a line,
Metrics and supplies, oh, how they shine!
With tests that guard and ensure delight,
Our token tale is now just right!" 🌼✨


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.

@freak12techno freak12techno deleted the add-supply branch July 28, 2024 21:26
@coderabbitai coderabbitai bot mentioned this pull request Sep 25, 2024
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.

1 participant