progress, simplify extension contracts, more coverage

ProjectOpenSea · Nov 15, 2023 · a98fb8c · a98fb8c
1 parent 7f5a636
commit a98fb8c
Show file tree

Hide file tree

Showing 26 changed files with 270 additions and 234 deletions.
diff --git a/script/DeployAndConfigure1155Receive.s.sol b/script/DeployAndConfigure1155Receive.s.sol
@@ -7,7 +7,7 @@ import {ItemType} from "seaport-types/src/lib/ConsiderationEnums.sol";
 import {OfferItem, ConsiderationItem} from "seaport-types/src/lib/ConsiderationStructs.sol";
 import {Campaign, CampaignParams, CampaignRequirements} from "../src/lib/RedeemablesStructs.sol";
 import {BURN_ADDRESS} from "../src/lib/RedeemablesConstants.sol";
-import {ERC721RedemptionMintable} from "../src/extensions/ERC721RedemptionMintable.sol";
+import {ERC721ShipyardRedeemableMintable} from "../src/extensions/ERC721ShipyardRedeemableMintable.sol";
 import {ERC721OwnerMintable} from "../src/test/ERC721OwnerMintable.sol";
 import {ERC1155ShipyardRedeemableMintable} from "../src/extensions/ERC1155ShipyardRedeemableMintable.sol";
 

diff --git a/script/DeployAndConfigureExampleCampaign.s.sol.txt b/script/DeployAndConfigureExampleCampaign.s.sol.txt
@@ -8,7 +8,7 @@ import {OfferItem, ConsiderationItem} from "seaport-types/src/lib/ConsiderationS
 import {RedeemableContractOfferer} from "../src/RedeemableContractOfferer.sol";
 import {CampaignParams} from "../src/lib/RedeemablesStructs.sol";
 import {BURN_ADDRESS} from "../src/lib/RedeemablesConstants.sol";
