@zoralabs/protocol-sdk 0.5.17 → 0.6.0

package/src/premint/preminter.ts

@@ -36,6 +36,8 @@ import {
   ContractCreationConfigOrAddress,
   ContractCreationConfigWithOptionalAdditionalAdmins,
 } from "./contract-types";
+import { IPremintGetter } from "./premint-api-client";
+import { isPremintConfigV1, isPremintConfigV2 } from "./conversions";
 
 export const getPremintExecutorAddress = () =>
   zoraCreator1155PremintExecutorImplAddress[999] as Address;
@@ -271,8 +273,8 @@ export const supportsPremintVersion = async ({
 
 export async function getPremintCollectionAddress({
   publicClient,
-  collection,
-  collectionAddress,
+  contract: collection,
+  contractAddress: collectionAddress,
 }: {
   publicClient: PublicClient;
 } & ContractCreationConfigOrAddress): Promise<Address> {
@@ -355,26 +357,74 @@ export async function getPremintMintFee({
   }
 }
 
+type GetMintCostsParams = {
+  tokenContract: Address;
+  tokenPrice: bigint;
+  quantityToMint: bigint | number;
+  publicClient: PublicClient;
+};
+
 export async function getPremintMintCosts({
   publicClient,
   tokenContract,
   tokenPrice,
   quantityToMint,
-}: {
-  tokenContract: Address;
-  tokenPrice: bigint;
-  quantityToMint: bigint;
-  publicClient: PublicClient;
-}): Promise<MintCosts> {
+}: GetMintCostsParams): Promise<MintCosts> {
   const mintFee = await getPremintMintFee({ tokenContract, publicClient });
 
+  const quantityToMintBigInt = BigInt(quantityToMint);
+
   return {
-    mintFee: mintFee * quantityToMint,
-    tokenPurchaseCost: tokenPrice * quantityToMint,
-    totalCost: (mintFee + tokenPrice) * quantityToMint,
+    mintFee: mintFee * quantityToMintBigInt,
+    totalPurchaseCost: tokenPrice * quantityToMintBigInt,
+    totalCostEth: (mintFee + tokenPrice) * quantityToMintBigInt,
   };
 }
 
+export async function getPremintPricePerToken({
+  collection,
+  uid,
+  premintGetter,
+}: {
+  collection: Address;
+  uid: number;
+  premintGetter: IPremintGetter;
+}) {
+  const premintConfigWithVersion = await premintGetter.getSignature({
+    collectionAddress: collection,
+    uid,
+  });
+
+  if (
+    isPremintConfigV1(premintConfigWithVersion) ||
+    isPremintConfigV2(premintConfigWithVersion)
+  ) {
+    return premintConfigWithVersion.premintConfig.tokenConfig.pricePerToken;
+  }
+
+  throw new Error("Premint version not supported to get price");
+}
+
+export async function getPremintMintCostsWithUnknownTokenPrice({
+  premintGetter,
+  uid,
+  ...rest
+}: Omit<GetMintCostsParams, "tokenPrice"> & {
+  premintGetter: IPremintGetter;
+  uid: number;
+}) {
+  const pricePerToken = await getPremintPricePerToken({
+    uid,
+    premintGetter,
+    collection: rest.tokenContract,
+  });
+
+  return await getPremintMintCosts({
+    ...rest,
+    tokenPrice: pricePerToken,
+  });
+}
+
 export function makeMintRewardsRecipient({
   mintReferral = zeroAddress,
   platformReferral = zeroAddress,
@@ -416,13 +466,13 @@ export const toContractCreationConfigOrAddress = ({
 }) => {
   if (typeof collection !== "undefined") {
     return {
-      collection,
+      contract: collection,
     };
   }
 
   if (typeof collectionAddress !== "undefined") {
     return {
-      collectionAddress,
+      contractAddress: collectionAddress,
     };
   }
 

package/src/sdk.ts

@@ -0,0 +1,98 @@
+import {
+  PremintClient,
+  getDataFromPremintReceipt,
+} from "./premint/premint-client";
+import { Create1155Client } from "./create/1155-create-helper";
+import { MintClient } from "./mint/mint-client";
+import { ClientConfig } from "./utils";
+import { IPremintAPI, PremintAPIClient } from "./premint/premint-api-client";
+import { SubgraphMintGetter } from "./mint/subgraph-mint-getter";
+import { IMintGetter } from "./mint/types";
+
+export type CreatorClient = {
+  createPremint: PremintClient["createPremint"];
+  updatePremint: PremintClient["updatePremint"];
+  deletePremint: PremintClient["deletePremint"];
+  create1155: Create1155Client["createNew1155Token"];
+};
+
+export type CollectorClient = {
+  getPremint: PremintClient["getPremint"];
+  getCollectDataFromPremintReceipt: PremintClient["getDataFromPremintReceipt"];
+  mint: MintClient["mint"];
+  getMintCosts: MintClient["getMintCosts"];
+};
+
+export type CreatorClientConfig = ClientConfig & {
+  /** API for submitting and getting premints.  Defaults to the Zora Premint API */
+  premintApi?: IPremintAPI;
+};
+
+/**
+ * Builds the sdk for creating/managing 1155 contracts and tokens
+ *
+ * @param clientConfig - Configuration for the client {@link CreatorClientConfig}
+ * @returns CreatorClient {@link CreatorClient}
+ * */
+export function createCreatorClient(
+  clientConfig: CreatorClientConfig,
+): CreatorClient {
+  const premintClient = new PremintClient({
+    chainId: clientConfig.chainId,
+    publicClient: clientConfig.publicClient,
+    premintApi:
+      clientConfig.premintApi || new PremintAPIClient(clientConfig.chainId),
+  });
+
+  const create1155CreatorClient = new Create1155Client({
+    chainId: clientConfig.chainId,
+    publicClient: clientConfig.publicClient,
+  });
+
+  return {
+    createPremint: (p) => premintClient.createPremint(p),
+    updatePremint: (p) => premintClient.updatePremint(p),
+    deletePremint: (p) => premintClient.deletePremint(p),
+    create1155: (p) => create1155CreatorClient.createNew1155Token(p),
+  };
+}
+
+export type CollectorClientConfig = ClientConfig & {
+  /** API for getting premints.  Defaults to the Zora Premint API */
+  premintGetter?: IPremintAPI;
+  /** API for getting onchain mints.  Defaults to the Zora Creator Subgraph */
+  mintGetter?: IMintGetter;
+};
+
+/**
+ * Builds the sdk for collecting Premints, 1155, and 721 tokens.
+ *
+ * @param clientConfig - Configuration for the client {@link CollectorClientConfig}
+ * @returns CollectorClient {@link CollectorClient}
+ */
+export function createCollectorClient(
+  params: CollectorClientConfig,
+): CollectorClient {
+  const premintGetterToUse =
+    params.premintGetter || new PremintAPIClient(params.chainId);
+  const mintGetterToUse =
+    params.mintGetter || new SubgraphMintGetter(params.chainId);
+  const mintClient = new MintClient({
+    chainId: params.chainId,
+    publicClient: params.publicClient,
+    premintGetter: premintGetterToUse,
+    mintGetter: mintGetterToUse,
+  });
+
+  return {
+    getPremint: (p) =>
+      premintGetterToUse.getSignature({
+        collectionAddress: p.address,
+        uid: p.uid,
+      }),
+    getCollectDataFromPremintReceipt: (p) =>
+      getDataFromPremintReceipt(p, params.chainId),
+    mint: (p) => mintClient.mint(p),
+    getMintCosts: (p) => mintClient.getMintCosts(p),
+  };
+}

package/src/utils.ts

@@ -7,23 +7,14 @@ import {
   ContractFunctionName,
   PublicClient as BasePublicClient,
   SimulateContractParameters,
-  Transport,
-  createPublicClient,
-  http,
+  AbiStateMutability,
 } from "viem";
-import {
-  IHttpClient,
-  httpClient as defaultHttpClient,
-} from "./apis/http-api-base";
 
-export const makeSimulateContractParamaters = <
+export const makeContractParameters = <
   const abi extends Abi | readonly unknown[],
-  functionName extends ContractFunctionName<abi, "nonpayable" | "payable">,
-  args extends ContractFunctionArgs<
-    abi,
-    "nonpayable" | "payable",
-    functionName
-  >,
+  stateMutabiliy extends AbiStateMutability,
+  functionName extends ContractFunctionName<abi, stateMutabiliy>,
+  args extends ContractFunctionArgs<abi, stateMutabiliy, functionName>,
   chainOverride extends Chain | undefined,
   accountOverride extends Account | Address | undefined = undefined,
 >(
@@ -37,19 +28,35 @@ export const makeSimulateContractParamaters = <
   >,
 ) => args;
 
-export type PublicClient = BasePublicClient<Transport, Chain>;
+export type PublicClient = Pick<BasePublicClient, "readContract">;
 
 export type ClientConfig = {
-  chain: Chain;
-  publicClient?: PublicClient;
-  httpClient?: IHttpClient;
+  /** The chain that the client is to run on. */
+  chainId: number;
+  /** Optional public client for the chain.  If not provide, it is created. */
+  publicClient: PublicClient;
 };
 
-export function setupClient({ chain, httpClient, publicClient }: ClientConfig) {
+export function setupClient({ chainId, publicClient }: ClientConfig) {
   return {
-    chain,
-    httpClient: httpClient || defaultHttpClient,
-    publicClient:
-      publicClient || createPublicClient({ chain, transport: http() }),
+    chainId,
+    publicClient,
   };
 }
+
+export function mintRecipientOrAccount({
+  mintRecipient,
+  minterAccount,
+}: {
+  mintRecipient?: Address;
+  minterAccount: Address | Account;
+}): Address {
+  return (
+    mintRecipient ||
+    (typeof minterAccount === "string" ? minterAccount : minterAccount.address)
+  );
+}
+
+export type Concrete<Type> = {
+  [Property in keyof Type]-?: Type[Property];
+};

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

@@ -40,7 +40,7 @@ tests.forEach(({ anvilTest, chain }) => {
             const [creatorAccount, createReferralAccount, minterAccount] =
               await walletClient.getAddresses();
             const premintClient = createPremintClient({
-              chain,
+              chainId: chain,
               publicClient,
             });
 
@@ -49,7 +49,7 @@ tests.forEach(({ anvilTest, chain }) => {
                 walletClient,
                 payoutRecipient: creatorAccount!,
                 checkSignature: true,
-                collection: {
+                contract: {
                   contractAdmin: creatorAccount!,
                   contractName: "Testing Contract Premint V2",
                   contractURI:
@@ -57,7 +57,7 @@ tests.forEach(({ anvilTest, chain }) => {
                   additionalAdmins: [],
                 },
                 premintConfigVersion: PremintConfigVersion.V2,
-                tokenCreationConfig: {
+                token: {
                   tokenURI:
                     "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2f",
                   createReferral: createReferralAccount!,
@@ -78,7 +78,7 @@ tests.forEach(({ anvilTest, chain }) => {
 
             await testClient.setBalance({
               address: minterAccount!,
-              value: mintCosts.totalCost,
+              value: mintCosts.totalCostEth,
             });
 
             // if simulation succeeds, mint will succeed
@@ -97,7 +97,7 @@ tests.forEach(({ anvilTest, chain }) => {
             const [creatorAccount, minterAccount] =
               await walletClient.getAddresses();
             const premintClient = createPremintClient({
-              chain,
+              chainId: chain,
               publicClient,
             });
 
@@ -106,7 +106,7 @@ tests.forEach(({ anvilTest, chain }) => {
                 walletClient,
                 payoutRecipient: creatorAccount!,
                 checkSignature: true,
-                collection: {
+                contract: {
                   contractAdmin: creatorAccount!,
                   contractName: `Testing Contract Premint V1 ${publicClient.chain?.name}`,
                   contractURI:
@@ -114,7 +114,7 @@ tests.forEach(({ anvilTest, chain }) => {
                   additionalAdmins: [],
                 },
                 premintConfigVersion: PremintConfigVersion.V1,
-                tokenCreationConfig: {
+                token: {
                   tokenURI:
                     "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
                 },
@@ -134,7 +134,7 @@ tests.forEach(({ anvilTest, chain }) => {
 
             await testClient.setBalance({
               address: minterAccount!,
-              value: mintCosts.totalCost,
+              value: mintCosts.totalCostEth,
             });
 
             // if simulation succeeds, mint will succeed

package/dist/mint/mint-api-client.d.ts

@@ -1,35 +0,0 @@
-import { Address } from "viem";
-import { IHttpClient } from "../apis/http-api-base";
-import { NetworkConfig } from "src/apis/chain-constants";
-import { GenericTokenIdTypes } from "src/types";
-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 type SalesConfigAndTokenInfo = {
-    salesConfig: SaleStrategies;
-    mintFeePerQuantity: bigint;
-};
-export declare const getApiNetworkConfigForChain: (chainId: number) => NetworkConfig;
-export declare class MintAPIClient {
-    httpClient: IHttpClient;
-    networkConfig: NetworkConfig;
-    constructor(chainId: number, httpClient?: IHttpClient);
-    getSalesConfigAndTokenInfo({ tokenAddress, tokenId, saleType, }: {
-        tokenAddress: Address;
-        tokenId?: GenericTokenIdTypes;
-        saleType?: SaleType;
-    }): Promise<SalesConfigAndTokenInfo>;
-}
-export {};
-//# sourceMappingURL=mint-api-client.d.ts.map

package/dist/mint/mint-api-client.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"mint-api-client.d.ts","sourceRoot":"","sources":["../../src/mint/mint-api-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,EAEL,WAAW,EACZ,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,aAAa,EAAwB,MAAM,0BAA0B,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAGhD,MAAM,MAAM,QAAQ,GAAG,YAAY,GAAG,OAAO,CAAC;AAiC9C,KAAK,YAAY,CAAC,CAAC,SAAS,QAAQ,IAAI;IACtC,QAAQ,EAAE,CAAC,CAAC;IACZ,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF,KAAK,sBAAsB,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC;AAEzD,KAAK,iBAAiB,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG;IAC/C,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,KAAK,cAAc,GAAG,sBAAsB,GAAG,iBAAiB,CAAC;AAEjE,MAAM,MAAM,uBAAuB,GAAG;IACpC,WAAW,EAAE,cAAc,CAAC;IAC5B,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,eAAO,MAAM,2BAA2B,YAAa,MAAM,KAAG,aAK7D,CAAC;AAEF,qBAAa,aAAa;IACxB,UAAU,EAAE,WAAW,CAAC;IACxB,aAAa,EAAE,aAAa,CAAC;gBAEjB,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,WAAW;IAK/C,0BAA0B,CAAC,EAC/B,YAAY,EACZ,OAAO,EACP,QAAQ,GACT,EAAE;QACD,YAAY,EAAE,OAAO,CAAC;QACtB,OAAO,CAAC,EAAE,mBAAmB,CAAC;QAC9B,QAAQ,CAAC,EAAE,QAAQ,CAAC;KACrB,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAwFrC"}