@zoralabs/protocol-deployments 0.0.7-prerelease.0 → 0.0.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zoralabs/protocol-deployments",
-  "version": "0.0.7-prerelease.0",
+  "version": "0.0.8",
   "repository": "https://github.com/ourzora/zora-protocol",
   "license": "MIT",
   "main": "./dist/index.js",
@@ -39,6 +39,7 @@
     "solady": "^0.0.132",
     "tsup": "^7.2.0",
     "tsx": "^3.13.0",
+    "zoralabs-tsconfig": "*",
     "typescript": "^5.2.2"
   }
 }

package/src/Zora1155PremintFixtures.sol

@@ -0,0 +1,75 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.17;
+
+import {ZoraCreator1155Impl} from "@zoralabs/zora-1155-contracts/src/nft/ZoraCreator1155Impl.sol";
+import {ZoraCreatorFixedPriceSaleStrategy} from "@zoralabs/zora-1155-contracts/src/minters/fixed-price/ZoraCreatorFixedPriceSaleStrategy.sol";
+import {IZoraCreator1155Errors} from "@zoralabs/zora-1155-contracts/src/interfaces/IZoraCreator1155Errors.sol";
+import {IMinter1155} from "@zoralabs/zora-1155-contracts/src/interfaces/IMinter1155.sol";
+import {Zora1155Factory} from "@zoralabs/zora-1155-contracts/src/proxies/Zora1155Factory.sol";
+import {ZoraCreator1155FactoryImpl} from "@zoralabs/zora-1155-contracts/src/factory/ZoraCreator1155FactoryImpl.sol";
+import {ProtocolRewards} from "@zoralabs/protocol-rewards/src/ProtocolRewards.sol";
+import {ProxyShim} from "@zoralabs/zora-1155-contracts/src/utils/ProxyShim.sol";
+import {PremintConfig, PremintConfigV2, ContractCreationConfig, TokenCreationConfigV2, TokenCreationConfig} from "@zoralabs/zora-1155-contracts/src/delegation/ZoraCreator1155Attribution.sol";
+
+library Zora1155PremintFixtures {
+    function makeDefaultContractCreationConfig(address contractAdmin) internal pure returns (ContractCreationConfig memory) {
+        return ContractCreationConfig({contractAdmin: contractAdmin, contractName: "blah_______blah", contractURI: "blah.contract"});
+    }
+
+    function makeTokenCreationConfigV2WithCreateReferral(
+        IMinter1155 fixedPriceMinter,
+        address payoutRecipient,
+        address createReferral
+    ) internal pure returns (TokenCreationConfigV2 memory) {
+        return
+            TokenCreationConfigV2({
+                tokenURI: "blah.token",
+                maxSupply: 10,
+                maxTokensPerAddress: 5,
+                pricePerToken: 0,
+                mintStart: 0,
+                mintDuration: 0,
+                fixedPriceMinter: address(fixedPriceMinter),
+                payoutRecipient: payoutRecipient,
+                royaltyBPS: 10,
+                createReferral: createReferral
+            });
+    }
+
+    function makeDefaultV2PremintConfig(
+        IMinter1155 fixedPriceMinter,
+        address payoutRecipient,
+        address createReferral
+    ) internal pure returns (PremintConfigV2 memory) {
+        // make a v2 premint config
+        return
+            PremintConfigV2({
+                tokenConfig: makeTokenCreationConfigV2WithCreateReferral(fixedPriceMinter, payoutRecipient, createReferral),
+                uid: 100,
+                version: 0,
+                deleted: false
+            });
+    }
+
+    function makeDefaultV1PremintConfig(IMinter1155 fixedPriceMinter, address royaltyRecipient) internal pure returns (PremintConfig memory) {
+        // make a v1 premint config
+        return
+            PremintConfig({
+                tokenConfig: TokenCreationConfig({
+                    tokenURI: "blah.token",
+                    maxSupply: 10,
+                    maxTokensPerAddress: 5,
+                    pricePerToken: 0,
+                    mintStart: 0,
+                    mintDuration: 0,
+                    fixedPriceMinter: address(fixedPriceMinter),
+                    royaltyRecipient: royaltyRecipient,
+                    royaltyBPS: 10,
+                    royaltyMintSchedule: 0
+                }),
+                uid: 100,
+                version: 0,
+                deleted: false
+            });
+    }
+}

package/test/UpgradesTest.t.sol

@@ -49,11 +49,28 @@ contract UpgradesTest is ForkDeploymentConfig, DeploymentTestingUtils, Test {
                 address currentImplementation = abi.decode(data, (address));
                 upgradeNeeded = currentImplementation != targetImpl;
             }
