Update protocol with index in transaction fields

[fracek]

This PR adds the {event,message,log}IndexInTransaction fields to track the index inside a transaction.

[coderabbitai]

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 buf (1.47.2)

packages/evm/proto/data.proto

Config file YAML parsing error: yaml: unmarshal errors:
line 1: cannot unmarshal !!str lint:{u... into bufconfig.externalFileVersion. Please check your buf configuration file for YAML syntax errors.

packages/starknet/proto/data.proto

Config file YAML parsing error: yaml: unmarshal errors:
line 1: cannot unmarshal !!str lint:{u... into bufconfig.externalFileVersion. Please check your buf configuration file for YAML syntax errors.

📝 Walkthrough

Walkthrough

This pull request introduces index tracking for events and logs across both Ethereum (EVM) and Starknet protocols. The changes add new optional fields to represent the index of logs, events, and messages within their respective transactions. These modifications enhance the granularity of transaction-related data structures in the Apibara libraries, allowing for more precise tracking of event and log positions during transaction processing.

Changes

File	Change Summary
change/@apibara-evm-f1bb6555-...	Added prerelease JSON object for @apibara/evm with patch-level changes
change/@apibara-starknet-5f888e...	Added prerelease JSON object for @apibara/starknet with patch-level changes
packages/evm/proto/data.proto	Added log_index_in_transaction field to Log message
packages/evm/src/block.ts	Added logIndexInTransaction property to Log schema
packages/evm/src/proto/data.ts	Updated Log interface with optional logIndexInTransaction
packages/starknet/proto/data.proto	Added event_index_in_transaction to Event and message_index_in_transaction to MessageToL1
packages/starknet/src/block.ts	Added eventIndexInTransaction and messageIndexInTransaction properties
packages/starknet/src/proto/data.ts	Updated Event and MessageToL1 interfaces with new index properties

Sequence Diagram

sequenceDiagram
    participant Transaction
    participant Log/Event
    Transaction->>Log/Event: Assign Index
    Log/Event-->>Transaction: Store Index
    Note over Log/Event: logIndexInTransaction
    Note over Log/Event: eventIndexInTransaction
    Note over Log/Event: messageIndexInTransaction

Loading

Possibly related PRs

• starknet: add event decoder module #133: Adds an event decoder for Starknet, which aligns with the current changes in event handling

Poem

🐰 Hop, hop, through the blockchain's maze,
Tracking logs with indexing praise!
Each event now has its own sweet spot,
In transactions, precisely caught.
A rabbit's guide to data's grace! 🔍

---

📜 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 9ef9de3 and 666e5c9.

📒 Files selected for processing (8)

• change/@apibara-evm-f1bb6555-a641-4402-82e4-692be980ad21.json (1 hunks)
• change/@apibara-starknet-5f888e7b-83d2-4a42-b2b5-d60e55fc7d2d.json (1 hunks)
• packages/evm/proto/data.proto (1 hunks)
• packages/evm/src/block.ts (1 hunks)
• packages/evm/src/proto/data.ts (7 hunks)
• packages/starknet/proto/data.proto (2 hunks)
• packages/starknet/src/block.ts (4 hunks)
• packages/starknet/src/proto/data.ts (14 hunks)

✅ Files skipped from review due to trivial changes (2)

• change/@apibara-starknet-5f888e7b-83d2-4a42-b2b5-d60e55fc7d2d.json
• change/@apibara-evm-f1bb6555-a641-4402-82e4-692be980ad21.json

👮 Files not reviewed due to content moderation or server errors (4)

• packages/evm/src/block.ts
• packages/starknet/src/block.ts
• packages/evm/src/proto/data.ts
• packages/starknet/src/proto/data.ts

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: test

🔇 Additional comments (3)

packages/evm/proto/data.proto (1)

178-179: LGTM! Field addition maintains protocol consistency.

The new field log_index_in_transaction is well-defined with:

• Appropriate type (uint32) matching other index fields
• Clear field name following the established naming pattern
• Proper field number assignment (9)

packages/starknet/proto/data.proto (2)

260-261: LGTM! Event index field properly defined.

The new field event_index_in_transaction follows the established pattern with appropriate type and field number.

---

280-281: LGTM! Excellent cross-protocol consistency.

The new field message_index_in_transaction maintains consistency with:

• Other index fields in the Starknet protocol
• Similar changes in the EVM protocol
• Proper type (uint32) and field numbering

Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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 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. (Beta)
• @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.