@zoralabs/protocol-sdk 0.5.16 → 0.6.0

package/src/mint/types.ts

@@ -0,0 +1,122 @@
+import { Account, Address } from "viem";
+import { GenericTokenIdTypes } from "src/types";
+
+export type MintParameters<MintType> = {
+  /** Type of the collection to be minted. */
+  mintType: MintType;
+};
+
+export type Erc1155MintParameters = MintParameters<"1155"> & {
+  /** Token id to mint */
+  tokenId: GenericTokenIdTypes;
+};
+
+export type Erc721MintParameters = MintParameters<"721">;
+
+export type OnChainMintParameters =
+  | Erc1155MintParameters
+  | Erc721MintParameters;
+
+export type PremintMintParameters = MintParameters<"premint"> & {
+  /** uid of the Premint to mint */
+  uid: number;
+};
+
+export type MintType = "1155" | "721" | "premint";
+
+export type MintTypes =
+  | Erc1155MintParameters
+  | Erc721MintParameters
+  | PremintMintParameters;
+
+export const isOnChainMint = (mint: MintTypes): mint is OnChainMintParameters =>
+  mint.mintType !== "premint";
+
+export const is1155Mint = (mint: MintTypes): mint is Erc1155MintParameters =>
+  mint.mintType === "1155";
+
+export type MakeMintParametersArgumentsBase = {
+  /** Premint contract address */
+  tokenContract: Address;
+  /** Account to execute the mint */
+  minterAccount: Account | Address;
+  /** Quantity of tokens to mint. Defaults to 1 */
+  quantityToMint: number | bigint;
+  /** Comment to add to the mint */
+  mintComment?: string;
+  /** Address to receive the mint referral reward */
+  mintReferral?: Address;
+  /** Address to receive the minted tokens. Defaults to the minting account */
+  mintRecipient?: Address;
+};
+
+export type Make1155MintArguments = MakeMintParametersArgumentsBase &
+  Erc1155MintParameters & {
+    saleType?: SaleType;
+  };
+
+export type Make721MintArguments = MakeMintParametersArgumentsBase &
+  Erc721MintParameters & {
+    saleType?: SaleType;
+  };
+
+export type MakePremintMintParametersArguments =
+  MakeMintParametersArgumentsBase &
+    PremintMintParameters & {
+      /** Account to receive first minter reward, if this mint brings the premint onchain */
+      firstMinter?: Address;
+    };
+
+export type MakeMintParametersArguments =
+  | Make1155MintArguments
+  | Make721MintArguments
+  | MakePremintMintParametersArguments;
+
+export type GetMintCostsParameters = {
+  /** Address of token contract/collection to get the mint costs for */
+  collection: Address;
+  /** Quantity of tokens that will be minted */
+  quantityMinted: number | bigint;
+} & MintTypes;
+
+export type SaleType = "fixedPrice" | "erc20";
+
+type SaleStrategy<T extends SaleType> = {
+  saleType: T;
+  address: Address;
+  pricePerToken: bigint;
+  saleEnd: string;
+  saleStart: string;
+  maxTokensPerAddress: bigint;
+};
+
+type FixedPriceSaleStrategy = SaleStrategy<"fixedPrice">;
+
+type ERC20SaleStrategy = SaleStrategy<"erc20"> & {
+  currency: Address;
+};
+
+type SaleStrategies = FixedPriceSaleStrategy | ERC20SaleStrategy;
+
+export function isErc20SaleStrategy(
+  salesConfig: SaleStrategies,
+): salesConfig is ERC20SaleStrategy {
+  return salesConfig.saleType === "erc20";
+}
+
+export type SalesConfigAndTokenInfo = {
+  salesConfig: SaleStrategies;
+  mintFeePerQuantity: bigint;
+};
+
+export interface IMintGetter {
+  getSalesConfigAndTokenInfo({
+    tokenAddress,
+    tokenId,
+    saleType,
+  }: {
+    tokenAddress: Address;
+    tokenId?: GenericTokenIdTypes;
+    saleType?: SaleType;
+  }): Promise<SalesConfigAndTokenInfo>;
+}

