Default power balance snapshot

[aminlatifi]

Set default zero for power balance snapshot on no return from balance aggregator
Ref #1655

Summary by CodeRabbit

• New Features

  • Introduced functionality to manage excluded addresses for balance calculations, allowing dynamic exclusion during queries.

• Bug Fixes

  • Enhanced test coverage to ensure that users excluded from the balance aggregator correctly receive zero snapshot balances.

• Refactor

  • Improved address management in balance processing by utilizing a Set to ensure unique wallet addresses and enhance efficiency.

[coderabbitai]

Walkthrough

The recent changes enhance the GivPowerBalanceAggregatorAdapterMock and the fillSnapshotBalances functionality by adding address exclusion capabilities and improving balance processing. Excluded addresses are now effectively managed, ensuring they do not affect balance calculations. Additionally, the handling of wallet addresses during snapshot balance filling has been optimized to account for cases where no balance is returned, allowing for zero balances to be recorded appropriately.

Changes

File	Change Summary
src/adapters/givPowerBalanceAggregator/givPowerBalanceAggregatorAdapterMock.ts	Introduced excludedAddresses Set for ignoring specific addresses, added addExcludedAddresses and clearExcludedAddresses methods, modified getAddressesBalance to filter excluded addresses.
src/services/cronJobs/fillSnapshotBalances.test.ts	Added tests for handling zero balances when addresses are excluded from the aggregator; reset excluded addresses after each test.
src/services/cronJobs/fillSnapshotBalances.ts	Updated processFillPowerSnapshotJobs to use a Set for unique wallet addresses, ensuring zero balances are filled for addresses without returned balances.

Possibly related issues

• Set zero power snapshot balance when balance aggregator doesn't return any balance for an address #1655: This change directly addresses the issue of filling zero power snapshot balances when the balance aggregator does not return any balance for an address.

Poem

🐰 In fields so wide, we hop with cheer,
Excluded addresses, we hold dear.
With balances zero, all fair and bright,
Our snapshots gleam in the soft moonlight.
Let's celebrate changes, both swift and wise,
For rabbits and balances, we reach for the skies! 🥕✨

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 27eed6f and ff8c26b.

Files selected for processing (3)

• src/adapters/givPowerBalanceAggregator/givPowerBalanceAggregatorAdapterMock.ts (2 hunks)
• src/services/cronJobs/fillSnapshotBalances.test.ts (4 hunks)
• src/services/cronJobs/fillSnapshotBalances.ts (1 hunks)

Additional comments not posted (9)

src/adapters/givPowerBalanceAggregator/givPowerBalanceAggregatorAdapterMock.ts (4)

13-13: Good use of a Set for excluded addresses.

The use of a Set for excludedAddresses is appropriate for efficient lookups and ensuring uniqueness.

---

15-19: Efficiently adding excluded addresses.

The addExcludedAddresses method efficiently adds multiple addresses to the excludedAddresses set.

---

21-23: Clear method for resetting excluded addresses.

The clearExcludedAddresses method provides a straightforward way to reset the excludedAddresses set.

---

36-38: Correctly filtering out excluded addresses.

The getAddressesBalance method correctly filters out addresses that are present in the excludedAddresses set.

src/services/cronJobs/fillSnapshotBalances.ts (3)

123-125: Efficient use of Set for unique wallet addresses.

The use of a Set for addressesToFetch ensures that duplicate addresses are eliminated efficiently.

---

136-141: Correctly handling processed addresses.

The logic for removing processed addresses from the addressesToFetch set ensures accurate tracking of which addresses have been processed.

---

149-158: Properly filling zero balances for missing addresses.

The logic for filling zero balances for addresses that were not represented in the fetched balances ensures that all wallet addresses are accounted for.

src/services/cronJobs/fillSnapshotBalances.test.ts (2)

40-40: Ensure excluded addresses are reset after each test.

The mockPowerBalanceAggregator.clearExcludedAddresses() call in the afterEach hook ensures that any excluded addresses are reset after each test.

---

305-395: Thorough test case for users with no balance on the balance aggregator.

The new test case thoroughly verifies the behavior of the system when users have no balance on the balance aggregator. It ensures that zero balances are correctly filled for excluded users.

---

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

[mohammadranjbarz]

Thanks @aminlatifi LGTM

[aminlatifi]

@mohammadranjbarz I see it's not merged yet. Feel free to merge it yourself when you think is appropriate

[mohammadranjbarz]

@CarlosQ96 As I dot work on impact-graph much, can you take care of it

@mohammadranjbarz I see it's not merged yet. Feel free to merge it yourself when you think is appropriate