[TRA-572] Send upsert vault event when setting parameters of vault.

[vincentwschau]

Changelist

When a vault is updated / initially created the vault params are set. Send the upsert vault event to the Indexer at this time.

Test Plan

Unit tests.

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 event management capabilities through the addition of the IndexerEventManager.
  • Introduced event logging for vault parameter changes, improving monitoring and auditing.

• Bug Fixes

  • Simplified the handling of the clobPairId parameter in vault events, improving code efficiency.

• Tests

  • Improved test coverage for vault parameters by validating emitted indexer events during parameter settings.
  • Enhanced test reliability by clearing previous events before running tests on vault orders.
  • Introduced a mock implementation of the IndexerMessageSender for controlled testing scenarios.

[linear]

TRA-572 Add indexer events on vault creation / update

[coderabbitai]

Walkthrough

The pull request introduces several modifications across multiple files in the protocol. Key changes include the addition of the IndexerEventManager parameter to the New function in app.go, simplification of the clobPairId type in upsert_vault.go, and enhancements to the Keeper struct to manage indexer events. Additionally, event logging for vault parameter changes is implemented, alongside improvements in testing to validate emitted indexer events.

Changes

Files	Change Summary
protocol/app/app.go	Added app.IndexerEventManager as a parameter in the New function.
protocol/indexer/events/upsert_vault.go	Modified NewUpsertVaultEvent to change clobPairId from clobtypes.ClobPairId to uint32.
protocol/x/vault/keeper/keeper.go	Added indexerEventManager field to Keeper struct, updated NewKeeper to accept this parameter, and added GetIndexerEventManager method.
protocol/x/vault/keeper/params.go	Enhanced SetVaultParams method to log events using GetIndexerEventManager().AddTxnEvent.
protocol/x/vault/keeper/params_test.go	Updated TestGetSetVaultParams to validate expected indexer events, added expectedIndexerEvents field, and created getUpsertVaultEventsFromIndexerBlock function to retrieve relevant events.
protocol/x/vault/keeper/orders_test.go	Added a line in TestRefreshAllVaultOrders to clear events before checking stateful orders.
protocol/testutil/keeper/vault.go	Introduced a mock implementation of IndexerMessageSender in createVaultKeeper for testing, allowing controlled simulation of indexer event behavior.

Possibly related PRs

• [OTE-696] Emit register affiliate event on successful registration #2219: Modifies the New function in protocol/app/app.go by adding the app.IndexerEventManager parameter, related to the main PR.
• [TRA-572] Add upsert vault event. #2250: Introduces an upsert vault event, relevant as the main PR's changes may impact event management.
• [TRA-571] Add vault table and vault event version/subtype. #2263: Adds a new subtype for vault events and enhances vault management, connecting to the main PR's focus on improving event handling.
• include operator params in vault params query #2281: Includes operator parameters in the vault parameters query, which may relate to overall enhancements in vault management and event handling discussed in the main PR.

Suggested labels

indexer, proto

Suggested reviewers

• vincentwschau
• tqin7

🐇 In the code we hop and play,
New events come out to stay.
With vaults that now can sing,
Indexers dance, and joy they bring!
Changes made, oh what a sight,
In our protocol, all feels right! 🌟

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 750ff51 and e378b42.

Files selected for processing (1)

• protocol/testutil/keeper/vault.go (3 hunks)

Additional comments not posted (5)

protocol/testutil/keeper/vault.go (5)

7-7: LGTM!

The import statement for the indexer_manager package is valid and necessary for using the IndexerEventManager in the createVaultKeeper function.

---

55-58: LGTM!

The mock implementation of the IndexerMessageSender interface is valid and necessary for testing the vault keeper's interaction with the indexer event manager. The mock behavior is appropriate for simulating the message sender in a controlled testing environment.

---

60-60: LGTM!

The creation of the IndexerEventManager instance using the mock message sender is valid and necessary for passing it as a parameter to the NewKeeper function.

---

71-71: LGTM!

Passing the mockIndexerEventsManager as a parameter to the NewKeeper function is valid and necessary for integrating the indexer event manager with the vault keeper.

---

Line range hint 1-80: Overall changes look good!

The changes introduce a mock implementation of the IndexerMessageSender interface, which is used to create an instance of IndexerEventManager. The mockIndexerEventsManager is then passed as a parameter to the NewKeeper function. These changes enhance the testing capabilities of the vault keeper by allowing it to interact with a mock indexer event manager, facilitating the testing of functionalities that depend on the indexer without requiring a live implementation.

The changes are well-structured and follow the necessary steps to integrate the mock indexer event manager with the vault keeper. There are no apparent issues or concerns with the overall changes.

---

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>, 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 generate interesting stats about this repository and render them as a table.
  -- @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 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.