@zoralabs/protocol-sdk 0.3.4 → 0.3.5

package/.turbo/turbo-build.log

@@ -7,9 +7,9 @@ $ tsup
 CLI Cleaning output folder
 CJS Build start
 ESM Build start
-ESM dist/index.js     37.02 KB
-ESM dist/index.js.map 74.33 KB
-ESM ⚡️ Build success in 34ms
-CJS dist/index.cjs     39.62 KB
-CJS dist/index.cjs.map 74.34 KB
-CJS ⚡️ Build success in 35ms
+CJS dist/index.cjs     44.13 KB
+CJS dist/index.cjs.map 83.73 KB
+CJS ⚡️ Build success in 44ms
+ESM dist/index.js     40.87 KB
+ESM dist/index.js.map 83.86 KB
+ESM ⚡️ Build success in 48ms

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @zoralabs/protocol-sdk
 
+## 0.3.5
+
+### Patch Changes
+
+- 7eb5e3f: ### Changes to `preminter`
+
+  lower level `preminter.ts` now supports premint v2 by defining v2 typed data defintions.
+
+  - `isValidSignature` now takes either v1 or v2 of a premint config, along with the premint config version. and both recovers the signer address and validates if the signer can create a premint on the given contract.
+  - new function `premintTypedDataDefinition` which takes a premint config version and returns the signable typed data definition for that version
+  - new function `recoverCreatorFromCreatorAttribution` which recovers the creator address from a `CreatorAttribution` event
+  - new function `supportsPremintVersion` which checks if a given token contract supports a given premint config version
+  - new function `tryRecoverPremintSigner` which takes a premint config version and a premint signature, and tries to recover the signer address from the signature. If the signature is invalid, it returns undefined.
+
+  ### Changes to PremintClient
+
+  `PremintClient` creation, updating, and deletion now take both premint config v1 and v2, but currently rejects them until the backend api supports creating v2 premints.
+
+  - `isValidSignature` now just takes the data directly as a param, instead of `{data}`
+
+- 27a2e23: Fix reading the FIXED_PRICE_MINTER from the subgraph
+
 ## 0.3.4
 
 ### Patch Changes

package/README.md

