@zoralabs/protocol-deployments 0.0.12 → 0.0.13

package/script/signDeploymentTransactions.ts

@@ -1,302 +0,0 @@
-import { createAccount } from "@turnkey/viem";
-import { TurnkeyClient } from "@turnkey/http";
-import { Address, encodeFunctionData, parseAbi, LocalAccount, Hex } from "viem";
-import { ApiKeyStamper } from "@turnkey/api-key-stamper";
-import { glob } from "glob";
-import * as path from "path";
-import * as dotenv from "dotenv";
-import { writeFile, readFile } from "fs/promises";
-import {
-  ConfiguredSalt,
-  DeterministicDeploymentConfig,
-  GenericDeploymentConfiguration,
-  signDeployFactory,
-  signGenericDeploy,
-} from "../package/deployment";
-import { fileURLToPath } from "url";
-import { dirname } from "path";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
-// Load environment variables from `.env.local`
-dotenv.config({ path: path.resolve(__dirname, "../.env") });
-
-type ChainConfig = {
-  chainId: number;
-  implementationAddress: Address;
-  owner: Address;
-};
-
-async function signAndSaveSignatures({
-  turnkeyAccount,
-  chainConfigs,
-  proxyName,
-  chainId,
-}: {
-  turnkeyAccount: LocalAccount;
-  chainConfigs: ChainConfig[];
-  proxyName: "factoryProxy" | "premintExecutorProxy";
-  chainId: number;
-}) {
-  const configFolder = path.resolve(
-    __dirname,
-    `../deterministicConfig/${proxyName}/`,
-  );
-  const configFile = path.join(configFolder, "params.json");
-  const deterministicDeployConfig = JSON.parse(
-    await readFile(configFile, "utf-8"),
-  );
-
-  const deploymentConfig: DeterministicDeploymentConfig = {
-    proxyDeployerAddress:
-      deterministicDeployConfig.proxyDeployerAddress as Address,
-    proxySalt: deterministicDeployConfig.proxySalt as ConfiguredSalt,
-    proxyShimSalt: deterministicDeployConfig.proxyShimSalt as ConfiguredSalt,
-    proxyCreationCode: deterministicDeployConfig.proxyCreationCode as Address,
-  };
-
-  const chainConfig = chainConfigs.find((x) => x.chainId === chainId);
-
-  if (!chainConfig) {
-    return;
-  }
-
-  const signature = await signDeployFactory({
-    account: turnkeyAccount,
-    implementationAddress: chainConfig.implementationAddress,
-    owner: chainConfig.owner,
-    chainId: chainConfig.chainId,
-    deterministicDeploymentConfig: deploymentConfig,
-  });
-
-  const existingSignatures = JSON.parse(
-    await readFile(path.join(configFolder, "signatures.json"), "utf-8"),
-  );
-
-  const updated = {
-    ...existingSignatures,
-    [chainId]: signature,
-  };
-
-  // aggregate above to object of key value pair indexed by chain id as number:
-  // write as json to ../deterministicConfig/factoryDeploySignatures.json:
-  await writeFile(
-    path.join(configFolder, "signatures.json"),
-    JSON.stringify(updated, null, 2),
-  );
-}
-
-async function signAndSaveUpgradeGate({
-  turnkeyAccount,
-  chainConfigs,
-  proxyName,
-  chainId,
-}: {
-  turnkeyAccount: LocalAccount;
-  chainConfigs: {
-    chainId: number;
-    owner: Address;
-  }[];
-  proxyName: "upgradeGate";
-  chainId: number;
-}) {
-  const configFolder = path.resolve(
-    __dirname,
-    `../deterministicConfig/${proxyName}/`,
-  );
-  const configFile = path.join(configFolder, "params.json");
-
-  const deterministicDeployConfig = JSON.parse(
-    await readFile(configFile, "utf-8"),
-  );
-
-  const deploymentConfig: GenericDeploymentConfiguration = {
-    creationCode: deterministicDeployConfig.creationCode! as Hex,
-    salt: deterministicDeployConfig.salt! as Hex,
-    deployerAddress: deterministicDeployConfig.deployerAddress! as Address,
-    upgradeGateAddress:
-      deterministicDeployConfig.upgradeGateAddress! as Address,
-    proxyDeployerAddress:
-      deterministicDeployConfig.proxyDeployerAddress! as Address,
-  };
-
-  const upgradeGateAbi = parseAbi(["function initialize(address owner)"]);
-
-  const chainConfig = chainConfigs.find((x) => x.chainId === chainId);
-
-  if (!chainConfig) {
-    throw new Error(`No chain config found for chain id ${chainId}`);
-  }
-
-  const initCall = encodeFunctionData({
-    abi: upgradeGateAbi,
-    functionName: "initialize",
-    args: [chainConfig.owner],
-  });
-
-  console.log("signing", { turnkeyAccount, deploymentConfig });
-
-  const signature = await signGenericDeploy({
-    account: turnkeyAccount,
-    chainId: chainConfig.chainId,
-    config: deploymentConfig,
-    initCall,
-  });
-
-  const existingSignatures = JSON.parse(
-    await readFile(path.join(configFolder, "signatures.json"), "utf-8"),
-  );
-
-  const updated = {
-    ...existingSignatures,
-    [chainId]: signature,
-  };
-
-  // write as json to ../deterministicConfig/factoryDeploySignatures.json:
-  await writeFile(
-    path.join(configFolder, "signatures.json"),
-    JSON.stringify(updated, null, 2),
-  );
-}
-
-const getChainConfigs = async () => {
-  const chainConfigsFiles = await glob(
-    path.resolve(__dirname, "../chainConfigs/*.json"),
-  );
-
-  const chainConfigs = await Promise.all(
-    chainConfigsFiles.map(async (chainConfigFile) => {
-      const chainId = parseInt(path.basename(chainConfigFile).split(".")[0]!);
-
-      // read file and process JSON contents:
-      const fileContents = await import(chainConfigFile);
-
-      return {
-        chainId,
-        owner: fileContents["FACTORY_OWNER"]! as Address,
-      };
-    }),
-  );
-
-  return chainConfigs;
-};
-
-const getFactoryImplConfigs = async () => {
-  const addresseFiles = await glob(
-    path.resolve(__dirname, "../addresses/*.json"),
-  );
-
-  const chainConfigs = await Promise.all(
-    addresseFiles.map(async (addressConfigFile) => {
-      const chainId = parseInt(path.basename(addressConfigFile).split(".")[0]!);
-
-      // read file and process JSON contents:
-      const fileContents = await import(addressConfigFile);
-
-      // read chain config file as json, which is located at: ../chainConfigs/${chainId}.json:
-      const chainConfig = await import(
-        path.resolve(__dirname, `../chainConfigs/${chainId}.json`)
-      );
-
-      return {
-        chainId,
-        implementationAddress: fileContents["FACTORY_IMPL"] as Address,
-        owner: chainConfig["FACTORY_OWNER"] as Address,
-      };
-    }),
-  );
-
-  return chainConfigs;
-};
-
-const getPreminterImplConfigs = async () => {
-  const addresseFiles = await glob(
-    path.resolve(__dirname, "../addresses/*.json"),
-  );
-
-  const chainConfigs = await Promise.all(
-    addresseFiles.map(async (addressConfigFile) => {
-      const chainId = parseInt(path.basename(addressConfigFile).split(".")[0]!);
-
-      // read file and process JSON contents:
-      const fileContents = await import(addressConfigFile);
-
-      // read chain config file as json, which is located at: ../chainConfigs/${chainId}.json:
-      const chainConfig = await import(
-        path.resolve(__dirname, `../chainConfigs/${chainId}.json`)
-      );
-
-      return {
-        chainId,
-        implementationAddress: fileContents["PREMINTER_IMPL"] as Address,
-        owner: chainConfig["FACTORY_OWNER"] as Address,
-      };
-    }),
-  );
-
-  return chainConfigs.filter((x) => x.implementationAddress !== undefined);
-};
-
-function getChainIdPositionalArg() {
-  // parse chain id as first argument:
-  const chainIdArg = process.argv[2];
-
-  if (!chainIdArg) {
-    throw new Error("Must provide chain id as first argument");
-  }
-
-  return parseInt(chainIdArg);
-}
-
-async function main() {
-  // Create a Turnkey HTTP client with API key credentials
-  const httpClient = new TurnkeyClient(
-    {
-      baseUrl: "https://api.turnkey.com",
-    },
-    // This uses API key credentials.
-    // If you're using passkeys, use `@turnkey/webauthn-stamper` to collect webauthn signatures:
-    new ApiKeyStamper({
-      apiPublicKey: process.env.TURNKEY_API_PUBLIC_KEY!,
-      apiPrivateKey: process.env.TURNKEY_API_PRIVATE_KEY!,
-    }),
-  );
-
-  // Create the Viem custom account
-  const turnkeyAccount = await createAccount({
-    client: httpClient,
-    organizationId: process.env.TURNKEY_ORGANIZATION_ID!,
-    signWith: process.env.TURNKEY_PRIVATE_KEY_ID!,
-    // optional; will be fetched from Turnkey if not provided
-    ethereumAddress: process.env.TURNKEY_TARGET_ADDRESS!,
-  });
-
-  const chainId = getChainIdPositionalArg();
-
-  await signAndSaveSignatures({
-    turnkeyAccount,
-    chainConfigs: await getFactoryImplConfigs(),
-    proxyName: "factoryProxy",
-    chainId,
-  });
-
-  await signAndSaveSignatures({
-    turnkeyAccount,
-    chainConfigs: await getPreminterImplConfigs(),
-    proxyName: "premintExecutorProxy",
-    chainId,
-  });
-
-  await signAndSaveUpgradeGate({
-    turnkeyAccount,
-    chainConfigs: await getChainConfigs(),
-    proxyName: "upgradeGate",
-    chainId,
-  });
-}
-
-main().catch((error) => {
-  console.error(error);
-  process.exit(1);
-});

