@zoralabs/protocol-deployments 0.1.8 → 0.1.10

package/src/typedData.ts

@@ -0,0 +1,226 @@
+import {
+  Address,
+  TypedDataDomain,
+  TypedData,
+  TypedDataToPrimitiveTypes,
+} from "abitype";
+import { TypedDataDefinition } from "viem";
+import { zoraMints1155Address } from "./generated/wagmi";
+
+const premintTypedDataDomain = ({
+  chainId,
+  version,
+  creator1155Contract: verifyingContract,
+}: {
+  chainId: number;
+  version: "1" | "2";
+  creator1155Contract: Address;
+}): TypedDataDomain => ({
+  chainId,
+  name: "Preminter",
+  version,
+  verifyingContract,
+});
+
+const premintV1TypedDataType = {
+  CreatorAttribution: [
+    { name: "tokenConfig", type: "TokenCreationConfig" },
+    // unique id scoped to the contract and token to create.
+    // ensure that a signature can be replaced, as long as the replacement
+    // has the same uid, and a newer version.
+    { name: "uid", type: "uint32" },
+    { name: "version", type: "uint32" },
+    // if this update should result in the signature being deleted.
+    { name: "deleted", type: "bool" },
+  ],
+  TokenCreationConfig: [
+    { name: "tokenURI", type: "string" },
+    { name: "maxSupply", type: "uint256" },
+    { name: "maxTokensPerAddress", type: "uint64" },
+    { name: "pricePerToken", type: "uint96" },
+    { name: "mintStart", type: "uint64" },
+    { name: "mintDuration", type: "uint64" },
+    { name: "royaltyMintSchedule", type: "uint32" },
+    { name: "royaltyBPS", type: "uint32" },
+    { name: "royaltyRecipient", type: "address" },
+    { name: "fixedPriceMinter", type: "address" },
+  ],
+} as const satisfies TypedData;
+
+/**
+ * Builds a typed data definition for a PremintConfigV1 to be signed
+ * @returns
+ */
+export const premintV1TypedDataDefinition = ({
+  chainId,
+  creator1155Contract,
+  message,
+}: {
+  chainId: number;
+  creator1155Contract: Address;
+  message: TypedDataToPrimitiveTypes<
+    typeof premintV1TypedDataType
+  >["CreatorAttribution"];
+}): TypedDataDefinition<
+  typeof premintV1TypedDataType,
+  "CreatorAttribution"
+> => ({
+  types: premintV1TypedDataType,
+  primaryType: "CreatorAttribution",
+  domain: premintTypedDataDomain({
+    chainId,
+    version: "1",
+    creator1155Contract,
+  }),
+  message,
+});
+
+const premintV2TypedDataType = {
+  CreatorAttribution: [
+    { name: "tokenConfig", type: "TokenCreationConfig" },
+    // unique id scoped to the contract and token to create.
+    // ensure that a signature can be replaced, as long as the replacement
+    // has the same uid, and a newer version.
+    { name: "uid", type: "uint32" },
+    { name: "version", type: "uint32" },
+    // if this update should result in the signature being deleted.
+    { name: "deleted", type: "bool" },
+  ],
+  TokenCreationConfig: [
+    { name: "tokenURI", type: "string" },
+    { name: "maxSupply", type: "uint256" },
+    { name: "maxTokensPerAddress", type: "uint64" },
+    { name: "pricePerToken", type: "uint96" },
+    { name: "mintStart", type: "uint64" },
+    { name: "mintDuration", type: "uint64" },
+    { name: "royaltyBPS", type: "uint32" },
+    { name: "payoutRecipient", type: "address" },
+    { name: "fixedPriceMinter", type: "address" },
+    { name: "createReferral", type: "address" },
+  ],
+} as const satisfies TypedData;
+
+/**
+ * Builds a typed data definition for a PremintConfigV2 to be signed
+ */
+export const premintV2TypedDataDefinition = ({
+  chainId,
+  creator1155Contract,
+  message,
+}: {
+  chainId: number;
+  creator1155Contract: Address;
+  message: TypedDataToPrimitiveTypes<
+    typeof premintV2TypedDataType
+  >["CreatorAttribution"];
+}): TypedDataDefinition<
+  typeof premintV2TypedDataType,
+  "CreatorAttribution"
+> => ({
+  types: premintV2TypedDataType,
+  primaryType: "CreatorAttribution",
+  domain: premintTypedDataDomain({
+    chainId,
+    version: "2",
+    creator1155Contract,
+  }),
+  message,
+});
+
+const permitSafeTransferTypedDataType = {
+  PermitSafeTransfer: [
+    { name: "owner", type: "address" },
+    { name: "to", type: "address" },
+    { name: "tokenId", type: "uint256" },
+    { name: "quantity", type: "uint256" },
+    { name: "safeTransferData", type: "bytes" },
+    { name: "nonce", type: "uint256" },
+    { name: "deadline", type: "uint256" },
+  ],
+} as const;
+
+/**
+ * Builds a typed data definition for a PermitSafeTransfer on the Mints1155 contract to be signed
+ */
+export const mintsSafeTransferTypedDataDefinition = ({
+  chainId,
+  message,
+}: {
+  chainId: keyof typeof zoraMints1155Address;
+  message: TypedDataToPrimitiveTypes<
+    typeof permitSafeTransferTypedDataType
+  >["PermitSafeTransfer"];
+}): TypedDataDefinition<
+  typeof permitSafeTransferTypedDataType,
+  "PermitSafeTransfer"
+> => ({
+  types: permitSafeTransferTypedDataType,
+  message,
+  primaryType: "PermitSafeTransfer",
+  domain: {
+    chainId,
+    name: "Mints",
+    version: "1",
+    verifyingContract: zoraMints1155Address[chainId],
+  },
+});
+
+const permitSafeBatchTransferTypedDataType = {
+  Permit: [
+    {
+      name: "owner",
+      type: "address",
+    },
+    {
+      name: "to",
+      type: "address",
+    },
+    {
+      name: "tokenIds",
+      type: "uint256[]",
+    },
+    {
+      name: "quantities",
+      type: "uint256[]",
+    },
+    {
+      name: "safeTransferData",
+      type: "bytes",
+    },
+    {
+      name: "nonce",
+      type: "uint256",
+    },
+    {
+      name: "deadline",
+      type: "uint256",
+    },
+  ],
+} as const;
+
+/**
+ * Builds a typed data definition for a PermitSafeTransferBatch on the Mints1155 contract to be signed
+ * @returns
+ */
+export const mintsSafeTransferBatchTypedDataDefinition = ({
+  chainId,
+  message,
+}: {
+  chainId: keyof typeof zoraMints1155Address;
+  message: TypedDataToPrimitiveTypes<
+    typeof permitSafeBatchTransferTypedDataType
+  >["Permit"];
+}): TypedDataDefinition<
+  typeof permitSafeBatchTransferTypedDataType,
+  "Permit"
+> => ({
+  types: permitSafeBatchTransferTypedDataType,
+  message,
+  primaryType: "Permit",
+  domain: {
+    chainId,
+    name: "Mints",
+    version: "1",
+    verifyingContract: zoraMints1155Address[chainId],
+  },
+});

