Merge pull request #13 from ProjectOpenSea/upgradeable

Add Upgradeable Contracts and Examples

Author: operatorfilterer

.gitignore

@@ -0,0 +1,12 @@
+# Compiler files
+cache/
+out/
+
+# Ignores development broadcast logs
+!/broadcast
+/broadcast/*/31337/
+/broadcast/**/dry-run/
+
+# Dotenv file
+.env
+remappings.txt

.gitmodules

@@ -4,3 +4,6 @@
 [submodule "lib/forge-std"]
 	path = lib/forge-std
 	url = https://github.com/foundry-rs/forge-std
+[submodule "lib/openzeppelin-contracts-upgradeable"]
+	path = lib/openzeppelin-contracts-upgradeable
+	url = https://github.com/openzeppelin/openzeppelin-contracts-upgradeable

foundry.toml

@@ -4,5 +4,8 @@ out = 'out'
 libs = ['lib']
 optimizer_runs = 1_000_000
 solc = '0.8.17'
+remappings = [
+    'openzeppelin-contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts',
+]
 
 # See more config options https://github.com/foundry-rs/foundry/tree/master/config

lib/openzeppelin-contracts-upgradeable

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.13;
 
 import {ERC1155} from "openzeppelin-contracts/token/ERC1155/ERC1155.sol";
-import {DefaultOperatorFilterer1155, OperatorFilterer1155} from "./DefaultOperatorFilterer1155.sol";
+import {DefaultOperatorFilterer1155} from "./DefaultOperatorFilterer1155.sol";
 import {Ownable} from "openzeppelin-contracts/access/Ownable.sol";
 
 /**

src/example/ExampleERC1155.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.13;
 
 import {ERC721} from "openzeppelin-contracts/token/ERC721/ERC721.sol";
-import {DefaultOperatorFilterer721, OperatorFilterer721} from "./DefaultOperatorFilterer721.sol";
+import {DefaultOperatorFilterer721} from "./DefaultOperatorFilterer721.sol";
 import {Ownable} from "openzeppelin-contracts/access/Ownable.sol";
 
 /**

src/example/ExampleERC721.sol

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.13;
+
+import {OperatorFilterer1155Upgradeable} from "./OperatorFilterer1155Upgradeable.sol";
+
+abstract contract DefaultOperatorFilterer1155Upgradeable is OperatorFilterer1155Upgradeable {
+    address constant DEFAULT_SUBSCRIPTION = address(0x3cc6CddA760b79bAfa08dF41ECFA224f810dCeB6);
+
+    function __DefaultOperatorFilterer1155_init() public onlyInitializing {
+        OperatorFilterer1155Upgradeable.__OperatorFilterer1155_init(DEFAULT_SUBSCRIPTION, true);
+    }
+}

src/example/upgradeable/DefaultOperatorFilterer1155Upgradeable.sol

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.13;
+
+import {OperatorFilterer721Upgradeable} from "./OperatorFilterer721Upgradeable.sol";
+
+abstract contract DefaultOperatorFilterer721Upgradeable is OperatorFilterer721Upgradeable {
+    address constant DEFAULT_SUBSCRIPTION = address(0x3cc6CddA760b79bAfa08dF41ECFA224f810dCeB6);
+
+    function __DefaultOperatorFilterer721_init() public onlyInitializing {
+        OperatorFilterer721Upgradeable.__OperatorFilterer721_init(DEFAULT_SUBSCRIPTION, true);
+    }
+}

src/example/upgradeable/DefaultOperatorFilterer721Upgradeable.sol

@@ -0,0 +1,43 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.13;
+
+import {ERC1155Upgradeable} from "openzeppelin-contracts-upgradeable/token/ERC1155/ERC1155Upgradeable.sol";
+import {DefaultOperatorFilterer1155Upgradeable} from "./DefaultOperatorFilterer1155Upgradeable.sol";
+import {OwnableUpgradeable} from "openzeppelin-contracts-upgradeable/access/OwnableUpgradeable.sol";
+
+/**
+ * @title  ExampleERC1155Upgradeable
+ * @notice This example contract is configured to use the DefaultOperatorFilterer, which automatically registers the
+ *         token and subscribes it to OpenSea's curated filters.
+ *         Adding the onlyAllowedOperator modifier to the transferFrom and both safeTransferFrom methods ensures that
+ *         the msg.sender (operator) is allowed by the OperatorFilterRegistry.
+ */
+abstract contract ExampleERC1155Upgradeable is
+    ERC1155Upgradeable,
+    DefaultOperatorFilterer1155Upgradeable,
+    OwnableUpgradeable
+{
+    function initialize() public initializer {
+        __ERC1155_init("");
+        __Ownable_init();
+        __DefaultOperatorFilterer1155_init();
+    }
+
+    function safeTransferFrom(address from, address to, uint256 tokenId, uint256 amount, bytes memory data)
+        public
+        override
+        onlyAllowedOperator(from, tokenId)
+    {
+        super.safeTransferFrom(from, to, tokenId, amount, data);
+    }
+
+    function safeBatchTransferFrom(
+        address from,
+        address to,
+        uint256[] memory ids,
+        uint256[] memory amounts,
+        bytes memory data
+    ) public virtual override onlyAllowedOperatorBatch(from, ids) {
+        super.safeBatchTransferFrom(from, to, ids, amounts, data);
+    }
+}

src/example/upgradeable/ExampleERC1155Upgradeable.sol

@@ -0,0 +1,45 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.13;
+
+import {ERC721Upgradeable} from "openzeppelin-contracts-upgradeable/token/ERC721/ERC721Upgradeable.sol";
+import {DefaultOperatorFilterer721Upgradeable} from "./DefaultOperatorFilterer721Upgradeable.sol";
+import {OwnableUpgradeable} from "openzeppelin-contracts-upgradeable/access/OwnableUpgradeable.sol";
+
+/**
+ * @title  ExampleERC721Upgradeable
+ * @notice This example contract is configured to use the DefaultOperatorFilterer, which automatically registers the
+ *         token and subscribes it to OpenSea's curated filters.
+ *         Adding the onlyAllowedOperator modifier to the transferFrom and both safeTransferFrom methods ensures that
+ *         the msg.sender (operator) is allowed by the OperatorFilterRegistry.
+ */
+abstract contract ExampleERC721Upgradeable is
+    ERC721Upgradeable,
+    DefaultOperatorFilterer721Upgradeable,
+    OwnableUpgradeable
+{
+    function initialize() public initializer {
+        __ERC721_init("Example", "EXAMPLE");
+        __Ownable_init();
+        __DefaultOperatorFilterer721_init();
+    }
+
+    function transferFrom(address from, address to, uint256 tokenId) public override onlyAllowedOperator(from) {
+        super.transferFrom(from, to, tokenId);
+    }
+
+    function safeTransferFrom(address from, address to, uint256 tokenId) public override onlyAllowedOperator(from) {
+        super.safeTransferFrom(from, to, tokenId);
+    }
+
+    function safeTransferFrom(address from, address to, uint256 tokenId, bytes memory data)
+        public
+        override
+        onlyAllowedOperator(from)
+    {
+        super.safeTransferFrom(from, to, tokenId, data);
+    }
+
+    function tokenURI(uint256) public pure override returns (string memory) {
+        return "";
+    }
+}