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

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

@@ -1 +1 @@
-{"version":3,"file":"permission.d.ts","sourceRoot":"../../../../src/resources","sources":["permission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAiE,MAAM,MAAM,CAAC;AAGnG,OAAO,EACL,qCAAqC,EACrC,mCAAmC,EACnC,wBAAwB,EACxB,0BAA0B,EAC1B,qBAAqB,EACrB,sBAAsB,EACvB,yCAAsC;AACvC,OAAO,EAEL,sBAAsB,EACtB,wBAAwB,EAExB,qBAAqB,EACrB,kBAAkB,EACnB,4BAAyB;AAI1B,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAE3C,qBAAa,gBAAgB;IACpB,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,wBAAwB,EAAE,wBAAwB,CAAC;IAC1D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;gBAEvB,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IASlF;;;;;;;;;;;;;;;;;;;OAmBG;IACU,aAAa,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IA8B3F;;;;;;;;;;;;OAYG;IACU,4BAA4B,CACvC,OAAO,EAAE,mCAAmC,GAC3C,OAAO,CAAC,sBAAsB,CAAC;IA8DlC;;;;;;;;;OASG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,sBAAsB,CAAC;IA0BlC;;;;;;;;;;;;;OAaG;IACU,mBAAmB,CAC9B,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,sBAAsB,CAAC;IAiClC;;;;;;;;;;;;;;OAcG;IACU,8BAA8B,CACzC,OAAO,EAAE,qCAAqC,GAC7C,OAAO,CAAC,sBAAsB,CAAC;YA0DpB,iBAAiB;CAQhC"}
+{"version":3,"file":"permission.d.ts","sourceRoot":"../../../../src/resources","sources":["permission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAiE,MAAM,MAAM,CAAC;AAGnG,OAAO,EACL,qCAAqC,EACrC,mCAAmC,EACnC,wBAAwB,EACxB,0BAA0B,EAC1B,qBAAqB,EACrB,sBAAsB,EACvB,yCAAsC;AACvC,OAAO,EAEL,sBAAsB,EACtB,wBAAwB,EAExB,qBAAqB,EACrB,kBAAkB,EACnB,4BAAyB;AAI1B,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAE3C,qBAAa,gBAAgB;IACpB,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,wBAAwB,EAAE,wBAAwB,CAAC;IAC1D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;gBAEvB,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IASlF;;;;;;;;OAQG;IACU,aAAa,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IA8B3F;;;;OAIG;IACU,4BAA4B,CACvC,OAAO,EAAE,mCAAmC,GAC3C,OAAO,CAAC,sBAAsB,CAAC;IA8DlC;;;;OAIG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,sBAAsB,CAAC;IA0BlC;;;;OAIG;IACU,mBAAmB,CAC9B,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,sBAAsB,CAAC;IAiClC;;;;OAIG;IACU,8BAA8B,CACzC,OAAO,EAAE,qCAAqC,GAC7C,OAAO,CAAC,sBAAsB,CAAC;YA0DpB,iBAAiB;CAQhC"}

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

@@ -17,9 +17,14 @@ export declare class RoyaltyClient {
     private readonly chainId;
     constructor(rpcClient: PublicClient, wallet: SimpleWalletClient, chainId: ChainIds);
     /**
-     * Claims all revenue from the child IPs of an ancestor IP, then transfer.
+     * 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.
+     *
+     * @remarks
+     * Even if there are no child IPs, you must still populate {@link ClaimAllRevenueRequest.currencyTokens} with
+     * the token addresses you wish to claim. This is required for the claim operation to know which
+     * token balances to process.
      */
     claimAllRevenue(req: ClaimAllRevenueRequest): Promise<ClaimAllRevenueResponse>;
     /**
@@ -27,6 +32,11 @@ export declare class RoyaltyClient {
      * if multicall is disabled, it will call @link{claimAllRevenue} for each 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.
+     *
+     * @remarks
+     * Even if there are no child IPs, you must still populate `currencyTokens` in each ancestor IP
+     * with the token addresses you wish to claim. This is required for the claim operation to know which
+     * token balances to process.
      */
     batchClaimAllRevenue(request: BatchClaimAllRevenueRequest): Promise<BatchClaimAllRevenueResponse>;
     /**
@@ -35,17 +45,11 @@ export declare class RoyaltyClient {
     payRoyaltyOnBehalf(request: PayRoyaltyOnBehalfRequest): Promise<PayRoyaltyOnBehalfResponse>;
     /**
      * Get total amount of revenue token claimable by a royalty token holder.
-     * @param request - The request object that contains all data needed to claim Revenue.
-     *   @param request.royaltyVaultIpId The id of the royalty vault.
-     *   @param request.claimer The address of the royalty token holder
-     *   @param request.token The revenue token to claim.
-     * @returns A Promise that contains the amount of revenue token claimable
+     * Returns the amount of revenue token claimable by the claimer.
      */
     claimableRevenue(request: ClaimableRevenueRequest): Promise<ClaimableRevenueResponse>;
     /**
      * Get the royalty vault proxy address of given royaltyVaultIpId.
-     * @param royaltyVaultIpId the id of the royalty vault.
-     * @returns A Promise that resolves to an object containing the royalty vault address.
      */
     getRoyaltyVaultAddress(royaltyVaultIpId: Hex): Promise<Address>;
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"royalty.d.ts","sourceRoot":"../../../../src/resources","sources":["royalty.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EAGP,GAAG,EACH,YAAY,EAGb,MAAM,MAAM,CAAC;AAGd,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,uBAAuB,EACvB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAE1B,sBAAsB,EACvB,sCAAmC;AACpC,OAAO,EAEL,qBAAqB,EACrB,6BAA6B,EAC7B,gCAAgC,EAEhC,gBAAgB,EAChB,mBAAmB,EAEnB,sBAAsB,EACtB,kBAAkB,EAClB,eAAe,EAChB,4BAAyB;AAK1B,OAAO,EAAE,mBAAmB,EAAE,4BAAyB;AACvD,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAI3C,qBAAa,aAAa;IACjB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,gCAAgC,EAAE,gCAAgC,CAAC;IACnE,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,eAAe,EAAE,eAAe,CAAC;IACxC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAU;IACxC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;gBAEvB,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAalF;;;;OAIG;IACU,eAAe,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAmD3F;;;;;OAKG;IACU,oBAAoB,CAC/B,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,4BAA4B,CAAC;IAoHxC;;OAEG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IA6DtC;;;;;;;OAOG;IACU,gBAAgB,CAC3B,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;IAepC;;;;OAIG;IACU,sBAAsB,CAAC,gBAAgB,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAU5E;;OAEG;IACU,eAAe,CAAC,EAC3B,SAAS,EACT,IAAI,EACJ,aAAa,EACb,YAAY,EACZ,KAAK,GACN,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC;YAsB1C,mCAAmC;YAuBnC,cAAc;IAY5B;;;OAGG;YACW,eAAe;CAe9B"}
+{"version":3,"file":"royalty.d.ts","sourceRoot":"../../../../src/resources","sources":["royalty.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EAGP,GAAG,EACH,YAAY,EAGb,MAAM,MAAM,CAAC;AAGd,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,uBAAuB,EACvB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAE1B,sBAAsB,EACvB,sCAAmC;AACpC,OAAO,EAEL,qBAAqB,EACrB,6BAA6B,EAC7B,gCAAgC,EAEhC,gBAAgB,EAChB,mBAAmB,EAEnB,sBAAsB,EACtB,kBAAkB,EAClB,eAAe,EAChB,4BAAyB;AAK1B,OAAO,EAAE,mBAAmB,EAAE,4BAAyB;AACvD,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAI3C,qBAAa,aAAa;IACjB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,gCAAgC,EAAE,gCAAgC,CAAC;IACnE,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,eAAe,EAAE,eAAe,CAAC;IACxC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAU;IACxC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;gBAEvB,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAalF;;;;;;;;;OASG;IACU,eAAe,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAmD3F;;;;;;;;;;OAUG;IACU,oBAAoB,CAC/B,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,4BAA4B,CAAC;IAoHxC;;OAEG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IA6DtC;;;OAGG;IACU,gBAAgB,CAC3B,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;IAepC;;OAEG;IACU,sBAAsB,CAAC,gBAAgB,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAU5E;;OAEG;IACU,eAAe,CAAC,EAC3B,SAAS,EACT,IAAI,EACJ,aAAa,EACb,YAAY,EACZ,KAAK,GACN,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC;YAsB1C,mCAAmC;YAuBnC,cAAc;IAY5B;;;OAGG;YACW,eAAe;CAe9B"}

package/dist/declarations/src/types/common.d.ts

@@ -9,14 +9,22 @@ export type IpMetadataAndTxOptions = WithTxOptions & {
     /** The desired metadata for the newly minted NFT and newly registered IP. */
     ipMetadata?: Partial<IpMetadataForWorkflow>;
 };
-export type LicensingConfig = {
+/**
+ * This data used IP owners to define the configuration
+ * when others are minting license tokens of their IP through the LicensingModule.
+ * @see {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/lib/Licensing.sol#L27 | Licensing.sol}
+ */
+export type LicensingConfigInput = {
     /** Whether the configuration is set or not */
     isSet: boolean;
     /** The minting fee to be paid when minting license tokens. */
     mintingFee: bigint | string | number;
     /** The hook contract address for the licensing module, or zero address if none. */
     licensingHook: Address;
-    /** The data to be used by the licensing hook. */
+    /**
+     * The data to be used by the licensing hook.
+     * Set to a zero hash if no data is provided.
+     */
     hookData: Hex;
     /** The commercial revenue share percentage (from 0 to 100%, represented as 100_000_000). */
     commercialRevShare: number | string;
@@ -27,7 +35,7 @@ export type LicensingConfig = {
     /** The address of the expected group reward pool. The IP can only be added to a group with this specified reward pool address, or zero address if the IP does not want to be added to any group. */
     expectGroupRewardPool: Address;
 };
-export type ValidatedLicensingConfig = LicensingConfig & {
+export type LicensingConfig = LicensingConfigInput & {
     mintingFee: bigint;
     commercialRevShare: number;
     expectMinimumGroupRewardShare: number;

package/dist/declarations/src/types/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"../../../../src/types","sources":["common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EAAE,aAAa,EAAE,qBAAkB;AAC1C,OAAO,EAAE,qBAAqB,EAAE,6CAA0C;AAE1E,MAAM,MAAM,SAAS,GAAG;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,OAAO,EAAE,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,aAAa,GAAG;IACnD,6EAA6E;IAC7E,UAAU,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;CAC7C,CAAC;AACF,MAAM,MAAM,eAAe,GAAG;IAC5B,8CAA8C;IAC9C,KAAK,EAAE,OAAO,CAAC;IACf,8DAA8D;IAC9D,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACrC,mFAAmF;IACnF,aAAa,EAAE,OAAO,CAAC;IACvB,iDAAiD;IACjD,QAAQ,EAAE,GAAG,CAAC;IACd,4FAA4F;IAC5F,kBAAkB,EAAE,MAAM,GAAG,MAAM,CAAC;IACpC,gDAAgD;IAChD,QAAQ,EAAE,OAAO,CAAC;IAClB,qKAAqK;IACrK,6BAA6B,EAAE,MAAM,GAAG,MAAM,CAAC;IAC/C,oMAAoM;IACpM,qBAAqB,EAAE,OAAO,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,eAAe,GAAG;IACvD,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,6BAA6B,EAAE,MAAM,CAAC;CACvC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,MAAM,CAAC;AAE/C;;;GAGG;AACH,oBAAY,YAAY;IACtB,wBAAwB,uBAAuB;IAC/C,iBAAiB,oBAAoB;IACrC,wBAAwB,0BAA0B;CACnD"}
+{"version":3,"file":"common.d.ts","sourceRoot":"../../../../src/types","sources":["common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EAAE,aAAa,EAAE,qBAAkB;AAC1C,OAAO,EAAE,qBAAqB,EAAE,6CAA0C;AAE1E,MAAM,MAAM,SAAS,GAAG;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,OAAO,EAAE,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,aAAa,GAAG;IACnD,6EAA6E;IAC7E,UAAU,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;CAC7C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,8CAA8C;IAC9C,KAAK,EAAE,OAAO,CAAC;IACf,8DAA8D;IAC9D,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACrC,mFAAmF;IACnF,aAAa,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,QAAQ,EAAE,GAAG,CAAC;IACd,4FAA4F;IAC5F,kBAAkB,EAAE,MAAM,GAAG,MAAM,CAAC;IACpC,gDAAgD;IAChD,QAAQ,EAAE,OAAO,CAAC;IAClB,qKAAqK;IACrK,6BAA6B,EAAE,MAAM,GAAG,MAAM,CAAC;IAC/C,oMAAoM;IACpM,qBAAqB,EAAE,OAAO,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,oBAAoB,GAAG;IACnD,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,6BAA6B,EAAE,MAAM,CAAC;CACvC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,MAAM,CAAC;AAE/C;;;GAGG;AACH,oBAAY,YAAY;IACtB,wBAAwB,uBAAuB;IAC/C,iBAAiB,oBAAoB;IACrC,wBAAwB,0BAA0B;CACnD"}

package/dist/declarations/src/types/config.d.ts

@@ -13,16 +13,31 @@ export type SupportedChainIds = "aeneid" | "mainnet" | ChainIds;
  */
 export type UseAccountStoryConfig = {
     readonly account: Account | Address;
+    /**
+     * The chain ID to use, the default is `aeneid`.
+     *
+     * @default 13_15
+     */
     readonly chainId?: SupportedChainIds;
     readonly transport: Transport;
 };
 export type UseWalletStoryConfig = {
+    /**
+     * The chain ID to use, the default is `aeneid`.
+     *
+     * @default 13_15
+     */
     readonly chainId?: SupportedChainIds;
     readonly transport: Transport;
     readonly wallet: SimpleWalletClient;
 };
 export type StoryConfig = {
     readonly transport: Transport;
+    /**
+     * The chain ID to use, the default is `aeneid`.
+     *
+     * @default 13_15
+     */
     readonly chainId?: SupportedChainIds;
     readonly wallet?: SimpleWalletClient;
     readonly account?: Account | Address;

package/dist/declarations/src/types/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"../../../../src/types","sources":["config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAEnD,OAAO,EAAE,kBAAkB,EAAE,4BAAyB;AAEtD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC;IACpC,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;KAAG,GAAG,IAAI,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAAE,CAAC;AAErF,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC"}
+{"version":3,"file":"config.d.ts","sourceRoot":"../../../../src/types","sources":["config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAEnD,OAAO,EAAE,kBAAkB,EAAE,4BAAyB;AAEtD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC;IACpC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;KAAG,GAAG,IAAI,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAAE,CAAC;AAErF,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC"}

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

@@ -22,8 +22,9 @@ export type RaiseDisputeRequest = WithTxOptions & {
      * The amount of wrapper IP that the dispute initiator pays upfront into a pool.
      * To counter that dispute the opposite party of the dispute has to place a bond of the same amount.
      * The winner of the dispute gets the original bond back + 50% of the other party bond. The remaining 50% of the loser party bond goes to the reviewer.
+     * The bond amount must be between the minimum and maximum bond values defined in the Optimistic Oracle V3 (OOV3) contract. If not specified, it defaults to the minimum bond value.
      */
-    bond: bigint | number | string;
+    bond?: bigint | number | string;
     /**
      * Omit {@link WipOptions.useMulticallWhenPossible} for this function due to disputeInitiator issue.
      * It will be executed sequentially with several transactions.
@@ -37,7 +38,12 @@ export type RaiseDisputeResponse = {
 };
 export type CancelDisputeRequest = {
     disputeId: number | string | bigint;
-    data?: Address;
+    /**
+     * Additional data used in the cancellation process.
+     *
+     * @default 0x
+     */
+    data?: Hex;
     txOptions?: TxOptions;
 };
 export type CancelDisputeResponse = {
@@ -46,7 +52,12 @@ export type CancelDisputeResponse = {
 };
 export type ResolveDisputeRequest = {
     disputeId: number | string | bigint;
-    data: Address;
+    /**
+     * Additional data used in the resolution process.
+     *
+     * @default 0x
+     */
+    data?: Hex;
     txOptions?: TxOptions;
 };
 export type ResolveDisputeResponse = {

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

@@ -1 +1 @@
-{"version":3,"file":"dispute.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["dispute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,sBAAmB;AAClE,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAEpD,MAAM,MAAM,mBAAmB,GAAG,aAAa,GAAG;IAChD,mDAAmD;IACnD,UAAU,EAAE,OAAO,CAAC;IACpB;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,yGAAyG;IACzG,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACnC;;;;OAIG;IACH,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC/B;;;OAGG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,0BAA0B,CAAC,CAAC;CAC3D,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACpC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACpC,IAAI,EAAE,OAAO,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;CAC/B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,gBAAgB,EAAE;QAChB,sBAAsB;QACtB,IAAI,EAAE,OAAO,CAAC;QACd,6DAA6D;QAC7D,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;KACrC,EAAE,CAAC;IACJ,OAAO,CAAC,EAAE;QACR;;;;;WAKG;QACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;KACpC,CAAC;CACH,GAAG,aAAa,CAAC;AAElB,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IACd;;;;OAIG;IACH,WAAW,EAAE,GAAG,CAAC;IACjB;;;;;OAKG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,0BAA0B,CAAC,CAAC;CAC3D,GAAG,aAAa,CAAC"}
+{"version":3,"file":"dispute.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["dispute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,sBAAmB;AAClE,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAEpD,MAAM,MAAM,mBAAmB,GAAG,aAAa,GAAG;IAChD,mDAAmD;IACnD,UAAU,EAAE,OAAO,CAAC;IACpB;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,yGAAyG;IACzG,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACnC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAChC;;;OAGG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,0BAA0B,CAAC,CAAC;CAC3D,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACpC;;;;OAIG;IACH,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACpC;;;;OAIG;IACH,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,gBAAgB,EAAE;QAChB,sBAAsB;QACtB,IAAI,EAAE,OAAO,CAAC;QACd,6DAA6D;QAC7D,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;KACrC,EAAE,CAAC;IACJ,OAAO,CAAC,EAAE;QACR;;;;;WAKG;QACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;KACpC,CAAC;CACH,GAAG,aAAa,CAAC;AAElB,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IACd;;;;OAIG;IACH,WAAW,EAAE,GAAG,CAAC;IACjB;;;;;OAKG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,0BAA0B,CAAC,CAAC;CAC3D,GAAG,aAAa,CAAC"}

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

@@ -1,15 +1,19 @@
 import { Address, Hash, TransactionReceipt } from "viem";
 import { TxOptions } from "../options.js";
 import { EncodedTxData, GroupingModuleCollectedRoyaltiesToGroupPoolEvent } from "../../abi/generated.js";
-import { IpMetadataAndTxOptions, LicensingConfig, ValidatedLicensingConfig } from "../common.js";
-export type LicenseData = {
+import { IpMetadataAndTxOptions, LicensingConfigInput, LicensingConfig } from "../common.js";
+export type LicenseDataInput = {
     licenseTermsId: string | bigint | number;
-    licensingConfig?: LicensingConfig;
+    /**
+     * The address of the license template.
+     * Defaults to {@link https://docs.story.foundation/docs/programmable-ip-license | PIL} address if not provided.
+     */
+    licensingConfig?: LicensingConfigInput;
     licenseTemplate?: Address;
 };
-export type ValidatedLicenseData = {
+export type LicenseData = {
     licenseTermsId: bigint;
-    licensingConfig: ValidatedLicensingConfig;
+    licensingConfig: LicensingConfig;
     licenseTemplate: Address;
 };
 export type MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest = {
@@ -24,7 +28,7 @@ export type MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest = {
     /** The maximum reward share percentage that can be allocated to each member IP. */
     maxAllowedRewardShare: number | string;
     /** The data of the license and its configuration to be attached to the new group IP. */
-    licenseData: LicenseData[];
+    licenseData: LicenseDataInput[];
     /** The address of the recipient of the minted NFT. If not provided, the function will use the user's own wallet address. */
     recipient?: Address;
     /**
@@ -40,6 +44,7 @@ export type MintAndRegisterIpAndAttachLicenseAndAddToGroupResponse = {
     tokenId?: bigint;
 };
 export type RegisterGroupRequest = {
+    /** The address specifying how royalty will be split amongst the pool of IPs in the group. */
     groupPool: Address;
     txOptions?: TxOptions;
 };
@@ -59,7 +64,7 @@ export type RegisterIpAndAttachLicenseAndAddToGroupRequest = {
      */
     deadline?: bigint;
     /** The data of the license and its configuration to be attached to the new group IP. */
-    licenseData: LicenseData[];
+    licenseData: LicenseDataInput[];
     /** The maximum reward share percentage that can be allocated to each member IP. */
     maxAllowedRewardShare: number | string;
 } & IpMetadataAndTxOptions;
@@ -73,7 +78,7 @@ export type RegisterGroupAndAttachLicenseRequest = {
     /** The address specifying how royalty will be split amongst the pool of IPs in the group. */
     groupPool: Address;
     /** The data of the license and its configuration to be attached to the new group IP. */
-    licenseData: LicenseData;
+    licenseData: LicenseDataInput;
     txOptions?: TxOptions;
 };
 export type RegisterGroupAndAttachLicenseResponse = {
@@ -87,7 +92,7 @@ export type RegisterGroupAndAttachLicenseAndAddIpsRequest = {
     /** The IP IDs of the IPs to be added to the group. */
     ipIds: Address[];
     /** The data of the license and its configuration to be attached to the new group IP. */
-    licenseData: LicenseData;
+    licenseData: LicenseDataInput;
     /** The maximum reward share percentage that can be allocated to each member IP. */
     maxAllowedRewardShare: number | string;
     txOptions?: TxOptions;

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

@@ -1 +1 @@
-{"version":3,"file":"group.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAEzD,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EACL,aAAa,EACb,gDAAgD,EACjD,+BAA4B;AAC7B,OAAO,EAAE,sBAAsB,EAAE,eAAe,EAAE,wBAAwB,EAAE,qBAAkB;AAE9F,MAAM,MAAM,WAAW,GAAG;IACxB,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACzC,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,wBAAwB,CAAC;IAC1C,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC;AACF,MAAM,MAAM,qDAAqD,GAAG;IAClE,cAAc,EAAE,OAAO,CAAC;IACxB,6DAA6D;IAC7D,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,mFAAmF;IACnF,qBAAqB,EAAE,MAAM,GAAG,MAAM,CAAC;IACvC,wFAAwF;IACxF,WAAW,EAAE,WAAW,EAAE,CAAC;IAC3B,4HAA4H;IAC5H,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACrC,GAAG,sBAAsB,CAAC;AAE3B,MAAM,MAAM,sDAAsD,GAAG;IACnE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AACF,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AACF,MAAM,MAAM,8CAA8C,GAAG;IAC3D,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAClC,6DAA6D;IAC7D,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wFAAwF;IACxF,WAAW,EAAE,WAAW,EAAE,CAAC;IAC3B,mFAAmF;IACnF,qBAAqB,EAAE,MAAM,GAAG,MAAM,CAAC;CACxC,GAAG,sBAAsB,CAAC;AAE3B,MAAM,MAAM,+CAA+C,GAAG;IAC5D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AACF,MAAM,MAAM,oCAAoC,GAAG;IACjD,6FAA6F;IAC7F,SAAS,EAAE,OAAO,CAAC;IACnB,wFAAwF;IACxF,WAAW,EAAE,WAAW,CAAC;IACzB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG;IAClD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AACF,MAAM,MAAM,6CAA6C,GAAG;IAC1D,6FAA6F;IAC7F,SAAS,EAAE,OAAO,CAAC;IACnB,sDAAsD;IACtD,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,wFAAwF;IACxF,WAAW,EAAE,WAAW,CAAC;IACzB,mFAAmF;IACnF,qBAAqB,EAAE,MAAM,GAAG,MAAM,CAAC;IACvC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,8CAA8C,GAAG;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,yCAAyC,GAAG;IACtD,SAAS,EAAE,OAAO,CAAC;IACnB,+DAA+D;IAC/D,cAAc,EAAE,OAAO,EAAE,CAAC;IAC1B,8DAA8D;IAC9D,WAAW,EAAE,OAAO,EAAE,CAAC;IACvB,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,0CAA0C,GAAG;IACvD,MAAM,EAAE,IAAI,CAAC;IACb,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAChC,kBAAkB,CAAC,EAAE,IAAI,CAAC,gDAAgD,EAAE,MAAM,CAAC,EAAE,CAAC;IACtF,oBAAoB,CAAC,EAAE;QACrB,IAAI,EAAE,OAAO,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,OAAO,CAAC;QACf;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB,EAAE,CAAC;CACL,CAAC"}
+{"version":3,"file":"group.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAEzD,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EACL,aAAa,EACb,gDAAgD,EACjD,+BAA4B;AAC7B,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,eAAe,EAAE,qBAAkB;AAE1F,MAAM,MAAM,gBAAgB,GAAG;IAC7B,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACzC;;;OAGG;IACH,eAAe,CAAC,EAAE,oBAAoB,CAAC;IACvC,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,eAAe,CAAC;IACjC,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC;AACF,MAAM,MAAM,qDAAqD,GAAG;IAClE,cAAc,EAAE,OAAO,CAAC;IACxB,6DAA6D;IAC7D,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,mFAAmF;IACnF,qBAAqB,EAAE,MAAM,GAAG,MAAM,CAAC;IACvC,wFAAwF;IACxF,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAChC,4HAA4H;IAC5H,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACrC,GAAG,sBAAsB,CAAC;AAE3B,MAAM,MAAM,sDAAsD,GAAG;IACnE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AACF,MAAM,MAAM,oBAAoB,GAAG;IACjC,6FAA6F;IAC7F,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AACF,MAAM,MAAM,8CAA8C,GAAG;IAC3D,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAClC,6DAA6D;IAC7D,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wFAAwF;IACxF,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAChC,mFAAmF;IACnF,qBAAqB,EAAE,MAAM,GAAG,MAAM,CAAC;CACxC,GAAG,sBAAsB,CAAC;AAE3B,MAAM,MAAM,+CAA+C,GAAG;IAC5D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AACF,MAAM,MAAM,oCAAoC,GAAG;IACjD,6FAA6F;IAC7F,SAAS,EAAE,OAAO,CAAC;IACnB,wFAAwF;IACxF,WAAW,EAAE,gBAAgB,CAAC;IAC9B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG;IAClD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AACF,MAAM,MAAM,6CAA6C,GAAG;IAC1D,6FAA6F;IAC7F,SAAS,EAAE,OAAO,CAAC;IACnB,sDAAsD;IACtD,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,wFAAwF;IACxF,WAAW,EAAE,gBAAgB,CAAC;IAC9B,mFAAmF;IACnF,qBAAqB,EAAE,MAAM,GAAG,MAAM,CAAC;IACvC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,8CAA8C,GAAG;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,yCAAyC,GAAG;IACtD,SAAS,EAAE,OAAO,CAAC;IACnB,+DAA+D;IAC/D,cAAc,EAAE,OAAO,EAAE,CAAC;IAC1B,8DAA8D;IAC9D,WAAW,EAAE,OAAO,EAAE,CAAC;IACvB,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,0CAA0C,GAAG;IACvD,MAAM,EAAE,IAAI,CAAC;IACb,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAChC,kBAAkB,CAAC,EAAE,IAAI,CAAC,gDAAgD,EAAE,MAAM,CAAC,EAAE,CAAC;IACtF,oBAAoB,CAAC,EAAE;QACrB,IAAI,EAAE,OAAO,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,OAAO,CAAC;QACf;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB,EAAE,CAAC;CACL,CAAC"}

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

@@ -3,10 +3,14 @@ import { TxOptions } from "../options.js";
 import { EncodedTxData } from "../../abi/generated.js";
 import { TokenAmountInput } from "../common.js";
 export type IPAccountExecuteRequest = {
+    /** The IP ID of the IP Account {@link https://docs.story.foundation/docs/ip-account}. */
     ipId: Address;
+    /** The recipient of the transaction. */
     to: Address;
+    /** The amount of IP to send. */
     value: number;
-    data: Address;
+    /** The data to send along with the transaction. */
+    data: Hex;
     txOptions?: TxOptions;
 };
 export type IPAccountExecuteResponse = {
@@ -14,12 +18,19 @@ export type IPAccountExecuteResponse = {
     encodedTxData?: EncodedTxData;
 };
 export type IPAccountExecuteWithSigRequest = {
+    /** The IP ID of the IP Account {@link https://docs.story.foundation/docs/ip-account}.*/
     ipId: Address;
+    /** The recipient of the transaction. */
     to: Address;
-    data: Address;
+    /** The data to send along with the transaction. */
+    data: Hex;
+    /** The signer of the transaction. */
     signer: Address;
+    /** The deadline of the transaction signature in seconds. */
     deadline: number | bigint | string;
+    /** The signature of the transaction, EIP-712 encoded. The helper method `getPermissionSignature` supports generating the signature. */
     signature: Address;
+    /** The amount of IP to send. */
     value?: number | bigint | string;
     txOptions?: TxOptions;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"ipAccount.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["ipAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,gBAAgB,EAAE,qBAAkB;AAE7C,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,OAAO,CAAC;IACd,EAAE,EAAE,OAAO,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,OAAO,CAAC;IACd,EAAE,EAAE,OAAO,CAAC;IACZ,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACnC,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACjC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAEzC,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,OAAO,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,OAAO,CAAC;IACd,+CAA+C;IAC/C,WAAW,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,YAAY,EAAE,GAAG,CAAC;IAClB,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE;QACN,uEAAuE;QACvE,OAAO,EAAE,OAAO,CAAC;QACjB,MAAM,EAAE,gBAAgB,CAAC;QACzB,oCAAoC;QACpC,MAAM,EAAE,OAAO,CAAC;KACjB,EAAE,CAAC;IACJ,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;CAClD,CAAC"}
+{"version":3,"file":"ipAccount.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["ipAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,gBAAgB,EAAE,qBAAkB;AAE7C,MAAM,MAAM,uBAAuB,GAAG;IACpC,yFAAyF;IACzF,IAAI,EAAE,OAAO,CAAC;IACd,wCAAwC;IACxC,EAAE,EAAE,OAAO,CAAC;IACZ,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,IAAI,EAAE,GAAG,CAAC;IACV,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,wFAAwF;IACxF,IAAI,EAAE,OAAO,CAAC;IACd,wCAAwC;IACxC,EAAE,EAAE,OAAO,CAAC;IACZ,mDAAmD;IACnD,IAAI,EAAE,GAAG,CAAC;IACV,qCAAqC;IACrC,MAAM,EAAE,OAAO,CAAC;IAChB,4DAA4D;IAC5D,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACnC,uIAAuI;IACvI,SAAS,EAAE,OAAO,CAAC;IACnB,gCAAgC;IAChC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACjC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAEzC,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,OAAO,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,OAAO,CAAC;IACd,+CAA+C;IAC/C,WAAW,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,YAAY,EAAE,GAAG,CAAC;IAClB,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE;QACN,uEAAuE;QACvE,OAAO,EAAE,OAAO,CAAC;QACjB,MAAM,EAAE,gBAAgB,CAAC;QACzB,oCAAoC;QACpC,MAAM,EAAE,OAAO,CAAC;KACjB,EAAE,CAAC;IACJ,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;CAClD,CAAC"}

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

@@ -1,10 +1,9 @@
 import { Address, Hash, Hex, TransactionReceipt } from "viem";
 import { TxOptions, WithWipOptions } from "../options.js";
-import { LicenseTerms, RegisterPILTermsRequest } from "./license.js";
+import { LicenseTerms, LicenseTermsInput } from "./license.js";
 import { EncodedTxData } from "../../abi/generated.js";
-import { IpMetadataAndTxOptions, LicensingConfig, ValidatedLicensingConfig } from "../common.js";
-import { IpMetadataForWorkflow } from "../../utils/getIpMetadataForWorkflow.js";
-export type DerivativeData = {
+import { IpMetadataAndTxOptions, LicensingConfig, LicensingConfigInput } from "../common.js";
+export type DerivativeDataInput = {
     parentIpIds: Address[];
     /** The IDs of the license terms that the parent IP supports. */
     licenseTermsIds: bigint[] | string[] | number[];
@@ -23,10 +22,13 @@ export type DerivativeData = {
      * @default 100
      */
     maxRevenueShare?: number | string;
-    /** The license template address, default value is Programmable IP License. */
+    /**
+     * The address of the license template.
+     * Defaults to {@link https://docs.story.foundation/docs/programmable-ip-license | License Template} address if not provided.
+     */
     licenseTemplate?: Address;
 };
-export type InternalDerivativeData = {
+export type DerivativeData = {
     parentIpIds: readonly Address[];
     licenseTermsIds: readonly bigint[];
     royaltyContext: Hex;
@@ -39,13 +41,22 @@ export type RegisterIpResponse = RegistrationResponse & {
     encodedTxData?: EncodedTxData;
 };
 export type RegisterRequest = {
+    /** The address of the NFT. */
     nftContract: Address;
+    /** The token identifier of the NFT. */
     tokenId: string | number | bigint;
+    /**
+     * The deadline of the transaction signature in seconds.
+     * @default 1000
+     */
     deadline?: string | number | bigint;
 } & IpMetadataAndTxOptions;
 export type RegisterDerivativeWithLicenseTokensRequest = {
+    /** The derivative IP ID. */
     childIpId: Address;
+    /** The IDs of the license tokens. */
     licenseTokenIds: string[] | bigint[] | number[];
+    /** The maximum number of royalty tokens that can be distributed to the external royalty policies (max: 100,000,000). */
     maxRts: number | string;
     txOptions?: TxOptions;
 };
@@ -53,7 +64,7 @@ export type RegisterDerivativeWithLicenseTokensResponse = {
     txHash?: Hex;
     encodedTxData?: EncodedTxData;
 };
-export type RegisterDerivativeRequest = WithWipOptions & DerivativeData & {
+export type RegisterDerivativeRequest = WithWipOptions & DerivativeDataInput & {
     txOptions?: TxOptions;
     childIpId: Address;
 };
@@ -61,12 +72,12 @@ export type RegisterDerivativeResponse = {
     txHash?: Hex;
     encodedTxData?: EncodedTxData;
 };
-export type LicenseTermsData<T = RegisterPILTermsRequest, C = LicensingConfig> = {
+export type LicenseTermsDataInput<T = LicenseTermsInput, C = LicensingConfigInput> = {
     terms: T;
     licensingConfig?: C;
 };
-export type ValidatedLicenseTermsData = Omit<LicenseTermsData<LicenseTerms, ValidatedLicensingConfig>, "licensingConfig"> & {
-    licensingConfig: ValidatedLicensingConfig;
+export type LicenseTermsData = Omit<LicenseTermsDataInput<LicenseTerms, LicensingConfig>, "licensingConfig"> & {
+    licensingConfig: LicensingConfig;
 };
 export type MintAndRegisterIpAssetWithPilTermsRequest = {
     spgNftContract: Address;
@@ -76,8 +87,8 @@ export type MintAndRegisterIpAssetWithPilTermsRequest = {
      */
     allowDuplicates?: boolean;
     /** The data of the license and its configuration to be attached to the IP. */
-    licenseTermsData: LicenseTermsData[];
-    /** The address to receive the minted NFT. If not provided, the function will use the user's own wallet address. */
+    licenseTermsData: LicenseTermsDataInput[];
+    /** The address to receive the minted NFT. If not provided, the client's own wallet address will be used. */
     recipient?: Address;
 } & IpMetadataAndTxOptions & WithWipOptions;
 export type MintAndRegisterIpAssetWithPilTermsResponse = {
@@ -97,7 +108,7 @@ export type RegisterIpAndMakeDerivativeRequest = {
      */
     deadline?: string | number | bigint;
     /** The derivative data to be used for register derivative. */
-    derivData: DerivativeData;
+    derivData: DerivativeDataInput;
 } & IpMetadataAndTxOptions & WithWipOptions;
 export type RegisterIpAndMakeDerivativeResponse = {
     txHash?: Hex;
@@ -110,7 +121,7 @@ export type RegisterIpAndAttachPilTermsRequest = {
     nftContract: Address;
     tokenId: bigint | string | number;
     /** The data of the license and its configuration to be attached to the IP. */
-    licenseTermsData: LicenseTermsData[];
+    licenseTermsData: LicenseTermsDataInput[];
     /**
      * The deadline for the signature in seconds.
      * @default 1000
@@ -127,8 +138,8 @@ export type RegisterIpAndAttachPilTermsResponse = {
 export type MintAndRegisterIpAndMakeDerivativeRequest = {
     spgNftContract: Address;
     /** The derivative data to be used for register derivative. */
-    derivData: DerivativeData;
-    /** The address to receive the minted NFT. If not provided, the function will use the user's own wallet address. */
+    derivData: DerivativeDataInput;
+    /** The address to receive the minted NFT. If not provided, the client's own wallet address will be used. */
     recipient?: Address;
     /**
      * Set to true to allow minting an NFT with a duplicate metadata hash.
@@ -139,7 +150,7 @@ export type MintAndRegisterIpAndMakeDerivativeRequest = {
 export type MintAndRegisterIpAndMakeDerivativeResponse = RegistrationResponse & {
     encodedTxData?: EncodedTxData;
 };
-type IPMetadataInfo = {
+type WithIpMetadata = {
     ipMetadata?: {
         ipMetadataURI?: string;
         ipMetadataHash?: Hex;
@@ -149,6 +160,7 @@ type IPMetadataInfo = {
 };
 export type MintAndRegisterIpRequest = IpMetadataAndTxOptions & WithWipOptions & {
     spgNftContract: Address;
+    /** The address of the recipient of the minted NFT. If not provided, the client's own wallet address will be used. */
     recipient?: Address;
     /**
      * Set to true to allow minting an NFT with a duplicate metadata hash.
@@ -159,7 +171,7 @@ export type MintAndRegisterIpRequest = IpMetadataAndTxOptions & WithWipOptions &
 export type RegisterPilTermsAndAttachRequest = {
     ipId: Address;
     /** The data of the license and its configuration to be attached to the IP. */
-    licenseTermsData: LicenseTermsData[];
+    licenseTermsData: LicenseTermsDataInput[];
     /** The deadline for the signature in seconds.
      * @default 1000
      */
@@ -173,8 +185,11 @@ export type RegisterPilTermsAndAttachResponse = {
 };
 export type MintAndRegisterIpAndMakeDerivativeWithLicenseTokensRequest = {
     spgNftContract: Address;
+    /** The IDs of the license tokens to be burned for linking the IP to parent IPs. */
     licenseTokenIds: string[] | bigint[] | number[];
+    /** The address of the recipient of the minted NFT. If not provided, the client's own wallet address will be used. */
     recipient?: Address;
+    /** The maximum number of royalty tokens that can be distributed to the external royalty policies (max: 100,000,000). */
     maxRts: number | string;
     /**
      * Set to true to allow minting an NFT with a duplicate metadata hash.
@@ -185,9 +200,15 @@ export type MintAndRegisterIpAndMakeDerivativeWithLicenseTokensRequest = {
 export type RegisterIpAndMakeDerivativeWithLicenseTokensRequest = {
     nftContract: Address;
     tokenId: string | number | bigint;
+    /** The IDs of the license tokens to be burned for linking the IP to parent IPs. */
     licenseTokenIds: string[] | bigint[] | number[];
-    deadline?: string | number | bigint;
+    /** The maximum number of royalty tokens that can be distributed to the external royalty policies (max: 100,000,000). */
     maxRts: number | string;
+    /**
+     * The deadline for the signature in seconds.
+     * @default 1000
+     */
+    deadline?: string | number | bigint;
 } & IpMetadataAndTxOptions & WithWipOptions;
 export type BatchMintAndRegisterIpAssetWithPilTermsRequest = {
     args: Omit<MintAndRegisterIpAssetWithPilTermsRequest, "txOptions">[];
@@ -205,6 +226,9 @@ export type BatchMintAndRegisterIpAssetWithPilTermsResponse = {
 };
 export type BatchRegisterDerivativeRequest = {
     args: RegisterDerivativeRequest[];
+    /** The deadline for the signature in seconds.
+     * @default 1000
+     */
     deadline?: string | number | bigint;
     txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
 };
@@ -232,7 +256,7 @@ export type RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest = {
     nftContract: Address;
     tokenId: bigint | string | number;
     /** The data of the license and its configuration to be attached to the new group IP. */
-    licenseTermsData: LicenseTermsData[];
+    licenseTermsData: LicenseTermsDataInput[];
     /**
      * The deadline for the signature in seconds.
      * @default 1000
@@ -241,7 +265,7 @@ export type RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest = {
     /** Authors of the IP and their shares of the royalty tokens. */
     royaltyShares: RoyaltyShare[];
     txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
-} & IPMetadataInfo;
+} & WithIpMetadata;
 export type RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse = {
     registerIpAndAttachPilTermsAndDeployRoyaltyVaultTxHash: Hex;
     distributeRoyaltyTokensTxHash: Hex;
@@ -284,13 +308,11 @@ export type RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensReq
      */
     deadline?: string | number | bigint;
     /** The derivative data to be used for register derivative.*/
-    derivData: DerivativeData;
+    derivData: DerivativeDataInput;
     /** Authors of the IP and their shares of the royalty tokens. */
     royaltyShares: RoyaltyShare[];
-    /** The desired metadata for the newly minted NFT and newly registered IP. */
-    ipMetadata?: IpMetadataForWorkflow;
     txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
-} & WithWipOptions;
+} & WithWipOptions & WithIpMetadata;
 export type RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse = {
     registerDerivativeIpAndAttachLicenseTermsAndDistributeRoyaltyTokensTxHash: Address;
     distributeRoyaltyTokensTxHash: Address;
@@ -307,13 +329,13 @@ export type MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensRequest
      */
     allowDuplicates?: boolean;
     /** The data of the license and its configuration to be attached to the new group IP. */
-    licenseTermsData: LicenseTermsData[];
+    licenseTermsData: LicenseTermsDataInput[];
     /** Authors of the IP and their shares of the royalty tokens */
     royaltyShares: RoyaltyShare[];
-    /** The address to receive the minted NFT. If not provided, the function will use the user's own wallet address. */
+    /** The address to receive the minted NFT. If not provided, the client's own wallet address will be used. */
     recipient?: Address;
     txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
-} & IPMetadataInfo & WithWipOptions;
+} & WithIpMetadata & WithWipOptions;
 export type MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensResponse = {
     txHash: Hex;
     ipId?: Address;
@@ -324,7 +346,7 @@ export type MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensResponse
 export type MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensRequest = {
     spgNftContract: Address;
     /** The derivative data to be used for register derivative. */
-    derivData: DerivativeData;
+    derivData: DerivativeDataInput;
     /** Authors of the IP and their shares of the royalty tokens. */
     royaltyShares: RoyaltyShare[];
     /**
@@ -332,10 +354,10 @@ export type MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensRequest
      * @default true
      */
     allowDuplicates?: boolean;
-    /** The address to receive the minted NFT. If not provided, the function will use the user's own wallet address. */
+    /** The address to receive the minted NFT. If not provided, the client's own wallet address will be used. */
     recipient?: Address;
     txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
-} & IPMetadataInfo & WithWipOptions;
+} & WithIpMetadata & WithWipOptions;
 export type MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensResponse = {
     txHash: Hex;
     ipId?: Address;
@@ -347,7 +369,7 @@ export type CommonRegistrationParams = WithWipOptions & {
     spgNftContract?: Address;
     /** the spg contract in which the minting fee is paid to  */
     spgSpenderAddress: Address;
-    derivData?: InternalDerivativeData;
+    derivData?: DerivativeData;
     sender: Address;
     txOptions?: TxOptions;
 };