@@ -43,16 +43,11 @@ async function mintNFT({
 }) {
   const mintClient = createMintClient({chain: walletClient.chain!});
 
-  // get mintable information about the token.
-  const mintable = await mintClient.getMintable({
-    tokenContract,
-    tokenId,
-  });
-
   // prepare the mint transaction, which can be simulated via an rpc with the public client.
   const prepared = await mintClient.makePrepareMintTokenParams({
     // token to mint
-    mintable,
+    tokenContract,
+    tokenId,
     mintArguments: {
       // address that will receive the token
       mintToAddress,
@@ -81,7 +76,7 @@ async function mintNFT({
 #### Using wagmi
 
 ```tsx
-import {createMintClient, Mintable} from "@zoralabs/protocol-sdk";
+import {createMintClient} from "@zoralabs/protocol-sdk";
 import {useEffect, useMemo, useState} from "react";
 import {BaseError, SimulateContractParameters, stringify} from "viem";
 import {Address, useAccount, useContractWrite, useNetwork, usePrepareContractWrite, usePublicClient, useWaitForTransaction} from "wagmi";
@@ -104,33 +99,19 @@ export const Mint = ({tokenId, tokenContract}: {tokenId: string; tokenContract:
   // value will be set by the form
   const [quantityToMint, setQuantityToMint] = useState<number>(1);
 
-  // fetched mintable info from the sdk
-  const [mintable, setMintable] = useState<Mintable>();
-
-  useEffect(() => {
-    // fetch the mintable token info
-    const fetchMintable = async () => {
-      if (mintClient) {
-        const mintable = await mintClient.getMintable({tokenId, tokenContract});
-        setMintable(mintable);
-      }
-    };
-
-    fetchMintable();
-  }, [mintClient, tokenId, tokenContract]);
-
   // params for the prepare contract write hook
   const [params, setParams] = useState<SimulateContractParameters>();
 
   const {address} = useAccount();
 
   useEffect(() => {
-    if (!mintable || !mintClient || !address) return;
+    if (!mintClient || !address) return;
 
     const makeParams = async () => {
       // make the params for the prepare contract write hook
       const params = await mintClient.makePrepareMintTokenParams({
-        mintable,
+        tokenId,
+        tokenContract,
         minterAccount: address,
         mintArguments: {
           mintToAddress: address,
@@ -141,7 +122,7 @@ export const Mint = ({tokenId, tokenContract}: {tokenId: string; tokenContract:
     };
 
     makeParams();
-  }, [mintable, mintClient, address, quantityToMint]);
+  }, [mintClient, address, quantityToMint]);
 
   const {config} = usePrepareContractWrite(params);
 

package/dist/anvil.d.ts

@@ -6,10 +6,11 @@ export interface AnvilViemClientsTest {
         testClient: TestClient;
     };
 }
-export declare const makeAnvilTest: ({ forkUrl, forkBlockNumber, }: {
+export type AnvilTestForkSettings = {
     forkUrl: string;
     forkBlockNumber: number;
-}) => import("@vitest/runner/dist/tasks-e594cd24").e<{
+};
+export declare const makeAnvilTest: ({ forkUrl, forkBlockNumber, }: AnvilTestForkSettings) => import("@vitest/runner/dist/tasks-e594cd24").e<{
     viemClients: {
         walletClient: WalletClient;
         publicClient: PublicClient;
@@ -19,6 +20,7 @@ export declare const makeAnvilTest: ({ forkUrl, forkBlockNumber, }: {
 export declare const forkUrls: {
     zoraMainnet: string;
     zoraGoerli: string;
+    zoraSepoli: string;
 };
 export declare const anvilTest: import("@vitest/runner/dist/tasks-e594cd24").e<{
     viemClients: {

package/dist/anvil.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"anvil.d.ts","sourceRoot":"","sources":["../src/anvil.ts"],"names":[],"mappings":"AAGA,OAAO,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;KACxB,CAAC;CACH;AAUD,eAAO,MAAM,aAAa;aAIf,MAAM;qBACE,MAAM;;;sBAnBP,YAAY;sBACZ,YAAY;oBACd,UAAU;;EAwEtB,CAAC;AAEL,eAAO,MAAM,QAAQ;;;CAGpB,CAAC;AAEF,eAAO,MAAM,SAAS;;sBAjFJ,YAAY;sBACZ,YAAY;oBACd,UAAU;;EAkFxB,CAAC"}
+{"version":3,"file":"anvil.d.ts","sourceRoot":"","sources":["../src/anvil.ts"],"names":[],"mappings":"AAGA,OAAO,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;KACxB,CAAC;CACH;AAUD,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,eAAO,MAAM,aAAa,kCAGvB,qBAAqB;;sBAtBN,YAAY;sBACZ,YAAY;oBACd,UAAU;;EA0EtB,CAAC;AAEL,eAAO,MAAM,QAAQ;;;;CAIpB,CAAC;AAEF,eAAO,MAAM,SAAS;;sBApFJ,YAAY;sBACZ,YAAY;oBACd,UAAU;;EAqFxB,CAAC"}

package/dist/constants.d.ts

@@ -1,4 +1,36 @@
 export declare const ZORA_API_BASE = "https://api.zora.co/";
 export declare const OPEN_EDITION_MINT_SIZE: bigint;
 export declare function getSubgraph(name: string, version: string): string;
+export declare const zora721Abi: readonly [{
+    readonly name: "mintWithRewards";
+    readonly type: "function";
+    readonly stateMutability: "payable";
+    readonly inputs: readonly [{
+        readonly type: "address";
+        readonly name: "recipient";
+    }, {
+        readonly type: "uint256";
+        readonly name: "quantity";
+    }, {
+        readonly type: "string";
+        readonly name: "comment";
+    }, {
+        readonly type: "address";
+        readonly name: "mintReferral";
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly name: "zoraFeeForAmount";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly type: "uint256";
+        readonly name: "amount";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "address";
+    }, {
+        readonly type: "uint256";
+    }];
+}];
 //# 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":"AAAA,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"}
+{"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"}