@zoralabs/protocol-sdk 0.2.0 → 0.3.1

package/.turbo/turbo-build.log

@@ -7,9 +7,9 @@ $ tsup
 CLI Cleaning output folder
 CJS Build start
 ESM Build start
-CJS dist/index.cjs     31.18 KB
-CJS dist/index.cjs.map 56.54 KB
-CJS ⚡️ Build success in 21ms
-ESM dist/index.js     28.64 KB
-ESM dist/index.js.map 56.31 KB
-ESM ⚡️ Build success in 22ms
+CJS dist/index.cjs     35.89 KB
+CJS dist/index.cjs.map 65.52 KB
+CJS ⚡️ Build success in 25ms
+ESM dist/index.js     33.30 KB
+ESM dist/index.js.map 65.40 KB
+ESM ⚡️ Build success in 24ms

package/CHANGELOG.md

@@ -1,4 +1,22 @@
-# @zoralabs/premint-sdk
+# @zoralabs/protocol-sdk
+
+## 0.3.1
+
+### Patch Changes
+
+- 92da3ed: Exporting mint client
+- Updated dependencies [293e2c0]
+  - @zoralabs/protocol-deployments@0.0.5
+
+## 0.3.0
+
+### Minor Changes
+
+- 40e0b32:
+  - rename premint-sdk to protocol-sdk
+  - added minting sdk, usable with `createMintClient`
+  - added 1155 creation sdk, usable with `create1155CreatorClient`
+  - premint sdk is now useable with `createPremintClient`
 
 ## 0.1.1
 

package/README.md

@@ -12,7 +12,7 @@ Protocol SDK allows users to manage zora mints and collects.
 ### Creating a mint from an on-chain contract:
 
 ```ts
-import { MintAPI } from "@zoralabs/protocol-sdk";
+import { createMintClient } from "@zoralabs/protocol-sdk";
 import type { Address, WalletClient } from "viem";
 
 async function mintNFT(
@@ -20,7 +20,7 @@ async function mintNFT(
   address: Address,
   tokenId: bigint,
 ) {
-  const mintAPI = new MintAPI(walletClient.chain);
+  const mintAPI = createMintClient({ chain: walletClient.chain });
   await mintAPI.mintNFT({
     walletClient,
     address,
@@ -33,6 +33,40 @@ async function mintNFT(
 }
 ```
 
