@story-protocol/core-sdk 1.3.0-beta.1 → 1.3.0-beta.2

package/dist/declarations/src/types/resources/royalty.d.ts

@@ -1,6 +1,8 @@
-import { Address } from "viem";
-import { TxOptions } from "../options.js";
-import { EncodedTxData } from "../../abi/generated.js";
+import { Address, Hash, TransactionReceipt } from "viem";
+import { TxOptions, WithTxOptions } from "../options.js";
+import { EncodedTxData, IpAccountImplClient } from "../../abi/generated.js";
+import { WithWipOptions } from "../utils/wip.js";
+import { TokenAmountInput } from "../common.js";
 export type RoyaltyPolicyApiResponse = {
     data: RoyaltyPolicy;
 };
@@ -34,11 +36,11 @@ export type PayRoyaltyOnBehalfRequest = {
     receiverIpId: Address;
     payerIpId: Address;
     token: Address;
-    amount: string | number | bigint;
-    txOptions?: TxOptions;
-};
+    amount: TokenAmountInput;
+} & WithTxOptions & WithWipOptions;
 export type PayRoyaltyOnBehalfResponse = {
     txHash?: string;
+    receipt?: TransactionReceipt;
     encodedTxData?: EncodedTxData;
 };
 export type SnapshotRequest = {
@@ -118,5 +120,64 @@ export type SnapshotAndClaimBySnapshotBatchResponse = {
     snapshotId?: bigint;
     amountsClaimed?: bigint;
 };
+/**
+ * Claims all revenue from the child IPs of an ancestor IP, then transfer
+ * all claimed tokens to the wallet if the wallet owns the IP or is the claimer.
+ * If claimed token is WIP, it will also be converted back to IP.
+ */
+export type ClaimAllRevenueRequest = {
+    /** The address of the ancestor IP from which the revenue is being claimed. */
+    ancestorIpId: Address;
+    /**
+     * The address of the claimer of the currency (revenue) tokens.
+     *
+     * This is normally the ipId of the ancestor IP if the IP has all royalty tokens.
+     * Otherwise, this would be the address that is holding the ancestor IP royalty tokens.
+     */
+    claimer: Address;
+    /** The addresses of the child IPs from which royalties are derived. */
+    childIpIds: Address[];
+    /**
+     * The addresses of the royalty policies, where
+     * royaltyPolicies[i] governs the royalty flow for childIpIds[i].
+     */
+    royaltyPolicies: Address[];
+    /** The addresses of the currency tokens in which royalties will be claimed */
+    currencyTokens: Address[];
+    claimOptions?: {
+        /**
+         * When enabled, all claimed tokens on the claimer are transferred to the
+         * wallet address if the wallet owns the IP. If the wallet is the claimer
+         * or if the claimer is not an IP owned by the wallet, then the tokens
+         * will not be transferred.
+         * Set to false to disable auto transferring claimed tokens from the claimer.
+         *
+         * @default true
+         */
+        autoTransferAllClaimedTokensFromIp?: boolean;
+        /**
+         * By default all claimed WIP tokens are converted back to IP after
+         * they are transferred.
+         * Set this to false to disable this behavior.
+         *
+         * @default false
+         */
+        autoUnwrapIpTokens?: boolean;
+    };
+};
+export type ClaimedToken = {
+    token: Address;
+    amount: bigint;
+};
+export type ClaimAllRevenueResponse = {
+    txHashes: Hash[];
+    receipt?: TransactionReceipt;
+    claimedTokens?: ClaimedToken[];
+};
+export type TransferClaimedTokensFromIpToWalletParams = {
+    ipAccount: IpAccountImplClient;
+    skipUnwrapIp: boolean;
+    claimedTokens: ClaimedToken[];
+};
 export {};
 //# sourceMappingURL=royalty.d.ts.map

package/dist/declarations/src/types/resources/royalty.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"royalty.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["royalty.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAEpD,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,EAAE,OAAO,CAAC;IACZ,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,mBAAmB,EAAE,MAAM,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,yBAAyB,EAAE,MAAM,EAAE,CAAC;IACpC,yBAAyB,EAAE,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,qBAAqB,EAAE,OAAO;IAC9B,cAAc,EAAE,OAAO;IACvB,YAAY,EAAE,MAAM;IACpB,kBAAkB,EAAE,OAAO;IAC3B,kBAAkB,EAAE,MAAM,EAAE;CAC7B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAE9C,MAAM,MAAM,yBAAyB,GAAG;IACtC,YAAY,EAAE,OAAO,CAAC;IACtB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACjC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IAC5C,KAAK,EAAE,OAAO,CAAC;IACf,gBAAgB,EAAE,OAAO,CAAC;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AACF,KAAK,kBAAkB,GAAG;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,aAAa,EAAE,OAAO,CAAC;IACvB,aAAa,EAAE,OAAO,CAAC;IACvB,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CAClC,CAAC;AACF,MAAM,MAAM,qDAAqD,GAAG;IAClE,YAAY,EAAE,OAAO,CAAC;IACtB,mBAAmB,EAAE,kBAAkB,EAAE,CAAC;IAC1C,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,sDAAsD,GAAG;IACnE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,wDAAwD,GAAG;IACrE,YAAY,EAAE,OAAO,CAAC;IACtB,oBAAoB,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IACrD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,mBAAmB,EAAE,kBAAkB,EAAE,CAAC;IAC1C,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,yDAAyD,GAAG;IACtE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,mCAAmC,GAAG;IAChD,gBAAgB,EAAE,OAAO,CAAC;IAC1B,cAAc,EAAE,OAAO,EAAE,CAAC;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,oCAAoC,GAAG;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,sCAAsC,GAAG;IACnD,gBAAgB,EAAE,OAAO,CAAC;IAC1B,oBAAoB,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IACrD,cAAc,EAAE,OAAO,EAAE,CAAC;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,uCAAuC,GAAG;IACpD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC"}
+{"version":3,"file":"royalty.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["royalty.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAEzD,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,sBAAmB;AACtD,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,+BAA4B;AACzE,OAAO,EAAE,cAAc,EAAE,wBAAqB;AAC9C,OAAO,EAAE,gBAAgB,EAAE,qBAAkB;AAE7C,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,EAAE,OAAO,CAAC;IACZ,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,mBAAmB,EAAE,MAAM,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,yBAAyB,EAAE,MAAM,EAAE,CAAC;IACpC,yBAAyB,EAAE,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,qBAAqB,EAAE,OAAO;IAC9B,cAAc,EAAE,OAAO;IACvB,YAAY,EAAE,MAAM;IACpB,kBAAkB,EAAE,OAAO;IAC3B,kBAAkB,EAAE,MAAM,EAAE;CAC7B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAE9C,MAAM,MAAM,yBAAyB,GAAG;IACtC,YAAY,EAAE,OAAO,CAAC;IACtB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,gBAAgB,CAAC;CAC1B,GAAG,aAAa,GACf,cAAc,CAAC;AAEjB,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IAC5C,KAAK,EAAE,OAAO,CAAC;IACf,gBAAgB,EAAE,OAAO,CAAC;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AACF,KAAK,kBAAkB,GAAG;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,aAAa,EAAE,OAAO,CAAC;IACvB,aAAa,EAAE,OAAO,CAAC;IACvB,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CAClC,CAAC;AACF,MAAM,MAAM,qDAAqD,GAAG;IAClE,YAAY,EAAE,OAAO,CAAC;IACtB,mBAAmB,EAAE,kBAAkB,EAAE,CAAC;IAC1C,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,sDAAsD,GAAG;IACnE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,wDAAwD,GAAG;IACrE,YAAY,EAAE,OAAO,CAAC;IACtB,oBAAoB,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IACrD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,mBAAmB,EAAE,kBAAkB,EAAE,CAAC;IAC1C,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,yDAAyD,GAAG;IACtE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,mCAAmC,GAAG;IAChD,gBAAgB,EAAE,OAAO,CAAC;IAC1B,cAAc,EAAE,OAAO,EAAE,CAAC;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,oCAAoC,GAAG;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,sCAAsC,GAAG;IACnD,gBAAgB,EAAE,OAAO,CAAC;IAC1B,oBAAoB,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IACrD,cAAc,EAAE,OAAO,EAAE,CAAC;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,uCAAuC,GAAG;IACpD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,8EAA8E;IAC9E,YAAY,EAAE,OAAO,CAAC;IACtB;;;;;OAKG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB,uEAAuE;IACvE,UAAU,EAAE,OAAO,EAAE,CAAC;IACtB;;;OAGG;IACH,eAAe,EAAE,OAAO,EAAE,CAAC;IAC3B,8EAA8E;IAC9E,cAAc,EAAE,OAAO,EAAE,CAAC;IAE1B,YAAY,CAAC,EAAE;QACb;;;;;;;;WAQG;QACH,kCAAkC,CAAC,EAAE,OAAO,CAAC;QAE7C;;;;;;WAMG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,QAAQ,EAAE,IAAI,EAAE,CAAC;IACjB,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,yCAAyC,GAAG;IACtD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,YAAY,EAAE,CAAC;CAC/B,CAAC"}

package/dist/declarations/src/types/resources/wip.d.ts

@@ -0,0 +1,16 @@
+import { Address } from "viem";
+import { TokenAmountInput } from "../common.js";
+import { WithTxOptions } from "../options.js";
+export type ApproveRequest = WithTxOptions & {
+    /** The address that will use the WIP tokens */
+    spender: Address;
+    /** The amount of WIP tokens to approve.  */
+    amount: TokenAmountInput;
+};
+export type DepositRequest = WithTxOptions & {
+    amount: TokenAmountInput;
+};
+export type WithdrawRequest = WithTxOptions & {
+    amount: TokenAmountInput;
+};
+//# sourceMappingURL=wip.d.ts.map

package/dist/declarations/src/types/resources/wip.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wip.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["wip.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,OAAO,EAAE,gBAAgB,EAAE,qBAAkB;AAC7C,OAAO,EAAE,aAAa,EAAE,sBAAmB;AAE3C,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG;IAC3C,+CAA+C;IAC/C,OAAO,EAAE,OAAO,CAAC;IACjB,4CAA4C;IAC5C,MAAM,EAAE,gBAAgB,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG;IAC3C,MAAM,EAAE,gBAAgB,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,aAAa,GAAG;IAC5C,MAAM,EAAE,gBAAgB,CAAC;CAC1B,CAAC"}

package/dist/declarations/src/types/utils/txOptions.d.ts

@@ -0,0 +1,13 @@
+import { Hex, PublicClient, TransactionReceipt } from "viem";
+import { TxOptions } from "../options.js";
+export type HandleTxOptionsParams = {
+    txHash: Hex;
+    txOptions?: TxOptions;
+    rpcClient: PublicClient;
+};
+export type HandleTxOptionsResponse = {
+    txHash: Hex;
+    /** Transaction receipt, only available if waitForTransaction is set to true */
+    receipt?: TransactionReceipt;
+};
+//# sourceMappingURL=txOptions.d.ts.map

package/dist/declarations/src/types/utils/txOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"txOptions.d.ts","sourceRoot":"../../../../../src/types/utils","sources":["txOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAE7D,OAAO,EAAE,SAAS,EAAE,sBAAmB;AAEvC,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,GAAG,CAAC;IACZ,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,SAAS,EAAE,YAAY,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EAAE,GAAG,CAAC;IAEZ,+EAA+E;IAC/E,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAC9B,CAAC"}

package/dist/declarations/src/types/utils/wip.d.ts

@@ -0,0 +1,87 @@
+import { Address, Hash, PublicClient } from "viem";
+import { Multicall3Aggregate3Request, Multicall3Client, Erc20TokenClient, EncodedTxData, SimpleWalletClient, PiLicenseTemplateClient, LicensingModuleClient } from "../../abi/generated.js";
+import { TxOptions } from "../options.js";
+/**
+ * Options to override the default behavior of the auto wrapping IP
+ * and auto approve logic.
+ */
+export type WithWipOptions = {
+    /** options to configure WIP behavior */
+    wipOptions?: {
+        /**
+         * Use multicall to batch the WIP calls into one transaction when possible.
+         *
+         * @default true
+         */
+        useMulticallWhenPossible?: boolean;
+        /**
+         * By default IP is converted to WIP if the current WIP
+         * balance does not cover the fees.
+         * Set this to `false` to disable this behavior.
+         *
+         * @default true
+         */
+        enableAutoWrapIp?: boolean;
+        /**
+         * Automatically approve WIP usage when WIP is needed but current allowance
+         * is not sufficient.
+         * Set this to `false` to disable this behavior.
+         *
+         * @default true
+         */
+        enableAutoApprove?: boolean;
+    };
+};
+export type Multicall3ValueCall = Multicall3Aggregate3Request["calls"][0] & {
+    value: bigint;
+};
+export type WipSpender = {
+    address: Address;
+    /**
+     * Amount that the address will spend in WIP.
+     * If not provided, then unlimited amount is assumed.
+     */
+    amount?: bigint;
+};
+export type WipApprovalCall = {
+    spenders: WipSpender[];
+    client: Erc20TokenClient;
+    rpcClient: PublicClient;
+    /** owner is the address calling the approval */
+    owner: Address;
+    /** when true, will return an array of {@link Multicall3ValueCall} */
+    useMultiCall: boolean;
+};
+export type ContractCallWithWipFees = WithWipOptions & {
+    totalFees: bigint;
+    multicall3Client: Multicall3Client;
+    wipClient: Erc20TokenClient;
+    /** all possible spenders of the wip */
+    wipSpenders: WipSpender[];
+    contractCall: () => Promise<Hash>;
+    encodedTxs: EncodedTxData[];
+    rpcClient: PublicClient;
+    wallet: SimpleWalletClient;
+    sender: Address;
+    txOptions?: TxOptions;
+};
+export type MulticallWithWrapIp = WithWipOptions & {
+    calls: Multicall3ValueCall[];
+    ipAmountToWrap: bigint;
+    contractCall: () => Promise<Hash>;
+    wipSpenders: WipSpender[];
+    multicall3Client: Multicall3Client;
+    wipClient: Erc20TokenClient;
+    rpcClient: PublicClient;
+    wallet: SimpleWalletClient;
+};
+export type CalculateDerivativeMintFeeParams = {
+    multicall3Client: Multicall3Client;
+    licenseTemplateClient: PiLicenseTemplateClient;
+    licensingModuleClient: LicensingModuleClient;
+    parentIpId: Address;
+    licenseTermsId: bigint;
+    receiver: Address;
+    amount: bigint;
+};
+//# sourceMappingURL=wip.d.ts.map

package/dist/declarations/src/types/utils/wip.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wip.d.ts","sourceRoot":"../../../../../src/types/utils","sources":["wip.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAEnD,OAAO,EACL,2BAA2B,EAC3B,gBAAgB,EAChB,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,uBAAuB,EACvB,qBAAqB,EACtB,+BAA4B;AAC7B,OAAO,EAAE,SAAS,EAAE,sBAAmB;AAEvC;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,wCAAwC;IACxC,UAAU,CAAC,EAAE;QACX;;;;WAIG;QACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;QAEnC;;;;;;WAMG;QACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAE3B;;;;;;WAMG;QACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;KAC7B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,2BAA2B,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9F,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB,MAAM,EAAE,gBAAgB,CAAC;IACzB,SAAS,EAAE,YAAY,CAAC;IACxB,gDAAgD;IAChD,KAAK,EAAE,OAAO,CAAC;IACf,qEAAqE;IACrE,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG;IACrD,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,SAAS,EAAE,gBAAgB,CAAC;IAC5B,uCAAuC;IACvC,WAAW,EAAE,UAAU,EAAE,CAAC;IAC1B,YAAY,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAClC,UAAU,EAAE,aAAa,EAAE,CAAC;IAC5B,SAAS,EAAE,YAAY,CAAC;IACxB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,cAAc,GAAG;IACjD,KAAK,EAAE,mBAAmB,EAAE,CAAC;IAC7B,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAClC,WAAW,EAAE,UAAU,EAAE,CAAC;IAC1B,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,SAAS,EAAE,gBAAgB,CAAC;IAC5B,SAAS,EAAE,YAAY,CAAC;IACxB,MAAM,EAAE,kBAAkB,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,UAAU,EAAE,OAAO,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/declarations/src/utils/chain.d.ts

@@ -1,8 +1,8 @@
-export declare const homer: {
+export declare const aeneid: {
     blockExplorers: {
         readonly default: {
             readonly name: "Explorer";
-            readonly url: "https://devnet.storyscan.xyz/";
+            readonly url: "https://aeneid.storyscan.xyz/";
         };
     };
     contracts: {
@@ -12,7 +12,7 @@ export declare const homer: {
         };
     };
     id: 1315;
-    name: "homer";
+    name: "aeneid";
     nativeCurrency: {
         readonly name: "IP";
         readonly symbol: "IP";
@@ -20,7 +20,7 @@ export declare const homer: {
     };
     rpcUrls: {
         readonly default: {
-            readonly http: readonly ["https://devnet.storyrpc.io/"];
+            readonly http: readonly ["https://aeneid.storyrpc.io/"];
         };
     };
     sourceId?: number | undefined;

package/dist/declarations/src/utils/chain.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"chain.d.ts","sourceRoot":"../../../../src/utils","sources":["chain.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsBhB,CAAC"}
+{"version":3,"file":"chain.d.ts","sourceRoot":"../../../../src/utils","sources":["chain.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsBjB,CAAC"}

package/dist/declarations/src/utils/sign.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sign.d.ts","sourceRoot":"../../../../src/utils","sources":["sign.ts"],"names":[],"mappings":"AAWA,OAAO,EACL,0BAA0B,EAC1B,gBAAgB,EAChB,iBAAiB,EAClB,yCAAsC;AAEvC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB,UAC1B,0BAA0B,KAChC,QAAQ,iBAAiB,CAmC3B,CAAC;AAEF,eAAO,MAAM,WAAW,kBAAmB,MAAM,aAAa,MAAM,GAAG,MAAM,GAAG,MAAM,KAAG,MAKxF,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,6EAQtB,gBAAgB,KAAG,QAAQ,iBAAiB,CAkD9C,CAAC"}
+{"version":3,"file":"sign.d.ts","sourceRoot":"../../../../src/utils","sources":["sign.ts"],"names":[],"mappings":"AAWA,OAAO,EACL,0BAA0B,EAC1B,gBAAgB,EAChB,iBAAiB,EAClB,yCAAsC;AAEvC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB,UAC1B,0BAA0B,KAChC,QAAQ,iBAAiB,CAqC3B,CAAC;AAEF,eAAO,MAAM,WAAW,kBAAmB,MAAM,aAAa,MAAM,GAAG,MAAM,GAAG,MAAM,KAAG,MAKxF,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,6EAQtB,gBAAgB,KAAG,QAAQ,iBAAiB,CAkD9C,CAAC"}