@zoralabs/protocol-sdk 0.5.14 → 0.5.16

package/.turbo/turbo-build.log

@@ -7,9 +7,9 @@ $ tsup
 CLI Cleaning output folder
 CJS Build start
 ESM Build start
-CJS dist/index.cjs     58.27 KB
-CJS dist/index.cjs.map 116.71 KB
-CJS ⚡️ Build success in 115ms
-ESM dist/index.js     52.91 KB
-ESM dist/index.js.map 116.68 KB
-ESM ⚡️ Build success in 117ms
+CJS dist/index.cjs     60.94 KB
+CJS dist/index.cjs.map 127.62 KB
+CJS ⚡️ Build success in 96ms
+ESM dist/index.js     55.49 KB
+ESM dist/index.js.map 127.51 KB
+ESM ⚡️ Build success in 103ms

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @zoralabs/protocol-sdk
 
+## 0.5.16
+
+### Patch Changes
+
+- 12387133: `create1155CreatorClient` requires `chain` to be passed as a default argument instead of a `publicClient`
+- Updated dependencies [7af9c4db]
+  - @zoralabs/protocol-deployments@0.1.12
+
+## 0.5.15
+
+### Patch Changes
+
+- 888168b8: Fix protocol-sdk to point to `isAuthorizedToCreatePremint`
+- 344f452b: Add support for ERC-20 minting on 1155s using ERC20 minters within the function `makePrepareMintTokenParams`.
+
 ## 0.5.14
 
 ### Patch Changes

package/README.md

@@ -9,7 +9,6 @@ Protocol SDK allows developers to create tokens using the Zora Protocol and mint
 - `npm install viem`
 - `npm install `
 
