Skip to content

feat: [Indexer] implemented event fetching and processing#162

Open
sadiq1971 wants to merge 5 commits intomainfrom
feat/indexer-mvp
Open

feat: [Indexer] implemented event fetching and processing#162
sadiq1971 wants to merge 5 commits intomainfrom
feat/indexer-mvp

Conversation

@sadiq1971
Copy link
Member

Closes #158

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a comprehensive event fetching and processing pipeline for the indexer. It establishes a reliable streaming client for the Canton ledger, capable of handling disconnections and authentication issues. A generic framework for decoding and batching events is provided, along with a specific implementation for TokenTransferEvents. The core processing logic ensures atomic persistence of events and updates to derived state, such as token balances and total supply, enabling a robust and consistent indexing solution.

Highlights

  • Canton SDK Streaming Client: Implemented a new Canton SDK streaming client (pkg/cantonsdk/streaming/client.go) that provides automatic reconnection with exponential backoff and handles authentication token invalidation for robust ledger event fetching.
  • Generic Event Streaming Framework: Introduced a generic Stream[T] type (pkg/cantonsdk/streaming/stream.go) that wraps the core streamer and applies a per-event decode function, allowing for flexible processing of different DAML template types.
  • DAML Value Decoding Enhancements: Expanded DAML value decoding utilities (pkg/cantonsdk/values/decode.go) with new functions for robustly extracting text, party, numeric, and timestamp values, including nested and optional fields, to simplify event parsing.
  • TokenTransferEvent Decoder: Developed a specialized decoder (pkg/indexer/engine/decoder.go) for CIP56.Events.TokenTransferEvent that filters events based on instrument keys, extracts relevant data, and classifies them as Mint, Burn, or Transfer events.
  • Indexer Processor Core Logic: Created the main indexer Processor (pkg/indexer/engine/processor.go) responsible for orchestrating event fetching, atomic persistence of events and derived state (tokens, balances, total supply) in a transactional manner, and includes retry mechanisms for resilient operation.
  • New Indexer Data Models: Defined core data structures (pkg/indexer/types.go) such as ParsedEvent, InstrumentKey, Token, and Balance to represent the structured and indexed data derived from Canton ledger events.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a well-structured and robust implementation for fetching and processing events from the Canton ledger. The new streaming package provides a solid foundation with a generic, reconnecting client, and the indexer/engine builds upon it effectively. The code demonstrates good practices like dependency inversion, clear separation of concerns, and thorough testing. My review includes a few suggestions to refactor small pieces of code to enhance clarity and reduce redundancy.

Comment on lines +62 to +67
if !ev.IsNone("fromParty") {
v := ev.OptionalPartyField("fromParty")
if v != "" {
fromPartyID = &v
}
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The !ev.IsNone("fromParty") check is redundant because ev.OptionalPartyField("fromParty") will return an empty string if the field is None. You can simplify this block.

        if v := ev.OptionalPartyField("fromParty"); v != "" {
			fromPartyID = &v
		}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: [Indexer] Processor with event fetcher

1 participant