save aggregation process

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes encompass updates to various files, primarily enhancing the functionality and documentation of the service. Key modifications include the introduction of a new dependency for managing progress metadata, the addition of methods for checking entry existence and saving progress, and improvements to API documentation for vault-related endpoints. New schemas and services for progress metadata management have also been established, along with updates to existing methods to improve efficiency and error handling.

Changes

File Path	Change Summary
`README.md`	Added a section detailing the Swagger documentation endpoint `/docs` with a link to access it.
`src/aggregators/operations-aggregator/operations-aggregator-helpers/arrakis-operations-helper.service.ts`	Modified `ArrakisOperationsHelperService` to include `ProgressMetadataDbService`, added `checkIfEntryExists` method, and updated logic in `getFromBlocks` to retrieve the last processed block number.
`src/aggregators/operations-aggregator/operations-aggregator.service.ts`	Updated `OperationsAggregatorService` to include `ProgressMetadataDbService`, enhanced `processLogs` for concurrent processing, added `saveProgress` method, and modified `getLowestFromBlocks` to call `getFromBlocks` from `arrakisVaultOperationsHelperService`.
`src/api/vaults/vaults.controller.ts`	Added API documentation annotations for `/tvl/:address` and `/price/:address` endpoints, including details on parameters and expected responses, and introduced a `timeframe` query parameter.
`src/database/database.module.ts`	Introduced `ProgressMetadata` schema and `ProgressMetadataDbService`, updated module imports and exports to include new service and schema.
`src/database/db-models.ts`	Added `ProgressMetadataDto` class with a constructor for address, lastBlockNumber, and aggregationType.
`src/database/progress-metadata/progress-metadata-db.service.ts`	Created `ProgressMetadataDbService` for managing progress metadata, including methods `getLastBlockNumber` and `saveProgressMetadata`.
`src/database/schemas/ProgressMetadata.ts`	Introduced `ProgressMetadataDocument` and `ProgressMetadataSchema` for storing progress metadata, with a unique compound index on address and aggregation type.
`src/database/vault-db/vault-db.service.ts`	Added `checkIfEntryExists` method to check for existing entries and changed logging levels for empty data conditions from `error` to `warn`.
`src/dto/HistoricPriceDto.ts`	Updated example value for `timestamp` in `HistoricPriceDatapoint` from string to number.
`src/dto/HistoricTvlDto.ts`	Updated example value for `timestamp` in `HistoricTvlDatapoint` from string to number.
`src/shared/enum/AggregationType.ts`	Introduced `AggregationType` enum with a member `VAULT_COLLECTED_FEES_EVENT`.

Possibly related PRs

#4: The changes in this PR also involve the addition of a new section in the README.md file that provides information about the Swagger documentation, similar to the main PR's focus on enhancing documentation for the API.

🐰 In the meadow, changes sprout,
New paths for logs, no doubt!
Progress tracked with care and glee,
Vaults now sing in harmony.
With docs that guide, and methods bright,
Our code hops forward, pure delight! 🌼

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

weweswap / app-backend