Premint SDK - update to support additionalAdmins and executing premints against non-premint contracts (ourzora#433)

Updates the protocol sdk to:
* support creating/minting premints by just specifying a collection address
* support creating/minting premints with additional admins

Author: oveddan

.changeset/dirty-pants-shave.md

@@ -0,0 +1,5 @@
+---
+"@zoralabs/protocol-sdk": patch
+---
+
+premintClient now supports creating/minting premints with additional admins and ones that were created with just a collection address

packages/protocol-deployments/src/types.ts

@@ -4,19 +4,25 @@ import {
   zoraCreator1155PremintExecutorImplABI,
   iPremintDefinitionsABI,
 } from "./generated/wagmi";
+import { Address } from "viem";
 
 export enum PremintConfigVersion {
   V1 = "1",
   V2 = "2",
   V3 = "3",
 }
 
-export type ContractCreationConfig = AbiParametersToPrimitiveTypes<
-  ExtractAbiFunction<
-    typeof zoraCreator1155PremintExecutorImplABI,
-    "premint"
-  >["inputs"]
->[0];
+export type ContractCreationConfig = Omit<
+  AbiParametersToPrimitiveTypes<
+    ExtractAbiFunction<
+      typeof zoraCreator1155PremintExecutorImplABI,
+      "premint"
+    >["inputs"]
+  >[0],
+  "additionalAdmins"
+> & {
+  additionalAdmins: Address[];
+};
 
 export type TokenCreationConfigV1 = AbiParametersToPrimitiveTypes<
   ExtractAbiFunction<

packages/protocol-sdk/src/apis/generated/premint-api-types.ts

@@ -71,6 +71,11 @@ export interface components {
       contractURI: string;
       /** Contractname */
       contractName: string;
+      /**
+       * Additionaladmins
+       * @default []
+       */
+      additionalAdmins?: string[];
     };
     /** HTTPValidationError */
     HTTPValidationError: {
@@ -187,14 +192,16 @@ export interface components {
      *     ...:     other: str = "default"
      */
     PremintRequest: {
-      collection: components["schemas"]["CollectionCreationConfig"];
+      collection?: components["schemas"]["CollectionCreationConfig"];
       /** Premint */
       premint:
         | components["schemas"]["PremintConfigV1"]
         | components["schemas"]["PremintConfigV2"];
       chain_name: components["schemas"]["ChainName"];
       /** Signature */
       signature: string;
+      /** Collection Address */
+      collection_address?: string;
     };
     /**
      * PremintSignature
@@ -209,7 +216,7 @@ export interface components {
      *     ...:     other: str = "default"
      */
     PremintSignature: {
-      collection: components["schemas"]["CollectionCreationConfig"];
+      collection?: components["schemas"]["CollectionCreationConfig"];
       /** Premint */
       premint:
         | components["schemas"]["PremintConfigV1"]

packages/protocol-sdk/src/index.ts

@@ -19,3 +19,9 @@ export * from "./mints/mints-queries";
 export * from "./mints/mints-contracts";
 
 export * from "./mints/mints-eth-unwrapper-and-caller";
+
+export {
+  type ContractCreationConfigWithOptionalAdditionalAdmins,
+  type ContractCreationConfigOrAddress,
+  type ContractCreationConfigAndAddress,
+} from "./premint/contract-types";

packages/protocol-sdk/src/mints/mints-contracts.test.ts

@@ -18,7 +18,6 @@ import {
   Address,
   BaseError,
   ContractFunctionRevertedError,
-  PublicClient,
   WalletClient,
   parseEther,
 } from "viem";
@@ -39,8 +38,9 @@ import {
   getFixedPricedMinter,
   waitForSuccess,
 } from "src/test-utils";
+import { PublicClient } from "src/utils";
 
-const mintsMainnetDeployedBlock = 12990454;
+const mintsMainnetDeployedBlock = 15372992;
 
 const anvilTest = makeAnvilTest({
   forkUrl: forkUrls.zoraMainnet,

packages/protocol-sdk/src/premint/contract-types.ts

@@ -1,7 +1,38 @@
-import { PremintConfigVersion as PremintConfigVersionOrig } from "@zoralabs/protocol-deployments";
+import {
+  ContractCreationConfig,
+  PremintConfigVersion as PremintConfigVersionOrig,
+} from "@zoralabs/protocol-deployments";
+import { Address } from "viem";
 
 export enum PremintConfigVersion {
   V1 = PremintConfigVersionOrig.V1,
   V2 = PremintConfigVersionOrig.V2,
   V3 = PremintConfigVersionOrig.V3,
 }
+
+export type ContractCreationConfigWithOptionalAdditionalAdmins = Omit<
+  ContractCreationConfig,
+  "additionalAdmins"
+> & {
+  /** Optional: if there are additional admins accounts that should be added as contract wide admins upon contract creation. */
+  additionalAdmins?: Address[];
+};
+
+export type ContractCreationConfigAndAddress = {
+  /** Parameters for creating the contract for new premints. */
+  collection?: ContractCreationConfigWithOptionalAdditionalAdmins;
+  /** Premint collection address */
+  collectionAddress: Address;
+};
+
+export type ContractCreationConfigOrAddress =
+  | {
+      /** Parameters for creating the contract for new premints. */
+      collection: ContractCreationConfigWithOptionalAdditionalAdmins;
+      collectionAddress?: undefined;
+    }
+  | {
+      collection?: undefined;
+      /** Premint collection address */
+      collectionAddress: Address;
+    };

packages/protocol-sdk/src/premint/conversions.ts

@@ -10,14 +10,21 @@ import {
   PremintConfigWithVersion,
 } from "@zoralabs/protocol-deployments";
 import { PremintSignatureGetResponse } from "./premint-api-client";
+import { ContractCreationConfigOrAddress } from "./contract-types";
 
 export const convertCollectionFromApi = (
   collection: PremintSignatureGetResponse["collection"],
-): ContractCreationConfig => ({
-  ...collection,
-  contractAdmin: collection.contractAdmin as Address,
-  additionalAdmins: [],
-});
+): ContractCreationConfig | undefined => {
+  if (!collection) return undefined;
+
+  return {
+    additionalAdmins:
+      (collection.additionalAdmins as Address[] | undefined) || [],
+    contractAdmin: collection.contractAdmin as Address,
+    contractName: collection.contractName,
+    contractURI: collection.contractURI,
+  };
+};
 
 /**
  * Convert server to on-chain types for a premint
@@ -82,6 +89,7 @@ export const convertGetPremintApiResponse = (
 ) => ({
   ...convertPremintFromApi(response.premint),
   collection: convertCollectionFromApi(response.collection),
+  collectionAddress: response.collection_address as Address,
   signature: response.signature as Hex,
 });
 
@@ -143,20 +151,24 @@ export type PremintSignatureResponse =
  */
 export const encodePostSignatureInput = <T extends PremintConfigVersion>({
   collection,
+  collectionAddress,
   premintConfigVersion,
   premintConfig,
   signature,
   chainId,
 }: {
-  collection: ContractCreationConfig;
   signature: Hex;
   chainId: number;
-} & PremintConfigWithVersion<T>): PremintSignatureRequestBody => ({
+} & PremintConfigWithVersion<T> &
+  ContractCreationConfigOrAddress): PremintSignatureRequestBody => ({
   premint: encodePremintForAPI({
     premintConfig,
     premintConfigVersion,
   }),
   signature,
-  collection,
+  collection: collection as
+    | PremintSignatureRequestBody["collection"]
+    | undefined,
+  collection_address: collectionAddress,
   chain_name: networkConfigByChain[chainId]!.zoraBackendChainName,
 });

packages/protocol-sdk/src/premint/premint-api-client.ts

@@ -19,6 +19,7 @@ import {
   convertGetPremintApiResponse,
   encodePostSignatureInput,
 } from "./conversions";
+import { ContractCreationConfigOrAddress } from "./contract-types";
 
 type PremintNextUIDGetType =
   paths["/signature/{chain_name}/{collection_address}/next_uid"]["get"];
@@ -91,16 +92,14 @@ class PremintAPIClient {
     this.networkConfig = getApiNetworkConfigForChain(chainId);
   }
   postSignature = async <T extends PremintConfigVersion>({
-    collection,
     signature,
-    ...premintConfigAndVersion
+    ...rest
   }: {
-    collection: ContractCreationConfig;
     signature: Hex;
-  } & PremintConfigWithVersion<T>): Promise<PremintSignatureResponse> => {
+  } & PremintConfigWithVersion<T> &
+    ContractCreationConfigOrAddress): Promise<PremintSignatureResponse> => {
     const data = encodePostSignatureInput({
-      collection,
-      ...premintConfigAndVersion,
+      ...rest,
       chainId: this.networkConfig.chainId,
       signature,
     });
@@ -128,7 +127,8 @@ class PremintAPIClient {
   }): Promise<
     {
       signature: Hex;
-      collection: ContractCreationConfig;
+      collection: ContractCreationConfig | undefined;
+      collectionAddress: Address;
     } & PremintConfigAndVersion
   > => {
     const response = await getSignature({