Enable missing components in macros

packages/macros/src/attribute/with_components/components.rs

@@ -23,6 +23,8 @@ pub enum AllowedComponents {
     ERC1155Receiver,
     ERC2981,
     ERC4626,
+    ERC20Wrapper,
+    ERC721Wrapper,
     Upgradeable,
     Nonces,
     Multisig,
@@ -62,6 +64,8 @@ impl AllowedComponents {
             "ERC1155Receiver" => Ok(AllowedComponents::ERC1155Receiver),
             "ERC2981" => Ok(AllowedComponents::ERC2981),
             "ERC4626" => Ok(AllowedComponents::ERC4626),
+            "ERC20Wrapper" => Ok(AllowedComponents::ERC20Wrapper),
+            "ERC721Wrapper" => Ok(AllowedComponents::ERC721Wrapper),
             "Upgradeable" => Ok(AllowedComponents::Upgradeable),
             "Nonces" => Ok(AllowedComponents::Nonces),
             "Multisig" => Ok(AllowedComponents::Multisig),
@@ -260,6 +264,24 @@ impl AllowedComponents {
                 has_immutable_config: true,
                 internal_impls: vec!["InternalImpl"],
             },
+            AllowedComponents::ERC20Wrapper => ComponentInfo {
+                name: "ERC20WrapperComponent",
+                path: "openzeppelin_token::erc20::extensions::erc20_wrapper::ERC20WrapperComponent",
+                storage: "erc20_wrapper",
+                event: "ERC20WrapperEvent",
+                has_initializer: true,
+                has_immutable_config: false,
+                internal_impls: vec!["InternalImpl"],
+            },
+            AllowedComponents::ERC721Wrapper => ComponentInfo {
+                name: "ERC721WrapperComponent",
+                path: "openzeppelin_token::erc721::extensions::erc721_wrapper::ERC721WrapperComponent",
+                storage: "erc721_wrapper",
+                event: "ERC721WrapperEvent",
+                has_initializer: true,
+                has_immutable_config: false,
+                internal_impls: vec!["InternalImpl"],
+            },
             AllowedComponents::Upgradeable => ComponentInfo {
                 name: "UpgradeableComponent",
                 path: "openzeppelin_upgrades::UpgradeableComponent",

packages/macros/src/attribute/with_components/diagnostics.rs

@@ -110,6 +110,15 @@ pub mod warnings {
         "
     };
 
+    /// Warning when the ERC1155Supply hook call is missing.
+    pub const ERC1155_SUPPLY_HOOKS_MISSING: &str = indoc! {
+        "The ERC1155Supply component requires calling `self.erc1155_supply.after_update(...)`
+        inside the `ERC1155HooksTrait::after_update` hook, and it looks like it is missing.
+
+        This may lead to incorrect total supply tracking.
+        "
+    };
+
     /// Warning when the Upgradeable component is not used.
     pub const UPGRADEABLE_NOT_USED: &str = indoc! {
         "It looks like the `self.upgradeable.upgrade(new_class_hash)` function is not used in the contract. If
@@ -124,6 +133,15 @@ pub mod warnings {
         "
     };
 
+    /// Warning when the ERC721Enumerable hook call is missing.
+    pub const ERC721_ENUMERABLE_HOOKS_MISSING: &str = indoc! {
+        "The ERC721Enumerable component requires calling `self.erc721_enumerable.before_update(...)`
+        inside the `ERC721HooksTrait::before_update` hook, and it looks like it is missing.
+
+        This may lead to incorrect token enumeration data.
+        "
+    };
+
     /// Warning when the ERC4626 component is missing an implementation of the ERC4626HooksTrait.
     pub const ERC4626_HOOKS_IMPL_MISSING: &str = indoc! {
         "The ERC4626 component requires an implementation of the ERC4626HooksTrait in scope and

packages/macros/src/attribute/with_components/parser.rs

@@ -308,6 +308,14 @@ fn add_per_component_warnings(code: &str, component_info: &ComponentInfo) -> Vec
                 warnings.push(warning);
             }
         }
+        AllowedComponents::ERC1155Supply => {
+            let hook_called = code.contains("erc1155_supply.after_update(")
+                || code.contains("ERC1155SupplyInternalImpl::after_update(");
+            if !hook_called {
+                let warning = Diagnostic::warn(warnings::ERC1155_SUPPLY_HOOKS_MISSING);
+                warnings.push(warning);
+            }
+        }
         AllowedComponents::Upgradeable => {
             // Check that the upgrade function is called
             let upgrade_function_called = code.contains("self.upgradeable.upgrade");
@@ -324,6 +332,14 @@ fn add_per_component_warnings(code: &str, component_info: &ComponentInfo) -> Vec
                 warnings.push(warning);
             }
         }
+        AllowedComponents::ERC721Enumerable => {
+            let hook_called = code.contains("erc721_enumerable.before_update(")
+                || code.contains("ERC721EnumerableInternalImpl::before_update(");
+            if !hook_called {
+                let warning = Diagnostic::warn(warnings::ERC721_ENUMERABLE_HOOKS_MISSING);
+                warnings.push(warning);
+            }
+        }
         _ => {}
     }
     warnings

packages/macros/src/tests/snapshots/openzeppelin_macros__tests__test_with_components__with_erc20_wrapper.snap

@@ -0,0 +1,50 @@
+---
+source: src/tests/test_with_components.rs
+expression: result
+snapshot_kind: text
+---
+TokenStream:
+
+#[starknet::contract]
+pub mod MyToken {
+    use openzeppelin_token::erc20::{DefaultConfig, ERC20HooksEmptyImpl};
+    use starknet::ContractAddress;
+    #[storage]
+    pub struct Storage {
+        #[substorage(v0)]
+        pub erc20: ERC20Component::Storage,
+        #[substorage(v0)]
+        pub erc20_wrapper: ERC20WrapperComponent::Storage,
+    }
+    #[constructor]
+    fn constructor(ref self: ContractState, underlying: ContractAddress) {
+        self.erc20.initializer("MyToken", "MTK");
+        self.erc20_wrapper.initializer(underlying);
+    }
+    use openzeppelin_token::erc20::ERC20Component;
+    use openzeppelin_token::erc20::extensions::erc20_wrapper::ERC20WrapperComponent;
+
+    component!(path: ERC20Component, storage: erc20, event: ERC20Event);
+    component!(path: ERC20WrapperComponent, storage: erc20_wrapper, event: ERC20WrapperEvent);
+
+    impl ERC20InternalImpl = ERC20Component::InternalImpl<ContractState>;
+    impl ERC20WrapperInternalImpl = ERC20WrapperComponent::InternalImpl<ContractState>;
+
+    #[event]
+    #[derive(Drop, starknet::Event)]
+    enum Event {
+        #[flat]
+        ERC20Event: ERC20Component::Event,
+        #[flat]
+        ERC20WrapperEvent: ERC20WrapperComponent::Event,
+    }
+}
+
+
+Diagnostics:
+
+None
+
+AuxData:
+
+None

packages/macros/src/tests/snapshots/openzeppelin_macros__tests__test_with_components__with_erc20_wrapper_no_initializer.snap

@@ -0,0 +1,56 @@
+---
+source: src/tests/test_with_components.rs
+expression: result
+snapshot_kind: text
+---
+TokenStream:
+
+#[starknet::contract]
+pub mod MyToken {
+    use openzeppelin_token::erc20::{DefaultConfig, ERC20HooksEmptyImpl};
+    use starknet::ContractAddress;
+    #[storage]
+    pub struct Storage {
+        #[substorage(v0)]
+        pub erc20: ERC20Component::Storage,
+        #[substorage(v0)]
+        pub erc20_wrapper: ERC20WrapperComponent::Storage,
+    }
+    #[constructor]
+    fn constructor(ref self: ContractState) {
+        self.erc20.initializer("MyToken", "MTK");
+    }
+    use openzeppelin_token::erc20::ERC20Component;
+    use openzeppelin_token::erc20::extensions::erc20_wrapper::ERC20WrapperComponent;
+
+    component!(path: ERC20Component, storage: erc20, event: ERC20Event);
+    component!(path: ERC20WrapperComponent, storage: erc20_wrapper, event: ERC20WrapperEvent);
+
+    impl ERC20InternalImpl = ERC20Component::InternalImpl<ContractState>;
+    impl ERC20WrapperInternalImpl = ERC20WrapperComponent::InternalImpl<ContractState>;
+
+    #[event]
+    #[derive(Drop, starknet::Event)]
+    enum Event {
+        #[flat]
+        ERC20Event: ERC20Component::Event,
+        #[flat]
+        ERC20WrapperEvent: ERC20WrapperComponent::Event,
+    }
+}
+
+
+Diagnostics:
+
+====
+Warning: It looks like the initializers for the following components are missing:
+
+ERC20Wrapper
+
+This may lead to unexpected behavior.
+We recommend adding the corresponding initializer calls to the constructor.
+====
+
+AuxData:
+
+None

packages/macros/src/tests/snapshots/openzeppelin_macros__tests__test_with_components__with_erc721_enumerable.snap

@@ -35,7 +35,12 @@ pub mod MyContract {
 
 Diagnostics:
 
-None
+====
+Warning: The ERC721Enumerable component requires calling `self.erc721_enumerable.before_update(...)`
+inside the `ERC721HooksTrait::before_update` hook, and it looks like it is missing.
+
+This may lead to incorrect token enumeration data.
+====
 
 AuxData:
 

packages/macros/src/tests/snapshots/openzeppelin_macros__tests__test_with_components__with_erc721_enumerable_no_initializer.snap

@@ -38,6 +38,11 @@ ERC721Enumerable
 
 This may lead to unexpected behavior.
 We recommend adding the corresponding initializer calls to the constructor.
+========
+Warning: The ERC721Enumerable component requires calling `self.erc721_enumerable.before_update(...)`
+inside the `ERC721HooksTrait::before_update` hook, and it looks like it is missing.
+
+This may lead to incorrect token enumeration data.
 ====
 
 AuxData:

packages/macros/src/tests/snapshots/openzeppelin_macros__tests__test_with_components__with_erc721_enumerable_with_hooks.snap

@@ -0,0 +1,55 @@
+---
+source: src/tests/test_with_components.rs
+expression: result
+snapshot_kind: text
+---
+TokenStream:
+
+#[starknet::contract]
+pub mod MyContract {
+    use openzeppelin_token::erc721::ERC721Component;
+    use starknet::ContractAddress;
+    #[storage]
+    pub struct Storage {
+        #[substorage(v0)]
+        pub erc721_enumerable: ERC721EnumerableComponent::Storage,
+    }
+    #[constructor]
+    fn constructor(ref self: ContractState) {
+        self.erc721_enumerable.initializer();
+    }
+    impl ERC721HooksImpl of ERC721Component::ERC721HooksTrait<ContractState> {
+        fn before_update(
+            ref self: ERC721Component::ComponentState<ContractState>,
+            to: ContractAddress,
+            token_id: u256,
+            auth: ContractAddress,
+        ) {
+            let mut contract_state = self.get_contract_mut();
+            contract_state.erc721_enumerable.before_update(to, token_id);
+        }
+    }
+    use openzeppelin_token::erc721::extensions::ERC721EnumerableComponent;
+
+    component!(
+        path: ERC721EnumerableComponent, storage: erc721_enumerable, event: ERC721EnumerableEvent,
+    );
+
+    impl ERC721EnumerableInternalImpl = ERC721EnumerableComponent::InternalImpl<ContractState>;
+
+    #[event]
+    #[derive(Drop, starknet::Event)]
+    enum Event {
+        #[flat]
+        ERC721EnumerableEvent: ERC721EnumerableComponent::Event,
+    }
+}
+
+
+Diagnostics:
+
+None
+
+AuxData:
+
+None

packages/macros/src/tests/snapshots/openzeppelin_macros__tests__test_with_components__with_erc721_wrapper.snap

@@ -0,0 +1,57 @@
+---
+source: src/tests/test_with_components.rs
+expression: result
+snapshot_kind: text
+---
+TokenStream:
+
+#[starknet::contract]
+pub mod MyToken {
+    use openzeppelin_token::erc721::ERC721HooksEmptyImpl;
+    use starknet::ContractAddress;
+    #[storage]
+    pub struct Storage {
+        #[substorage(v0)]
+        pub erc721: ERC721Component::Storage,
+        #[substorage(v0)]
+        pub src5: SRC5Component::Storage,
+        #[substorage(v0)]
+        pub erc721_wrapper: ERC721WrapperComponent::Storage,
+    }
+    #[constructor]
+    fn constructor(ref self: ContractState, underlying: ContractAddress) {
+        self.erc721.initializer("MyToken", "MTK", "");
+        self.erc721_wrapper.initializer(underlying);
+    }
+    use openzeppelin_introspection::src5::SRC5Component;
+    use openzeppelin_token::erc721::ERC721Component;
+    use openzeppelin_token::erc721::extensions::erc721_wrapper::ERC721WrapperComponent;
+
+    component!(path: ERC721Component, storage: erc721, event: ERC721Event);
+    component!(path: SRC5Component, storage: src5, event: SRC5Event);
+    component!(path: ERC721WrapperComponent, storage: erc721_wrapper, event: ERC721WrapperEvent);
+
+    impl ERC721InternalImpl = ERC721Component::InternalImpl<ContractState>;
+    impl SRC5InternalImpl = SRC5Component::InternalImpl<ContractState>;
+    impl ERC721WrapperInternalImpl = ERC721WrapperComponent::InternalImpl<ContractState>;
+
+    #[event]
+    #[derive(Drop, starknet::Event)]
+    enum Event {
+        #[flat]
+        ERC721Event: ERC721Component::Event,
+        #[flat]
+        SRC5Event: SRC5Component::Event,
+        #[flat]
+        ERC721WrapperEvent: ERC721WrapperComponent::Event,
+    }
+}
+
+
+Diagnostics:
+
+None
+
+AuxData:
+
+None