-
-            console2.log(upgradeNeeded);
         }
     }
 
+    function _buildSafeUrl(address safe, address target, bytes memory cd) internal view returns (string memory) {
+        // sample url: https://ourzora.github.io/smol-safe/?value=0&safe={safeAddress}&to={target}&data={calldata}&network={chainId}
+        // https://ourzora.github.io/smol-safe/?safe={safe}&to={to}&data={data}&value=0&network={network}
+        string memory safeQueryString = string.concat("safe=", vm.toString(safe));
+        string memory toQueryString = string.concat("&to=", vm.toString(target));
+        string memory dataQueryString = string.concat("&data=", vm.toString(cd));
+        string memory valueQueryString = "&value=0";
+        string memory chainIdQueryString = string.concat("&network=", vm.toString(block.chainid));
+        string memory targetUrl = string.concat(
+            string.concat(
+                string.concat(string.concat(string.concat("https://ourzora.github.io/smol-safe/?", safeQueryString), toQueryString), dataQueryString),
+                valueQueryString
+            ),
+            chainIdQueryString
+        );
+
+        return targetUrl;
+    }
+
     /// @notice checks which chains need an upgrade, simulated the upgrade, and gets the upgrade calldata
     function simulateUpgradeOnFork(string memory chainName) private {
         // create and select the fork, which will be used for all subsequent calls
@@ -88,6 +105,7 @@ contract UpgradesTest is ForkDeploymentConfig, DeploymentTestingUtils, Test {
             console.logBytes(factory1155UpgradeCalldata);
             console2.log("upgrade to address:", targetImpl1155);
             console2.log("upgrade to version:", ZoraCreator1155FactoryImpl(targetImpl1155).contractVersion());
+            console2.log("smol safe upgrade url: ", _buildSafeUrl(chainConfig.factoryOwner, targetProxy1155, factory1155UpgradeCalldata));
             console2.log("------------------------");
         }
 
@@ -117,6 +135,7 @@ contract UpgradesTest is ForkDeploymentConfig, DeploymentTestingUtils, Test {
             console2.log("upgrade calldata:");
             console.logBytes(preminterUpgradeCalldata);
             console2.log("upgrade to address:", targetPremintImpl);
+            console2.log("smol safe upgrade url: ", _buildSafeUrl(chainConfig.factoryOwner, targetPreminterProxy, preminterUpgradeCalldata));
             console2.log("------------------------");
         }
 

package/test/ZoraCreator1155PremintExecutorForkTest.t.sol

@@ -3,14 +3,25 @@ pragma solidity 0.8.17;
 
 import "forge-std/Test.sol";
 import {ForkDeploymentConfig} from "../src/DeploymentConfig.sol";
-import {ZoraCreator1155Attribution, ContractCreationConfig, PremintConfig, TokenCreationConfig} from "@zoralabs/zora-1155-contracts/src/delegation/ZoraCreator1155Attribution.sol";
+import {ZoraCreator1155Attribution, ContractCreationConfig, PremintConfig, PremintConfigV2, TokenCreationConfig} from "@zoralabs/zora-1155-contracts/src/delegation/ZoraCreator1155Attribution.sol";
 import {ZoraCreator1155PremintExecutorImpl} from "@zoralabs/zora-1155-contracts/src/delegation/ZoraCreator1155PremintExecutorImpl.sol";
 import {ZoraCreator1155FactoryImpl} from "@zoralabs/zora-1155-contracts/src/factory/ZoraCreator1155FactoryImpl.sol";
+import {IZoraCreator1155PremintExecutor} from "@zoralabs/zora-1155-contracts/src/interfaces/IZoraCreator1155PremintExecutor.sol";
+import {Zora1155PremintFixtures} from "../src/Zora1155PremintFixtures.sol";
 
 contract ZoraCreator1155PreminterForkTest is ForkDeploymentConfig, Test {
     ZoraCreator1155FactoryImpl factory;
     ZoraCreator1155PremintExecutorImpl preminter;
     uint256 mintFeeAmount = 0.000777 ether;
+    address creator;
+    uint256 creatorPrivateKey;
+    address payoutRecipient = makeAddr("payoutRecipient");
+    address minter = makeAddr("minter");
+
+    ContractCreationConfig contractConfig;
+    PremintConfig premintConfig;
+    PremintConfigV2 premintConfigV2;
+    address createReferral = makeAddr("creatReferral");
 
     /// @notice gets the chains to do fork tests on, by reading environment var FORK_TEST_CHAINS.
     /// Chains are by name, and must match whats under `rpc_endpoints` in the foundry.toml
@@ -23,44 +34,98 @@ contract ZoraCreator1155PreminterForkTest is ForkDeploymentConfig, Test {
         }
     }
 
-    function testTheForkPremint(string memory chainName) private {
-        console.log("testing on fork: ", chainName);
-
-        // create and select the fork, which will be used for all subsequent calls
-        // it will also affect the current block chain id based on the rpc url returned
-        vm.createSelectFork(vm.rpcUrl(chainName));
-
+    function setupPremint() private {
         // get contract hash, which is unique per contract creation config, and can be used
         // retrieve the address created for a contract
         address preminterAddress = getDeployment().preminterProxy;
 
-        if (preminterAddress == address(0)) {
-            console.log("preminter not configured for chain...skipping");
-            return;
-        }
-
         // override local preminter to use the addresses from the chain
         factory = ZoraCreator1155FactoryImpl(getDeployment().factoryProxy);
         preminter = ZoraCreator1155PremintExecutorImpl(preminterAddress);
+
+        (creator, creatorPrivateKey) = makeAddrAndKey("creator");
+
+        contractConfig = Zora1155PremintFixtures.makeDefaultContractCreationConfig(creator);
+
+        premintConfig = Zora1155PremintFixtures.makeDefaultV1PremintConfig(factory.fixedPriceMinter(), payoutRecipient);
+        premintConfigV2 = Zora1155PremintFixtures.makeDefaultV2PremintConfig(factory.fixedPriceMinter(), payoutRecipient, createReferral);
     }
 
-    function test_fork_successfullyMintsTokens() external {
+    function equals(string memory str1, string memory str2) public pure returns (bool) {
+        return keccak256(abi.encodePacked(str1)) == keccak256(abi.encodePacked(str2));
+    }
+
+    function test_fork_legacyPremint_successfullyMintsPremintTokens() external {
         string[] memory forkTestChains = getForkTestChains();
         for (uint256 i = 0; i < forkTestChains.length; i++) {
-            testTheForkPremint(forkTestChains[i]);
+            string memory chainName = forkTestChains[i];
+
+            console.log("testing on fork: ", chainName);
+
+            // create and select the fork, which will be used for all subsequent calls
+            // it will also affect the current block chain id based on the rpc url returned
+            vm.createSelectFork(vm.rpcUrl(chainName));
+
+            setupPremint();
+
+            _signAndExecutePremintLegacy(creatorPrivateKey, minter, 1, "test comment");
         }
     }
 
-    function _signAndExecutePremint(
-        ContractCreationConfig memory contractConfig,
-        PremintConfig memory premintConfig,
+    function test_fork_premintV1_successfullyMintsPremintTokens() external {
+        string[] memory forkTestChains = getForkTestChains();
+        for (uint256 i = 0; i < forkTestChains.length; i++) {
+            string memory chainName = forkTestChains[i];
+
+            if (!_chainSupportsPremintV2(chainName)) {
+                console.log("skipping chain, does not support v1 premint: ", chainName);
+                continue;
+            }
+
+            console.log("testing on fork: ", chainName);
+
+            // it will also affect the current block chain id based on the rpc url returned
+            vm.createSelectFork(vm.rpcUrl(chainName));
+
+            setupPremint();
+
+            _signAndExecutePremintV1(creatorPrivateKey, minter, 1, "test comment");
+        }
+    }
+
+    function test_fork_premintV2_successfullyMintsPremintTokens() external {
+        string[] memory forkTestChains = getForkTestChains();
+        for (uint256 i = 0; i < forkTestChains.length; i++) {
+            string memory chainName = forkTestChains[i];
+
+            if (!_chainSupportsPremintV2(chainName)) {
+                console.log("skipping chain, does not support v2 premint: ", chainName);
+                continue;
+            }
+
+            console.log("testing on fork: ", chainName);
+
+            // it will also affect the current block chain id based on the rpc url returned
+            vm.createSelectFork(vm.rpcUrl(chainName));
+
+            setupPremint();
+
+            _signAndExecutePremintV2(creatorPrivateKey, minter, 0, "test comment");
+        }
+    }
+
+    function _chainSupportsPremintV2(string memory chainName) private pure returns (bool) {
+        // for now we know that only goerli and sepolia have v2 premint deployed
+        return (equals(chainName, "zora_sepolia") || equals(chainName, "zora_goerli"));
+    }
+
+    function _signAndExecutePremintLegacy(
         uint256 privateKey,
-        uint256 chainId,
         address executor,
         uint256 quantityToMint,
         string memory comment
     ) private returns (uint256 newTokenId) {
-        bytes memory signature = _signPremint(preminter.getContractAddress(contractConfig), premintConfig, privateKey, chainId);
+        bytes memory signature = _signPremintV1(preminter.getContractAddress(contractConfig), privateKey, block.chainid);
 
         uint256 mintCost = mintFeeAmount * quantityToMint;
         vm.deal(executor, mintCost);
@@ -70,12 +135,24 @@ contract ZoraCreator1155PreminterForkTest is ForkDeploymentConfig, Test {
         newTokenId = preminter.premint{value: mintCost}(contractConfig, premintConfig, signature, quantityToMint, comment);
     }
 
-    function _signPremint(
-        address contractAddress,
-        PremintConfig memory premintConfig,
-        uint256 privateKey,
-        uint256 chainId
-    ) private pure returns (bytes memory) {
+    function _signAndExecutePremintV1(uint256 privateKey, address executor, uint256 quantityToMint, string memory comment) private {
+        bytes memory signature = _signPremintV1(preminter.getContractAddress(contractConfig), privateKey, block.chainid);
+
+        uint256 mintCost = mintFeeAmount * quantityToMint;
+        vm.deal(executor, mintCost);
+
+        // now call the premint function, using the same config that was used to generate the digest, and the signature
+        vm.prank(executor);
+        preminter.premintV1{value: mintCost}(
+            contractConfig,
+            premintConfig,
+            signature,
+            quantityToMint,
+            IZoraCreator1155PremintExecutor.MintArguments({mintRecipient: executor, mintComment: comment, mintReferral: executor})
+        );
+    }
+
+    function _signPremintV1(address contractAddress, uint256 privateKey, uint256 chainId) private view returns (bytes memory) {
         bytes32 digest = ZoraCreator1155Attribution.premintHashedTypeDataV4(
             ZoraCreator1155Attribution.hashPremint(premintConfig),
             contractAddress,
@@ -88,6 +165,36 @@ contract ZoraCreator1155PreminterForkTest is ForkDeploymentConfig, Test {
         return _sign(privateKey, digest);
     }
 
+    function _signAndExecutePremintV2(uint256 privateKey, address executor, uint256 quantityToMint, string memory comment) private {
+        bytes memory signature = _signPremintV2(preminter.getContractAddress(contractConfig), privateKey, block.chainid);
+
+        uint256 mintCost = mintFeeAmount * quantityToMint;
+        vm.deal(executor, mintCost);
+
+        // now call the premint function, using the same config that was used to generate the digest, and the signature
+        vm.prank(executor);
+        preminter.premintV2{value: mintCost}(
+            contractConfig,
+            premintConfigV2,
+            signature,
+            quantityToMint,
+            IZoraCreator1155PremintExecutor.MintArguments({mintRecipient: executor, mintComment: comment, mintReferral: executor})
+        );
+    }
+
+    function _signPremintV2(address contractAddress, uint256 privateKey, uint256 chainId) private view returns (bytes memory) {
+        bytes32 digest = ZoraCreator1155Attribution.premintHashedTypeDataV4(
+            ZoraCreator1155Attribution.hashPremint(premintConfigV2),
+            contractAddress,
+            ZoraCreator1155Attribution.HASHED_VERSION_2,
+            chainId
+        );
+
+        // 3. Sign the digest
+        // create a signature with the digest for the params
+        return _sign(privateKey, digest);
+    }
+
     function _sign(uint256 privateKey, bytes32 digest) private pure returns (bytes memory) {
         // sign the message
         (uint8 v, bytes32 r, bytes32 s) = vm.sign(privateKey, digest);

package/tsconfig.json

@@ -1,23 +1,7 @@
 {
+  "extends": "zoralabs-tsconfig/tsconfig.json",
   "compilerOptions": {
-    "allowJs": true,
     "baseUrl": ".",
-    "downlevelIteration": true,
-    "esModuleInterop": true,
-    "isolatedModules": true,
-    "lib": ["es2021"],
-    "module": "esnext",
-    "moduleResolution": "node",
-    "noImplicitAny": true,
-    "noUncheckedIndexedAccess": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "resolveJsonModule": true,
-    "skipLibCheck": true,
-    "strict": true,
-    "strictNullChecks": true,
-    "target": "es2021",
-    "types": ["node"],
     "outDir": "dist"
   },
   "exclude": ["node_modules/**", "dist/**"],