@zoralabs/protocol-sdk 0.3.0 → 0.3.2

package/src/apis/generated/discover-api-types.ts

@@ -3,7 +3,6 @@
  * Do not make direct changes to the file.
  */
 
-
 export interface paths {
   "/": {
     /** Root */
@@ -148,7 +147,19 @@ export interface components {
      * @description An enumeration.
      * @enum {string}
      */
-    ChainName: "ETHEREUM-MAINNET" | "ETHEREUM-ROPSTEN" | "ETHEREUM-RINKEBY" | "ETHEREUM-GOERLI" | "ETHEREUM-SEPOLIA" | "OPTIMISM-MAINNET" | "OPTIMISM-GOERLI" | "ZORA-GOERLI" | "ZORA-MAINNET" | "BASE-MAINNET" | "BASE-GOERLI" | "PGN-MAINNET";
+    ChainName:
+      | "ETHEREUM-MAINNET"
+      | "ETHEREUM-ROPSTEN"
+      | "ETHEREUM-RINKEBY"
+      | "ETHEREUM-GOERLI"
+      | "ETHEREUM-SEPOLIA"
+      | "OPTIMISM-MAINNET"
+      | "OPTIMISM-GOERLI"
+      | "ZORA-GOERLI"
+      | "ZORA-MAINNET"
+      | "BASE-MAINNET"
+      | "BASE-GOERLI"
+      | "PGN-MAINNET";
     /** Collection */
     Collection: {
       /** Address */
@@ -395,7 +406,12 @@ export interface components {
      * @description An enumeration.
      * @enum {string}
      */
-    FeedType: "curated" | "most_recent" | "heuristic" | "trending" | "recommendations";
+    FeedType:
+      | "curated"
+      | "most_recent"
+      | "heuristic"
+      | "trending"
+      | "recommendations";
     /**
      * FixedPrice
      * @description ObjectBase extends Pydantic's BaseModel class to support extra functionality
@@ -691,7 +707,13 @@ export interface components {
       /** Token Name */
       token_name?: string;
       /** Mint Context */
-      mint_context?: components["schemas"]["ManifoldMintContext"] | components["schemas"]["ZoraCreateMintContext"] | components["schemas"]["FoundationMintContext"] | components["schemas"]["ZoraCreate1155MintContext"] | components["schemas"]["ZoraCreatePremintContext"] | components["schemas"]["InferredMintContext"];
+      mint_context?:
+        | components["schemas"]["ManifoldMintContext"]
+        | components["schemas"]["ZoraCreateMintContext"]
+        | components["schemas"]["FoundationMintContext"]
+        | components["schemas"]["ZoraCreate1155MintContext"]
+        | components["schemas"]["ZoraCreatePremintContext"]
+        | components["schemas"]["InferredMintContext"];
       /** Is Active */
       is_active: boolean;
       cost: components["schemas"]["zora__collect__feed__models__price_at_time__PriceAtTime"];
@@ -729,13 +751,30 @@ export interface components {
      * @description An enumeration.
      * @enum {string}
      */
-    MintableStatus: "ACTIVE" | "BLOCKED" | "EXPIRED" | "INVALID_MEDIA" | "MINTED_OUT" | "DELETED";
+    MintableStatus:
+      | "ACTIVE"
+      | "BLOCKED"
+      | "EXPIRED"
+      | "INVALID_MEDIA"
+      | "MINTED_OUT"
+      | "DELETED";
     /**
      * MintableType
      * @description An enumeration.
      * @enum {string}
      */
-    MintableType: "FOUNDATION_DROP_COLLECTION" | "FOUNDATION_TIMED_EDITION" | "MANIFOLD_ERC1155" | "MANIFOLD_ERC721" | "ZORA_CREATE" | "ZORA_CREATE_1155" | "ZORA_CREATE_1155_B2R_REDEEM_TOKEN" | "ZORA_CREATE_1155_PREMINT_TOKEN" | "ZORA_EDITION" | "ZORA_DROP" | "INFERRED";
+    MintableType:
+      | "FOUNDATION_DROP_COLLECTION"
+      | "FOUNDATION_TIMED_EDITION"
+      | "MANIFOLD_ERC1155"
+      | "MANIFOLD_ERC721"
+      | "ZORA_CREATE"
+      | "ZORA_CREATE_1155"
+      | "ZORA_CREATE_1155_B2R_REDEEM_TOKEN"
+      | "ZORA_CREATE_1155_PREMINT_TOKEN"
+      | "ZORA_EDITION"
+      | "ZORA_DROP"
+      | "INFERRED";
     /**
      * Network
      * @description An enumeration.
@@ -743,7 +782,9 @@ export interface components {
      */
     Network: "MAINNET" | "GOERLI";
     /** Notification */
-    Notification: components["schemas"]["MintNotification"] | components["schemas"]["MintCommentNotification"];
+    Notification:
+      | components["schemas"]["MintNotification"]
+      | components["schemas"]["MintCommentNotification"];
     /**
      * NotificationsResponse
      * @description This is a generic model for pagination in an infitite scrolling context.
@@ -911,7 +952,9 @@ export interface components {
       description?: string;
       entity_type: components["schemas"]["EntityType"];
       /** Entity */
-      entity: components["schemas"]["SearchCollection"] | components["schemas"]["SearchToken"];
+      entity:
+        | components["schemas"]["SearchCollection"]
+        | components["schemas"]["SearchToken"];
       media?: components["schemas"]["Media"];
       /**
        * Rank
@@ -1377,7 +1420,6 @@ export type $defs = Record<string, never>;
 export type external = Record<string, never>;
 
 export interface operations {
-
   /** Root */
   root__get: {
     responses: {

package/src/apis/generated/premint-api-types.ts

@@ -3,7 +3,6 @@
  * Do not make direct changes to the file.
  */
 
-
 export interface paths {
   "/signature": {
     /** Upsert Premint Signature */
@@ -36,7 +35,19 @@ export interface components {
      * @description An enumeration.
      * @enum {string}
      */
-    ChainName: "ETHEREUM-MAINNET" | "ETHEREUM-ROPSTEN" | "ETHEREUM-RINKEBY" | "ETHEREUM-GOERLI" | "ETHEREUM-SEPOLIA" | "OPTIMISM-MAINNET" | "OPTIMISM-GOERLI" | "ZORA-GOERLI" | "ZORA-MAINNET" | "BASE-MAINNET" | "BASE-GOERLI" | "PGN-MAINNET";
+    ChainName:
+      | "ETHEREUM-MAINNET"
+      | "ETHEREUM-ROPSTEN"
+      | "ETHEREUM-RINKEBY"
+      | "ETHEREUM-GOERLI"
+      | "ETHEREUM-SEPOLIA"
+      | "OPTIMISM-MAINNET"
+      | "OPTIMISM-GOERLI"
+      | "ZORA-GOERLI"
+      | "ZORA-MAINNET"
+      | "BASE-MAINNET"
+      | "BASE-GOERLI"
+      | "PGN-MAINNET";
     /**
      * CollectionCreationConfig
      * @description ObjectBase extends Pydantic's BaseModel class to support extra functionality
@@ -244,7 +255,6 @@ export type $defs = Record<string, never>;
 export type external = Record<string, never>;
 
 export interface operations {
-
   /** Upsert Premint Signature */
   upsert_premint_signature_signature_post: {
     requestBody: {

package/src/index.ts

@@ -6,4 +6,6 @@ export * from "./premint/premint-api-client";
 
 export * from "./mint/mint-api-client";
 
+export * from "./mint/mint-client";
+
 export * from "./create/1155-create-helper";

package/src/premint/premint-client.ts

@@ -570,7 +570,7 @@ class PremintClient extends ClientBase {
       quantityToMint: number;
       mintComment?: string;
     };
-  }): Promise<{request: SimulateContractParameters}> {
+  }): Promise<{ request: SimulateContractParameters }> {
     if (mintArguments && mintArguments?.quantityToMint < 1) {
       throw new Error("Quantity to mint cannot be below 1");
     }

package/src/premint/preminter.test.ts

@@ -1,4 +1,11 @@
-import { keccak256, Hex, concat, recoverAddress, hashDomain, Address } from "viem";
+import {
+  keccak256,
+  Hex,
+  concat,
+  recoverAddress,
+  hashDomain,
+  Address,
+} from "viem";
 import { foundry } from "viem/chains";
 import { describe, expect } from "vitest";
 import { parseEther } from "viem";
@@ -16,7 +23,12 @@ import {
   TokenCreationConfig,
   preminterTypedDataDefinition,
 } from "./preminter";
-import { AnvilViemClientsTest, anvilTest } from "src/anvil";
+import {
+  AnvilViemClientsTest,
+  anvilTest,
+  forkUrls,
+  makeAnvilTest,
+} from "src/anvil";
 
 // create token and contract creation config:
 const defaultContractConfig = ({
@@ -133,7 +145,10 @@ describe("ZoraCreator1155Preminter", () => {
     },
     20 * 1000,
   );
-  anvilTest(
+  makeAnvilTest({
+    forkUrl: forkUrls.zoraGoerli,
+    forkBlockNumber: 1676105,
+  })(
     "can sign and recover a signature",
     async ({ viemClients }) => {
       const {
@@ -167,13 +182,15 @@ describe("ZoraCreator1155Preminter", () => {
         account: creatorAccount,
       });
 
+      const preminterAddress = zoraCreator1155PremintExecutorAddress[999];
       // recover and verify address is correct
-      const recoveredAddress = await viemClients.publicClient.readContract({
-        abi: preminterAbi,
-        address: PREMINTER_ADDRESS,
-        functionName: "recoverSigner",
-        args: [premintConfig, contractAddress, signedMessage],
-      });
+      const [, , recoveredAddress] =
+        await viemClients.publicClient.readContract({
+          abi: preminterAbi,
+          address: preminterAddress,
+          functionName: "isValidSignature",
+          args: [contractConfig, premintConfig, signedMessage],
+        });
 
       expect(recoveredAddress).to.equal(creatorAccount);
     },
@@ -279,6 +296,7 @@ describe("ZoraCreator1155Preminter", () => {
         args: [contractAddress, premintConfig.uid],
       });
 
+      expect(contractCreated).toBe(true);
       expect(tokenId).not.toBe(0n);
 
       // now use what was created, to get the balance from the created contract

package/src/preminter.ts

@@ -0,0 +1,136 @@
+import { Address } from "abitype";
+import { ExtractAbiFunction, AbiParametersToPrimitiveTypes } from "abitype";
+import {
+  zoraCreator1155PremintExecutorImplABI as preminterAbi,
+  zoraCreator1155PremintExecutorImplAddress,
+} from "@zoralabs/protocol-deployments";
+import {
+  TypedDataDefinition,
+  recoverTypedDataAddress,
+  Hex,
+  PublicClient,
+} from "viem";
+
+type PremintInputs = ExtractAbiFunction<
+  typeof preminterAbi,
+  "premint"
+>["inputs"];
+
+type PreminterHashDataTypes = AbiParametersToPrimitiveTypes<PremintInputs>;
+
+export type ContractCreationConfig = PreminterHashDataTypes[0];
+export type PremintConfig = PreminterHashDataTypes[1];
+export type TokenCreationConfig = PremintConfig["tokenConfig"];
+
+// Convenience method to create the structured typed data
+// needed to sign for a premint contract and token
+export const preminterTypedDataDefinition = ({
+  verifyingContract,
+  premintConfig,
+  chainId,
+}: {
+  verifyingContract: Address;
+  premintConfig: PremintConfig;
+  chainId: number;
+}) => {
+  const { tokenConfig, uid, version, deleted } = premintConfig;
+  const types = {
+    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" },
+    ],
+  };
+
+  const result: TypedDataDefinition<typeof types, "CreatorAttribution"> = {
+    domain: {
+      chainId,
+      name: "Preminter",
+      version: "1",
+      verifyingContract: verifyingContract,
+    },
+    types,
+    message: {
+      tokenConfig,
+      uid,
+      version,
+      deleted,
+    },
+    primaryType: "CreatorAttribution",
+  };
+
+  return result;
+};
+
+export async function isValidSignatureV1({
+  contractAddress,
+  originalContractAdmin,
+  premintConfig,
+  signature,
+  chainId,
+  publicClient,
+}: {
+  contractAddress: Address;
+  originalContractAdmin: Address;
+  premintConfig: PremintConfig;
+  signature: Hex;
+  chainId: number;
+  publicClient: PublicClient;
+}): Promise<{
+  isAuthorized: boolean;
+  recoveredAddress?: Address;
+}> {
+  const typedData = preminterTypedDataDefinition({
+    verifyingContract: contractAddress,
+    premintConfig,
+    chainId,
+  });
+
+  // recover the address from the signature
+  let recoveredAddress: Address;
+
+  try {
+    recoveredAddress = await recoverTypedDataAddress({
+      ...typedData,
+      signature,
+    });
+  } catch (error) {
+    console.error(error);
+
+    return {
+      isAuthorized: false,
+    };
+  }
+
+  // premint executor is same address on all chains
+  const premintExecutorAddress = zoraCreator1155PremintExecutorImplAddress[999];
+
+  const isAuthorized = await publicClient.readContract({
+    abi: preminterAbi,
+    address: premintExecutorAddress,
+    functionName: "isAuthorizedToCreatePremint",
+    args: [recoveredAddress, originalContractAdmin, contractAddress],
+  });
+
+  return {
+    isAuthorized,
+    recoveredAddress,
+  };
+}