@story-protocol/core-sdk 1.3.0-rc.3 → 1.3.1-beta

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

@@ -1,11 +1,24 @@
-import { Address, Hex, WalletClient } from "viem";
+import { Address, Hex } from "viem";
 import { TxOptions } from "../options.js";
 import { EncodedTxData, SimpleWalletClient } from "../../abi/generated.js";
 export type SetPermissionsRequest = {
+    /** The IP ID that grants the permission for `signer`. */
     ipId: Address;
+    /**
+     * The address that will be granted permission to execute transactions.
+     * This address will be able to call functions on `to`
+     * on behalf of the IP Account {@link https://docs.story.foundation/docs/ip-account}.
+     */
     signer: Address;
+    /** The address that can be called by the `signer` (currently only modules can be `to`). */
     to: Address;
+    /** The new permission level of {@link AccessPermission}. */
     permission: AccessPermission;
+    /**
+     * The function selector string of `to` that can be called by the `signer` on behalf of the IP Account {@link https://docs.story.foundation/docs/ip-account}.
+     * Be default, it allows all functions.
+     * @default 0x00000000
+     */
     func?: string;
     txOptions?: TxOptions;
 };
@@ -15,21 +28,33 @@ export type SetPermissionsResponse = {
     success?: boolean;
 };
 export type SetAllPermissionsRequest = {
+    /** The IP ID that grants the permission for `signer`. */
     ipId: Address;
+    /** The address of the signer receiving the permissions. */
     signer: Address;
+    /** The new permission level of {@link AccessPermission}. */
     permission: AccessPermission;
     txOptions?: TxOptions;
 };
 /**
  * Permission level
- * @enum {number}
- **/
+ */
 export declare enum AccessPermission {
+    /**
+     * ABSTAIN means having not enough information to make decision at
+     * current level, deferred decision to up.
+     */
     ABSTAIN = 0,
+    /** ALLOW means the permission is granted to transaction signer to call the function. */
     ALLOW = 1,
+    /** DENY means the permission is denied to transaction signer to call the function. */
     DENY = 2
 }
 export type CreateSetPermissionSignatureRequest = {
+    /**
+     * The deadline for the signature in seconds.
+     * @default 1000
+     */
     deadline?: bigint | number | string;
 } & SetPermissionsRequest;
 export type SetBatchPermissionsRequest = {
@@ -37,14 +62,20 @@ export type SetBatchPermissionsRequest = {
     txOptions?: TxOptions;
 };
 export type CreateBatchPermissionSignatureRequest = {
+    /** The ip id that grants the permission for `signer`. */
     ipId: Address;
+    /**
+     * The deadline for the signature in seconds.
+     * @default 1000
+     */
     deadline?: bigint | number | string;
 } & SetBatchPermissionsRequest;
 export type PermissionSignatureRequest = {
     ipId: Address;
     state: Hex;
+    /** The deadline for the signature in seconds. */
     deadline: string | number | bigint;
-    wallet: WalletClient;
+    wallet: SimpleWalletClient;
     chainId: string | number | bigint;
     permissions: Omit<SetPermissionsRequest, "txOptions">[];
 };
@@ -54,6 +85,7 @@ export type SignatureRequest = {
     encodeData: Hex;
     wallet: SimpleWalletClient;
     verifyingContract: Address;
+    /** The deadline for the signature in seconds. */
     deadline: bigint | number | string;
     chainId: number | bigint | string;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"permission.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["permission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAElD,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,+BAA4B;AAExE,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,EAAE,EAAE,OAAO,CAAC;IACZ,UAAU,EAAE,gBAAgB,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,UAAU,EAAE,gBAAgB,CAAC;IAC7B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AACF;;;IAGI;AACJ,oBAAY,gBAAgB;IAE1B,OAAO,IAAA;IAEP,KAAK,IAAA;IAEL,IAAI,IAAA;CACL;AAED,MAAM,MAAM,mCAAmC,GAAG;IAChD,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACrC,GAAG,qBAAqB,CAAC;AAE1B,MAAM,MAAM,0BAA0B,GAAG;IACvC,WAAW,EAAE,IAAI,CAAC,qBAAqB,EAAE,WAAW,CAAC,EAAE,CAAC;IACxD,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACrC,GAAG,0BAA0B,CAAC;AAE/B,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,GAAG,CAAC;IACX,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACnC,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAClC,WAAW,EAAE,IAAI,CAAC,qBAAqB,EAAE,WAAW,CAAC,EAAE,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,GAAG,CAAC;IACX,EAAE,EAAE,OAAO,CAAC;IACZ,UAAU,EAAE,GAAG,CAAC;IAChB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACnC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAAE,SAAS,EAAE,GAAG,CAAC;IAAC,KAAK,EAAE,GAAG,CAAA;CAAE,CAAC"}
+{"version":3,"file":"permission.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["permission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,+BAA4B;AAExE,MAAM,MAAM,qBAAqB,GAAG;IAClC,yDAAyD;IACzD,IAAI,EAAE,OAAO,CAAC;IACd;;;;OAIG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB,2FAA2F;IAC3F,EAAE,EAAE,OAAO,CAAC;IACZ,4DAA4D;IAC5D,UAAU,EAAE,gBAAgB,CAAC;IAC7B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,yDAAyD;IACzD,IAAI,EAAE,OAAO,CAAC;IACd,2DAA2D;IAC3D,MAAM,EAAE,OAAO,CAAC;IAChB,4DAA4D;IAC5D,UAAU,EAAE,gBAAgB,CAAC;IAC7B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AACF;;GAEG;AACH,oBAAY,gBAAgB;IAC1B;;;OAGG;IACH,OAAO,IAAA;IACP,wFAAwF;IACxF,KAAK,IAAA;IACL,sFAAsF;IACtF,IAAI,IAAA;CACL;AAED,MAAM,MAAM,mCAAmC,GAAG;IAChD;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACrC,GAAG,qBAAqB,CAAC;AAE1B,MAAM,MAAM,0BAA0B,GAAG;IACvC,WAAW,EAAE,IAAI,CAAC,qBAAqB,EAAE,WAAW,CAAC,EAAE,CAAC;IACxD,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG;IAClD,yDAAyD;IACzD,IAAI,EAAE,OAAO,CAAC;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACrC,GAAG,0BAA0B,CAAC;AAE/B,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,GAAG,CAAC;IACX,iDAAiD;IACjD,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACnC,MAAM,EAAE,kBAAkB,CAAC;IAC3B,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAClC,WAAW,EAAE,IAAI,CAAC,qBAAqB,EAAE,WAAW,CAAC,EAAE,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,GAAG,CAAC;IACX,EAAE,EAAE,OAAO,CAAC;IACZ,UAAU,EAAE,GAAG,CAAC;IAChB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,iDAAiD;IACjD,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACnC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAAE,SAAS,EAAE,GAAG,CAAC;IAAC,KAAK,EAAE,GAAG,CAAA;CAAE,CAAC"}

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

@@ -4,10 +4,14 @@ import { EncodedTxData, IpAccountImplClient, IpRoyaltyVaultImplRevenueTokenClaim
 import { WithERC20Options } from "../options.js";
 import { TokenAmountInput } from "../common.js";
 export type ClaimableRevenueRequest = {
+    /** The IP ID of the royalty vault. */
     royaltyVaultIpId: Address;
+    /** The address of the royalty token holder. */
     claimer: Address;
+    /** The revenue token to claim. */
     token: Address;
 };
+/** The amount of revenue token claimable. */
 export type ClaimableRevenueResponse = bigint;
 export type PayRoyaltyOnBehalfRequest = WithTxOptions & WithERC20Options & WithWipOptions & {
     /** The IP ID that receives the royalties. */

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,IAAI,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAEzD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,sBAAmB;AAC3D,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,0CAA0C,EAC3C,+BAA4B;AAC7B,OAAO,EAAE,gBAAgB,EAAE,sBAAmB;AAC9C,OAAO,EAAE,gBAAgB,EAAE,qBAAkB;AAE7C,MAAM,MAAM,uBAAuB,GAAG;IACpC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC;AACF,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAC9C,MAAM,MAAM,yBAAyB,GAAG,aAAa,GACnD,gBAAgB,GAChB,cAAc,GAAG;IACf,6CAA6C;IAC7C,YAAY,EAAE,OAAO,CAAC;IACtB,yCAAyC;IACzC,SAAS,EAAE,OAAO,CAAC;IACnB,6CAA6C;IAC7C,KAAK,EAAE,OAAO,CAAC;IACf,yBAAyB;IACzB,MAAM,EAAE,gBAAgB,CAAC;CAC1B,CAAC;AAEJ,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,sBAAsB,GAAG,gBAAgB,GAAG;IACtD,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;CAC3B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,YAAY,CAAC,EAAE;QACb;;;;;;;;WAQG;QACH,kCAAkC,CAAC,EAAE,OAAO,CAAC;QAE7C;;;;;;WAMG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B,CAAC;CACH,CAAC;AACF,MAAM,MAAM,2BAA2B,GAAG,gBAAgB,GAAG;IAC3D,gEAAgE;IAChE,WAAW,EAAE,CAAC,IAAI,CAAC,sBAAsB,EAAE,cAAc,GAAG,cAAc,CAAC,GAAG;QAC5E,8EAA8E;QAC9E,IAAI,EAAE,OAAO,CAAC;KACf,CAAC,EAAE,CAAC;IACL,OAAO,CAAC,EAAE;QACR;;;;;WAKG;QACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;KACpC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,QAAQ,EAAE,IAAI,EAAE,CAAC;IACjB,QAAQ,EAAE,kBAAkB,EAAE,CAAC;IAC/B,aAAa,CAAC,EAAE,0CAA0C,EAAE,CAAC;CAC9D,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,QAAQ,EAAE,IAAI,EAAE,CAAC;IACjB,OAAO,EAAE,kBAAkB,CAAC;IAC5B;;;;OAIG;IACH,aAAa,CAAC,EAAE,0CAA0C,EAAE,CAAC;CAC9D,CAAC;AAEF,MAAM,MAAM,yCAAyC,GAAG;IACtD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,aAAa,EAAE,0CAA0C,EAAE,CAAC;CAC7D,CAAC;AAEF;;GAEG;AACH,oBAAY,mBAAmB;IAC7B,GAAG,IAAI;IACP,GAAG,IAAA;CACJ;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,mBAAmB,CAAC;AAE/D,MAAM,MAAM,sBAAsB,GAAG,aAAa,GAAG;IACnD,aAAa,EAAE,kBAAkB,CAAC;IAClC,IAAI,EAAE,OAAO,CAAC;IACd,YAAY,EAAE,OAAO,CAAC;IACtB,oCAAoC;IACpC,KAAK,EAAE,OAAO,CAAC;CAChB,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,aAAa,EAAE,cAAc,EAAE,sBAAmB;AAC3D,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,0CAA0C,EAC3C,+BAA4B;AAC7B,OAAO,EAAE,gBAAgB,EAAE,sBAAmB;AAC9C,OAAO,EAAE,gBAAgB,EAAE,qBAAkB;AAE7C,MAAM,MAAM,uBAAuB,GAAG;IACpC,sCAAsC;IACtC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,+CAA+C;IAC/C,OAAO,EAAE,OAAO,CAAC;IACjB,kCAAkC;IAClC,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,6CAA6C;AAC7C,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAE9C,MAAM,MAAM,yBAAyB,GAAG,aAAa,GACnD,gBAAgB,GAChB,cAAc,GAAG;IACf,6CAA6C;IAC7C,YAAY,EAAE,OAAO,CAAC;IACtB,yCAAyC;IACzC,SAAS,EAAE,OAAO,CAAC;IACnB,6CAA6C;IAC7C,KAAK,EAAE,OAAO,CAAC;IACf,yBAAyB;IACzB,MAAM,EAAE,gBAAgB,CAAC;CAC1B,CAAC;AAEJ,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,sBAAsB,GAAG,gBAAgB,GAAG;IACtD,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;CAC3B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,YAAY,CAAC,EAAE;QACb;;;;;;;;WAQG;QACH,kCAAkC,CAAC,EAAE,OAAO,CAAC;QAE7C;;;;;;WAMG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B,CAAC;CACH,CAAC;AACF,MAAM,MAAM,2BAA2B,GAAG,gBAAgB,GAAG;IAC3D,gEAAgE;IAChE,WAAW,EAAE,CAAC,IAAI,CAAC,sBAAsB,EAAE,cAAc,GAAG,cAAc,CAAC,GAAG;QAC5E,8EAA8E;QAC9E,IAAI,EAAE,OAAO,CAAC;KACf,CAAC,EAAE,CAAC;IACL,OAAO,CAAC,EAAE;QACR;;;;;WAKG;QACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;KACpC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,QAAQ,EAAE,IAAI,EAAE,CAAC;IACjB,QAAQ,EAAE,kBAAkB,EAAE,CAAC;IAC/B,aAAa,CAAC,EAAE,0CAA0C,EAAE,CAAC;CAC9D,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,QAAQ,EAAE,IAAI,EAAE,CAAC;IACjB,OAAO,EAAE,kBAAkB,CAAC;IAC5B;;;;OAIG;IACH,aAAa,CAAC,EAAE,0CAA0C,EAAE,CAAC;CAC9D,CAAC;AAEF,MAAM,MAAM,yCAAyC,GAAG;IACtD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,aAAa,EAAE,0CAA0C,EAAE,CAAC;CAC7D,CAAC;AAEF;;GAEG;AACH,oBAAY,mBAAmB;IAC7B,GAAG,IAAI;IACP,GAAG,IAAA;CACJ;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,mBAAmB,CAAC;AAE/D,MAAM,MAAM,sBAAsB,GAAG,aAAa,GAAG;IACnD,aAAa,EAAE,kBAAkB,CAAC;IAClC,IAAI,EAAE,OAAO,CAAC;IACd,YAAY,EAAE,OAAO,CAAC;IACtB,oCAAoC;IACpC,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC"}

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

@@ -0,0 +1,64 @@
+import { Address, Hash, PublicClient } from "viem";
+import { Multicall3Aggregate3Request, EncodedTxData, SimpleWalletClient, Erc20Client } from "../../abi/generated.js";
+import { ERC20Options, TransactionResponse, TxOptions, WipOptions, WithWipOptions } from "../options.js";
+import { TokenClient, WipTokenClient } from "../../utils/token.js";
+export type Multicall3ValueCall = Multicall3Aggregate3Request["calls"][0] & {
+    value: bigint;
+};
+export type Erc20Spender = {
+    address: Address;
+    /**
+     * Amount that the address will spend in erc20 token.
+     * If not provided, then unlimited amount is assumed.
+     */
+    amount?: bigint;
+};
+export type ApprovalCall = {
+    spenders: Erc20Spender[];
+    client: TokenClient;
+    rpcClient: PublicClient;
+    /** owner is the address calling the approval */
+    owner: Address;
+    /** when true, will return an array of {@link Multicall3ValueCall} */
+    useMultiCall: boolean;
+    multicallAddress?: Address;
+};
+export type TokenApprovalCall = {
+    spenders: Erc20Spender[];
+    client: Erc20Client;
+    multicallAddress: Address;
+    rpcClient: PublicClient;
+    /** owner is the address calling the approval */
+    owner: Address;
+    /** when true, will return an array of {@link Multicall3ValueCall} */
+    useMultiCall: boolean;
+};
+export type ContractCallWithFees<T extends Hash | Hash[] = Hash> = {
+    totalFees: bigint;
+    multicall3Address: Address;
+    /** all possible spenders of the erc20 token */
+    tokenSpenders: Erc20Spender[];
+    contractCall: () => Promise<T>;
+    encodedTxs: EncodedTxData[];
+    rpcClient: PublicClient;
+    wallet: SimpleWalletClient;
+    sender: Address;
+    options: {
+        wipOptions?: WipOptions;
+        erc20Options?: ERC20Options;
+    };
+    token?: Address;
+    txOptions?: TxOptions;
+};
+export type MulticallWithWrapIp = WithWipOptions & {
+    calls: Multicall3ValueCall[];
+    ipAmountToWrap: bigint;
+    contractCall: () => Promise<Hash | Hash[]>;
+    wipSpenders: Erc20Spender[];
+    multicall3Address: Address;
+    wipClient: WipTokenClient;
+    rpcClient: PublicClient;
+    wallet: SimpleWalletClient;
+};
+export type ContractCallWithFeesResponse<T extends Hash | Hash[]> = Promise<T extends Hash[] ? TransactionResponse[] : TransactionResponse>;
+//# 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,aAAa,EACb,kBAAkB,EAClB,WAAW,EACZ,+BAA4B;AAC7B,OAAO,EACL,YAAY,EACZ,mBAAmB,EACnB,SAAS,EACT,UAAU,EACV,cAAc,EACf,sBAAmB;AACpB,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,6BAA0B;AAEhE,MAAM,MAAM,mBAAmB,GAAG,2BAA2B,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9F,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,EAAE,YAAY,EAAE,CAAC;IACzB,MAAM,EAAE,WAAW,CAAC;IACpB,SAAS,EAAE,YAAY,CAAC;IACxB,gDAAgD;IAChD,KAAK,EAAE,OAAO,CAAC;IACf,qEAAqE;IACrE,YAAY,EAAE,OAAO,CAAC;IACtB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,EAAE,YAAY,EAAE,CAAC;IACzB,MAAM,EAAE,WAAW,CAAC;IACpB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,SAAS,EAAE,YAAY,CAAC;IACxB,gDAAgD;IAChD,KAAK,EAAE,OAAO,CAAC;IACf,qEAAqE;IACrE,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,IAAI,GAAG,IAAI,EAAE,GAAG,IAAI,IAAI;IACjE,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,+CAA+C;IAC/C,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,YAAY,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC;IAC/B,UAAU,EAAE,aAAa,EAAE,CAAC;IAC5B,SAAS,EAAE,YAAY,CAAC;IACxB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE;QACP,UAAU,CAAC,EAAE,UAAU,CAAC;QACxB,YAAY,CAAC,EAAE,YAAY,CAAC;KAC7B,CAAC;IACF,KAAK,CAAC,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,GAAG,IAAI,EAAE,CAAC,CAAC;IAC3C,WAAW,EAAE,YAAY,EAAE,CAAC;IAC5B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,SAAS,EAAE,cAAc,CAAC;IAC1B,SAAS,EAAE,YAAY,CAAC;IACxB,MAAM,EAAE,kBAAkB,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,4BAA4B,CAAC,CAAC,SAAS,IAAI,GAAG,IAAI,EAAE,IAAI,OAAO,CACzE,CAAC,SAAS,IAAI,EAAE,GAAG,mBAAmB,EAAE,GAAG,mBAAmB,CAC/D,CAAC"}

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

@@ -11,6 +11,7 @@ export declare const aeneid: {
             readonly blockCreated: 1792;
         };
     };
+    ensTlds?: readonly string[] | undefined;
     id: 1315;
     name: "aeneid";
     nativeCurrency: {
@@ -43,6 +44,7 @@ export declare const mainnet: {
             readonly blockCreated: 340998;
         };
     };
+    ensTlds?: readonly string[] | undefined;
     id: 1514;
     name: "mainnet";
     nativeCurrency: {

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,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsBjB,CAAC;AAEH,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsBlB,CAAC"}
+{"version":3,"file":"chain.d.ts","sourceRoot":"../../../../src/utils","sources":["chain.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsBjB,CAAC;AAEH,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsBlB,CAAC"}

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

@@ -9,5 +9,5 @@ export type IpMetadataForWorkflow = {
     /** The hash of the metadata for the IP NFT. */
     nftMetadataHash: Hex;
 };
-export declare const getIpMetadataForWorkflow: (metadata?: Partial<IpMetadataForWorkflow>) => IpMetadataForWorkflow;
+export declare const getIpMetadataForWorkflow: (ipMetadata?: Partial<IpMetadataForWorkflow>) => IpMetadataForWorkflow;
 //# sourceMappingURL=getIpMetadataForWorkflow.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getIpMetadataForWorkflow.d.ts","sourceRoot":"../../../../src/utils","sources":["getIpMetadataForWorkflow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAY,MAAM,MAAM,CAAC;AAErC,MAAM,MAAM,qBAAqB,GAAG;IAClC,0CAA0C;IAC1C,aAAa,EAAE,MAAM,CAAC;IACtB,2CAA2C;IAC3C,cAAc,EAAE,GAAG,CAAC;IACpB,2CAA2C;IAC3C,cAAc,EAAE,MAAM,CAAC;IACvB,+CAA+C;IAC/C,eAAe,EAAE,GAAG,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,wBAAwB,GACnC,WAAW,OAAO,CAAC,qBAAqB,CAAC,KACxC,qBAOF,CAAC"}
+{"version":3,"file":"getIpMetadataForWorkflow.d.ts","sourceRoot":"../../../../src/utils","sources":["getIpMetadataForWorkflow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAY,MAAM,MAAM,CAAC;AAErC,MAAM,MAAM,qBAAqB,GAAG;IAClC,0CAA0C;IAC1C,aAAa,EAAE,MAAM,CAAC;IACtB,2CAA2C;IAC3C,cAAc,EAAE,GAAG,CAAC;IACpB,2CAA2C;IAC3C,cAAc,EAAE,MAAM,CAAC;IACvB,+CAA+C;IAC/C,eAAe,EAAE,GAAG,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,wBAAwB,GACnC,aAAa,OAAO,CAAC,qBAAqB,CAAC,KAC1C,qBAOF,CAAC"}

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

@@ -1,28 +1,11 @@
 import { PermissionSignatureRequest, SignatureRequest, SignatureResponse } from "../types/resources/permission.js";
 /**
  * Get the signature for setting permissions.
- * @param param - The parameter object containing necessary data to get the signature.
- * @param param.ipId - The IP ID.
- * @param param.deadline - The deadline.
- * @param param.nonce - The nonce.
- * @param param.wallet - The wallet client.
- * @param param.chainId - The chain ID.
- * @param param.permissionFunc - The permission function,default function is setPermission.
- * @returns A Promise that resolves to the signature.
  */
 export declare const getPermissionSignature: (param: PermissionSignatureRequest) => Promise<SignatureResponse>;
 export declare const getDeadline: (unixTimestamp: bigint, deadline?: bigint | number | string) => bigint;
 /**
  * Get the signature.
- * @param param - The parameter object containing necessary data to get the signature.
- * @param param.state - The IP Account's state.
- * @param param.to - The recipient address.
- * @param param.encodeData - The encoded data.
- * @param param.wallet - The wallet client.
- * @param param.verifyingContract - The verifying contract.
- * @param param.deadline - The deadline.
- * @param param.chainId - The chain ID.
- * @returns A Promise that resolves to the signature.
  */
 export declare const getSignature: ({ state, to, encodeData, wallet, verifyingContract, deadline, chainId, }: SignatureRequest) => Promise<SignatureResponse>;
 //# sourceMappingURL=sign.d.ts.map

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,GACjC,OAAO,0BAA0B,KAChC,OAAO,CAAC,iBAAiB,CAqC3B,CAAC;AAEF,eAAO,MAAM,WAAW,GAAI,eAAe,MAAM,EAAE,WAAW,MAAM,GAAG,MAAM,GAAG,MAAM,KAAG,MAKxF,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,GAAU,0EAQhC,gBAAgB,KAAG,OAAO,CAAC,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;;GAEG;AACH,eAAO,MAAM,sBAAsB,GACjC,OAAO,0BAA0B,KAChC,OAAO,CAAC,iBAAiB,CAqC3B,CAAC;AAEF,eAAO,MAAM,WAAW,GAAI,eAAe,MAAM,EAAE,WAAW,MAAM,GAAG,MAAM,GAAG,MAAM,KAAG,MAKxF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY,GAAU,0EAQhC,gBAAgB,KAAG,OAAO,CAAC,iBAAiB,CAkD9C,CAAC"}

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

@@ -0,0 +1,28 @@
+import { Address, Hash, PublicClient } from "viem";
+import { EncodedTxData, SimpleWalletClient } from "../abi/generated.js";
+export interface TokenClient {
+    balanceOf(account: Address): Promise<bigint>;
+    allowance(owner: string, spender: string): Promise<bigint>;
+    approve(spender: string, value: bigint): Promise<Hash>;
+    approveEncode(spender: Address, value: bigint): EncodedTxData;
+}
+export declare class ERC20Client implements TokenClient {
+    private ercClient;
+    constructor(rpcClient: PublicClient, wallet: SimpleWalletClient, address: Address);
+    balanceOf(account: Address): Promise<bigint>;
+    allowance(owner: Address, spender: Address): Promise<bigint>;
+    approve(spender: Address, value: bigint): Promise<Hash>;
+    approveEncode(spender: Address, value: bigint): EncodedTxData;
+    mint(to: Address, amount: bigint): Promise<`0x${string}`>;
+}
+export declare class WipTokenClient implements TokenClient {
+    private wipClient;
+    constructor(rpcClient: PublicClient, wallet: SimpleWalletClient);
+    balanceOf(account: Address): Promise<bigint>;
+    allowance(owner: Address, spender: Address): Promise<bigint>;
+    approve(spender: Address, value: bigint): Promise<Hash>;
+    approveEncode(spender: Address, value: bigint): EncodedTxData;
+    depositEncode(): EncodedTxData;
+    get address(): Address;
+}
+//# sourceMappingURL=token.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"token.d.ts","sourceRoot":"../../../../src/utils","sources":["token.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAEnD,OAAO,EAAE,aAAa,EAAe,kBAAkB,EAAmB,4BAAyB;AAEnG,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7C,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3D,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvD,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,aAAa,CAAC;CAC/D;AAED,qBAAa,WAAY,YAAW,WAAW;IAC7C,OAAO,CAAC,SAAS,CAAc;gBAEnB,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,OAAO;IAI3E,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAI5C,SAAS,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAI5D,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7D,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,aAAa;IAIvD,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM;CAGvC;AAED,qBAAa,cAAe,YAAW,WAAW;IAChD,OAAO,CAAC,SAAS,CAAkB;gBAEvB,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAIzD,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAK5C,SAAS,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAK5D,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7D,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,aAAa;IAI7D,aAAa,IAAI,aAAa;IAI9B,IAAI,OAAO,IAAI,OAAO,CAErB;CACF"}