feat(default-funding): Add default funding to nextFunding calculation

[teddyding]

Changelist

Follow-up to #2674. Now that default funding is stored, add it to nextFunding calculation.

Test Plan

Unit test

Author/Reviewer Checklist

• If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
• If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
• If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
• If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
• If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
• Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

• New Features

  • Enhanced market updates now incorporate a default one-hour funding rate, providing more granular and accurate funding rate information.

• Refactor

  • Streamlined the funding rate calculation logic to blend funding samples with default values, ensuring improved precision in market updates.

• Tests

  • Expanded validations to verify accurate funding rate processing across various market scenarios.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request integrates a new optional property, defaultFundingRate1H, into the funding-related interfaces and functions. The changes update the PerpetualMarketUpdateObject interface, modify the getNextFunding function to accept tuples (ticker and default funding rate), and adjust related test cases across the indexer and service layers. These modifications alter data structures and control flows to incorporate default funding rates into market update calculations and validations.

Changes

File(s)	Change Summary
indexer/.../postgres/src/types/perpetual-market-types.ts	Added optional property defaultFundingRate1H?: string to PerpetualMarketUpdateObject.
indexer/.../redis/src/caches/next-funding-cache.ts indexer/.../redis/__tests__/caches/next-funding-cache.test.ts	Updated getNextFunding signature to receive an array of [ticker, defaultFundingRate1H] tuples and modified average funding rate calculation; corresponding tests adjusted to new input format and expected outputs.
indexer/.../ender/__tests__/handlers/funding-handler.test.ts indexer/.../ender/__tests__/helpers/redis-helpers.ts	Modified test cases and helper function expectNextFundingRate to include a ticker parameter and a default funding rate, updating assertions to verify the new funding rate logic.
indexer/.../roundtable/__tests__/tasks/market-updater.test.ts indexer/.../roundtable/src/tasks/market-updater.ts	Adjusted market updater tests and implementation to build and process tuples for ticker and default funding rate, including renaming tests and updating expected values.

Sequence Diagram(s)

sequenceDiagram
    participant MU as Market Updater
    participant RF as NextFundingCache.getNextFunding
    participant TS as Test Suite

    MU->>RF: Call with [(ticker, defaultFundingRate1H)]
    RF->>RF: Compute average from funding samples
    RF->>RF: Add defaultFundingRate1H to computed average
    RF-->>MU: Return updated funding rates
    TS->>RF: Verify returned funding rate with expectNextFundingRate()

Loading

Possibly related PRs

• Update DefaultFundingPpm for PML markets #2610: Updates funding rate parameters for enhanced market funding rate calculations, closely aligning with the introduction of defaultFundingRate1H.
• feat(funding): Add defaultFunding8hrPpm field to Perpetual Create/Update indexer events #2674: Introduces a related funding rate field (DefaultFunding8hrPpm) and shares similar adjustments in funding rate handling.

Suggested labels

feature:indexer/affiliates

Suggested reviewers

• vincentwschau
• hwray

Poem

Hoppin’ through the code with cheer,
I'm a rabbit, spreading a bug-free gear.
Funding rates now dance in pairs,
Tuples and tests in sweet software lairs.
With each hop, our updates sing—
CodeRabbit Inc. makes my circuits ring!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f2302a2 and 24f12c7.

📒 Files selected for processing (7)

• indexer/packages/postgres/src/types/perpetual-market-types.ts (1 hunks)
• indexer/packages/redis/__tests__/caches/next-funding-cache.test.ts (2 hunks)
• indexer/packages/redis/src/caches/next-funding-cache.ts (2 hunks)
• indexer/services/ender/__tests__/handlers/funding-handler.test.ts (10 hunks)
• indexer/services/ender/__tests__/helpers/redis-helpers.ts (1 hunks)
• indexer/services/roundtable/__tests__/tasks/market-updater.test.ts (2 hunks)
• indexer/services/roundtable/src/tasks/market-updater.ts (2 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate docstrings to generate docstrings for this 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.