Skip to content

Conversation

@GarmashAlex
Copy link
Contributor

Replace shorthand field names in documentation comments with the canonical names defined by the ERC-4337 interface:

  • verificationGas → verificationGasLimit
  • callGas → callGasLimit
  • maxPriorityFee → maxPriorityFeePerGas

@GarmashAlex GarmashAlex requested a review from a team as a code owner November 1, 2025 14:37
@changeset-bot
Copy link

changeset-bot bot commented Nov 1, 2025

⚠️ No Changeset found

Latest commit: fbe98c6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 1, 2025

Walkthrough

Documentation updates to the account abstraction module clarify field naming in PackedUserOperation. Comments are modified to reference the exact component field names: accountGasLimits is updated to reference verificationGasLimit and callGasLimit, and gasFees is updated to reference maxPriorityFeePerGas and maxFeePerGas. Changes are limited to documentation only with no modifications to code or type definitions.

Suggested labels

typo

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title "docs: use canonical PackedUserOperation field names" directly and clearly summarizes the main change in the pull request. According to the raw summary, the changeset updates comments in PackedUserOperation fields to reflect exact canonical field names as defined by the ERC-4337 interface, which is precisely what the title conveys. The title is specific, concise, and a developer scanning the repository history would immediately understand the primary change without ambiguity.
Description Check ✅ Passed The pull request description is clearly related to the changeset and provides specific information about the changes. It explains the intent to replace shorthand field names with canonical names defined by the ERC-4337 interface, and lists concrete examples of the mappings (verificationGas → verificationGasLimit, callGas → callGasLimit, maxPriorityFee → maxPriorityFeePerGas). This directly aligns with the documentation updates described in the raw summary and is neither vague nor off-topic.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 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 8631702 and fbe98c6.

📒 Files selected for processing (1)
  • docs/modules/ROOT/pages/account-abstraction.adoc (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (9)
  • GitHub Check: Redirect rules - solidity-contracts
  • GitHub Check: Header rules - solidity-contracts
  • GitHub Check: Pages changed - solidity-contracts
  • GitHub Check: slither
  • GitHub Check: tests-upgradeable
  • GitHub Check: halmos
  • GitHub Check: tests-foundry
  • GitHub Check: tests
  • GitHub Check: coverage
🔇 Additional comments (1)
docs/modules/ROOT/pages/account-abstraction.adoc (1)

21-23: Documentation correctly aligns with EIP-4337 specification.

The field name updates in the PackedUserOperation comments are accurate. The accountGasLimits field correctly decomposes into verificationGasLimit (16 bytes) and callGasLimit (16 bytes), and gasFees correctly decomposes into maxPriorityFeePerGas (16 bytes) and maxFeePerGas (16 bytes), matching the canonical ERC-4337 specification. The documentation now precisely reflects how packed components decompose, improving clarity for developers.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

@ernestognw ernestognw changed the base branch from master to typo-fixes November 3, 2025 17:27
Copy link
Member

@ernestognw ernestognw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

@ernestognw ernestognw merged commit 47615e5 into OpenZeppelin:typo-fixes Nov 3, 2025
20 of 21 checks passed
Copy link

@marshalokos marshalokos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants