dojo icon indicating copy to clipboard operation
dojo copied to clipboard
verified publisher icon dojoengine

Add name hash as const

Open bengineer42 opened this issue 7 months ago • 2 comments

Description

THIS WILL NEED AN UPDATE TO THE SCARB REPO

https://github.com/dojoengine/scarb/blob/fix-unit-type/scarb/Cargo.toml#L49

Before the hash of the model name was computed everyt time it was called, this has been moved to compile time and is now part of the ModelDefinition

pub trait ModelDefinition<T> {
    const NAME_HASH: felt252;
    fn name() -> ByteArray;
    fn layout() -> Layout;
    fn schema() -> Struct;
    fn size() -> Option<usize>;
}

Related issue

Tests

  • [ ] Yes
  • [ ] No, because they aren't needed
  • [ ] No, because I need help

Added to documentation?

  • [ ] README.md
  • [ ] Dojo Book
  • [ ] No documentation needed

Checklist

  • [ ] I've formatted my code (scripts/rust_fmt.sh, scripts/cairo_fmt.sh)
  • [ ] I've linted my code (scripts/clippy.sh, scripts/docs.sh)
  • [ ] I've commented my code
  • [ ] I've requested a review after addressing the comments

Summary by CodeRabbit

  • New Features

    • Introduced a new constant representing a hash of the event or model name, making it accessible in event and model definitions.

  • Refactor

    • Updated selector computations for events and models to use the new name hash constant instead of relying on name strings.

bengineer42 avatar Jul 11 '25 10:07 bengineer42

"""

Walkthrough

Ohayo sensei! This update introduces a new NAME_HASH constant to both event and model definitions across core and macro crates. Selector computations now use this precomputed hash instead of string-based names, standardizing hash-based identification for events and models. Macro code was extended to generate and embed these hashes.

Changes

Files / Groups Change Summary
crates/dojo/core/src/event/event.cairo, crates/dojo/core/src/model/definition.cairo Added const NAME_HASH: felt252; to EventDefinition and ModelDefinition traits.
crates/dojo/core/src/model/model.cairo, crates/dojo/core/src/model/model_value.cairo Updated selector methods to use selector_from_hashes with NAME_HASH instead of string-based names.
crates/dojo/macros/src/attributes/event.rs, crates/dojo/macros/src/attributes/model.rs Extended DojoEvent and DojoModel structs with name_hash field; macro now generates NAME_HASH constants.
examples/benchmark/src/model.cairo Removed trailing blank line in a test function (non-functional change).

Sequence Diagram(s)

sequenceDiagram
    participant Macro as Macro (DojoEvent/DojoModel)
    participant Definition as Event/Model Definition
    participant Selector as Selector Logic

    Macro->>Definition: Generate NAME_HASH constant (felt252)
    Selector->>Definition: Access NAME_HASH
    Selector->>Selector: Compute selector using selector_from_hashes(namespace_hash, NAME_HASH)

Possibly related PRs

  • dojoengine/dojo#2219: Introduces selector_from_names utility used for selector computation from namespace and name hashes, foundational for this PR’s selector changes.
  • dojoengine/dojo#2946: Adds bytearray_hash macro enabling hash computation for names, which this PR uses to generate NAME_HASH constants.
  • dojoengine/dojo#2156: Modifies selector computation to use hash-based constants like NAME_HASH, closely related to this PR’s selector refactoring.

Suggested labels

contributor

Suggested reviewers

  • glihm """
📜 Recent review details

Configuration used: .coderabbit.yaml Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 731391e7203b442f47136a43c9b5ab413a273d05 and 37220300dac7591ec996cefb86c66d4fa18c3b08.

📒 Files selected for processing (1)
  • examples/benchmark/src/model.cairo (0 hunks)
💤 Files with no reviewable changes (1)
  • examples/benchmark/src/model.cairo
✨ Finishing Touches
🧪 Generate unit tests
  • [ ] Create PR with unit tests
  • [ ] Post copyable unit tests in a comment

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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 auto-generate unit tests to generate unit tests for 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.

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.

coderabbitai[bot] avatar Jul 11 '25 10:07 coderabbitai[bot]

proc macros have been merged, don't hesitate to rebase. 🫡

glihm avatar Jul 14 '25 23:07 glihm