dydxprotocol / v4-chain

dydx v4 protocol
Other
231 stars 105 forks source link

Get funding index maps for vault positions in chunks. #2525

Closed vincentwschau closed 3 weeks ago

vincentwschau commented 3 weeks ago

Changelist

Chunk the funding index maps to get for each vault subaccount to reduce the amount of rows scanned. Heights to get funding index maps for will be separated into chunks that cover 250k blocks each (number of blocks per chunk can be configured). Updated funding index map query to limit searches to both a min and max block height.

Additional fixes:

Test Plan

Existing unit tests.

Author/Reviewer Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The changes in this pull request involve modifications to several files, primarily focusing on enhancing the functionality and performance of the funding index updates retrieval process. Key updates include the addition of a maximum height variable in the SQL query logic, a new configuration parameter for vault settings, improved logging and performance measurement in the vault controller, and the introduction of methods for efficient data retrieval. These changes collectively refine the data handling and observability of the vault-related operations.

Changes

File Path Change Summary
indexer/packages/postgres/src/stores/funding-index-updates-table.ts Added variable maxheight in findFundingIndexMaps to limit effectiveAtHeight in SQL query.
indexer/services/comlink/src/config.ts Introduced new config parameter VAULT_FETCH_FUNDING_INDEX_BLOCK_WINDOWS with default value 250,000.
indexer/services/comlink/src/controllers/api/v4/vault-controller.ts Added logging and timing for operations, introduced getFundingIndexMapsChunked, and added getHeightWindows.

Possibly related PRs

Suggested labels

backport/indexer/v7.x

Suggested reviewers

Poem

In the fields where numbers play,
A max height leads the way.
Configs grow, and logs will sing,
Fetching funds, a joyful thing!
With each update, we refine,
Hopping forward, all align! πŸ‡βœ¨


πŸ“œ Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
πŸ“₯ Commits Files that changed from the base of the PR and between 72c423a3a98fd2b96e9a54e0a5bf67052da5c260 and 60639d9b5130786ea203f66306cc11a9fdee3a96.
πŸ“’ Files selected for processing (1) * indexer/services/comlink/src/controllers/api/v4/vault-controller.ts (7 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * indexer/services/comlink/src/controllers/api/v4/vault-controller.ts
--- 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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
vincentwschau commented 3 weeks ago

@Mergifyio backport release/indexer/v7.x

mergify[bot] commented 3 weeks ago

backport release/indexer/v7.x

βœ… Backports have been created

* [#2527 Get funding index maps for vault positions in chunks. (backport #2525)](https://github.com/dydxprotocol/v4-chain/pull/2527) has been created for branch `release/indexer/v7.x`