[N-03] M3 Audit

[ericnordelo]

Clarifies the type-hash macro documentation, including SNIP-12 collections and the tuple-member extension.

Summary by CodeRabbit

• Documentation
  • Clarified documentation for SNIP-12 type categories.
  • Improved explanations of collection types and tuple extensions.
  • Clarified that type-name methods provide macro-facing names.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a5d79917-6f1a-46e5-88a5-71463fa3f954

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

Walkthrough

The pull request updates documentation in the type hash module. It clarifies SNIP-12 type categories, tuple extensions, user-defined types, and macro-facing type names. Runtime behavior and public declarations remain unchanged.

Changes

Type Hash Documentation

Layer / File(s)	Summary
Type category documentation packages/macros/src/attribute/type_hash/types.rs	Documentation comments clarify SNIP-12 collections, enum parameter lists, tuple-member extensions, user-defined types, and macro-facing type names.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Poem

I’m a rabbit with a careful pen,
Clarifying types for macros again.
SNIP-12 paths now read bright,
Tuples stand clear in the light.
No code hops, just docs take flight.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title identifies the N-03 M3 audit, which relates to the documentation changes, but it does not describe the specific SNIP-12 documentation updates.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix/m3-audit-N-03

---

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@packages/macros/src/attribute/type_hash/types.rs`:
- Around line 1-19: Update the module documentation near the “Types recognized
by the type hash derive macro” heading so SNIP-12 lists only basic, preset, and
user-defined types as its type categories; describe arrays and parenthesized
enum parameter lists separately, while retaining the note that tuple-typed
members are an OpenZeppelin-specific extension.

🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 52fddd15-9dbb-4477-97a0-b58baab46751

📥 Commits

Reviewing files that changed from the base of the PR and between 619acaa and 8c15494.

📒 Files selected for processing (1)

• packages/macros/src/attribute/type_hash/types.rs

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[immrsd]

LGTM