contracts: fix share points check #2597

credence0x · 2024-12-26T10:52:33Z

Summary by CodeRabbit

New Features
- Enhanced key generation for tracking share points using a unique hashing mechanism.
Bug Fixes
- Improved error messaging for duplicate point addition, now includes epoch index for better context.

vercel · 2024-12-26T10:52:40Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
eternum	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 26, 2024 10:58am
eternum-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 26, 2024 10:58am

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
eternum-landing	⬜️ Ignored (Inspect)	Visit Preview		Dec 26, 2024 10:58am

coderabbitai · 2024-12-26T10:52:43Z

Walkthrough

The pull request introduces a modification to the compute_total_share_points function in the hyperstructure contracts. The primary change involves replacing the direct use of a hyperstructure entity ID with a more robust key generation method using poseidon_hash_span. This new approach creates a unique hash by combining the hyperstructure entity ID and epoch index, enhancing the key generation mechanism for tracking point additions and preventing potential collisions.

Changes

File	Change Summary
`contracts/src/systems/hyperstructure/contracts.cairo`	- Added import: `use core::poseidon::poseidon_hash_span` - Modified key generation in `compute_total_share_points` using `poseidon_hash_span` - Updated error message to include epoch index

Sequence Diagram

sequenceDiagram
    participant Func as compute_total_share_points
    participant Hasher as Poseidon Hash
    participant Storage as Point Tracking Storage

    Func->>Hasher: Generate unique key
    Hasher-->>Func: Hashed key (entity ID + epoch)
    Func->>Storage: Check if points already added
    alt Points not added
        Func->>Storage: Add points
    else Points already added
        Func->>Func: Raise error with detailed message
    end

Possibly related PRs

contracts: fix hyperstructure share points calculation #2329: Modifications to the compute_total_share_points function, focusing on point calculation logic for hyperstructures

Suggested reviewers

edisontim

Poem

🐰 Hashing keys with Poseidon's might,
Preventing collisions, making logic tight,
Epochs and IDs now dance as one,
A cryptographic rabbit's clever run!
No double points shall slip away, hooray! 🔑✨

📜 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 d668b3e and 64b401c.

📒 Files selected for processing (1)

contracts/src/systems/hyperstructure/contracts.cairo (2 hunks)

🔇 Additional comments (4)

contracts/src/systems/hyperstructure/contracts.cairo (4)

42-42: Poseidon hash import is correct and aligns with the new key generation requirement.
Good choice to import poseidon_hash_span; this helps strengthen the uniqueness properties of the generated keys.

600-604: Strong approach to avoid collisions by combining entity ID and epoch index in the hash.
Using poseidon_hash_span with both the hyperstructure_entity_id and index is a robust way to ensure uniqueness, preventing point-tracking collisions across epochs.

605-606: Panic message provides clear debugging info.
Explicitly naming the hyperstructure_entity_id and epoch in the error message helps significantly with debugging.

608-609: Dictionary insertion is logically placed after the check.
Inserting the hash key after verifying it does not exist prevents double counting. The flow is consistent and correct.

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

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

mentatbot

The changes look good and fix the issue with points calculation for different epochs of the same hyperstructure. The implementation is secure using poseidon_hash_span to create unique keys from both hyperstructure ID and epoch index. The only minor suggestion is to enhance the error message for better debugging.

Thanks for using MentatBot. Give comments a 👍 or 👎 to help me improve!

mentatbot · 2024-12-26T10:53:43Z

contracts/src/systems/hyperstructure/contracts.cairo

+                    array![hyperstructure_entity_id.into(), index.into()].span()
+                );
+
+                if points_already_added.get(points_already_added_key) {
                    panic!("points already added for hyperstructure {}", hyperstructure_entity_id);


Consider enhancing the error message to include the epoch index for better debugging. Something like: points already added for hyperstructure {} epoch {}

Suggested change

panic!("points already added for hyperstructure {}", hyperstructure_entity_id);

panic!("points already added for hyperstructure {} epoch {}", hyperstructure_entity_id, index);

github-actions · 2024-12-26T10:54:02Z

Failed to generate code suggestions for PR

contracts: fix share points check

5846755

credence0x requested review from aymericdelab and edisontim December 26, 2024 10:52

vercel bot deployed to Preview – eternum-docs December 26, 2024 10:53 View deployment

mentatbot bot reviewed Dec 26, 2024

View reviewed changes

contracts: fix share points check

64b401c

vercel bot deployed to Preview – eternum-docs December 26, 2024 10:56 View deployment

vercel bot deployed to Preview – eternum December 26, 2024 10:58 View deployment

ponderingdemocritus merged commit 0374f7e into next Dec 26, 2024
19 of 23 checks passed

ponderingdemocritus deleted the share-points-fix branch December 26, 2024 19:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

contracts: fix share points check #2597

contracts: fix share points check #2597

credence0x commented Dec 26, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Dec 26, 2024 •

edited

Loading

coderabbitai bot commented Dec 26, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

mentatbot bot left a comment

mentatbot bot Dec 26, 2024

github-actions bot commented Dec 26, 2024

	panic!("points already added for hyperstructure {}", hyperstructure_entity_id);
	panic!("points already added for hyperstructure {} epoch {}", hyperstructure_entity_id, index);

contracts: fix share points check #2597

contracts: fix share points check #2597

Conversation

credence0x commented Dec 26, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

vercel bot commented Dec 26, 2024 • edited Loading

coderabbitai bot commented Dec 26, 2024 • edited Loading

Walkthrough

Changes

Sequence Diagram

Possibly related PRs

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

mentatbot bot left a comment

Choose a reason for hiding this comment

mentatbot bot Dec 26, 2024

Choose a reason for hiding this comment

github-actions bot commented Dec 26, 2024

credence0x commented Dec 26, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Dec 26, 2024 •

edited

Loading

coderabbitai bot commented Dec 26, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)