weweswap / app-backend

Utils and APR backend
https://app-backend-production-676d.up.railway.app/docs
MIT License
0 stars 0 forks source link

hourly aggregation, tvl, token price #3

Closed masterjacy01 closed 1 month ago

masterjacy01 commented 1 month ago

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes involve a significant update to the vault aggregation and data retrieval system, transitioning from daily to hourly data aggregation. New methods have been introduced for fetching historical Total Value Locked (TVL) and price data, alongside the addition of new properties and classes to accommodate these changes. The modifications enhance the functionality of various services and controllers, allowing for more frequent and detailed data access regarding vault tokens.

Changes

Files Change Summary
src/aggregators/vault-aggregator/vault-aggregator.service.ts Renamed method for aggregation frequency from daily to hourly, updated scheduling function, and modified aggregation logic to reflect hourly data processing.
src/api/vaults/vaults-data-provider/vaults-data-provider.ts Added methods getHistoricTvl and getHistoricPrice for retrieving historical data based on a provided timeframe.
src/api/vaults/vaults.controller.ts Introduced two new GET endpoints (/tvl/:address and /price/:address) for fetching historical TVL and price data, with validation and error handling.
src/api/vaults/vaults.service.ts Added methods getHistoricTvl and getHistoricPrice to retrieve historical TVL and price data from the data provider.
src/contract-connectors/arrakis-contracts/arrakis-contracts.service.ts Enhanced data retrieval with new variable for vault token decimals and added calculation for vaultTokenPriceUsd, modifying the return structure to include this new data.
src/database/schemas/VaultHistoricalData.schema.ts Added a new required property vaultTokenPrice to the VaultHistoricalMetadata class.
src/database/vault-db/vault-db.service.ts Introduced methods for retrieving historical price and TVL data, updated log message in saveVaultData method to reflect hourly data saving.
src/dto/HistoricDataQueryParamsDto.ts Introduced an enum and DTO for handling historical data query parameters, including a timeframe property.
src/dto/HistoricPriceDto.ts Added HistoricPriceDatapoint class to represent historical price data points with timestamp and price properties.
src/dto/HistoricTvlDto.ts Added HistoricTvlDatapoint class to represent historical TVL data points with timestamp and TVL properties.
src/shared/class/VaultHistoricalDataDto.ts Modified VaultHistoricalMetadataDto to include a new property vaultTokenPrice and updated the constructor accordingly.

Poem

🐰 In the meadow where the vaults do play,
Hourly data hops in, brightening the day.
With prices and TVL, all in a row,
Our little rabbit hearts are aglow!
So gather 'round, friends, let’s cheer and rejoice,
For changes have come, and we all have a voice! πŸŽ‰


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?

:heart: 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)
:placard: 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 , 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](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.