package/wagmi.config.ts

@@ -1,189 +0,0 @@
-import { defineConfig } from "@wagmi/cli";
-import { Abi, zeroAddress } from "viem";
-import { readdirSync, readFileSync } from "fs";
-import * as abis from "@zoralabs/zora-1155-contracts";
-import {
-  zoraMints1155ABI,
-  zoraMintsManagerImplABI,
-  mintsEthUnwrapperAndCallerABI,
-  iUnwrapAndForwardActionABI,
-} from "@zoralabs/mints-contracts";
-
-type Address = `0x${string}`;
-
-type Addresses = {
-  [contractName: string]: {
-    address: {
-      [chainId: number]: Address;
-    };
-    abi: Abi;
-  };
-};
-
-const get1155Addresses = () => {
-  const addresses: Addresses = {};
-
-  const addressesFiles = readdirSync("../1155-deployments/addresses");
-
-  const addAddress = ({
-    contractName,
-    chainId,
-    address,
-    abi,
-  }: {
-    contractName: string;
-    chainId: number;
-    address?: Address;
-    abi: Abi;
-  }) => {
-    if (!address || address === zeroAddress) return;
-    if (!addresses[contractName]) {
-      addresses[contractName] = {
-        address: {},
-        abi,
-      };
-    }
-
-    addresses[contractName]!.address[chainId] = address;
-  };
-
-  const protocolRewardsConfig = JSON.parse(
-    readFileSync("../protocol-rewards/deterministicConfig.json", "utf-8"),
-  ) as {
-    expectedAddress: Address;
-  };
-
-  for (const addressesFile of addressesFiles) {
-    const jsonAddress = JSON.parse(
-      readFileSync(`../1155-deployments/addresses/${addressesFile}`, "utf-8"),
-    ) as {
-      FIXED_PRICE_SALE_STRATEGY: Address;
-      MERKLE_MINT_SALE_STRATEGY: Address;
-      REDEEM_MINTER_FACTORY: Address;
-      "1155_IMPL": Address;
-      FACTORY_IMPL: Address;
-      FACTORY_PROXY: Address;
-      PREMINTER_PROXY?: Address;
-      ERC20_MINTER?: Address;
-    };
-
-    const chainId = parseInt(addressesFile.split(".")[0]);
-
-    addAddress({
-      contractName: "ZoraCreatorFixedPriceSaleStrategy",
-      chainId,
-      address: jsonAddress.FIXED_PRICE_SALE_STRATEGY,
-      abi: abis.zoraCreatorFixedPriceSaleStrategyABI,
-    });
-    addAddress({
-      contractName: "ZoraCreatorMerkleMinterStrategy",
-      chainId,
-      address: jsonAddress.MERKLE_MINT_SALE_STRATEGY,
-      abi: abis.zoraCreatorMerkleMinterStrategyABI,
-    });
-    addAddress({
-      contractName: "ZoraCreator1155FactoryImpl",
-      chainId,
-      address: jsonAddress.FACTORY_PROXY,
-      abi: abis.zoraCreator1155FactoryImplABI,
-    });
-    addAddress({
-      contractName: "ZoraCreatorRedeemMinterFactory",
-      chainId,
-      address: jsonAddress.REDEEM_MINTER_FACTORY,
-      abi: abis.zoraCreatorRedeemMinterFactoryABI,
-    });
-    addAddress({
-      contractName: "ZoraCreator1155PremintExecutorImpl",
-      chainId,
-      address: jsonAddress.PREMINTER_PROXY,
-      abi: abis.zoraCreator1155PremintExecutorImplABI,
-    });
-    addAddress({
-      contractName: "ProtocolRewards",
-      chainId,
-      address: protocolRewardsConfig.expectedAddress,
-      abi: abis.protocolRewardsABI,
-    });
-    addAddress({
-      contractName: "ERC20Minter",
-      chainId,
-      abi: abis.erc20MinterABI,
-      address: jsonAddress.ERC20_MINTER,
-    });
-  }
-
-  return addresses;
-};
-
-const getMintsAddresses = () => {
-  const addressesFiles = readdirSync("../mints-deployments/addresses");
-
-  const chainIds = addressesFiles.map((x) => Number(x.split(".")[0]));
-
-  const mintsProxyConfig = JSON.parse(
-    readFileSync(
-      "../mints-deployments/deterministicConfig/mintsProxy/params.json",
-      "utf-8",
-    ),
-  );
-
-  const mintsEthUnwrapperAndCallerAddress = JSON.parse(
-    readFileSync("../mints-deployments/addresses/999999999.json", "utf-8"),
-  ).MINTS_ETH_UNWRAPPER_AND_CALLER as Address;
-
-  const mintsManagerAddress = mintsProxyConfig.manager
-    .deployedAddress as Address;
-  const zoraMints1155Address = mintsProxyConfig.mints1155
-    .deployedAddress as Address;
-
-  return {
-    mintsManager: Object.fromEntries(
-      chainIds.map((chainId) => [chainId, mintsManagerAddress]),
-    ),
-    mints1155: Object.fromEntries(
-      chainIds.map((chainId) => [chainId, zoraMints1155Address as Address]),
-    ),
-    mintsEthUnwrapperAndCaller: Object.fromEntries(
-      chainIds.map((chainId) => [chainId, mintsEthUnwrapperAndCallerAddress]),
-    ),
-  };
-};
-
-const mintsAddresses = getMintsAddresses();
-
-export default defineConfig({
-  out: "src/generated/wagmi.ts",
-  contracts: [
-    ...Object.entries(get1155Addresses()).map(
-      ([contractName, addressConfig]) => ({
-        abi: addressConfig.abi,
-        address: addressConfig.address,
-        name: contractName,
-      }),
-    ),
-    {
-      abi: abis.zoraCreator1155ImplABI,
-      name: "ZoraCreator1155Impl",
-    },
-    {
-      abi: zoraMintsManagerImplABI,
-      name: "ZoraMintsManagerImpl",
-      address: mintsAddresses.mintsManager,
-    },
-    {
-      abi: zoraMints1155ABI,
-      name: "ZoraMints1155",
-      address: mintsAddresses.mints1155,
-    },
-    {
-      abi: mintsEthUnwrapperAndCallerABI,
-      name: "MintsEthUnwrapperAndCaller",
-      address: mintsAddresses.mintsEthUnwrapperAndCaller,
-    },
-    {
-      abi: iUnwrapAndForwardActionABI,
-      name: "IUnwrapAndForwardAction",
-    },
-  ],
-});