Skip to content

docs(interfaces): deprecate ERC1155InvalidApprover in IERC1155Errors #5994

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(interfaces): deprecate ERC1155InvalidApprover in IERC1155Errors #5994

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion contracts/interfaces/draft-IERC6093.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,8 @@ interface IERC1155Errors {
error ERC1155MissingApprovalForAll(address operator, address owner);

/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @dev Non-standard for ERC-1155. ERC-1155 only defines operator-wide approvals via {setApprovalForAll}.
* @deprecated Non-standard for ERC-1155; use {ERC1155InvalidOperator} or {ERC1155MissingApprovalForAll} instead.
* @param approver Address initiating an approval operation.
Comment on lines +144 to 146
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

Replace the unsupported @deprecated tag

Hardhat is rejecting this docblock (DocstringParsingError: Documentation tag @deprecated not valid for errors), so the contract no longer compiles. Please keep the deprecation note but phrase it without the NatSpec tag, e.g.:

-     * @deprecated Non-standard for ERC-1155; use {ERC1155InvalidOperator} or {ERC1155MissingApprovalForAll} instead.
+     * Deprecated: non-standard for ERC-1155; use {ERC1155InvalidOperator} or {ERC1155MissingApprovalForAll} instead.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
* @dev Non-standard for ERC-1155. ERC-1155 only defines operator-wide approvals via {setApprovalForAll}.
* @deprecated Non-standard for ERC-1155; use {ERC1155InvalidOperator} or {ERC1155MissingApprovalForAll} instead.
* @param approver Address initiating an approval operation.
* @dev Non-standard for ERC-1155. ERC-1155 only defines operator-wide approvals via {setApprovalForAll}.
* Deprecated: non-standard for ERC-1155; use {ERC1155InvalidOperator} or {ERC1155MissingApprovalForAll} instead.
* @param approver Address initiating an approval operation.
🤖 Prompt for AI Agents 
contracts/interfaces/draft-IERC6093.sol around lines 144-146: the NatSpec uses
the @deprecated tag on an error docblock which Hardhat rejects; remove the
@deprecated tag and rephrase the deprecation note as plain text in the comment
(e.g., "Deprecated — Non-standard for ERC-1155; use ERC1155InvalidOperator or
ERC1155MissingApprovalForAll instead.") so it is not treated as a NatSpec tag,
keeping the param and description intact.

*/
error ERC1155InvalidApprover(address approver);
Expand Down
Loading