package/src/DeploymentConfig.sol

@@ -1,124 +0,0 @@
-// SPDX-License-Identifier: MIT
-pragma solidity 0.8.17;
-
-import "forge-std/Test.sol";
-import {CommonBase} from "forge-std/Base.sol";
-import {Strings} from "@openzeppelin/contracts/utils/Strings.sol";
-import {Script} from "forge-std/Script.sol";
-
-/// @notice Chain configuration for constants set manually during deploy. Does not get written to after deploys.
-struct ChainConfig {
-    /// @notice The user that owns the factory proxy. Allows ability to upgrade for new implementations deployed.
-    address factoryOwner;
-    /// @notice Mint fee recipient user
-    address mintFeeRecipient;
-    /// @notice Protocol rewards contract address
-    address protocolRewards;
-}
-
-/// @notice Deployment addresses – set to new deployed addresses by the scripts.
-struct Deployment {
-    /// @notice Fixed price minter strategy configuration contract
-    address fixedPriceSaleStrategy;
-    /// @notice Merkle minter strategy (formerly presale) configuration
-    address merkleMintSaleStrategy;
-    /// @notice Redeem minter factory contract for redeem sales configurations
-    address redeemMinterFactory;
-    /// @notice Implementation contract for the 1155 contract
-    address contract1155Impl;
-    /// @notice Implementation contract version for the 1155 contract
-    string contract1155ImplVersion;
-    /// @notice Factory implementation contract that is the impl for the above proxy.
-    address factoryImpl;
-    /// @notice Factory proxy contract that creates zora drops style NFT contracts
-    address factoryProxy;
-    /// @notice Preminter proxy contract address
-    address preminterImpl;
-    /// @notice Preminter implementation contract address
-    address preminterProxy;
-    /// @notice Upgrade gate
-    address upgradeGate;
-}
-
-abstract contract DeploymentConfig is Script {
-    using stdJson for string;
-
-    /// @notice ChainID convenience getter
-    /// @return id chainId
-    function chainId() internal view virtual returns (uint256 id);
-
-    ///
-    // These are the JSON key constants to standardize writing and reading configuration
-    ///
-
-    string constant FACTORY_OWNER = "FACTORY_OWNER";
-    string constant MINT_FEE_RECIPIENT = "MINT_FEE_RECIPIENT";
-    string constant PROTOCOL_REWARDS = "PROTOCOL_REWARDS";
-
-    string constant FIXED_PRICE_SALE_STRATEGY = "FIXED_PRICE_SALE_STRATEGY";
-    string constant MERKLE_MINT_SALE_STRATEGY = "MERKLE_MINT_SALE_STRATEGY";
-    string constant REDEEM_MINTER_FACTORY = "REDEEM_MINTER_FACTORY";
-    string constant CONTRACT_1155_IMPL = "CONTRACT_1155_IMPL";
-    string constant CONTRACT_1155_IMPL_VERSION = "CONTRACT_1155_IMPL_VERSION";
-    string constant FACTORY_IMPL = "FACTORY_IMPL";
-    string constant FACTORY_PROXY = "FACTORY_PROXY";
-    string constant PREMINTER_PROXY = "PREMINTER_PROXY";
-    string constant PREMINTER_IMPL = "PREMINTER_IMPL";
-    string constant UPGRADE_GATE = "UPGRADE_GATE";
-
-    /// @notice Return a prefixed key for reading with a ".".
-    /// @param key key to prefix
-    /// @return prefixed key
-    function getKeyPrefix(string memory key) internal pure returns (string memory) {
-        return string.concat(".", key);
-    }
-
-    /// @notice Returns the chain configuration struct from the JSON configuration file
-    /// @return chainConfig structure
-    function getChainConfig() internal view returns (ChainConfig memory chainConfig) {
-        string memory json = vm.readFile(string.concat("chainConfigs/", Strings.toString(chainId()), ".json"));
-        chainConfig.factoryOwner = json.readAddress(getKeyPrefix(FACTORY_OWNER));
-        chainConfig.mintFeeRecipient = json.readAddress(getKeyPrefix(MINT_FEE_RECIPIENT));
-        chainConfig.protocolRewards = json.readAddress(getKeyPrefix(PROTOCOL_REWARDS));
-    }
-
-    function readAddressOrDefaultToZero(string memory json, string memory key) internal view returns (address addr) {
-        string memory keyPrefix = getKeyPrefix(key);
-
-        if (vm.keyExists(json, keyPrefix)) {
-            addr = json.readAddress(keyPrefix);
-        } else {
-            addr = address(0);
-        }
-    }
-
-    /// @notice Get the deployment configuration struct from the JSON configuration file
-    /// @return deployment deployment configuration structure
-    function getDeployment() internal view returns (Deployment memory deployment) {
-        string memory json = vm.readFile(string.concat("addresses/", Strings.toString(chainId()), ".json"));
-        deployment.fixedPriceSaleStrategy = readAddressOrDefaultToZero(json, FIXED_PRICE_SALE_STRATEGY);
-        deployment.merkleMintSaleStrategy = readAddressOrDefaultToZero(json, MERKLE_MINT_SALE_STRATEGY);
-        deployment.redeemMinterFactory = readAddressOrDefaultToZero(json, REDEEM_MINTER_FACTORY);
-        deployment.contract1155Impl = readAddressOrDefaultToZero(json, CONTRACT_1155_IMPL);
-        deployment.contract1155ImplVersion = json.readString(getKeyPrefix(CONTRACT_1155_IMPL_VERSION));
-        deployment.factoryImpl = readAddressOrDefaultToZero(json, FACTORY_IMPL);
-        deployment.factoryProxy = readAddressOrDefaultToZero(json, FACTORY_PROXY);
-        deployment.preminterImpl = readAddressOrDefaultToZero(json, PREMINTER_IMPL);
-        deployment.preminterProxy = readAddressOrDefaultToZero(json, PREMINTER_PROXY);
-        deployment.upgradeGate = readAddressOrDefaultToZero(json, UPGRADE_GATE);
-    }
-}
-
-contract ForkDeploymentConfig is DeploymentConfig {
-    function chainId() internal view override returns (uint256 id) {
-        return block.chainid;
-    }
-}
-
-contract ScriptDeploymentConfig is DeploymentConfig {
-    function chainId() internal view override returns (uint256 id) {
-        assembly {
-            id := chainid()
-        }
-    }
-}