-import {ERC721RedemptionMintable} from "../src/extensions/ERC721RedemptionMintable.sol";
+import {ERC721ShipyardRedeemableMintable} from "../src/extensions/ERC721ShipyardRedeemableMintable.sol";
 import {TestERC721} from "../test/utils/mocks/TestERC721.sol";
 
 contract DeployAndConfigureExampleCampaign is Script {
@@ -26,7 +26,7 @@ contract DeployAndConfigureExampleCampaign is Script {
             seaport
         );
         TestERC721 redeemableToken = new TestERC721();
-        ERC721RedemptionMintable redemptionToken = new ERC721RedemptionMintable(
+        ERC721ShipyardRedeemableMintable redemptionToken = new ERC721ShipyardRedeemableMintable(
             address(offerer),
             address(redeemableToken)
         );

diff --git a/script/DeployAndRedeemTokens-CampaignOnReceiveToken.s.sol b/script/DeployAndRedeemTokens-CampaignOnReceiveToken.s.sol
@@ -7,7 +7,7 @@ import {ItemType} from "seaport-types/src/lib/ConsiderationEnums.sol";
 import {OfferItem, ConsiderationItem} from "seaport-types/src/lib/ConsiderationStructs.sol";
 import {Campaign, CampaignParams, CampaignRequirements} from "../src/lib/RedeemablesStructs.sol";
 import {BURN_ADDRESS} from "../src/lib/RedeemablesConstants.sol";
-import {ERC721RedemptionMintable} from "../src/extensions/ERC721RedemptionMintable.sol";
+import {ERC721ShipyardRedeemableMintable} from "../src/extensions/ERC721ShipyardRedeemableMintable.sol";
 import {ERC721OwnerMintable} from "../src/test/ERC721OwnerMintable.sol";
 import {ERC721ShipyardRedeemableMintable} from "../src/extensions/ERC721ShipyardRedeemableMintable.sol";
 

diff --git a/script/DeployAndRedeemTokens.s.sol b/script/DeployAndRedeemTokens.s.sol
@@ -7,7 +7,7 @@ import {ItemType} from "seaport-types/src/lib/ConsiderationEnums.sol";
 import {OfferItem, ConsiderationItem} from "seaport-types/src/lib/ConsiderationStructs.sol";
 import {Campaign, CampaignParams, CampaignRequirements} from "../src/lib/RedeemablesStructs.sol";
 import {BURN_ADDRESS} from "../src/lib/RedeemablesConstants.sol";
-import {ERC721RedemptionMintable} from "../src/extensions/ERC721RedemptionMintable.sol";
+import {ERC721ShipyardRedeemableMintable} from "../src/extensions/ERC721ShipyardRedeemableMintable.sol";
 import {ERC721ShipyardRedeemableOwnerMintable} from "../src/test/ERC721ShipyardRedeemableOwnerMintable.sol";
 
 contract DeployAndRedeemTokens is Script, Test {
@@ -20,11 +20,11 @@ contract DeployAndRedeemTokens is Script, Test {
             );
         address[] memory redeemTokens = new address[](1);
         redeemTokens[0] = address(redeemToken);
-        ERC721RedemptionMintable receiveToken = new ERC721RedemptionMintable(
+        ERC721ShipyardRedeemableMintable receiveToken = new ERC721ShipyardRedeemableMintable(
             "TestRedeemablesRecieveToken",
-            "TEST",
-            redeemTokens
+            "TEST"
         );
+        receiveToken.setRedeemablesContracts(redeemTokens);
 
         // Configure the campaign.
         OfferItem[] memory offer = new OfferItem[](1);

diff --git a/script/DeployAndRedeemTrait.s.sol b/script/DeployAndRedeemTrait.s.sol
@@ -7,10 +7,9 @@ import {ItemType} from "seaport-types/src/lib/ConsiderationEnums.sol";
 import {OfferItem, ConsiderationItem} from "seaport-types/src/lib/ConsiderationStructs.sol";
 import {IERC7496} from "shipyard-core/src/dynamic-traits/interfaces/IERC7496.sol";
 import {Campaign, CampaignParams, CampaignRequirements, TraitRedemption} from "../src/lib/RedeemablesStructs.sol";
-import {ERC721RedemptionMintable} from "../src/extensions/ERC721RedemptionMintable.sol";
 import {ERC721ShipyardRedeemableMintable} from "../src/extensions/ERC721ShipyardRedeemableMintable.sol";
-import {ERC721ShipyardRedeemablePreapprovedTraitSetters} from
-    "../src/test/ERC721ShipyardRedeemablePreapprovedTraitSetters.sol";
+import {ERC721ShipyardRedeemableMintable} from "../src/extensions/ERC721ShipyardRedeemableMintable.sol";
+import {ERC721ShipyardRedeemableTraitSetters} from "../src/test/ERC721ShipyardRedeemableTraitSetters.sol";
 
 contract DeployAndRedeemTrait is Script, Test {
     function run() external {
@@ -27,8 +26,7 @@ contract DeployAndRedeemTrait is Script, Test {
         allowedTraitSetters[0] = address(receiveToken);
 
         // deploy the redeem token with the receive token as an allowed trait setter
-        ERC721ShipyardRedeemablePreapprovedTraitSetters redeemToken =
-        new ERC721ShipyardRedeemablePreapprovedTraitSetters(
+        ERC721ShipyardRedeemableTraitSetters redeemToken = new ERC721ShipyardRedeemableTraitSetters(
                 "DynamicTraitsRedeemToken",
                 "TEST",
                 allowedTraitSetters

diff --git a/script/DeployERC721ReceiveTokenWithPredeployedSeadropRedeemToken.s.sol b/script/DeployERC721ReceiveTokenWithPredeployedSeadropRedeemToken.s.sol
@@ -7,7 +7,7 @@ import {ItemType} from "seaport-types/src/lib/ConsiderationEnums.sol";
 import {OfferItem, ConsiderationItem} from "seaport-types/src/lib/ConsiderationStructs.sol";
 import {Campaign, CampaignParams, CampaignRequirements} from "../src/lib/RedeemablesStructs.sol";
 import {BURN_ADDRESS} from "../src/lib/RedeemablesConstants.sol";
-import {ERC721RedemptionMintable} from "../src/extensions/ERC721RedemptionMintable.sol";
+import {ERC721ShipyardRedeemableMintable} from "../src/extensions/ERC721ShipyardRedeemableMintable.sol";
 import {ERC721OwnerMintable} from "../src/test/ERC721OwnerMintable.sol";
 import {ERC721ShipyardRedeemableMintable} from "../src/extensions/ERC721ShipyardRedeemableMintable.sol";
 

diff --git a/script/RedeemTokens.s.sol b/script/RedeemTokens.s.sol
@@ -6,7 +6,7 @@ import {Test} from "forge-std/Test.sol";
 import {ItemType} from "seaport-types/src/lib/ConsiderationEnums.sol";
 import {OfferItem, ConsiderationItem} from "seaport-types/src/lib/ConsiderationStructs.sol";
 import {CampaignParams, CampaignRequirements} from "../src/lib/RedeemablesStructs.sol";
-import {ERC721RedemptionMintable} from "../src/extensions/ERC721RedemptionMintable.sol";
+import {ERC721ShipyardRedeemableMintable} from "../src/extensions/ERC721ShipyardRedeemableMintable.sol";
 import {ERC721OwnerMintable} from "../src/test/ERC721OwnerMintable.sol";
 import {ERC1155ShipyardRedeemableMintable} from "../src/extensions/ERC1155ShipyardRedeemableMintable.sol";
 

diff --git a/src/ERC721SeaDropRedeemable.sol b/src/ERC721SeaDropRedeemable.sol
@@ -26,9 +26,7 @@ contract ERC721SeaDropRedeemable is ERC721SeaDrop, ERC7498NFTRedeemables {
     }
 
     function setTrait(uint256 tokenId, bytes32 traitKey, bytes32 value) public virtual override onlyOwner {
-        if (!_exists(tokenId)) {
-            revert TokenDoesNotExist();
-        }
+        if (!_exists(tokenId)) revert TokenDoesNotExist();
 
         DynamicTraits.setTrait(tokenId, traitKey, value);
     }
@@ -40,9 +38,7 @@ contract ERC721SeaDropRedeemable is ERC721SeaDrop, ERC7498NFTRedeemables {
         override
         returns (bytes32 traitValue)
     {
-        if (!_exists(tokenId)) {
-            revert TokenDoesNotExist();
-        }
+        if (!_exists(tokenId)) revert TokenDoesNotExist();
 
         traitValue = DynamicTraits.getTraitValue(tokenId, traitKey);
     }

diff --git a/src/ERC721ShipyardRedeemable.sol b/src/ERC721ShipyardRedeemable.sol
@@ -19,9 +19,7 @@ contract ERC721ShipyardRedeemable is ERC721ShipyardContractMetadata, ERC7498NFTR
     }
 
     function setTrait(uint256 tokenId, bytes32 traitKey, bytes32 value) public virtual override onlyOwner {
-        if (!_exists(tokenId)) {
-            revert TokenDoesNotExist();
-        }
+        if (!_exists(tokenId)) revert TokenDoesNotExist();
 
         DynamicTraits.setTrait(tokenId, traitKey, value);
     }
@@ -33,9 +31,7 @@ contract ERC721ShipyardRedeemable is ERC721ShipyardContractMetadata, ERC7498NFTR
         override
         returns (bytes32 traitValue)
     {
-        if (!_exists(tokenId)) {
-            revert TokenDoesNotExist();
-        }
+        if (!_exists(tokenId)) revert TokenDoesNotExist();
 
         traitValue = DynamicTraits.getTraitValue(tokenId, traitKey);
     }

diff --git a/src/extensions/ERC1155RedemptionMintable.sol b/src/extensions/ERC1155RedemptionMintable.sol
diff --git a/src/extensions/ERC1155ShipyardRedeemableMintable.sol b/src/extensions/ERC1155ShipyardRedeemableMintable.sol
@@ -13,8 +13,8 @@ import {IRedemptionMintable} from "../interfaces/IRedemptionMintable.sol";
 import {TraitRedemption} from "../lib/RedeemablesStructs.sol";
 
 contract ERC1155ShipyardRedeemableMintable is ERC1155ShipyardRedeemable, IRedemptionMintable {
-    /// @dev Revert if the sender of mintRedemption is not this contract.
-    error InvalidSender();
+    /// @dev The ERC-7498 redeemables contracts.
+    address[] internal _erc7498RedeemablesContracts;
 
     /// @dev The next token id to mint. Each token will have a supply of 1.
     uint256 _nextTokenId = 1;
@@ -27,16 +27,38 @@ contract ERC1155ShipyardRedeemableMintable is ERC1155ShipyardRedeemable, IRedemp
         ConsiderationItem[] calldata, /* consideration */
         TraitRedemption[] calldata /* traitRedemptions */
     ) external {
-        if (msg.sender != address(this)) {
-            revert InvalidSender();
-        }
+        // Require that msg.sender is valid.
+        _requireValidRedeemablesCaller();
 
         // Increment nextTokenId first so more of the same token id cannot be minted through reentrancy.
         ++_nextTokenId;
 
         _mint(recipient, _nextTokenId - 1, 1, "");
     }
 
+    function getRedeemablesContracts() external view returns (address[] memory) {
+        return _erc7498RedeemablesContracts;
+    }
+
+    function setRedeemablesContracts(address[] calldata redeemablesContracts) external onlyOwner {
+        _erc7498RedeemablesContracts = redeemablesContracts;
+    }
+
+    function _requireValidRedeemablesCaller() internal view {
+        // Allow the contract to call itself.
+        if (msg.sender == address(this)) return;
+
+        bool validCaller;
+        for (uint256 i; i < _erc7498RedeemablesContracts.length; i++) {
+            if (msg.sender == _erc7498RedeemablesContracts[i]) {
+                validCaller = true;
+            }
+        }
+        if (!validCaller) {
+            revert InvalidCaller(msg.sender);
+        }
+    }
+
     function supportsInterface(bytes4 interfaceId)
         public
         view

diff --git a/src/extensions/ERC721RedemptionMintable.sol b/src/extensions/ERC721RedemptionMintable.sol
diff --git a/src/extensions/ERC721ShipyardRedeemableMintable.sol b/src/extensions/ERC721ShipyardRedeemableMintable.sol
@@ -13,8 +13,8 @@ import {IRedemptionMintable} from "../interfaces/IRedemptionMintable.sol";
 import {TraitRedemption} from "../lib/RedeemablesStructs.sol";
 
 contract ERC721ShipyardRedeemableMintable is ERC721ShipyardRedeemable, IRedemptionMintable {
-    /// @dev Revert if the sender of mintRedemption is not this contract.
-    error InvalidSender();
+    /// @dev The ERC-7498 redeemables contracts.
+    address[] internal _erc7498RedeemablesContracts;
 
     /// @dev The next token id to mint.
     uint256 _nextTokenId = 1;
@@ -27,15 +27,36 @@ contract ERC721ShipyardRedeemableMintable is ERC721ShipyardRedeemable, IRedempti
         ConsiderationItem[] calldata, /* consideration */
         TraitRedemption[] calldata /* traitRedemptions */
     ) external {
-        if (msg.sender != address(this)) {
-            revert InvalidSender();
-        }
+        // Require that msg.sender is valid.
+        _requireValidRedeemablesCaller();
+
         // Increment nextTokenId first so more of the same token id cannot be minted through reentrancy.
         ++_nextTokenId;
 
         _mint(recipient, _nextTokenId - 1);
     }
 
+    function getRedeemablesContracts() external view returns (address[] memory) {
+        return _erc7498RedeemablesContracts;
+    }
+
+    function setRedeemablesContracts(address[] calldata redeemablesContracts) external onlyOwner {
+        _erc7498RedeemablesContracts = redeemablesContracts;
+    }
+
+    function _requireValidRedeemablesCaller() internal view {
+        // Allow the contract to call itself.
+        if (msg.sender == address(this)) return;
+
+        bool validCaller;
+        for (uint256 i; i < _erc7498RedeemablesContracts.length; i++) {
+            if (msg.sender == _erc7498RedeemablesContracts[i]) {
+                validCaller = true;
+            }
+        }
+        if (!validCaller) revert InvalidCaller(msg.sender);
+    }
+
     function supportsInterface(bytes4 interfaceId)
         public
         view