package/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,
@@ -77,7 +77,7 @@ const setupContractUsingPremint = async ({
   contractConfig.contractName = "Testing contract for MINTS";
 
   const contractAddress = await getPremintCollectionAddress({
-    collection: contractConfig,
+    contract: contractConfig,
     publicClient,
   });
 

package/src/mints/mints-contracts.ts

@@ -12,7 +12,7 @@ import {
   PremintConfigV2,
 } from "@zoralabs/protocol-deployments";
 import { ContractCreationConfig } from "src/preminter";
-import { makeSimulateContractParamaters } from "src/utils";
+import { makeContractParameters } from "src/utils";
 import {
   Account,
   Address,
@@ -53,7 +53,7 @@ export const mintWithEthParams = ({
   pricePerMint: bigint;
   account: Address | Account;
 }) =>
-  makeSimulateContractParamaters({
+  makeContractParameters({
     abi: zoraMintsManagerImplConfig.abi,
     address: zoraMintsManagerImplConfig.address[chainId],
     functionName: "mintWithEth",
@@ -152,7 +152,7 @@ export function collectWithMintsParams({
     mintArguments,
   });
 
-  return makeSimulateContractParamaters({
+  return makeContractParameters({
     abi: zoraMints1155Config.abi,
     address: zoraMints1155Config.address[chainId],
     functionName: "transferBatchToManagerAndCall",
@@ -416,7 +416,7 @@ export function collectPremintV2WithMintsParams({
     ...rest,
   });
 
-  return makeSimulateContractParamaters({
+  return makeContractParameters({
     abi: zoraMints1155Config.abi,
     address: zoraMints1155Config.address[chainId],
     functionName: "transferBatchToManagerAndCall",

package/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. */
+      contract: ContractCreationConfigWithOptionalAdditionalAdmins;
+      contractAddress?: undefined;
+    }
+  | {
+      contract?: undefined;
+      /** Premint collection address */
+      contractAddress: Address;
+    };

package/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,
 });
 
@@ -142,21 +150,35 @@ export type PremintSignatureResponse =
  * @returns
  */
 export const encodePostSignatureInput = <T extends PremintConfigVersion>({
-  collection,
+  contract: collection,
+  contractAddress: 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,
 });
+
+export const isPremintConfigV1 = (
+  premintConfigAndVersion: PremintConfigAndVersion,
+): premintConfigAndVersion is PremintConfigWithVersion<PremintConfigVersion.V1> =>
+  premintConfigAndVersion.premintConfigVersion === PremintConfigVersion.V1;
+
+export const isPremintConfigV2 = (
+  premintConfigAndVersion: PremintConfigAndVersion,
+): premintConfigAndVersion is PremintConfigWithVersion<PremintConfigVersion.V2> =>
+  premintConfigAndVersion.premintConfigVersion === PremintConfigVersion.V2;

package/src/premint/premint-api-client.ts

@@ -4,8 +4,7 @@ import {
 } from "../apis/http-api-base";
 import { components, paths } from "../apis/generated/premint-api-types";
 import { ZORA_API_BASE } from "../constants";
-import { NetworkConfig } from "src/apis/chain-constants";
-import { getApiNetworkConfigForChain } from "src/mint/mint-api-client";
+import { getApiNetworkConfigForChain } from "src/mint/subgraph-mint-getter";
 import {
   ContractCreationConfig,
   PremintConfigAndVersion,
@@ -19,6 +18,7 @@ import {
   convertGetPremintApiResponse,
   encodePostSignatureInput,
 } from "./conversions";
+import { ContractCreationConfigOrAddress } from "./contract-types";
 
 type PremintNextUIDGetType =
   paths["/signature/{chain_name}/{collection_address}/next_uid"]["get"];
@@ -29,8 +29,6 @@ export type PremintNextUIDGetResponse =
 
 type SignaturePremintGetType =
   paths["/signature/{chain_name}/{collection_address}/{uid}"]["get"];
-type PremintSignatureGetPathParameters =
-  SignaturePremintGetType["parameters"]["path"];
 export type PremintSignatureGetResponse =
   SignaturePremintGetType["responses"][200]["content"]["application/json"];
 
@@ -49,59 +47,83 @@ const postSignature = async ({
   );
 
 const getNextUID = async ({
-  chain_name,
+  chainId,
   collection_address,
   httpClient: { retries, get } = defaultHttpClient,
-}: PremintNextUIDGetPathParameters & {
+}: Omit<PremintNextUIDGetPathParameters, "chain_name"> & {
+  chainId: number;
   httpClient?: Pick<IHttpClient, "retries" | "get">;
 }): Promise<PremintNextUIDGetResponse> =>
   retries(() =>
     get<PremintNextUIDGetResponse>(
-      `${ZORA_API_BASE}premint/signature/${chain_name}/${collection_address}/next_uid`,
+      `${ZORA_API_BASE}premint/signature/${
+        getApiNetworkConfigForChain(chainId).zoraBackendChainName
+      }/${collection_address}/next_uid`,
     ),
   );
 
-const getSignature = async ({
-  collection_address,
+export const getSignature = async ({
+  collectionAddress,
   uid,
-  chain_name,
+  chainId,
   httpClient: { retries, get } = defaultHttpClient,
-}: PremintSignatureGetPathParameters & {
+}: {
+  collectionAddress: Address;
+  uid: number;
+  chainId: number;
   httpClient?: Pick<IHttpClient, "retries" | "get">;
 }): Promise<
-  PremintSignatureGetResponse & {
-    premint_config_version?: PremintConfigVersion;
-  }
+  {
+    signature: Hex;
+    collection: ContractCreationConfig | undefined;
+    collectionAddress: Address;
+  } & PremintConfigAndVersion
 > => {
+  const chainName = getApiNetworkConfigForChain(chainId).zoraBackendChainName;
   const result = await retries(() =>
     get<PremintSignatureGetResponse>(
-      `${ZORA_API_BASE}premint/signature/${chain_name}/${collection_address}/${uid}`,
+      `${ZORA_API_BASE}premint/signature/${chainName}/${collectionAddress.toLowerCase()}/${uid}`,
     ),
   );
 
-  return result;
+  return convertGetPremintApiResponse(result);
 };
 
-class PremintAPIClient {
+export interface IPremintGetter {
+  getSignature(params: {
+    collectionAddress: Address;
+    uid: number;
+  }): ReturnType<typeof getSignature>;
+}
+
+export interface IPremintAPI {
+  getSignature: IPremintGetter["getSignature"];
+
+  getNextUID(collectionAddress: Address): Promise<number>;
+
+  postSignature<T extends PremintConfigVersion>(
+    params: {
+      signature: Hex;
+    } & PremintConfigWithVersion<T> &
+      ContractCreationConfigOrAddress,
+  ): Promise<PremintSignatureResponse>;
+}
+
+class PremintAPIClient implements IPremintAPI {
+  chainId: number;
   httpClient: IHttpClient;
-  networkConfig: NetworkConfig;
 
   constructor(chainId: number, httpClient?: IHttpClient) {
+    this.chainId = chainId;
     this.httpClient = httpClient || defaultHttpClient;
-    this.networkConfig = getApiNetworkConfigForChain(chainId);
   }
-  postSignature = async <T extends PremintConfigVersion>({
-    collection,
+  postSignature: IPremintAPI["postSignature"] = ({
     signature,
-    ...premintConfigAndVersion
-  }: {
-    collection: ContractCreationConfig;
-    signature: Hex;
-  } & PremintConfigWithVersion<T>): Promise<PremintSignatureResponse> => {
+    ...rest
+  }): Promise<PremintSignatureResponse> => {
     const data = encodePostSignatureInput({
-      collection,
-      ...premintConfigAndVersion,
-      chainId: this.networkConfig.chainId,
+      ...rest,
+      chainId: this.chainId,
       signature,
     });
     return postSignature({
@@ -110,35 +132,25 @@ class PremintAPIClient {
     });
   };
 
-  getNextUID = async (collectionAddress: Address): Promise<number> =>
+  getNextUID: IPremintAPI["getNextUID"] = async (collectionAddress) =>
     (
       await getNextUID({
         collection_address: collectionAddress.toLowerCase(),
-        chain_name: this.networkConfig.zoraBackendChainName,
+        chainId: this.chainId,
         httpClient: this.httpClient,
       })
     ).next_uid;
 
-  getSignature = async ({
+  getSignature: IPremintAPI["getSignature"] = async ({
     collectionAddress,
     uid,
-  }: {
-    collectionAddress: Address;
-    uid: number;
-  }): Promise<
-    {
-      signature: Hex;
-      collection: ContractCreationConfig;
-    } & PremintConfigAndVersion
-  > => {
-    const response = await getSignature({
-      collection_address: collectionAddress.toLowerCase(),
+  }) => {
+    return getSignature({
+      collectionAddress,
       uid,
-      chain_name: this.networkConfig.zoraBackendChainName,
+      chainId: this.chainId,
       httpClient: this.httpClient,
     });
-
-    return convertGetPremintApiResponse(response);
   };
 }