-
 ## Examples
 
 - [Creating a mint from an on-chain contract](#creating-a-mint-from-an-on-chain-contract)
@@ -83,6 +82,44 @@ async function mintNFT({
 }
 ```
 
+### Minting an NFT with an ERC20 minter
+
+If an 1155 token is set to be an ERC20 mint, use the `makePrepareMintTokenParams` the same way as for
+eth based mints. The underlying function should handle preparing arguments for the ERC20 mint.
+
+```ts
+import type { PublicClient } from "viem";
+
+async function mint1155TokenWithERC20Currency(
+  publicClient: PublicClient,
+  minterAddress: Address,
+) {
+  const mintClient = createMintClient({ chain: zora });
+  const exampleCurrency = "0xb6b701878a1f80197dF2c209D0BDd292EA73164D";
+  // nft collection address
+  const targetContract = "0x689bc305456c38656856d12469aed282fbd89fe0";
+  const tokenId = 17;
+  // the NFT token price in WEI value
+  const erc20PricePerToken = 2000000000000000000;
+
+  const tokenParams = await mintClient.makePrepareMintTokenParams({
+    minterAccount: minterAddress,
+    tokenId: tokenId,
+    tokenAddress: targetContract,
+    mintArguments: {
+      mintToAddress: minterAddress,
+      quantityToMint: 1,
+    },
+  });
+
+  const simulationResult = await publicClient.simulateContract(params);
+  const hash = await walletClient.writeContract(simulationResult.request);
+  const receipt = await publicClient.waitForTransactionReceipt({ hash });
+
+  return receipt;
+}
+```
+
 #### Using wagmi
 
 ```tsx
@@ -260,7 +297,10 @@ async function createForFree({
     checkSignature: true,
     // collection info of collection to create
     collection: {
-      contractAdmin: typeof creatorAccount === "string" ? creatorAccount : creatorAccount.address,
+      contractAdmin:
+        typeof creatorAccount === "string"
+          ? creatorAccount
+          : creatorAccount.address,
       contractName: "Testing Contract",
       contractURI:
         "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",

package/dist/anvil.d.ts

@@ -1,8 +1,8 @@
-import { Chain, PublicClient, TestClient, WalletClient } from "viem";
+import { Chain, PublicClient, TestClient, Transport, WalletClient } from "viem";
 export interface AnvilViemClientsTest {
     viemClients: {
         walletClient: WalletClient;
-        publicClient: PublicClient;
+        publicClient: PublicClient<Transport, Chain>;
         testClient: TestClient;
         chain: Chain;
     };
@@ -15,7 +15,7 @@ export type AnvilTestForkSettings = {
 export declare const makeAnvilTest: ({ forkUrl, forkBlockNumber, anvilChainId, }: AnvilTestForkSettings) => import("@vitest/runner/dist/tasks-e594cd24").e<{
     viemClients: {
         walletClient: WalletClient;
-        publicClient: PublicClient;
+        publicClient: PublicClient<Transport, Chain>;
         testClient: TestClient;
         chain: Chain;
     };
@@ -28,7 +28,7 @@ export declare const forkUrls: {
 export declare const anvilTest: import("@vitest/runner/dist/tasks-e594cd24").e<{
     viemClients: {
         walletClient: WalletClient;
-        publicClient: PublicClient;
+        publicClient: PublicClient<Transport, Chain>;
         testClient: TestClient;
         chain: Chain;
     };

package/dist/anvil.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"anvil.d.ts","sourceRoot":"","sources":["../src/anvil.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,KAAK,EACL,YAAY,EACZ,UAAU,EACV,YAAY,EAKb,MAAM,MAAM,CAAC;AAGd,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE;QACX,YAAY,EAAE,YAAY,CAAC;QAC3B,YAAY,EAAE,YAAY,CAAC;QAC3B,UAAU,EAAE,UAAU,CAAC;QACvB,KAAK,EAAE,KAAK,CAAC;KACd,CAAC;CACH;AAUD,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,eAAO,MAAM,aAAa,gDAIvB,qBAAqB;;sBAzBN,YAAY;sBACZ,YAAY;oBACd,UAAU;eACf,KAAK;;EA8EZ,CAAC;AAEL,eAAO,MAAM,QAAQ;;;;CAIpB,CAAC;AAEF,eAAO,MAAM,SAAS;;sBAzFJ,YAAY;sBACZ,YAAY;oBACd,UAAU;eACf,KAAK;;EA0Fd,CAAC"}
+{"version":3,"file":"anvil.d.ts","sourceRoot":"","sources":["../src/anvil.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,KAAK,EACL,YAAY,EACZ,UAAU,EACV,SAAS,EACT,YAAY,EAKb,MAAM,MAAM,CAAC;AAGd,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE;QACX,YAAY,EAAE,YAAY,CAAC;QAE3B,YAAY,EAAE,YAAY,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAC7C,UAAU,EAAE,UAAU,CAAC;QACvB,KAAK,EAAE,KAAK,CAAC;KACd,CAAC;CACH;AAUD,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,eAAO,MAAM,aAAa,gDAIvB,qBAAqB;;sBA1BN,YAAY;sBAEZ,aAAa,SAAS,EAAE,KAAK,CAAC;oBAChC,UAAU;eACf,KAAK;;EA8EZ,CAAC;AAEL,eAAO,MAAM,QAAQ;;;;CAIpB,CAAC;AAEF,eAAO,MAAM,SAAS;;sBA1FJ,YAAY;sBAEZ,aAAa,SAAS,EAAE,KAAK,CAAC;oBAChC,UAAU;eACf,KAAK;;EA0Fd,CAAC"}

package/dist/constants.d.ts

@@ -33,4 +33,5 @@ export declare const zora721Abi: readonly [{
         readonly type: "uint256";
     }];
 }];
+export declare const NFT_SALE_QUERY = "\nfragment SaleStrategy on SalesStrategyConfig {\n  type\n  fixedPrice {\n    address\n    pricePerToken\n    saleEnd\n    saleStart\n    maxTokensPerAddress\n  }\n  erc20Minter {\n    address\n    pricePerToken\n    currency\n    saleEnd\n    saleStart\n    maxTokensPerAddress\n  }\n}\n\nquery ($id: ID!) {\n  zoraCreateToken(id: $id) {\n    id\n    contract {\n      mintFeePerQuantity\n      salesStrategies(where: {type_in: [\"FIXED_PRICE\", \"ERC_20_MINTER\"]}) {\n        ...SaleStrategy\n      }\n    }\n    salesStrategies(where: {type_in: [\"FIXED_PRICE\", \"ERC_20_MINTER\"]}) {\n      ...SaleStrategy\n    }\n  }\n}\n";
 //# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,aAAa,yBAAyB,CAAC;AACpD,eAAO,MAAM,sBAAsB,QAAiC,CAAC;AAMrE,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAEjE;AAED,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGZ,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,aAAa,yBAAyB,CAAC;AACpD,eAAO,MAAM,sBAAsB,QAAiC,CAAC;AAMrE,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAEjE;AAED,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGZ,CAAC;AAEZ,eAAO,MAAM,cAAc,0nBAkC1B,CAAC"}

package/dist/create/1155-create-helper.d.ts

@@ -1,4 +1,5 @@
-import type { Account, Address, Hex, PublicClient, SimulateContractParameters, TransactionReceipt } from "viem";
+import type { Account, Address, Hex, SimulateContractParameters, TransactionReceipt } from "viem";
+import { ClientConfig } from "src/utils";
 type SalesConfigParamsType = {
     pricePerToken?: bigint;
     saleStart?: bigint;
@@ -40,9 +41,7 @@ type CreateNew1155TokenReturn = {
     contractAddress: Address;
     contractExists: boolean;
 };
-export declare function create1155CreatorClient({ publicClient, }: {
-    publicClient: PublicClient;
-}): {
+export declare function create1155CreatorClient(clientConfig: ClientConfig): {
     createNew1155Token: ({ contract, tokenMetadataURI, mintToCreatorCount, salesConfig, maxSupply, account, royaltySettings, createReferral, getAdditionalSetupActions, }: {
         account: Address;
         maxSupply?: number | bigint | undefined;

package/dist/create/1155-create-helper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"1155-create-helper.d.ts","sourceRoot":"","sources":["../../src/create/1155-create-helper.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACV,OAAO,EACP,OAAO,EACP,GAAG,EACH,YAAY,EACZ,0BAA0B,EAC1B,kBAAkB,EACnB,MAAM,MAAM,CAAC;AAWd,KAAK,qBAAqB,GAAG;IAE3B,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,eAAO,MAAM,qBAAqB;;;;;;CAUjC,CAAC;AAKF,KAAK,YAAY,GACb;IACE,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GACD,OAAO,CAAC;AAEZ,KAAK,mBAAmB,GAAG;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,wBAAgB,wBAAwB,CAAC,EACvC,WAAW,EAEX,kBAAkB,EAClB,gBAAgB,EAEhB,uBAAuB,EAEvB,cAAc,EAEd,SAAS,EAET,OAAO,EACP,WAAW,EACX,eAAe,GAChB,EAAE;IACD,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC5B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,GAAG,MAAM,CAAC;IAEpC,OAAO,EAAE,OAAO,CAAC;IACjB,gBAAgB,EAAE,MAAM,CAAC;IACzB,uBAAuB,EAAE,OAAO,CAAC;IACjC,WAAW,EAAE,qBAAqB,CAAC;IACnC,eAAe,CAAC,EAAE,mBAAmB,CAAC;CACvC,mBA+EA;AAED,eAAO,MAAM,2BAA2B,YAC7B,kBAAkB,KAC1B,MAAM,GAAG,SAaX,CAAC;AA4CF,KAAK,wBAAwB,GAAG;IAC9B,OAAO,EAAE,0BAA0B,CACjC,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,OAAO,GAAG,OAAO,CAClB,CAAC;IACF,iBAAiB,EAAE,GAAG,EAAE,CAAC;IACzB,eAAe,EAAE,OAAO,CAAC;IACzB,cAAc,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF,wBAAgB,uBAAuB,CAAC,EACtC,YAAY,GACb,EAAE;IACD,YAAY,EAAE,YAAY,CAAC;CAC5B;;iBAYY,OAAO;;;;kBAIN,YAAY;0BACJ,MAAM;;;;4CAIW;YACjC,OAAO,EAAE,MAAM,CAAC;YAChB,eAAe,EAAE,OAAO,CAAC;SAC1B,KAAK,GAAG,EAAE;UACT,QAAQ,wBAAwB,CAAC;EA2FtC"}
+{"version":3,"file":"1155-create-helper.d.ts","sourceRoot":"","sources":["../../src/create/1155-create-helper.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACV,OAAO,EACP,OAAO,EACP,GAAG,EACH,0BAA0B,EAC1B,kBAAkB,EACnB,MAAM,MAAM,CAAC;AAGd,OAAO,EAEL,YAAY,EAGb,MAAM,WAAW,CAAC;AAQnB,KAAK,qBAAqB,GAAG;IAE3B,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,eAAO,MAAM,qBAAqB;;;;;;CAUjC,CAAC;AAKF,KAAK,YAAY,GACb;IACE,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GACD,OAAO,CAAC;AAEZ,KAAK,mBAAmB,GAAG;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,wBAAgB,wBAAwB,CAAC,EACvC,WAAW,EAEX,kBAAkB,EAClB,gBAAgB,EAEhB,uBAAuB,EAEvB,cAAc,EAEd,SAAS,EAET,OAAO,EACP,WAAW,EACX,eAAe,GAChB,EAAE;IACD,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC5B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,GAAG,MAAM,CAAC;IAEpC,OAAO,EAAE,OAAO,CAAC;IACjB,gBAAgB,EAAE,MAAM,CAAC;IACzB,uBAAuB,EAAE,OAAO,CAAC;IACjC,WAAW,EAAE,qBAAqB,CAAC;IACnC,eAAe,CAAC,EAAE,mBAAmB,CAAC;CACvC,mBA+EA;AAED,eAAO,MAAM,2BAA2B,YAC7B,kBAAkB,KAC1B,MAAM,GAAG,SAaX,CAAC;AA4CF,KAAK,wBAAwB,GAAG;IAC9B,OAAO,EAAE,0BAA0B,CACjC,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,OAAO,GAAG,OAAO,CAClB,CAAC;IACF,iBAAiB,EAAE,GAAG,EAAE,CAAC;IACzB,eAAe,EAAE,OAAO,CAAC;IACzB,cAAc,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF,wBAAgB,uBAAuB,CAAC,YAAY,EAAE,YAAY;;iBAarD,OAAO;;;;kBAIN,YAAY;0BACJ,MAAM;;;;4CAIW;YACjC,OAAO,EAAE,MAAM,CAAC;YAChB,eAAe,EAAE,OAAO,CAAC;SAC1B,KAAK,GAAG,EAAE;UACT,QAAQ,wBAAwB,CAAC;EA2FtC"}