package/src/DeploymentTestingUtils.sol

@@ -1,166 +0,0 @@
-// SPDX-License-Identifier: MIT
-pragma solidity ^0.8.13;
-
-import "forge-std/Script.sol";
-import {IMinter1155} from "@zoralabs/zora-1155-contracts/src/interfaces/IMinter1155.sol";
-import {IZoraCreator1155PremintExecutor} from "@zoralabs/zora-1155-contracts/src/interfaces/IZoraCreator1155PremintExecutor.sol";
-import {ZoraCreator1155PremintExecutorImpl} from "@zoralabs/zora-1155-contracts/src/delegation/ZoraCreator1155PremintExecutorImpl.sol";
-import {ZoraCreator1155FactoryImpl} from "@zoralabs/zora-1155-contracts/src/factory/ZoraCreator1155FactoryImpl.sol";
-import {ZoraCreator1155Attribution, ContractCreationConfig, PremintConfigV2, TokenCreationConfigV2, PremintConfig, TokenCreationConfig} from "@zoralabs/zora-1155-contracts/src/delegation/ZoraCreator1155Attribution.sol";
-import {ScriptDeploymentConfig} from "./DeploymentConfig.sol";
-import {ZoraCreator1155Impl} from "@zoralabs/zora-1155-contracts/src/nft/ZoraCreator1155Impl.sol";
-
-contract DeploymentTestingUtils is Script {
-    function createAndSignPremintV1(
-        address premintExecutorProxyAddress,
-        address payoutRecipient
-    )
-        internal
-        returns (
-            ContractCreationConfig memory contractConfig,
-            IZoraCreator1155PremintExecutor preminterAtProxy,
-            PremintConfig memory premintConfig,
-            bytes memory signature
-        )
-    {
-        (address creator, uint256 creatorPrivateKey) = makeAddrAndKey("creator");
-        preminterAtProxy = IZoraCreator1155PremintExecutor(premintExecutorProxyAddress);
-
-        premintConfig = PremintConfig({
-            tokenConfig: TokenCreationConfig({
-                tokenURI: "blah.token",
-                maxSupply: 10,
-                maxTokensPerAddress: 5,
-                pricePerToken: 0,
-                mintStart: 0,
-                mintDuration: 0,
-                royaltyMintSchedule: 0,
-                royaltyBPS: 100,
-                royaltyRecipient: payoutRecipient,
-                fixedPriceMinter: address(ZoraCreator1155FactoryImpl(address(preminterAtProxy.zora1155Factory())).fixedPriceMinter())
-            }),
-            uid: 101,
-            version: 0,
-            deleted: false
-        });
-
-        // now interface with proxy preminter - sign and execute the premint
-        contractConfig = ContractCreationConfig({contractAdmin: creator, contractName: "blahb", contractURI: "blah.contract"});
-        address deterministicAddress = preminterAtProxy.getContractAddress(contractConfig);
-
-        signature = signPremint(premintConfig, deterministicAddress, creatorPrivateKey);
-    }
-
-    function signAndExecutePremintV1(
-        address premintExecutorProxyAddress,
-        address payoutRecipient,
-        IZoraCreator1155PremintExecutor.MintArguments memory mintArguments
-    ) internal {
-        (
-            ContractCreationConfig memory contractConfig,
-            IZoraCreator1155PremintExecutor preminterAtProxy,
-            PremintConfig memory premintConfig,
-            bytes memory signature
-        ) = createAndSignPremintV1(premintExecutorProxyAddress, payoutRecipient);
-
-        uint256 quantityToMint = 1;
-
-        // execute the premint
-        IZoraCreator1155PremintExecutor.PremintResult memory premintResult = preminterAtProxy.premintV1{value: mintFee(quantityToMint)}(
-            contractConfig,
-            premintConfig,
-            signature,
-            quantityToMint,
-            mintArguments
-        );
-
-        require(ZoraCreator1155Impl(payable(premintResult.contractAddress)).delegatedTokenId(premintConfig.uid) == premintResult.tokenId, "token id mismatch");
-    }
-
-    function createAndSignPremintV2(
-        address premintExecutorProxyAddress,
-        address payoutRecipient
-    )
-        internal
-        returns (
-            ContractCreationConfig memory contractConfig,
-            IZoraCreator1155PremintExecutor preminterAtProxy,
-            PremintConfigV2 memory premintConfig,
-            bytes memory signature
-        )
-    {
-        (address creator, uint256 creatorPrivateKey) = makeAddrAndKey("creator");
-        preminterAtProxy = IZoraCreator1155PremintExecutor(premintExecutorProxyAddress);
-
-        premintConfig = PremintConfigV2({
-            tokenConfig: TokenCreationConfigV2({
-                tokenURI: "blah.token",
-                maxSupply: 100,
-                maxTokensPerAddress: 50,
-                pricePerToken: 0,
-                mintStart: 0,
-                mintDuration: 0,
-                royaltyBPS: 100,
-                payoutRecipient: payoutRecipient,
-                fixedPriceMinter: address(ZoraCreator1155FactoryImpl(address(preminterAtProxy.zora1155Factory())).fixedPriceMinter()),
-                createReferral: creator
-            }),
-            uid: 100,
-            version: 0,
-            deleted: false
-        });
-
-        // now interface with proxy preminter - sign and execute the premint
-        contractConfig = ContractCreationConfig({contractAdmin: creator, contractName: "blahb", contractURI: "blah.contract"});
-        address deterministicAddress = preminterAtProxy.getContractAddress(contractConfig);
-
-        signature = signPremint(premintConfig, deterministicAddress, creatorPrivateKey);
-    }
-
-    function signAndExecutePremintV2(
-        address premintExecutorProxyAddress,
-        address payoutRecipient,
-        IZoraCreator1155PremintExecutor.MintArguments memory mintArguments
-    ) internal {
-        (
-            ContractCreationConfig memory contractConfig,
-            IZoraCreator1155PremintExecutor preminterAtProxy,
-            PremintConfigV2 memory premintConfig,
-            bytes memory signature
-        ) = createAndSignPremintV2(premintExecutorProxyAddress, payoutRecipient);
-
-        uint256 quantityToMint = 1;
-        // execute the premint
-        uint256 tokenId = preminterAtProxy
-        .premintV2{value: mintFee(quantityToMint)}(contractConfig, premintConfig, signature, quantityToMint, mintArguments).tokenId;
-
-        require(
-            ZoraCreator1155Impl(payable(preminterAtProxy.getContractAddress(contractConfig))).delegatedTokenId(premintConfig.uid) == tokenId,
-            "token id not created for uid"
-        );
-    }
-
-    function signPremint(PremintConfigV2 memory premintConfig, address deterministicAddress, uint256 privateKey) private view returns (bytes memory signature) {
-        bytes32 signatureVersion = ZoraCreator1155Attribution.HASHED_VERSION_2;
-        bytes32 structHash = ZoraCreator1155Attribution.hashPremint(premintConfig);
-        // sign the premint
-        bytes32 digest = ZoraCreator1155Attribution.premintHashedTypeDataV4(structHash, deterministicAddress, signatureVersion, block.chainid);
-
-        (uint8 v, bytes32 r, bytes32 s) = vm.sign(privateKey, digest);
-        return abi.encodePacked(r, s, v);
-    }
-
-    function mintFee(uint256 quantityToMint) internal pure returns (uint256) {
-        return quantityToMint * 0.000777 ether;
-    }
-
-    function signPremint(PremintConfig memory premintConfig, address deterministicAddress, uint256 privateKey) private view returns (bytes memory signature) {
-        bytes32 signatureVersion = ZoraCreator1155Attribution.HASHED_VERSION_1;
-        bytes32 structHash = ZoraCreator1155Attribution.hashPremint(premintConfig);
-        // sign the premint
-        bytes32 digest = ZoraCreator1155Attribution.premintHashedTypeDataV4(structHash, deterministicAddress, signatureVersion, block.chainid);
-
-        (uint8 v, bytes32 r, bytes32 s) = vm.sign(privateKey, digest);
-        return abi.encodePacked(r, s, v);
-    }
-}