refactor(erc1155): modular facet architecture with exportSelectors#286
refactor(erc1155): modular facet architecture with exportSelectors#286maxnorm merged 6 commits intoPerfect-Abstractions:mainfrom
Conversation
…d selector discovery.
…nd renaming burn functions for clarity.
# Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.
👷 Deploy request for compose-diamonds pending review.Visit the deploys page to approve it
|
|
|
||
| /** | ||
| * @notice Burns a single token type from an address. | ||
| * @dev Decreases the balance and emits a TransferSingle event. |
There was a problem hiding this comment.
For extra safety, do you think it's worth adding a @dev notice on the fact that the module doesn't check for approval like the functions in the facet?
There was a problem hiding this comment.
Good call, added a @dev notice on both burn and burnBatch
clarifying that the module skips approval checks — callers should
use the facet if approval enforcement is needed.
There was a problem hiding this comment.
I'm not sure about "Use the facet for approval-checked burns.". More like "Ensure proper ownership or approval validation before calling this function."
The use of module is to extend default behavior inside your own facet, so use facet isn't suited. What do you think?
After that, i think it's ready to merge
|
Thanks for the great work as always! |
2 participants
Summary
Refactors the ERC1155 implementation to match the modular facet pattern established by ERC20
and ERC721. Splits the monolithic
ERC1155Facet.solinto focused facets and modules perconcern, and adds
exportSelectors()to each facet as a selector discovery mechanism perEIP-8153.
Changes Made
ERC1155Facet.sol,ERC1155DataFacet.sol,ERC1155Mod.solApprove/ERC1155ApproveFacet.sol— externalsetApprovalForAllApprove/ERC1155ApproveMod.sol— internal free function for approval logicBurn/ERC1155BurnFacet.sol— externalburnERC1155andburnERC1155Batchwithowner/operator authorization
Burn/ERC1155BurnMod.sol— internal free functions for burn logicData/ERC1155DataFacet.sol— external read-only functions:balanceOf,balanceOfBatch,isApprovedForAllMetadata/ERC1155MetadataFacet.sol— externaluriwith per-token and base URIsupport
Metadata/ERC1155MetadataMod.sol— internal free functions:setURI,setBaseURI,setTokenURIMint/ERC1155MintMod.sol— internal free functions:mintERC1155,mintERC1155Batchwith ERC1155Receiver validationTransfer/ERC1155TransferFacet.sol— externalsafeTransferFromandsafeBatchTransferFromwith ERC1155Receiver validationTransfer/ERC1155TransferMod.sol— internal free functions for transfer logicexportSelectors()to all 5 facets (Approve, Burn, Data, Metadata, Transfer)mintERC1155,burnERC1155, etc.(consistent with
mintERC20,burnERC721)keccak256("erc1155")for core token data,keccak256("erc1155.metadata")for metadataChecklist
Before submitting this PR, please ensure:
Code follows the Solidity feature ban - No inheritance, constructors, modifiers,
public/private variables, external library functions,
using fordirectives, orselfdestructCode follows Design Principles - Readable, uses diamond storage, favors composition
over inheritance
Code matches the codebase style - Consistent formatting, documentation, and
patterns (e.g. ERC20Facet.sol)
Code is formatted with
forge fmtExisting tests pass - Run tests to be sure existing tests pass.
All tests pass - Run
forge testand ensure everything worksDocumentation updated - If applicable, update relevant documentation
Make sure to follow the
contributing guidelines.
Additional Notes
Existing test files still reference the deleted pre-refactor files and will need to be
updated.