Generate report IDs

[neekolas]

TL;DR

Added functionality to generate unique IDs for payer reports based on their contents.

What changed?

• Added a new ID() method to the PayerReport struct that generates a unique identifier by hashing the report's fields
• Created a new payerreport/id.go file with ABI definitions for hashing payer report data
• Added NodesMerkleRoot and NodesLeafCount fields to the PayerReport struct
• Implemented a ToProto() method to convert a PayerReport to its protobuf representation
• Added utility functions for hashing payer report data and converting byte slices to fixed-size arrays
• Added tests to verify the payer report ID generation

How to test?

Run the new test in pkg/payerreport/report_test.go to verify that the ID generation works correctly:

go test -v ./pkg/payerreport -run TestPayerReportID

Why make this change?

This change enables unique identification of payer reports based on their content, which is necessary for tracking, referencing, and validating reports throughout the system. The ID generation follows Ethereum's ABI encoding standards to ensure compatibility with smart contract verification.

Summary by CodeRabbit

• New Features

  • Enhanced payer reports by including node merkle root and leaf count details.
  • Added conversion of report data into a protocol-friendly format.
  • Improved unique report ID generation using secure hashing methods.
  • Introduced utilities for byte slice conversion and hashing.

• Tests

  • Added tests to validate the correctness of report ID generation.

[coderabbitai[bot]]

Walkthrough

This update introduces new functionality in the payerreport package to support Ethereum smart contract interactions for payer reports. A new file defines argument structures for encoding report data. The PayerReport struct replaces PayersLeafCount with ActiveNodeIds and adds methods to convert to protobuf and compute a unique identifier by packing fields and hashing. Utility functions for hashing and converting a byte slice to a fixed 32-byte array are added. Tests verify the ID generation.

Changes

Files	Change Summary
pkg/payerreport/id.go	Added payerReportMessageHash defining Ethereum ABI argument mappings for payer report fields including originator node ID, sequence IDs, Merkle root, and active node IDs array.
pkg/payerreport/interface.go	Removed PayersLeafCount field; added ActiveNodeIds []uint32. Added methods ToProto() for protobuf conversion and ID() to compute unique identifier by packing fields and hashing.
pkg/payerreport/report_test.go	Added test function TestPayerReportID to verify the correctness of the ID() method of PayerReport.
pkg/utils/hash.go	Added HashPayerReportInput function to compute the Keccak256 hash of a given byte slice.
pkg/utils/slice.go	Added SliceToArray32 function to convert a byte slice into a fixed-size 32-byte array.
pkg/payerreport/manager.go	Removed all assignments to the now-removed PayersLeafCount field in GenerateReport method.
pkg/payerreport/manager_test.go	Removed all assertions related to the PayersLeafCount field in test cases, retaining other field checks.

Sequence Diagram(s)

sequenceDiagram
    participant T as Test
    participant PR as PayerReport
    participant H as HashPayerReportInput (utils)

    T->>PR: Call ID()
    PR->>PR: Pack report fields (originatorNodeID, sequenceIDs, Merkle root, activeNodeIds)
    PR->>H: Compute Keccak256 hash on packed bytes
    H-->>PR: Return 32-byte hash
    PR-->>T: Return unique identifier (ID)

Suggested reviewers

• mkysel

[!TIP]

⚡️ Faster reviews with caching

• CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

---

📜 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 7af7d25989620ae2909e5b201d1220fdb73ce4f1 and 44734b5f22a10be562c5b14128a24fed3124aa0f.

📒 Files selected for processing (7)

• pkg/payerreport/id.go (1 hunks)
• pkg/payerreport/interface.go (2 hunks)
• pkg/payerreport/manager.go (0 hunks)
• pkg/payerreport/manager_test.go (0 hunks)
• pkg/payerreport/report_test.go (1 hunks)
• pkg/utils/hash.go (1 hunks)
• pkg/utils/slice.go (1 hunks)

💤 Files with no reviewable changes (2)

• pkg/payerreport/manager_test.go
• pkg/payerreport/manager.go

🚧 Files skipped from review as they are similar to previous changes (5)

• pkg/payerreport/report_test.go
• pkg/payerreport/id.go
• pkg/utils/slice.go
• pkg/utils/hash.go
• pkg/payerreport/interface.go

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

• GitHub Check: Graphite / mergeability_check
• GitHub Check: Graphite / mergeability_check

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

[neekolas]

[!WARNING] This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite. Learn more

• #760 : 2 dependent PRs (#761 , #764 )
• #703
• #702
• #701 👈 (View in Graphite)
• #700
• main

---

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

• Queue - adds this PR to the back of the merge queue
• Hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

[macroscopeapp[bot]]

Add PayerReport.ID() method to generate unique identifiers for payer reports using Keccak256 hashing

• Introduces new payerReportMessageHash structure in id.go defining fields for report hashing
• Adds PayerReport.ID() and PayerReport.ToProto() methods in interface.go
• Removes PayersLeafCount field and adds ActiveNodeIds to PayerReport struct
• Adds utility functions HashPayerReportInput and SliceToArray32 in hash.go and slice.go

📍Where to Start

Start with the payerReportMessageHash definition in id.go, then follow the implementation through to the PayerReport.ID() method in interface.go.

---

Macroscope summarized 44734b5.

[graphite-app[bot]]

Merge activity

• May 8, 8:02 AM PDT: neekolas added this pull request to the Graphite merge queue.
• May 8, 8:03 AM PDT: CI is running for this pull request on a draft pull request (#770) due to your merge queue CI optimization settings.
• May 8, 8:04 AM PDT: Merged by the Graphite merge queue via draft PR: #770.