@zoralabs/protocol-sdk 0.9.6 → 0.10.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @zoralabs/protocol-sdk@0.9.6 build /home/runner/work/zora-protocol-private/zora-protocol-private/packages/protocol-sdk
+> @zoralabs/protocol-sdk@0.10.0 build /home/runner/work/zora-protocol-private/zora-protocol-private/packages/protocol-sdk
 > pnpm tsup
 
 CLI Building entry: src/index.ts
@@ -10,9 +10,9 @@ CLI Target: es2021
 CLI Cleaning output folder
 CJS Build start
 ESM Build start
-ESM dist/index.js     195.04 KB
-ESM dist/index.js.map 401.87 KB
-ESM ⚡️ Build success in 299ms
-CJS dist/index.cjs     200.93 KB
-CJS dist/index.cjs.map 403.89 KB
-CJS ⚡️ Build success in 338ms
+ESM dist/index.js     201.75 KB
+ESM dist/index.js.map 417.86 KB
+ESM ⚡️ Build success in 313ms
+CJS dist/index.cjs     207.89 KB
+CJS dist/index.cjs.map 419.77 KB
+CJS ⚡️ Build success in 313ms

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @zoralabs/protocol-sdk
 
+## 0.10.0
+
+### Minor Changes
+
+- fc4a7f65: Support viewing and withdrawing protocol rewards and secondary royalties balances from the sdk, using the new methods `getRewardsBalances` and `withdrawRewards`.
+
 ## 0.9.6
 
 ### Patch Changes

package/dist/anvil.d.ts

@@ -1,4 +1,5 @@
 import { Account, Chain, PublicClient, SimulateContractReturnType, TestClient, Transport, WalletClient } from "viem";