+### Creating an 1155 contract:
+
+If an object with {name, uri} is passed in to this helper, it uses the creatorAccount and those values to either 1) create or 2) mint to that existing contract.
+
+If you wish to mint on an existing contract, pass that contract in the contract field. The return value is the prepared transaction that you can use viem or wagmi to send.
+
+```ts
+import type { PublicClient } from "viem";
+import { create1155CreatorClient } from "@zoralabs/protocol-sdk";
+
+export async function createContract({
+  publicClient,
+  walletClient,
+}: {
+  publicClient: PublicClient;
+  walletClient: WalletClient;
+}) {
+  const creatorClient = create1155CreatorClient({ publicClient });
+  const { request } = await creatorClient.createNew1155Token({
+    contract: {
+      name: "testContract",
+      uri: demoContractMetadataURI,
+    },
+    tokenMetadataURI: demoTokenMetadataURI,
+    account: creatorAccount,
+    mintToCreatorCount: 1,
+  });
+  const { request: simulateRequest } = publicClient.simulateContract(request);
+  const hash = await walletClient.writeContract(simulateRequest);
+  const receipt = await publicClient.waitForTransactionReceipt({ hash });
+  return receipt;
+}
+```
+
 ### Creating a premint:
 
 ```ts
@@ -40,11 +74,8 @@ import { PremintAPI } from "@zoralabs/protocol-sdk";
 import type { Address, WalletClient } from "viem";
 
 async function makePremint(walletClient: WalletClient) {
-  // Create premint API object passing in the current wallet chain (only zora and zora testnet are supported currently).
-  const premintAPI = new PremintAPI(walletClient.chain);
-
   // Create premint
-  const premint = await premintAPI.createPremint({
+  const premint = await createPremintAPI(walletClient.chain).createPremint({
     // Extra step to check the signature on-chain before attempting to sign
     checkSignature: true,
     // Collection information that this premint NFT will exist in once minted.
@@ -76,7 +107,7 @@ import type { Address, WalletClient } from "viem";
 
 async function updatePremint(walletClient: WalletClient) {
   // Create premint API object passing in the current wallet chain (only zora and zora testnet are supported currently).
-  const premintAPI = new PremintAPI(walletClient.chain);
+  const premintAPI = createPremintAPI(walletClient.chain);
 
   // Create premint
   const premint = await premintAPI.updatePremint({
@@ -105,7 +136,7 @@ import type { Address, WalletClient } from "viem";
 
 async function deletePremint(walletClient: WalletClient) {
   // Create premint API object passing in the current wallet chain (only zora and zora testnet are supported currently).
-  const premintAPI = new PremintAPI(walletClient.chain);
+  const premintAPI = createPremintClient({ chain: walletClient.chain });
 
   // Create premint
   const premint = await premintAPI.deletePremint({
@@ -132,7 +163,7 @@ async function executePremint(
   premintAddress: Address,
   premintUID: number,
 ) {
-  const premintAPI = new PremintAPI(walletClient.chain);
+  const premintAPI = createPremintClient({ chain: walletClient.chain });
 
   return await premintAPI.executePremintWithWallet({
     data: premintAPI.getPremintData(premintAddress, premintUID),
@@ -146,12 +177,12 @@ async function executePremint(
 
 ### Deleting a premint:
 
-```js
+```ts
 import {PremintAPI} from '@zoralabs/premint-sdk';
 import type {Address, WalletClient} from 'viem';
 
 async function deletePremint(walletClient: WalletClient, collection: Address, uid: number) {
-    const premintAPI = new PremintAPI(walletClient.chain);
+    const premintAPI = createPremintClient({chain: walletClient.chain});
 
     return await premintAPI.deletePremint({
         walletClient,

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

@@ -1,4 +1,4 @@
-import type { Address, Hex, PublicClient, TransactionReceipt, WalletClient } from "viem";
+import type { Address, Hex, PublicClient, SimulateContractParameters, TransactionReceipt } from "viem";
 type SalesConfigParamsType = {
     pricePerToken?: bigint;
     saleStart?: bigint;
@@ -34,30 +34,29 @@ export declare function create1155TokenSetupArgs({ nextTokenId, mintToCreatorCou
     royaltySettings?: RoyaltySettingsType;
 }): `0x${string}`[];
 export declare const getTokenIdFromCreateReceipt: (receipt: TransactionReceipt) => bigint | undefined;
-export declare function createNew1155Token({ publicClient, contract, tokenMetadataURI, mintToCreatorCount, salesConfig, maxSupply, account, royaltySettings, getAdditionalSetupActions, }: {
+type CreateNew1155TokenReturn = {
+    request: SimulateContractParameters;
+    tokenSetupActions: Hex[];
+    contractAddress: Address;
+    contractExists: boolean;
+};
+export declare function create1155CreatorClient({ publicClient, }: {
     publicClient: PublicClient;
-    account: Address;
-    maxSupply?: bigint | number;
-    royaltySettings?: RoyaltySettingsType;
-    royaltyBPS?: number;
-    contract: ContractType;
-    tokenMetadataURI: string;
-    mintToCreatorCount?: bigint | number;
-    salesConfig?: SalesConfigParamsType;
-    getAdditionalSetupActions?: (args: {
-        tokenId: bigint;
-        contractAddress: Address;
-    }) => Hex[];
-}): Promise<{
-    send: (walletClient: WalletClient) => Promise<`0x${string}`>;
-    tokenSetupActions: `0x${string}`[];
-    contractAddress: `0x${string}`;
-    contractExists: false;
-} | {
-    send: (walletClient: WalletClient) => Promise<`0x${string}`>;
-    tokenSetupActions: `0x${string}`[];
-    contractAddress: `0x${string}`;
-    contractExists: true;
-}>;
+}): {
+    createNew1155Token: ({ contract, tokenMetadataURI, mintToCreatorCount, salesConfig, maxSupply, account, royaltySettings, getAdditionalSetupActions, }: {
+        account: Address;
+        maxSupply?: number | bigint | undefined;
+        royaltySettings?: RoyaltySettingsType | undefined;
+        royaltyBPS?: number | undefined;
+        contract: ContractType;
+        tokenMetadataURI: string;
+        mintToCreatorCount?: number | bigint | undefined;
+        salesConfig?: SalesConfigParamsType | undefined;
+        getAdditionalSetupActions?: ((args: {
+            tokenId: bigint;
+            contractAddress: Address;
+        }) => Hex[]) | undefined;
+    }) => Promise<CreateNew1155TokenReturn>;
+};
 export {};
 //# sourceMappingURL=1155-create-helper.d.ts.map

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,GAAG,EACH,YAAY,EACZ,kBAAkB,EAClB,YAAY,EACb,MAAM,MAAM,CAAC;AAUd,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;AA6CF,wBAAsB,kBAAkB,CAAC,EACvC,YAAY,EACZ,QAAQ,EACR,gBAAgB,EAChB,kBAAsB,EACtB,WAAgB,EAChB,SAAS,EACT,OAAO,EACP,eAAe,EACf,yBAAyB,GAC1B,EAAE;IACD,YAAY,EAAE,YAAY,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC5B,eAAe,CAAC,EAAE,mBAAmB,CAAC;IACtC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,YAAY,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACrC,WAAW,CAAC,EAAE,qBAAqB,CAAC;IACpC,yBAAyB,CAAC,EAAE,CAAC,IAAI,EAAE;QACjC,OAAO,EAAE,MAAM,CAAC;QAChB,eAAe,EAAE,OAAO,CAAC;KAC1B,KAAK,GAAG,EAAE,CAAC;CACb;yBAmE0B,YAAY;;;;;yBAcZ,YAAY;;;;GAOtC"}
+{"version":3,"file":"1155-create-helper.d.ts","sourceRoot":"","sources":["../../src/create/1155-create-helper.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACV,OAAO,EACP,GAAG,EACH,YAAY,EACZ,0BAA0B,EAC1B,kBAAkB,EACnB,MAAM,MAAM,CAAC;AAUd,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,CAAC;IACpC,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;;iBAWY,OAAO;;;;kBAIN,YAAY;0BACJ,MAAM;;;4CAGW;YACjC,OAAO,EAAE,MAAM,CAAC;YAChB,eAAe,EAAE,OAAO,CAAC;SAC1B,KAAK,GAAG,EAAE;UACT,QAAQ,wBAAwB,CAAC;EAgGtC"}