@zoralabs/protocol-sdk 0.5.15 → 0.5.17

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

@@ -1,7 +1,8 @@
-import { Address, Chain, PublicClient, Account, SimulateContractParameters } from "viem";
+import { Address, Chain, Account, SimulateContractParameters } from "viem";
 import { IHttpClient } from "src/apis/http-api-base";
 import { GenericTokenIdTypes } from "src/types";
 import { MintAPIClient, SalesConfigAndTokenInfo, SaleType } from "./mint-api-client";
+import { ClientConfig, PublicClient } from "src/utils";
 declare class MintError extends Error {
 }
 declare class MintInactiveError extends Error {
@@ -11,29 +12,37 @@ export declare const Errors: {
     MintInactiveError: typeof MintInactiveError;
 };
 type MintArguments = {
+    /** Quantity of tokens to mint */
     quantityToMint: number;
+    /** Comment to add to the mint */
     mintComment?: string;
+    /** Optional address to receive the mint referral reward */
     mintReferral?: Address;
+    /** Address to receive the minted tokens */
     mintToAddress: Address;
     saleType?: SaleType;
 };
+type MintTokenParams = {
+    /** Account to execute the mint */
+    minterAccount: Address | Account;
+    /** Contract address of token to mint */
+    tokenAddress: Address;
+    /** Id of token to mint */
+    tokenId?: GenericTokenIdTypes;
+    /** Mint settings */
+    mintArguments: MintArguments;
+};
 declare class MintClient {
     readonly apiClient: MintAPIClient;
     readonly publicClient: PublicClient;
-    constructor(chain: Chain, publicClient?: PublicClient, httpClient?: IHttpClient);
+    constructor(chain: Chain, publicClient: PublicClient, httpClient: IHttpClient);
     /**
      * Returns the parameters needed to prepare a transaction mint a token.
-     * @param param0.minterAccount The account that will mint the token.
-     * @param param0.mintable The mintable token to mint.
-     * @param param0.mintArguments The arguments for the mint (mint recipient, comment, mint referral, quantity to mint)
-     * @returns
+     *
+     * @param parameters - Parameters for collecting the token {@link MintTokenParams}
+     * @returns Parameters for simulating/executing the mint transaction
      */
-    makePrepareMintTokenParams({ ...rest }: {
-        minterAccount: Address | Account;
-        tokenAddress: Address;
-        tokenId?: GenericTokenIdTypes;
-        mintArguments: MintArguments;
-    }): Promise<SimulateContractParameters<any, any, any, any, any, `0x${string}` | Account>>;
+    makePrepareMintTokenParams(parameters: MintTokenParams): Promise<SimulateContractParameters<any, any, any, any, any, `0x${string}` | Account>>;
 }
 /**
  * Creates a new MintClient.
@@ -42,11 +51,7 @@ declare class MintClient {
  * @param param0.httpClient Optional http client to override post, get, and retry methods
  * @returns
  */
-export declare function createMintClient({ chain, publicClient, httpClient, }: {
-    chain: Chain;
-    publicClient?: PublicClient;
-    httpClient?: IHttpClient;
-}): MintClient;
+export declare function createMintClient(clientConfig: ClientConfig): MintClient;
 export type TMintClient = ReturnType<typeof createMintClient>;
 export type MintCosts = {
     mintFee: bigint;

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

@@ -1 +1 @@
-{"version":3,"file":"mint-client.d.ts","sourceRoot":"","sources":["../../src/mint/mint-client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,KAAK,EACL,YAAY,EAMZ,OAAO,EACP,0BAA0B,EAC3B,MAAM,MAAM,CAAC;AAOd,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAEhD,OAAO,EACL,aAAa,EACb,uBAAuB,EACvB,QAAQ,EACT,MAAM,mBAAmB,CAAC;AAE3B,cAAM,SAAU,SAAQ,KAAK;CAAG;AAChC,cAAM,iBAAkB,SAAQ,KAAK;CAAG;AAExC,eAAO,MAAM,MAAM;;;CAGlB,CAAC;AAEF,KAAK,aAAa,GAAG;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,aAAa,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC;AAEF,cAAM,UAAU;IACd,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;IAClC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;gBAGlC,KAAK,EAAE,KAAK,EACZ,YAAY,CAAC,EAAE,YAAY,EAC3B,UAAU,CAAC,EAAE,WAAW;IAO1B;;;;;;OAMG;IACG,0BAA0B,CAAC,EAC/B,GAAG,IAAI,EACR,EAAE;QACD,aAAa,EAAE,OAAO,GAAG,OAAO,CAAC;QACjC,YAAY,EAAE,OAAO,CAAC;QACtB,OAAO,CAAC,EAAE,mBAAmB,CAAC;QAC9B,aAAa,EAAE,aAAa,CAAC;KAC9B;CAOF;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,EAC/B,KAAK,EACL,YAAY,EACZ,UAAU,GACX,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;IACb,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,UAAU,CAAC,EAAE,WAAW,CAAC;CAC1B,cAEA;AAED,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC;AA0E9D,MAAM,MAAM,SAAS,GAAG;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,wBAAgB,YAAY,CAAC,EAC3B,uBAAuB,EACvB,cAAc,GACf,EAAE;IACD,uBAAuB,EAAE,uBAAuB,CAAC;IACjD,cAAc,EAAE,MAAM,CAAC;CACxB,GAAG,SAAS,CAWZ"}
+{"version":3,"file":"mint-client.d.ts","sourceRoot":"","sources":["../../src/mint/mint-client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,KAAK,EAIL,OAAO,EACP,0BAA0B,EAC3B,MAAM,MAAM,CAAC;AAOd,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EACL,aAAa,EACb,uBAAuB,EACvB,QAAQ,EACT,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAEL,YAAY,EAEZ,YAAY,EACb,MAAM,WAAW,CAAC;AAEnB,cAAM,SAAU,SAAQ,KAAK;CAAG;AAChC,cAAM,iBAAkB,SAAQ,KAAK;CAAG;AAExC,eAAO,MAAM,MAAM;;;CAGlB,CAAC;AAEF,KAAK,aAAa,GAAG;IACnB,iCAAiC;IACjC,cAAc,EAAE,MAAM,CAAC;IACvB,iCAAiC;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2DAA2D;IAC3D,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,2CAA2C;IAC3C,aAAa,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,kCAAkC;IAClC,aAAa,EAAE,OAAO,GAAG,OAAO,CAAC;IACjC,wCAAwC;IACxC,YAAY,EAAE,OAAO,CAAC;IACtB,0BAA0B;IAC1B,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,oBAAoB;IACpB,aAAa,EAAE,aAAa,CAAC;CAC9B,CAAC;AAEF,cAAM,UAAU;IACd,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;IAClC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;gBAGlC,KAAK,EAAE,KAAK,EACZ,YAAY,EAAE,YAAY,EAC1B,UAAU,EAAE,WAAW;IAMzB;;;;;OAKG;IACG,0BAA0B,CAAC,UAAU,EAAE,eAAe;CAO7D;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,YAAY,cAG1D;AAED,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC;AA0E9D,MAAM,MAAM,SAAS,GAAG;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,wBAAgB,YAAY,CAAC,EAC3B,uBAAuB,EACvB,cAAc,GACf,EAAE;IACD,uBAAuB,EAAE,uBAAuB,CAAC;IACjD,cAAc,EAAE,MAAM,CAAC;CACxB,GAAG,SAAS,CAWZ"}