@zoralabs/protocol-sdk 0.8.0 → 0.9.0

package/src/mint/types.ts

@@ -3,6 +3,7 @@ import {
   GenericTokenIdTypes,
   SimulateContractParametersWithAccount,
 } from "src/types";
+import { AllowListEntry } from "src/allow-list/types";
 
 export type MintParameters<MintType> = {
   /** Type of the collection to be minted. */
@@ -25,7 +26,7 @@ export type PremintMintParameters = MintParameters<"premint"> & {
   uid: number;
 };
 
-export type MintType = "1155" | "721" | "premint";
+export type MintType = "1155" | "721" | "allowlist" | "premint";
 
 export type MintTypes =
   | Erc1155MintParameters
@@ -63,6 +64,8 @@ export type MintParametersBase = {
   mintRecipient?: Address;
   /** If this is a premint, the address to get the first minter reward */
   firstMinter?: Address;
+  /** If this is an allow list mint, the info for the allow list entry */
+  allowListEntry?: AllowListEntry;
 };
 
 export type MakeMintParametersArgumentsBase = MintParametersBase & {
@@ -99,44 +102,81 @@ export type GetMintCostsParameters = {
   quantityMinted: number | bigint;
 } & MintTypes;
 
-export type SaleType = "fixedPrice" | "erc20" | "premint";
+export type SaleType =
+  | "fixedPrice"
+  | "erc20"
+  | "allowlist"
+  | "premint"
+  | "timed";
 
 type SaleStrategy<T extends SaleType> = {
   saleType: T;
+  mintFeePerQuantity: bigint;
+};
+
+type PricedSaleStrategy = {
   pricePerToken: bigint;
   maxTokensPerAddress: bigint;
 };
 
-type FixedPriceSaleStrategy = SaleStrategy<"fixedPrice"> & {
-  address: Address;
+export type StartAndEnd = {
   saleStart: string;
   saleEnd: string;
 };
 
-type ERC20SaleStrategy = SaleStrategy<"erc20"> & {
+type FixedPriceSaleStrategy = SaleStrategy<"fixedPrice"> &
+  PricedSaleStrategy &
+  StartAndEnd & {
+    address: Address;
+  };
+
+type ERC20SaleStrategy = SaleStrategy<"erc20"> &
+  PricedSaleStrategy &
+  StartAndEnd & {
+    address: Address;
+    currency: Address;
+  };
+
+type AllowListSaleStrategy = SaleStrategy<"allowlist"> & {
   address: Address;
   saleStart: string;
   saleEnd: string;
-  currency: Address;
+  merkleRoot: string;
 };
 
-type PremintSaleStrategy = SaleStrategy<"premint"> & {
-  duration: bigint;
-};
+type ZoraTimedSaleStrategy = SaleStrategy<"timed"> & {
+  mintFee: bigint;
+  erc20Z: Address;
+  pool: Address;
+  secondaryActivated: boolean;
+  address: Address;
+} & StartAndEnd;
+
+type PremintSaleStrategy = SaleStrategy<"premint"> &
+  PricedSaleStrategy & {
+    duration: bigint;
+  };
 
-export type SaleStrategies =
+export type OnchainSalesStrategies =
   | FixedPriceSaleStrategy
   | ERC20SaleStrategy
-  | PremintSaleStrategy;
+  | AllowListSaleStrategy
+  | ZoraTimedSaleStrategy;
 
-export type OnchainSalesStrategies = FixedPriceSaleStrategy | ERC20SaleStrategy;
+export type SaleStrategies = OnchainSalesStrategies | PremintSaleStrategy;
 
 export function isErc20SaleStrategy(
-  salesConfig: FixedPriceSaleStrategy | ERC20SaleStrategy | PremintSaleStrategy,
+  salesConfig: SaleStrategies,
 ): salesConfig is ERC20SaleStrategy {
   return salesConfig.saleType === "erc20";
 }
 
+export function isTimedSaleStrategy(
+  salesConfig: SaleStrategies,
+): salesConfig is ZoraTimedSaleStrategy {
+  return salesConfig.saleType === "timed";
+}
+
 export type ContractInfo = {
   /** Address of the contract */
   address: Address;
@@ -151,8 +191,6 @@ export type MintableBase = {
   contract: ContractInfo;
   /** Token metadata URI */
   tokenURI: string;
-  /** Price in eth to mint 1 item */
-  mintFeePerQuantity: bigint;
   /** Creator of the mintable item */
   creator: Address;
   /** Maximum total number of items that can be minted */
@@ -173,7 +211,7 @@ export type PremintMintable = MintableBase & {
 };
 
 export type OnchainSalesConfigAndTokenInfo = {
-  salesConfig: FixedPriceSaleStrategy | ERC20SaleStrategy;
+  salesConfig?: OnchainSalesStrategies;
 } & OnchainMintable;
 
 export type PremintSalesConfigAndTokenInfo = {
@@ -189,6 +227,7 @@ export interface IOnchainMintGetter {
     tokenAddress: Address;
     tokenId?: GenericTokenIdTypes;
     preferredSaleType?: SaleType;
+    blockTime: bigint;
   }): Promise<OnchainSalesConfigAndTokenInfo>;
 
   getContractMintable(params: {

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

@@ -29,7 +29,7 @@ describe("ZoraCreator1155Premint", () => {
       const premintApiClient = new PremintAPIClient(chain.id);
 
       premintApiClient.get = vi
-        .fn<any, ReturnType<typeof premintApiClient.get>>()
+        .fn<typeof premintApiClient.get>()
         .mockResolvedValue({
           collection: {
             contractAdmin: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
@@ -120,11 +120,12 @@ describe("ZoraCreator1155Premint - v2 signatures", () => {
       const premintApiClient = new PremintAPIClient(chain.id);
 
       premintApiClient.getNextUID = vi
-        .fn<any, ReturnType<typeof premintApiClient.getNextUID>>()
+        .fn<typeof premintApiClient.getNextUID>()
         .mockResolvedValue(3);
       premintApiClient.postSignature = vi
-        .fn<Parameters<typeof premintApiClient.postSignature>>()
-        .mockResolvedValue({ ok: true });
+        .fn<typeof premintApiClient.postSignature>()
+        // @ts-ignore
+        .mockResolvedValue({});
 
       const creatorClient = createCreatorClient({
         chainId: chain.id,
@@ -242,7 +243,7 @@ describe("ZoraCreator1155Premint - v2 signatures", () => {
       });
 
       premintApiClient.get = vi
-        .fn<any, ReturnType<typeof premintApiClient.get>>()
+        .fn<typeof premintApiClient.get>()
         .mockResolvedValue({
           collection,
           collectionAddress,

package/src/types.ts

@@ -7,7 +7,7 @@ import {
 
 export type GenericTokenIdTypes = number | bigint | string;
 
-export type IPublicClient = Pick<PublicClient, "readContract">;
+export type IPublicClient = Pick<PublicClient, "readContract" | "getBlock">;
 
 export type SimulateContractParametersWithAccount = SimulateContractParameters<
   any,

package/src/utils.ts

@@ -1,12 +1,11 @@
 import { Account, Address, PublicClient as BasePublicClient } from "viem";
-import { IHttpClient } from "./apis/http-api-base";
 import { SimulateContractParametersWithAccount } from "./types";
 
 export const makeContractParameters = (
   args: SimulateContractParametersWithAccount,
 ) => args;
 
-export type PublicClient = Pick<BasePublicClient, "readContract">;
+export type PublicClient = Pick<BasePublicClient, "readContract" | "getBlock">;
 
 export type ClientConfig = {
   /** The chain that the client is to run on. */
@@ -38,26 +37,3 @@ export function mintRecipientOrAccount({
 export type Concrete<Type> = {
   [Property in keyof Type]-?: Type[Property];
 };
-
-export async function querySubgraphWithRetries({
-  httpClient,
-  subgraphUrl,
-  query,
-  variables,
-}: {
-  httpClient: IHttpClient;
-  subgraphUrl: string;
-  query: string;
-  variables: any;
-}) {
-  const { retries, post } = httpClient;
-
-  const result = await retries(async () => {
-    return await post<any>(subgraphUrl, {
-      query,
-      variables,
-    });
-  });
-
-  return result?.data;
-}