@zoralabs/protocol-sdk 0.5.9 → 0.5.11

package/.turbo/turbo-build.log

@@ -7,9 +7,9 @@ $ tsup
 CLI Cleaning output folder
 CJS Build start
 ESM Build start
-CJS dist/index.cjs     64.20 KB
-CJS dist/index.cjs.map 123.86 KB
-CJS ⚡️ Build success in 90ms
-ESM dist/index.js     58.21 KB
-ESM dist/index.js.map 123.88 KB
-ESM ⚡️ Build success in 91ms
+CJS dist/index.cjs     1.06 MB
+CJS dist/index.cjs.map 1.43 MB
+CJS ⚡️ Build success in 845ms
+ESM dist/index.js     1.05 MB
+ESM dist/index.js.map 1.43 MB
+ESM ⚡️ Build success in 856ms

package/CHANGELOG.md

@@ -1,10 +1,26 @@
 # @zoralabs/protocol-sdk
 
+## 0.5.11
+
+### Patch Changes
+
+- 8e514b7: Cleanup protocol-sdk to have better docs around all methods, and remove methods that do not need to be exported and are not used.
+- 598a95b: Bumps protocol-sdk to use viem@2.x- see the [viem 2.X.X migration guide](https://viem.sh/docs/migration-guide#2xx-breaking-changes) for breaking changes when migratring from viem 1.X.X to 2.X.X
+- Updated dependencies [8e514b7]
+  - @zoralabs/protocol-deployments@0.1.8
+
+## 0.5.10
+
+### Patch Changes
+
+- Updated dependencies [9a16b81]
+  - @zoralabs/protocol-deployments@0.1.6
+
 ## 0.5.9
 
 ### Patch Changes
 
-- 825e5f7: Adds optional `createReferral` to `createNew1155Token` params 
+- 825e5f7: Adds optional `createReferral` to `createNew1155Token` params
 
 ## 0.5.8
 

package/README.md

@@ -9,6 +9,16 @@ 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)
+- [Creating an 1155 contract](#creating-an-1155-contract)
+- [Premint: create a mint without paying gas](#premint-create-a-mint-without-paying-gas)
+- [Updating a premint before it is brought onchain](#updating-a-premint-before-it-is-brought-onchain)
+- [Deleting a premint before it is brought onchain](#deleting-a-premint-before-it-is-brought-onchain)
+- [Minting a premint and bringing it onchain](#minting-a-premint-and-bringing-it-onchain)
+
 ### Creating a mint from an on-chain contract
 
 #### Using viem

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

@@ -1,4 +1,4 @@
-import type { Address, Hex, PublicClient, SimulateContractParameters, TransactionReceipt } from "viem";
+import type { Account, Address, Hex, PublicClient, SimulateContractParameters, TransactionReceipt } from "viem";
 type SalesConfigParamsType = {
     pricePerToken?: bigint;
     saleStart?: bigint;
@@ -35,7 +35,7 @@ export declare function create1155TokenSetupArgs({ nextTokenId, mintToCreatorCou
 }): `0x${string}`[];
 export declare const getTokenIdFromCreateReceipt: (receipt: TransactionReceipt) => bigint | undefined;
 type CreateNew1155TokenReturn = {
-    request: SimulateContractParameters;
+    request: SimulateContractParameters<any, any, any, any, any, Account | Address>;
     tokenSetupActions: Hex[];
     contractAddress: Address;
     contractExists: boolean;

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,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;;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;EAiGtC"}
+{"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"}