+import { SimulateContractParametersWithAccount } from "./types";
 export interface AnvilViemClientsTest {
     viemClients: {
         walletClient: WalletClient;
@@ -32,5 +33,14 @@ export declare const anvilTest: import("vitest").TestAPI<{
         chain: Chain;
     };
 }>;
-export declare function writeContractWithRetries(request: SimulateContractReturnType<any, any, any, Chain, Account>["request"], walletClient: WalletClient, publicClient: PublicClient): Promise<import("viem").TransactionReceipt>;
+export declare function simulateAndWriteContractWithRetries({ parameters, walletClient, publicClient, }: {
+    parameters: SimulateContractParametersWithAccount;
+    walletClient: WalletClient;
+    publicClient: PublicClient;
+}): Promise<import("viem").TransactionReceipt>;
+export declare function writeContractWithRetries({ request, walletClient, publicClient, }: {
+    request: SimulateContractReturnType<any, any, any, Chain, Account>["request"];
+    walletClient: WalletClient;
+    publicClient: PublicClient;
+}): Promise<import("viem").TransactionReceipt>;
 //# sourceMappingURL=anvil.d.ts.map

package/dist/anvil.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"anvil.d.ts","sourceRoot":"","sources":["../src/anvil.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,OAAO,EACP,KAAK,EACL,YAAY,EACZ,0BAA0B,EAC1B,UAAU,EACV,SAAS,EACT,YAAY,EAKb,MAAM,MAAM,CAAC;AAId,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,YAAY,CAAC,SAAS,EAAE,KAAK,CAAC;oBAChC,UAAU;eACf,KAAK;;EA+EZ,CAAC;AAEL,eAAO,MAAM,QAAQ;;;CAGpB,CAAC;AAEF,eAAO,MAAM,SAAS;;sBA1FJ,YAAY;sBAEZ,YAAY,CAAC,SAAS,EAAE,KAAK,CAAC;oBAChC,UAAU;eACf,KAAK;;EA0Fd,CAAC;AAEH,wBAAsB,wBAAwB,CAC5C,OAAO,EAAE,0BAA0B,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,EAC7E,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,YAAY,8CAwB3B"}
+{"version":3,"file":"anvil.d.ts","sourceRoot":"","sources":["../src/anvil.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,OAAO,EACP,KAAK,EACL,YAAY,EACZ,0BAA0B,EAC1B,UAAU,EACV,SAAS,EACT,YAAY,EAKb,MAAM,MAAM,CAAC;AAGd,OAAO,EAAE,qCAAqC,EAAE,MAAM,SAAS,CAAC;AAEhE,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,YAAY,CAAC,SAAS,EAAE,KAAK,CAAC;oBAChC,UAAU;eACf,KAAK;;EA+EZ,CAAC;AAEL,eAAO,MAAM,QAAQ;;;CAGpB,CAAC;AAEF,eAAO,MAAM,SAAS;;sBA1FJ,YAAY;sBAEZ,YAAY,CAAC,SAAS,EAAE,KAAK,CAAC;oBAChC,UAAU;eACf,KAAK;;EA0Fd,CAAC;AAEH,wBAAsB,mCAAmC,CAAC,EACxD,UAAU,EACV,YAAY,EACZ,YAAY,GACb,EAAE;IACD,UAAU,EAAE,qCAAqC,CAAC;IAClD,YAAY,EAAE,YAAY,CAAC;IAC3B,YAAY,EAAE,YAAY,CAAC;CAC5B,8CAOA;AAED,wBAAsB,wBAAwB,CAAC,EAC7C,OAAO,EACP,YAAY,EACZ,YAAY,GACb,EAAE;IACD,OAAO,EAAE,0BAA0B,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC;IAC9E,YAAY,EAAE,YAAY,CAAC;IAC3B,YAAY,EAAE,YAAY,CAAC;CAC5B,8CAuBA"}

package/dist/apis/multicall3.d.ts

@@ -0,0 +1,9 @@
+import { Address, Hex } from "viem";
+export declare const multicall3Abi: readonly ["struct Call { address target; bytes callData; }", "struct Call3 { address target; bool allowFailure; bytes callData; }", "struct Call3Value { address target; bool allowFailure; uint256 value; bytes callData; }", "struct Result { bool success; bytes returnData; }", "function aggregate(Call[] calldata calls) public payable returns (uint256 blockNumber, bytes[] memory returnData)", "function aggregate3(Call3[] calldata calls) public payable returns (Result[] memory returnData)", "function aggregate3Value(Call3Value[] calldata calls) public payable returns (Result[] memory returnData)"];
+export declare const multicall3Address = "0xcA11bde05977b3631167028862bE2a173976CA11";
+export type Multicall3Call3 = {
+    target: Address;
+    allowFailure: boolean;
+    callData: Hex;
+};
+//# sourceMappingURL=multicall3.d.ts.map

package/dist/apis/multicall3.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"multicall3.d.ts","sourceRoot":"","sources":["../../src/apis/multicall3.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAEpC,eAAO,MAAM,aAAa,0lBAQhB,CAAC;AAEX,eAAO,MAAM,iBAAiB,+CAA+C,CAAC;AAE9E,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,OAAO,CAAC;IAChB,YAAY,EAAE,OAAO,CAAC;IACtB,QAAQ,EAAE,GAAG,CAAC;CACf,CAAC"}

package/dist/apis/subgraph-getter.d.ts

@@ -0,0 +1,9 @@
+import { NetworkConfig } from "./chain-constants";
+import { ISubgraphQuerier, ISubgraphQuery } from "./subgraph-querier";
+export declare class SubgraphGetter {
+    readonly subgraphQuerier: ISubgraphQuerier;
+    networkConfig: NetworkConfig;
+    constructor(chainId: number, subgraphQuerier?: ISubgraphQuerier);
+    querySubgraphWithRetries<T>({ query, variables, parseResponseData, }: ISubgraphQuery<T>): Promise<T | undefined>;
+}
+//# sourceMappingURL=subgraph-getter.d.ts.map

package/dist/apis/subgraph-getter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subgraph-getter.d.ts","sourceRoot":"","sources":["../../src/apis/subgraph-getter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EACL,gBAAgB,EAChB,cAAc,EAEf,MAAM,oBAAoB,CAAC;AAG5B,qBAAa,cAAc;IACzB,SAAgB,eAAe,EAAE,gBAAgB,CAAC;IAClD,aAAa,EAAE,aAAa,CAAC;gBAEjB,OAAO,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,gBAAgB;IAMzD,wBAAwB,CAAC,CAAC,EAAE,EAChC,KAAK,EACL,SAAS,EACT,iBAAiB,GAClB,EAAE,cAAc,CAAC,CAAC,CAAC;CASrB"}

package/dist/create/contract-getter.d.ts

@@ -1,6 +1,6 @@
-import { NetworkConfig } from "src/apis/chain-constants";
-import { ISubgraphQuerier, ISubgraphQuery } from "src/apis/subgraph-querier";
+import { ISubgraphQuerier } from "src/apis/subgraph-querier";
 import { Address } from "viem";
+import { SubgraphGetter } from "src/apis/subgraph-getter";
 export interface IContractGetter {
     getContractInfo: (params: {
         contractAddress: Address;
@@ -12,11 +12,8 @@ export interface IContractGetter {
         mintFee: bigint;
     }>;
 }
-export declare class SubgraphContractGetter implements IContractGetter {
-    readonly subgraphQuerier: ISubgraphQuerier;
-    networkConfig: NetworkConfig;
+export declare class SubgraphContractGetter extends SubgraphGetter implements IContractGetter {
     constructor(chainId: number, subgraphQuerier?: ISubgraphQuerier);
-    querySubgraphWithRetries<T>({ query, variables, parseResponseData, }: ISubgraphQuery<T>): Promise<T | undefined>;
     getContractInfo({ contractAddress, retries, }: {
         contractAddress: Address;
         retries?: number;

package/dist/create/contract-getter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"contract-getter.d.ts","sourceRoot":"","sources":["../../src/create/contract-getter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EACL,gBAAgB,EAChB,cAAc,EAEf,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAK/B,MAAM,WAAW,eAAe;IAC9B,eAAe,EAAE,CAAC,MAAM,EAAE;QACxB,eAAe,EAAE,OAAO,CAAC;QACzB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,KAAK,OAAO,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,eAAe,EAAE,MAAM,CAAC;QACxB,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC,CAAC;CACJ;AAED,qBAAa,sBAAuB,YAAW,eAAe;IAC5D,SAAgB,eAAe,EAAE,gBAAgB,CAAC;IAClD,aAAa,EAAE,aAAa,CAAC;gBAEjB,OAAO,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,gBAAgB;IAMzD,wBAAwB,CAAC,CAAC,EAAE,EAChC,KAAK,EACL,SAAS,EACT,iBAAiB,GAClB,EAAE,cAAc,CAAC,CAAC,CAAC;IAUd,eAAe,CAAC,EACpB,eAAe,EACf,OAAW,GACZ,EAAE;QACD,eAAe,EAAE,OAAO,CAAC;QACzB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO,CAAC;QACV,IAAI,EAAE,MAAM,CAAC;QACb,eAAe,EAAE,MAAM,CAAC;QACxB,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CA8BH"}
+{"version":3,"file":"contract-getter.d.ts","sourceRoot":"","sources":["../../src/create/contract-getter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAG/B,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE1D,MAAM,WAAW,eAAe;IAC9B,eAAe,EAAE,CAAC,MAAM,EAAE;QACxB,eAAe,EAAE,OAAO,CAAC;QACzB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,KAAK,OAAO,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,eAAe,EAAE,MAAM,CAAC;QACxB,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC,CAAC;CACJ;AAED,qBAAa,sBACX,SAAQ,cACR,YAAW,eAAe;gBAEd,OAAO,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,gBAAgB;IAIzD,eAAe,CAAC,EACpB,eAAe,EACf,OAAW,GACZ,EAAE;QACD,eAAe,EAAE,OAAO,CAAC;QACzB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO,CAAC;QACV,IAAI,EAAE,MAAM,CAAC;QACb,eAAe,EAAE,MAAM,CAAC;QACxB,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CA8BH"}

package/dist/fixtures/mint-query-results.d.ts

@@ -0,0 +1,10 @@
+import { Address } from "viem";
+import { TokenQueryResult } from "../mint/subgraph-queries";
+export declare const mockTimedSaleStrategyTokenQueryResult: ({ tokenId, contractAddress, contractVersion, chainId, saleEnd, }: {
+    tokenId: bigint;
+    contractAddress: Address;
+    contractVersion: string;
+    chainId: number;
+    saleEnd?: bigint;
+}) => TokenQueryResult;
+//# sourceMappingURL=mint-query-results.d.ts.map

package/dist/fixtures/mint-query-results.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mint-query-results.d.ts","sourceRoot":"","sources":["../../src/fixtures/mint-query-results.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAA2B,MAAM,MAAM,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAI5D,eAAO,MAAM,qCAAqC,qEAM/C;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,OAAO,CAAC;IACzB,eAAe,EAAE,MAAM,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,KAAG,gBAqCF,CAAC"}

package/dist/fixtures/rewards-query-results.d.ts

@@ -0,0 +1,6 @@
+import { Address } from "viem";
+import { CreatorERC20zQueryResult } from "../rewards/subgraph-queries";
+export declare const mockRewardsQueryResults: ({ erc20z, }: {
+    erc20z: Address[];
+}) => CreatorERC20zQueryResult;
+//# sourceMappingURL=rewards-query-results.d.ts.map

package/dist/fixtures/rewards-query-results.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rewards-query-results.d.ts","sourceRoot":"","sources":["../../src/fixtures/rewards-query-results.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,EAEL,wBAAwB,EACzB,MAAM,6BAA6B,CAAC;AAcrC,eAAO,MAAM,uBAAuB,gBAEjC;IACD,MAAM,EAAE,OAAO,EAAE,CAAC;CACnB,KAAG,wBAEF,CAAC"}