@story-protocol/core-sdk 1.1.0-stable → 1.2.0-rc.1

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

@@ -0,0 +1,85 @@
+import { PublicClient } from "viem";
+import { CoreMetadataModuleClient, GroupingModuleClient, GroupingModuleEventClient, GroupingWorkflowsClient, IpAssetRegistryClient, LicenseRegistryReadOnlyClient, LicenseTokenReadOnlyClient, LicensingModuleClient, PiLicenseTemplateClient, SimpleWalletClient } from "../abi/generated.js";
+import { SupportedChainIds } from "../types/config.js";
+import { MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest, MintAndRegisterIpAndAttachLicenseAndAddToGroupResponse, RegisterGroupAndAttachLicenseAndAddIpsRequest, RegisterGroupAndAttachLicenseAndAddIpsResponse, RegisterGroupAndAttachLicenseRequest, RegisterGroupAndAttachLicenseResponse, RegisterGroupRequest, RegisterGroupResponse, RegisterIpAndAttachLicenseAndAddToGroupRequest, RegisterIpAndAttachLicenseAndAddToGroupResponse } from "../types/resources/group.js";
+export declare class GroupClient {
+    groupingWorkflowsClient: GroupingWorkflowsClient;
+    groupingModuleEventClient: GroupingModuleEventClient;
+    groupingModuleClient: GroupingModuleClient;
+    licenseTemplateClient: PiLicenseTemplateClient;
+    licenseTokenReadOnlyClient: LicenseTokenReadOnlyClient;
+    ipAssetRegistryClient: IpAssetRegistryClient;
+    coreMetadataModuleClient: CoreMetadataModuleClient;
+    licensingModuleClient: LicensingModuleClient;
+    licenseRegistryReadOnlyClient: LicenseRegistryReadOnlyClient;
+    private readonly rpcClient;
+    private readonly wallet;
+    private readonly chainId;
+    constructor(rpcClient: PublicClient, wallet: SimpleWalletClient, chainId: SupportedChainIds);
+    /** Registers a Group IPA.
+     * @param request - The request object containing necessary data to register group.
+     *   @param request.groupPool The address specifying how royalty will be split amongst the pool of IPs in the group.
+     *   @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes group id.
+     * @emits PGroupRegistered (groupId, groupPool);
+     */
+    registerGroup(request: RegisterGroupRequest): Promise<RegisterGroupResponse>;
+    /** Mint an NFT from a SPGNFT collection, register it with metadata as an IP, attach license terms to the registered IP, and add it to a group IP.
+     * @param request - The request object containing necessary data to mint and register Ip and attach license and add to group.
+     *   @param request.nftContract The address of the NFT collection.
+     *   @param request.groupId The ID of the group IP to add the newly registered IP.
+     *   @param request.licenseTermsId The ID of the registered license terms that will be attached to the new IP.
+     *   @param request.recipient [Optional] The address of the recipient of the minted NFT,default value is your wallet address.
+     *   @param request.licenseTemplate [Optional] The address of the license template to be attached to the new group IP,default value is Programmable IP License.
+     * . @param request.deadline [Optional] The deadline for the signature in milliseconds,default value is 1000ms.
+     *   @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
+     *   @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
+     *   @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
+     *   @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
+     *   @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
+     *   @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes IP ID, token ID.
+     * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, resolverAddr, metadataProviderAddress, metadata)
+     */
+    mintAndRegisterIpAndAttachLicenseAndAddToGroup(request: MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest): Promise<MintAndRegisterIpAndAttachLicenseAndAddToGroupResponse>;
+    /** Register an NFT as IP with metadata, attach license terms to the registered IP, and add it to a group IP.
+     * @param request - The request object containing necessary data to register ip and attach license and add to group.
+     *   @param request.spgNftContract The address of the NFT collection.
+     *   @param request.tokenId The ID of the NFT.
+     *   @param request.groupId The ID of the group IP to add the newly registered IP.
+     *   @param request.licenseTermsId The ID of the registered license terms that will be attached to the new IP.
+     *   @param request.licenseTemplate [Optional] The address of the license template to be attached to the new group IP,default value is Programmable IP License.
+     * . @param request.deadline [Optional] The deadline for the signature in milliseconds,default is 1000ms.
+     *   @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
+     *   @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
+     *   @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
+     *   @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
+     *   @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
+     *   @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes IP ID, token ID.
+     * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, resolverAddr, metadataProviderAddress, metadata)
+     */
+    registerIpAndAttachLicenseAndAddToGroup(request: RegisterIpAndAttachLicenseAndAddToGroupRequest): Promise<RegisterIpAndAttachLicenseAndAddToGroupResponse>;
+    /** Register a group IP with a group reward pool and attach license terms to the group IP.
+     * @param request - The request object containing necessary data to register group and attach license.
+     *   @param request.groupPool The address specifying how royalty will be split amongst the pool of IPs in the group.
+     *   @param request.licenseTermsId The ID of the registered license terms that will be attached to the new group IP.
+     *   @param request.licenseTemplate [Optional] The address of the license template to be attached to the new group IP, default value is Programmable IP License.
+     *   @param request.txOptions [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes group id.
+     * @emits PGroupRegistered (groupId, groupPool);
+     */
+    registerGroupAndAttachLicense(request: RegisterGroupAndAttachLicenseRequest): Promise<RegisterGroupAndAttachLicenseResponse>;
+    /** Register a group IP with a group reward pool, attach license terms to the group IP, and add individual IPs to the group IP.
+     * @param request - The request object containing necessary data to register group and attach license and add ips.
+     *   @param request.pIds must have the same PIL terms as the group IP.
+     *   @param request.groupPool The address specifying how royalty will be split amongst the pool of IPs in the group.
+     *   @param request.licenseTermsId The ID of the registered license terms that will be attached to the new group IP.
+     *   @param request.licenseTemplate [Optional] The address of the license template to be attached to the new group IP,default value is Programmable IP License.
+     *   @param request.txOptions [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes group id.
+     * @emits PGroupRegistered (groupId, groupPool);
+     */
+    registerGroupAndAttachLicenseAndAddIps(request: RegisterGroupAndAttachLicenseAndAddIpsRequest): Promise<RegisterGroupAndAttachLicenseAndAddIpsResponse>;
+}
+//# sourceMappingURL=group.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"group.d.ts","sourceRoot":"../../../../src/resources","sources":["group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAiC,MAAM,MAAM,CAAC;AAEnE,OAAO,EACL,wBAAwB,EACxB,oBAAoB,EACpB,yBAAyB,EAEzB,uBAAuB,EAKvB,qBAAqB,EACrB,6BAA6B,EAC7B,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACvB,kBAAkB,EACnB,4BAAyB;AAK1B,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AACpD,OAAO,EACL,qDAAqD,EACrD,sDAAsD,EACtD,6CAA6C,EAC7C,8CAA8C,EAC9C,oCAAoC,EACpC,qCAAqC,EACrC,oBAAoB,EACpB,qBAAqB,EACrB,8CAA8C,EAC9C,+CAA+C,EAChD,oCAAiC;AAElC,qBAAa,WAAW;IACf,uBAAuB,EAAE,uBAAuB,CAAC;IACjD,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,6BAA6B,EAAE,6BAA6B,CAAC;IAEpE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAc3F;;;;;;OAMG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA0BzF;;;;;;;;;;;;;;;;OAgBG;IACU,8CAA8C,CACzD,OAAO,EAAE,qDAAqD,GAC7D,OAAO,CAAC,sDAAsD,CAAC;IA0ElE;;;;;;;;;;;;;;;;OAgBG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IAsG3D;;;;;;;;OAQG;IACU,6BAA6B,CACxC,OAAO,EAAE,oCAAoC,GAC5C,OAAO,CAAC,qCAAqC,CAAC;IA8BjD;;;;;;;;;OASG;IACU,sCAAsC,CACjD,OAAO,EAAE,6CAA6C,GACrD,OAAO,CAAC,8CAA8C,CAAC;CAyD3D"}

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

@@ -1,17 +1,18 @@
 import { PublicClient } from "viem";
 import { SupportedChainIds } from "../types/config.js";
-import { CreateIpAssetWithPilTermsRequest, CreateIpAssetWithPilTermsResponse, GenerateCreatorMetadataParam, GenerateIpMetadataParam, IpCreator, IpMetadata, MintAndRegisterIpAndMakeDerivativeRequest, RegisterDerivativeRequest, RegisterDerivativeResponse, RegisterDerivativeWithLicenseTokensRequest, RegisterDerivativeWithLicenseTokensResponse, RegisterIpAndAttachPilTermsRequest, RegisterIpAndAttachPilTermsResponse, RegisterIpAndMakeDerivativeRequest, RegisterIpAndMakeDerivativeResponse, RegisterIpResponse, RegisterRequest } from "../types/resources/ipAsset.js";
-import { AccessControllerClient, CoreMetadataModuleClient, IpAssetRegistryClient, LicenseRegistryReadOnlyClient, LicenseTokenReadOnlyClient, LicensingModuleClient, PiLicenseTemplateClient, RoyaltyPolicyLapClient, SimpleWalletClient, SpgClient } from "../abi/generated.js";
+import { CreateIpAssetWithPilTermsRequest, CreateIpAssetWithPilTermsResponse, GenerateCreatorMetadataParam, GenerateIpMetadataParam, IpCreator, IpMetadata, MintAndRegisterIpAndMakeDerivativeRequest, MintAndRegisterIpAndMakeDerivativeWithLicenseTokensRequest, MintAndRegisterIpRequest, RegisterDerivativeRequest, RegisterDerivativeResponse, RegisterDerivativeWithLicenseTokensRequest, RegisterDerivativeWithLicenseTokensResponse, RegisterIpAndAttachPilTermsRequest, RegisterIpAndAttachPilTermsResponse, RegisterIpAndMakeDerivativeRequest, RegisterIpAndMakeDerivativeResponse, RegisterIpAndMakeDerivativeWithLicenseTokensRequest, RegisterIpResponse, RegisterPilTermsAndAttachRequest, RegisterPilTermsAndAttachResponse, RegisterRequest } from "../types/resources/ipAsset.js";
+import { AccessControllerClient, CoreMetadataModuleClient, DerivativeWorkflowsClient, IpAssetRegistryClient, LicenseAttachmentWorkflowsClient, LicenseRegistryReadOnlyClient, LicenseTokenReadOnlyClient, LicensingModuleClient, PiLicenseTemplateClient, RegistrationWorkflowsClient, SimpleWalletClient } from "../abi/generated.js";
 export declare class IPAssetClient {
     licensingModuleClient: LicensingModuleClient;
     ipAssetRegistryClient: IpAssetRegistryClient;
     licenseTemplateClient: PiLicenseTemplateClient;
     licenseRegistryReadOnlyClient: LicenseRegistryReadOnlyClient;
     licenseTokenReadOnlyClient: LicenseTokenReadOnlyClient;
-    royaltyPolicyLAPClient: RoyaltyPolicyLapClient;
     accessControllerClient: AccessControllerClient;
     coreMetadataModuleClient: CoreMetadataModuleClient;
-    spgClient: SpgClient;
+    registrationWorkflowsClient: RegistrationWorkflowsClient;
+    licenseAttachmentWorkflowsClient: LicenseAttachmentWorkflowsClient;
+    derivativeWorkflowsClient: DerivativeWorkflowsClient;
     private readonly rpcClient;
     private readonly wallet;
     private readonly chainId;
@@ -82,8 +83,8 @@ export declare class IPAssetClient {
      *   @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
      *   @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
      *   @param request.deadline [Optional] The deadline for the signature in milliseconds, default is 1000ms.
-     *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to an object containing the transaction hash and optional IP ID if waitForTxn is set to true.
+     *   @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes IP ID, token ID.
      * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, resolverAddr, metadataProviderAddress, metadata)
      */
     register(request: RegisterRequest): Promise<RegisterIpResponse>;
@@ -116,19 +117,20 @@ export declare class IPAssetClient {
     /**
      * Mint an NFT from a collection and register it as an IP.
      * @param request - The request object that contains all data needed to mint and register ip.
-     *   @param request.nftContract The address of the NFT collection.
+     *   @param request.spgNftContract The address of the NFT collection.
      *   @param request.pilType The type of the PIL.
      *   @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
      *   @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
      *   @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
      *   @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
      *   @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
-     *   @param request.recipient [Optional] The address of the recipient of the minted NFT.
+     *   @param request.royaltyPolicyAddress [Optional] The address of the royalty policy contract, default value is LAP.
+     *   @param request.recipient [Optional] The address of the recipient of the minted NFT,default value is your wallet address.
      *   @param request.mintingFee [Optional] The fee to be paid when minting a license.
      *   @param request.commercialRevShare [Optional] Percentage of revenue that must be shared with the licensor.
      *   @param request.currency [Optional] The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
-     *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to an object containing the transaction hash and optional IP ID, Token ID, License Terms Id if waitForTxn is set to true.
+     *   @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes IP ID, Token ID, License Terms Id.
      * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
      * @emits LicenseTermsAttached (caller, ipId, licenseTemplate, licenseTermsId)
      */
@@ -144,6 +146,7 @@ export declare class IPAssetClient {
      *   @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
      *   @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
      *   @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
+     *   @param request.royaltyPolicyAddress [Optional] The address of the royalty policy contract, default value is LAP.
      *   @param request.deadline [Optional] The deadline for the signature in milliseconds, default is 1000ms.
      *   @param request.mintingFee [Optional] The fee to be paid when minting a license.
      *   @param request.commercialRevShare [Optional] Percentage of revenue that must be shared with the licensor.
@@ -176,7 +179,7 @@ export declare class IPAssetClient {
     /**
      * Mint an NFT from a collection and register it as a derivative IP without license tokens.
      * @param request - The request object that contains all data needed to mint and register ip and make derivative.
-     *   @param request.nftContract The address of the NFT collection.
+     *   @param request.spgNftContract The address of the NFT collection.
      *   @param request.derivData The derivative data to be used for registerDerivative.
      *   @param request.derivData.parentIpIds The IDs of the parent IPs to link the registered derivative IP.
      *   @param request.derivData.licenseTermsIds The IDs of the license terms to be used for the linking.
@@ -185,16 +188,92 @@ export declare class IPAssetClient {
      *   @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
      *   @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
      *   @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
-     *   @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.*
-     *   @param request.recipient [Optional] The address of the recipient of the minted NFT.
+     *   @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
+     *   @param request.recipient [Optional] The address of the recipient of the minted NFT,default value is your wallet address.
      *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to an object containing the transaction hash and optional IP ID if waitForTxn is set to true.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes child ip id and token id.
      * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
      */
     mintAndRegisterIpAndMakeDerivative(request: MintAndRegisterIpAndMakeDerivativeRequest): Promise<RegisterDerivativeResponse>;
+    /**
+     * Mint an NFT from a SPGNFT collection and register it with metadata as an IP.
+     * @param request - The request object that contains all data needed to attach license terms.
+     *   @param request.spgNftContract The address of the SPGNFT collection.
+     *   @param request.recipient The address of the recipient of the minted NFT,default value is your wallet address.
+     *   @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
+     *   @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
+     *   @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
+     *   @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
+     *   @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
+     *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, or if waitForTransaction is true, includes IP ID and Token ID.
+     * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
+     */
+    mintAndRegisterIp(request: MintAndRegisterIpRequest): Promise<RegisterIpResponse>;
+    /**
+     * Register Programmable IP License Terms (if unregistered) and attach it to IP.
+     * @param request - The request object that contains all data needed to attach license terms.
+     *   @param request.ipId The ID of the IP.
+     *   @param request.terms The PIL terms to be registered.
+     *     @param request.terms.transferable Indicates whether the license is transferable or not.
+     *     @param request.terms.royaltyPolicy The address of the royalty policy contract which required to StoryProtocol in advance.
+     *     @param request.terms.mintingFee The fee to be paid when minting a license.
+     *     @param request.terms.expiration The expiration period of the license.
+     *     @param request.terms.commercialUse Indicates whether the work can be used commercially or not.
+     *     @param request.terms.commercialAttribution Whether attribution is required when reproducing the work commercially or not.
+     *     @param request.terms.commercializerChecker Commercializers that are allowed to commercially exploit the work. If zero address, then no restrictions is enforced.
+     *     @param request.terms.commercializerCheckerData The data to be passed to the commercializer checker contract.
+     *     @param request.terms.commercialRevShare Percentage of revenue that must be shared with the licensor.
+     *     @param request.terms.commercialRevCeiling The maximum revenue that can be generated from the commercial use of the work.
+     *     @param request.terms.derivativesAllowed Indicates whether the licensee can create derivatives of his work or not.
+     *     @param request.terms.derivativesAttribution Indicates whether attribution is required for derivatives of the work or not.
+     *     @param request.terms.derivativesApproval Indicates whether the licensor must approve derivatives of the work before they can be linked to the licensor IP ID or not.
+     *     @param request.terms.derivativesReciprocal Indicates whether the licensee must license derivatives of the work under the same terms or not.
+     *     @param request.terms.derivativeRevCeiling The maximum revenue that can be generated from the derivative use of the work.
+     *     @param request.terms.currency The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
+     *     @param request.terms.uri The URI of the license terms, which can be used to fetch the offchain license terms.
+     *   @param request.deadline [Optional] The deadline for the signature in milliseconds,default is 1000ms.
+     *   @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes license terms id.
+     * @emits LicenseTermsAttached (caller, ipId, licenseTemplate, licenseTermsId)
+     */
+    registerPilTermsAndAttach(request: RegisterPilTermsAndAttachRequest): Promise<RegisterPilTermsAndAttachResponse>;
+    /**
+     *  Mint an NFT from a collection and register it as a derivative IP using license tokens
+     * @param request - The request object that contains all data needed to mint and register ip and make derivative with license tokens.
+     *   @param request.spgNftContract The address of the NFT collection.
+     *   @param request.licenseTokenIds The IDs of the license tokens to be burned for linking the IP to parent IPs.
+     *   @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
+     *   @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
+     *   @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
+     *   @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
+     *   @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
+     *   @param request.recipient - [Optional] The address to receive the minted NFT,default value is your wallet address.
+     *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, or if waitForTransaction is true, includes IP ID and Token ID.
+     * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
+     */
+    mintAndRegisterIpAndMakeDerivativeWithLicenseTokens(request: MintAndRegisterIpAndMakeDerivativeWithLicenseTokensRequest): Promise<RegisterIpResponse>;
+    /**
+     * Register the given NFT as a derivative IP using license tokens.
+     * @param request - The request object that contains all data needed to register ip and make derivative with license tokens.
+     *   @param request.nftContract The address of the NFT collection.
+     *   @param request.licenseTokenIds The IDs of the license tokens to be burned for linking the IP to parent IPs.
+     *   @param request.tokenId The ID of the NFT.
+     *   @param request.deadline [Optional] The deadline for the signature in milliseconds, default is 1000ms.
+     *   @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
+     *   @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
+     *   @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
+     *   @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
+     *   @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
+     *   @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, or if waitForTransaction is true, includes IP ID.
+     */
+    registerIpAndMakeDerivativeWithLicenseTokens(request: RegisterIpAndMakeDerivativeWithLicenseTokensRequest): Promise<RegisterIpResponse>;
     private getIpIdAddress;
     private isRegistered;
     private getSigSignatureState;
     private getLicenseTermsId;
+    private validateLicenseTokenIds;
 }
 //# sourceMappingURL=ipAsset.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,EAWb,MAAM,MAAM,CAAC;AAGd,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAEpD,OAAO,EACL,gCAAgC,EAChC,iCAAiC,EACjC,4BAA4B,EAC5B,uBAAuB,EACvB,SAAS,EACT,UAAU,EACV,yCAAyC,EACzC,yBAAyB,EACzB,0BAA0B,EAC1B,0CAA0C,EAC1C,2CAA2C,EAC3C,kCAAkC,EAClC,mCAAmC,EACnC,kCAAkC,EAClC,mCAAmC,EACnC,kBAAkB,EAClB,eAAe,EAChB,sCAAmC;AACpC,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,qBAAqB,EACrB,6BAA6B,EAC7B,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACtB,kBAAkB,EAClB,SAAS,EAQV,4BAAyB;AAK1B,qBAAa,aAAa;IACjB,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,SAAS,EAAE,SAAS,CAAC;IAC5B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAe3F;;;;;;;;;;;;;OAaG;IACI,uBAAuB,CAAC,KAAK,EAAE,4BAA4B,GAAG,SAAS;IAqB9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACI,kBAAkB,CAAC,KAAK,EAAE,uBAAuB,GAAG,UAAU;IAiCrE;;;;;;;;;;;;;;OAcG;IACU,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAoF5E;;;;;;;;;;;;OAYG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IA4DtC;;;;;;;;;;OAUG;IACU,mCAAmC,CAC9C,OAAO,EAAE,0CAA0C,GAClD,OAAO,CAAC,2CAA2C,CAAC;IAyCvD;;;;;;;;;;;;;;;;;;OAkBG;IACU,kCAAkC,CAC7C,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,iCAAiC,CAAC;IAiD7C;;;;;;;;;;;;;;;;;;OAkBG;IACU,2BAA2B,CACtC,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IAsG/C;;;;;;;;;;;;;;;;;;OAkBG;IACU,oBAAoB,CAC/B,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IA6H/C;;;;;;;;;;;;;;;;;OAiBG;IACU,kCAAkC,CAC7C,OAAO,EAAE,yCAAyC,GACjD,OAAO,CAAC,0BAA0B,CAAC;YA4DxB,cAAc;YAYd,YAAY;IAI1B,OAAO,CAAC,oBAAoB;YA+Bd,iBAAiB;CAYhC"}
+{"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,EAWb,MAAM,MAAM,CAAC;AAGd,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAEpD,OAAO,EACL,gCAAgC,EAChC,iCAAiC,EACjC,4BAA4B,EAC5B,uBAAuB,EACvB,SAAS,EACT,UAAU,EACV,yCAAyC,EACzC,0DAA0D,EAC1D,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC1B,0CAA0C,EAC1C,2CAA2C,EAC3C,kCAAkC,EAClC,mCAAmC,EACnC,kCAAkC,EAClC,mCAAmC,EACnC,mDAAmD,EACnD,kBAAkB,EAClB,gCAAgC,EAChC,iCAAiC,EACjC,eAAe,EAChB,sCAAmC;AACpC,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,yBAAyB,EAMzB,qBAAqB,EACrB,gCAAgC,EAIhC,6BAA6B,EAC7B,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACvB,2BAA2B,EAG3B,kBAAkB,EAInB,4BAAyB;AAK1B,qBAAa,aAAa;IACjB,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,2BAA2B,EAAE,2BAA2B,CAAC;IACzD,gCAAgC,EAAE,gCAAgC,CAAC;IACnE,yBAAyB,EAAE,yBAAyB,CAAC;IAE5D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAgB3F;;;;;;;;;;;;;OAaG;IACI,uBAAuB,CAAC,KAAK,EAAE,4BAA4B,GAAG,SAAS;IAqB9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACI,kBAAkB,CAAC,KAAK,EAAE,uBAAuB,GAAG,UAAU;IAiCrE;;;;;;;;;;;;;;OAcG;IACU,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAuF5E;;;;;;;;;;;;OAYG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IA4DtC;;;;;;;;;;OAUG;IACU,mCAAmC,CAC9C,OAAO,EAAE,0CAA0C,GAClD,OAAO,CAAC,2CAA2C,CAAC;IAiCvD;;;;;;;;;;;;;;;;;;;OAmBG;IACU,kCAAkC,CAC7C,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,iCAAiC,CAAC;IAwD7C;;;;;;;;;;;;;;;;;;;OAmBG;IACU,2BAA2B,CACtC,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IAoH/C;;;;;;;;;;;;;;;;;;OAkBG;IACU,oBAAoB,CAC/B,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IA+H/C;;;;;;;;;;;;;;;;;OAiBG;IACU,kCAAkC,CAC7C,OAAO,EAAE,yCAAyC,GACjD,OAAO,CAAC,0BAA0B,CAAC;IAiEtC;;;;;;;;;;;;;OAaG;IACU,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAgC9F;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,yBAAyB,CACpC,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,iCAAiC,CAAC;IAiE7C;;;;;;;;;;;;;;OAcG;IACU,mDAAmD,CAC9D,OAAO,EAAE,0DAA0D,GAClE,OAAO,CAAC,kBAAkB,CAAC;IA4C9B;;;;;;;;;;;;;;OAcG;IACU,4CAA4C,CACvD,OAAO,EAAE,mDAAmD,GAC3D,OAAO,CAAC,kBAAkB,CAAC;YA+FhB,cAAc;YAYd,YAAY;IAI1B,OAAO,CAAC,oBAAoB;YA+Bd,iBAAiB;YAajB,uBAAuB;CAiBtC"}

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

@@ -1,18 +1,19 @@
 import { PublicClient } from "viem";
-import { IpAssetRegistryClient, LicenseRegistryEventClient, LicenseRegistryReadOnlyClient, LicensingModuleClient, PiLicenseTemplateClient, PiLicenseTemplateGetLicenseTermsResponse, PiLicenseTemplateReadOnlyClient, RoyaltyModuleReadOnlyClient, RoyaltyPolicyLapClient, SimpleWalletClient } from "../abi/generated.js";
-import { RegisterNonComSocialRemixingPILRequest, RegisterPILResponse, RegisterCommercialUsePILRequest, RegisterCommercialRemixPILRequest, AttachLicenseTermsRequest, MintLicenseTokensRequest, MintLicenseTokensResponse, AttachLicenseTermsResponse, LicenseTermsId, RegisterPILTermsRequest } from "../types/resources/license.js";
+import { IpAssetRegistryClient, LicenseRegistryEventClient, LicenseRegistryReadOnlyClient, LicensingModuleClient, LicensingModulePredictMintingLicenseFeeResponse, ModuleRegistryReadOnlyClient, PiLicenseTemplateClient, PiLicenseTemplateGetLicenseTermsResponse, PiLicenseTemplateReadOnlyClient, SimpleWalletClient } from "../abi/generated.js";
+import { RegisterNonComSocialRemixingPILRequest, RegisterPILResponse, RegisterCommercialUsePILRequest, RegisterCommercialRemixPILRequest, AttachLicenseTermsRequest, MintLicenseTokensRequest, MintLicenseTokensResponse, AttachLicenseTermsResponse, LicenseTermsId, RegisterPILTermsRequest, PredictMintingLicenseFeeRequest, SetLicensingConfigRequest, SetLicensingConfigResponse } from "../types/resources/license.js";
+import { SupportedChainIds } from "../types/config.js";
 export declare class LicenseClient {
     licenseRegistryClient: LicenseRegistryEventClient;
     licensingModuleClient: LicensingModuleClient;
     ipAssetRegistryClient: IpAssetRegistryClient;
     piLicenseTemplateReadOnlyClient: PiLicenseTemplateReadOnlyClient;
     licenseTemplateClient: PiLicenseTemplateClient;
-    royaltyPolicyLAPClient: RoyaltyPolicyLapClient;
-    royaltyModuleReadOnlyClient: RoyaltyModuleReadOnlyClient;
     licenseRegistryReadOnlyClient: LicenseRegistryReadOnlyClient;
+    moduleRegistryReadOnlyClient: ModuleRegistryReadOnlyClient;
     private readonly rpcClient;
     private readonly wallet;
-    constructor(rpcClient: PublicClient, wallet: SimpleWalletClient);
+    private readonly chainId;
+    constructor(rpcClient: PublicClient, wallet: SimpleWalletClient, chainId: SupportedChainIds);
     /**
      * Registers new license terms and return the ID of the newly registered license terms.
      * @param request - The request object that contains all data needed to register a license term.
@@ -34,7 +35,7 @@ export declare class LicenseClient {
      *   @param request.currency The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
      *   @param request.uri The URI of the license terms, which can be used to fetch the offchain license terms.
      *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to an object containing the optional transaction hash, optional transaction encodedTxData and optional license terms Id.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes license terms Id.
      * @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
      */
     registerPILTerms(request: RegisterPILTermsRequest): Promise<RegisterPILResponse>;
@@ -42,7 +43,7 @@ export declare class LicenseClient {
      * Convenient function to register a PIL non commercial social remix license to the registry
      * @param request - [Optional] The request object that contains all data needed to register a PIL non commercial social remix license.
      *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to an object containing the optional transaction hash and optional license terms Id.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes license terms Id.
      * @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
      */
     registerNonComSocialRemixingPIL(request?: RegisterNonComSocialRemixingPILRequest): Promise<RegisterPILResponse>;
@@ -51,8 +52,9 @@ export declare class LicenseClient {
      * @param request - The request object that contains all data needed to register a PIL commercial use license.
      *   @param request.defaultMintingFee The fee to be paid when minting a license.
      *   @param request.currency The ERC20 token to be used to pay the minting fee and the token must be registered in story protocol.
+     *   @param request.royaltyPolicyAddress [Optional] The address of the royalty policy contract, default value is LAP.
      *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to an object containing the optional transaction hash and optional license terms Id.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes license terms Id.
      * @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
      */
     registerCommercialUsePIL(request: RegisterCommercialUsePILRequest): Promise<RegisterPILResponse>;
@@ -62,8 +64,9 @@ export declare class LicenseClient {
      *   @param request.defaultMintingFee The fee to be paid when minting a license.
      *   @param request.commercialRevShare Percentage of revenue that must be shared with the licensor.
      *   @param request.currency The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
+     *   @param request.royaltyPolicyAddress [Optional] The address of the royalty policy contract, default value is LAP.
      *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to an object containing the optional transaction hash and optional license terms Id.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes license terms Id.
      * @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
      */
     registerCommercialRemixPIL(request: RegisterCommercialRemixPILRequest): Promise<RegisterPILResponse>;
@@ -74,7 +77,8 @@ export declare class LicenseClient {
      *   @param request.licenseTemplate The address of the license template.
      *   @param request.licenseTermsId The ID of the license terms.
      *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to an object containing the transaction hash.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes success.
+     * If Ip have attached license terms, success will return false and txhash is empty.
      */
     attachLicenseTerms(request: AttachLicenseTermsRequest): Promise<AttachLicenseTermsResponse>;
     /**
@@ -96,7 +100,7 @@ export declare class LicenseClient {
      *   @param request.amount The amount of license tokens to mint.
      *   @param request.receiver The address of the receiver.
      *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to an object containing the transaction hash and optional license token IDs if waitForTxn is set to true.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes license token IDs.
      * @emits LicenseTokensMinted (msg.sender, licensorIpId, licenseTemplate, licenseTermsId, amount, receiver, startLicenseTokenId);
      */
     mintLicenseTokens(request: MintLicenseTokensRequest): Promise<MintLicenseTokensResponse>;
@@ -106,8 +110,33 @@ export declare class LicenseClient {
      * @returns A Promise that resolves to an object containing the PILTerms associate with the given ID.
      */
     getLicenseTerms(selectedLicenseTermsId: LicenseTermsId): Promise<PiLicenseTemplateGetLicenseTermsResponse>;
+    /**
+     * Pre-compute the minting license fee for the given IP and license terms. The function can be used to calculate the minting license fee before minting license tokens.
+     * @param request - The request object that contains all data needed to predict minting licenses fee.
+     *   @param request.licensorIpId The IP ID of the licensor.
+     *   @param request.licenseTermsId The ID of the license terms.
+     *   @param request.amount The amount of license tokens to mint.
+     *   @param request.licenseTemplate [Optional] The address of the license template,default value is Programmable IP License.
+     *   @param request.receiver [Optional] The address of the receiver,default value is your wallet address.
+     *   @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
+     * @returns A Promise that resolves to an object containing the currency token and token amount.
+     */
+    predictMintingLicenseFee(request: PredictMintingLicenseFeeRequest): Promise<LicensingModulePredictMintingLicenseFeeResponse>;
+    /**
+     * Sets the licensing configuration for a specific license terms of an IP. If both licenseTemplate and licenseTermsId are not specified then the licensing config apply to all licenses of given IP.
+     * @param request - The request object that contains all data needed to set licensing config.
+     *   @param request.ipId The address of the IP for which the configuration is being set.
+     *   @param request.licenseTermsId The ID of the license terms within the license template.
+     *   @param request.licenseTemplate The address of the license template used, If not specified, the configuration applies to all licenses.
+     *   @param request.licensingConfig The licensing configuration for the license.
+     *   @param request.licensingConfig.isSet Whether the configuration is set or not.
+     *   @param request.licensingConfig.mintingFee The minting fee to be paid when minting license tokens.
+     *   @param request.licensingConfig.hookData The data to be used by the licensing hook.
+     *   @param request.licensingConfig.licensingHook The hook contract address for the licensing module, or address(0) if none.
+     *   @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes success.
+     */
+    setLicensingConfig(request: SetLicensingConfigRequest): Promise<SetLicensingConfigResponse>;
     private getLicenseTermsId;
-    private verifyCommercialUse;
-    private verifyDerivatives;
 }
 //# sourceMappingURL=license.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"license.d.ts","sourceRoot":"../../../../src/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAe,MAAM,MAAM,CAAC;AAEjD,OAAO,EACL,qBAAqB,EACrB,0BAA0B,EAC1B,6BAA6B,EAC7B,qBAAqB,EACrB,uBAAuB,EACvB,wCAAwC,EACxC,+BAA+B,EAC/B,2BAA2B,EAC3B,sBAAsB,EACtB,kBAAkB,EACnB,4BAAyB;AAC1B,OAAO,EAEL,sCAAsC,EACtC,mBAAmB,EACnB,+BAA+B,EAC/B,iCAAiC,EACjC,yBAAyB,EAEzB,wBAAwB,EACxB,yBAAyB,EAEzB,0BAA0B,EAC1B,cAAc,EACd,uBAAuB,EACxB,sCAAmC;AAKpC,qBAAa,aAAa;IACjB,qBAAqB,EAAE,0BAA0B,CAAC;IAClD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,+BAA+B,EAAE,+BAA+B,CAAC;IACjE,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,2BAA2B,EAAE,2BAA2B,CAAC;IACzD,6BAA6B,EAAE,6BAA6B,CAAC;IACpE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAY/D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAkE7F;;;;;;OAMG;IACU,+BAA+B,CAC1C,OAAO,CAAC,EAAE,sCAAsC,GAC/C,OAAO,CAAC,mBAAmB,CAAC;IAiC/B;;;;;;;;OAQG;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,mBAAmB,CAAC;IAqC/B;;;;;;;;;OASG;IACU,0BAA0B,CACrC,OAAO,EAAE,iCAAiC,GACzC,OAAO,CAAC,mBAAmB,CAAC;IAuC/B;;;;;;;;OAQG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IAmDtC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC;IAiErC;;;;OAIG;IACU,eAAe,CAC1B,sBAAsB,EAAE,cAAc,GACrC,OAAO,CAAC,wCAAwC,CAAC;YAUtC,iBAAiB;IAI/B,OAAO,CAAC,mBAAmB;IA6B3B,OAAO,CAAC,iBAAiB;CAgB1B"}
+{"version":3,"file":"license.d.ts","sourceRoot":"../../../../src/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAe,MAAM,MAAM,CAAC;AAEjD,OAAO,EACL,qBAAqB,EACrB,0BAA0B,EAC1B,6BAA6B,EAC7B,qBAAqB,EAErB,+CAA+C,EAE/C,4BAA4B,EAC5B,uBAAuB,EACvB,wCAAwC,EACxC,+BAA+B,EAC/B,kBAAkB,EAEnB,4BAAyB;AAC1B,OAAO,EAEL,sCAAsC,EACtC,mBAAmB,EACnB,+BAA+B,EAC/B,iCAAiC,EACjC,yBAAyB,EAEzB,wBAAwB,EACxB,yBAAyB,EAEzB,0BAA0B,EAC1B,cAAc,EACd,uBAAuB,EACvB,+BAA+B,EAC/B,yBAAyB,EACzB,0BAA0B,EAC3B,sCAAmC;AAIpC,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAEpD,qBAAa,aAAa;IACjB,qBAAqB,EAAE,0BAA0B,CAAC;IAClD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,+BAA+B,EAAE,+BAA+B,CAAC;IACjE,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,4BAA4B,EAAE,4BAA4B,CAAC;IAClE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAY3F;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAiC7F;;;;;;OAMG;IACU,+BAA+B,CAC1C,OAAO,CAAC,EAAE,sCAAsC,GAC/C,OAAO,CAAC,mBAAmB,CAAC;IAiC/B;;;;;;;;;OASG;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,mBAAmB,CAAC;IAwC/B;;;;;;;;;;OAUG;IACU,0BAA0B,CACrC,OAAO,EAAE,iCAAiC,GACzC,OAAO,CAAC,mBAAmB,CAAC;IA0C/B;;;;;;;;;OASG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IAmDtC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC;IAiErC;;;;OAIG;IACU,eAAe,CAC1B,sBAAsB,EAAE,cAAc,GACrC,OAAO,CAAC,wCAAwC,CAAC;IAUpD;;;;;;;;;;OAUG;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,+CAA+C,CAAC;IAkC3D;;;;;;;;;;;;;OAaG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;YAuDxB,iBAAiB;CAIhC"}

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

@@ -1,8 +1,8 @@
 import { PublicClient } from "viem";
-import { SimpleWalletClient, SpgClient } from "../abi/generated.js";
+import { RegistrationWorkflowsClient, SimpleWalletClient } from "../abi/generated.js";
 import { CreateNFTCollectionRequest, CreateNFTCollectionResponse } from "../types/resources/nftClient.js";
 export declare class NftClient {
-    spgClient: SpgClient;
+    registrationWorkflowsClient: RegistrationWorkflowsClient;
     private readonly rpcClient;
     private readonly wallet;
     constructor(rpcClient: PublicClient, wallet: SimpleWalletClient);
@@ -11,13 +11,18 @@ export declare class NftClient {
      * @param request - The request object containing necessary data to create a SPG NFT Collection.
      *   @param request.name - The name of the collection.
      * 	 @param request.symbol - The symbol of the collection.
-     * 	 @param request.maxSupply - The maximum supply of the collection.
-     * 	 @param request.mintFee - The cost to mint a token.
-     * 	 @param request.mintFeeToken - The token to mint.
-     * 	 @param request.owner - The owner of the collection.
-     *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to a CreateNFTCollectionResponse containing the transaction hash and collection address.
-     * @emits CollectionCreated (nftContract);
+     * 	 @param request.isPublicMinting - If true, anyone can mint from the collection. If false, only the addresses with the minter role can mint.
+     * 	 @param request.mintOpen Whether the collection is open for minting on creation.
+     *   @param request.mintFeeRecipient - The address to receive mint fees.
+     *   @param request.mintFeeRecipient - The contract URI for the collection. Follows ERC-7572 standard. See https://eips.ethereum.org/EIPS/eip-7572
+     * 	 @param request.baseURI - [Optional] The base URI for the collection. If baseURI is not empty, tokenURI will be either baseURI + token ID (if nftMetadataURI is empty) or baseURI + nftMetadataURI.
+     * 	 @param request.maxSupply - [Optional] The maximum supply of the collection.
+     * 	 @param request.mintFee - [Optional] The cost to mint a token.
+     * 	 @param request.mintFeeToken - [Optional] The token to mint.
+     * 	 @param request.owner - [Optional] The owner of the collection.
+     *   @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes spg nft contract address.
+     * @emits CollectionCreated (spgNftContract);
      */
     createNFTCollection(request: CreateNFTCollectionRequest): Promise<CreateNFTCollectionResponse>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"nftClient.d.ts","sourceRoot":"../../../../src/resources","sources":["nftClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAqC,MAAM,MAAM,CAAC;AAEvE,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,4BAAyB;AACjE,OAAO,EACL,0BAA0B,EAC1B,2BAA2B,EAC5B,wCAAqC;AAItC,qBAAa,SAAS;IACb,SAAS,EAAE,SAAS,CAAC;IAC5B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAM/D;;;;;;;;;;;;OAYG;IACU,mBAAmB,CAC9B,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,2BAA2B,CAAC;CAyCxC"}
+{"version":3,"file":"nftClient.d.ts","sourceRoot":"../../../../src/resources","sources":["nftClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAqC,MAAM,MAAM,CAAC;AAEvE,OAAO,EACL,2BAA2B,EAE3B,kBAAkB,EACnB,4BAAyB;AAC1B,OAAO,EACL,0BAA0B,EAC1B,2BAA2B,EAC5B,wCAAqC;AAItC,qBAAa,SAAS;IACb,2BAA2B,EAAE,2BAA2B,CAAC;IAChE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAM/D;;;;;;;;;;;;;;;;;OAiBG;IACU,mBAAmB,CAC9B,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,2BAA2B,CAAC;CAmDxC"}

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

@@ -1,11 +1,10 @@
 import { PublicClient } from "viem";
 import { CreateBatchPermissionSignatureRequest, CreateSetPermissionSignatureRequest, SetAllPermissionsRequest, SetBatchPermissionsRequest, SetPermissionsRequest, SetPermissionsResponse } from "../types/resources/permission.js";
-import { AccessControllerClient, CoreMetadataModuleClient, IpAssetRegistryClient, SimpleWalletClient, SpgClient } from "../abi/generated.js";
+import { AccessControllerClient, CoreMetadataModuleClient, IpAssetRegistryClient, SimpleWalletClient } from "../abi/generated.js";
 import { SupportedChainIds } from "../types/config.js";
 export declare class PermissionClient {
     accessControllerClient: AccessControllerClient;
     ipAssetRegistryClient: IpAssetRegistryClient;
-    spgClient: SpgClient;
     coreMetadataModuleClient: CoreMetadataModuleClient;
     private readonly wallet;
     private readonly rpcClient;

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,EAClB,SAAS,EACV,4BAAyB;AAE1B,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAIpD,qBAAa,gBAAgB;IACpB,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,SAAS,EAAE,SAAS,CAAC;IACrB,wBAAwB,EAAE,wBAAwB,CAAC;IAC1D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAU3F;;;;;;;;;;;;;;;;;;;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;IA6DlC;;;;;;;;;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;;;;;;;;;;;;;OAaG;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;AAE1B,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAIpD,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,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAS3F;;;;;;;;;;;;;;;;;;;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;IA6DlC;;;;;;;;;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;;;;;;;;;;;;;OAaG;IACU,8BAA8B,CACzC,OAAO,EAAE,qCAAqC,GAC7C,OAAO,CAAC,sBAAsB,CAAC;YA0DpB,iBAAiB;CAQhC"}

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

@@ -1,25 +1,17 @@
 import { Address, Hex, PublicClient } from "viem";
-import { ClaimableRevenueRequest, ClaimableRevenueResponse, CollectRoyaltyTokensRequest, CollectRoyaltyTokensResponse, PayRoyaltyOnBehalfRequest, PayRoyaltyOnBehalfResponse, SnapshotRequest, SnapshotResponse, ClaimRevenueRequest, ClaimRevenueResponse } from "../types/resources/royalty.js";
-import { IpAssetRegistryClient, RoyaltyModuleClient, RoyaltyPolicyLapClient, SimpleWalletClient } from "../abi/generated.js";
+import { ClaimableRevenueRequest, ClaimableRevenueResponse, PayRoyaltyOnBehalfRequest, PayRoyaltyOnBehalfResponse, SnapshotRequest, SnapshotResponse, TransferToVaultAndSnapshotAndClaimByTokenBatchRequest, TransferToVaultAndSnapshotAndClaimBySnapshotBatchRequest, SnapshotAndClaimByTokenBatchRequest, SnapshotAndClaimBySnapshotBatchRequest, ClaimRevenueRequest, ClaimRevenueResponse, SnapshotAndClaimBySnapshotBatchResponse, TransferToVaultAndSnapshotAndClaimBySnapshotBatchResponse, TransferToVaultAndSnapshotAndClaimByTokenBatchResponse, SnapshotAndClaimByTokenBatchResponse } from "../types/resources/royalty.js";
+import { IpAssetRegistryClient, IpRoyaltyVaultImplClient, IpRoyaltyVaultImplEventClient, RoyaltyModuleClient, RoyaltyWorkflowsClient, SimpleWalletClient } from "../abi/generated.js";
 import { IPAccountClient } from "./ipAccount.js";
 export declare class RoyaltyClient {
-    royaltyPolicyLapClient: RoyaltyPolicyLapClient;
     royaltyModuleClient: RoyaltyModuleClient;
     ipAssetRegistryClient: IpAssetRegistryClient;
     ipAccountClient: IPAccountClient;
+    royaltyWorkflowsClient: RoyaltyWorkflowsClient;
+    ipRoyaltyVaultImplClient: IpRoyaltyVaultImplClient;
+    ipRoyaltyVaultImplEventClient: IpRoyaltyVaultImplEventClient;
     private readonly rpcClient;
     private readonly wallet;
     constructor(rpcClient: PublicClient, wallet: SimpleWalletClient);
-    /**
-     * Allows ancestors to claim the royalty tokens and any accrued revenue tokens
-     * @param request - The request object that contains all data needed to collect royalty tokens.
-     *   @param request.parentIpId The ip id of the ancestor to whom the royalty tokens belong to.
-     *   @param request.royaltyVaultIpId The id of the royalty vault.
-     *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to an object containing the transaction hash and optional the amount of royalty tokens collected if waitForTxn is set to true.
-     * @emits RoyaltyTokensCollected (ancestorIpId, royaltyTokensCollected)
-     */
-    collectRoyaltyTokens(request: CollectRoyaltyTokensRequest): Promise<CollectRoyaltyTokensResponse>;
     /**
      * Allows the function caller to pay royalties to the receiver IP asset on behalf of the payer IP asset.
      * @param request - The request object that contains all data needed to pay royalty on behalf.
@@ -68,5 +60,64 @@ export declare class RoyaltyClient {
      * @returns A Promise that resolves to an object containing the royalty vault address.
      */
     getRoyaltyVaultAddress(royaltyVaultIpId: Hex): Promise<Address>;
+    /**
+     *  Transfers royalties from royalty policy to the ancestor IP's royalty vault, takes a snapshot, and claims revenue on that snapshot for each specified currency token.
+     * @param request - The request object that contains all data needed to transfer to vault and snapshot and claim by token batch.
+     *   @param request.ancestorIpId The address of the ancestor IP.
+     *   @param request.royaltyClaimDetails The details of the royalty claim from child IPs
+     *   @param request.royaltyClaimDetails - The details of the royalty claim from child IPs
+     *   @param request.royaltyClaimDetails.childIpId The address of the child IP.
+     *   @param request.royaltyClaimDetails.royaltyPolicy The address of the royalty policy.
+     *   @param request.royaltyClaimDetails.currencyToken The address of the currency (revenue) token to claim.
+     *   @param request.claimer [Optional] The address of the claimer of the revenue tokens (must be a royalty token holder), default value is wallet address.
+     *   @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, or if waitForTransaction is true, includes snapshot ID and amounts claimed.
+     * @emits SnapshotCompleted (snapshotId, snapshotTimestamp, unclaimedTokens).
+     * @emits RevenueTokenClaimed (claimer, token, amount).
+     */
+    transferToVaultAndSnapshotAndClaimByTokenBatch(request: TransferToVaultAndSnapshotAndClaimByTokenBatchRequest): Promise<TransferToVaultAndSnapshotAndClaimByTokenBatchResponse>;
+    /**
+     *  Transfers royalties to the ancestor IP's royalty vault, takes a snapshot, claims revenue for each
+     * specified currency token both on the new snapshot and on each specified unclaimed snapshots.
+     * @param request - The request object that contains all data needed to transfer to vault and snapshot and claim by snapshot batch.
+     *   @param request.ancestorIpId The address of the ancestor IP.
+     *   @param request.unclaimedSnapshotIds The IDs of unclaimed snapshots to include in the claim.
+     *   @param request.royaltyClaimDetails The details of the royalty claim from child IPs
+     *   @param request.royaltyClaimDetails - The details of the royalty claim from child IPs
+     *   @param request.royaltyClaimDetails.childIpId The address of the child IP.
+     *   @param request.royaltyClaimDetails.royaltyPolicy The address of the royalty policy.
+     *   @param request.royaltyClaimDetails.currencyToken The address of the currency (revenue) token to claim.
+     *   @param request.claimer [Optional] The address of the claimer of the revenue tokens (must be a royalty token holder), default value is wallet address.
+     *   @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, or if waitForTransaction is true, includes snapshot ID and amounts claimed.
+     * @emits SnapshotCompleted (snapshotId, snapshotTimestamp, unclaimedTokens).
+     * @emits RevenueTokenClaimed (claimer, token, amount).
+     */
+    transferToVaultAndSnapshotAndClaimBySnapshotBatch(request: TransferToVaultAndSnapshotAndClaimBySnapshotBatchRequest): Promise<TransferToVaultAndSnapshotAndClaimBySnapshotBatchResponse>;
+    /**
+     * Takes a snapshot of the IP's royalty vault and claims revenue on that snapshot for each
+     * @param request - The request object that contains all data needed to snapshot and claim by token batch.
+     *   @param request.royaltyVaultIpId The address of the IP.
+     *   @param request.currencyTokens The addresses of the currency (revenue) tokens to claim.
+     *   @param request.claimer [Optional] The address of the claimer of the revenue tokens (must be a royalty token holder), default value is wallet address.
+     *   @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, or if waitForTransaction is true, includes snapshot ID and amounts claimed.
+     * @emits SnapshotCompleted (snapshotId, snapshotTimestamp, unclaimedTokens).
+     * @emits RevenueTokenClaimed (claimer, token, amount).
+     */
+    snapshotAndClaimByTokenBatch(request: SnapshotAndClaimByTokenBatchRequest): Promise<SnapshotAndClaimByTokenBatchResponse>;
+    /**
+     * Takes a snapshot of the IP's royalty vault and claims revenue for each specified currency token
+     * @param request - The request object that contains all data needed to snapshot and claim by snapshot batch.
+     *   @param request.royaltyVaultIpId The address of the IP.
+     *   @param request.unclaimedSnapshotIds The IDs of unclaimed snapshots to include in the claim.
+     *   @param request.currencyTokens The addresses of the currency (revenue) tokens to claim.
+     *   @param request.claimer [Optional] The address of the claimer of the revenue tokens (must be a royalty token holder), default value is wallet address.
+     *   @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
+     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, or if waitForTransaction is true, includes snapshot ID and amounts claimed.
+     * @emits SnapshotCompleted (snapshotId, snapshotTimestamp, unclaimedTokens).
+     * @emits RevenueTokenClaimed (claimer, token, amount).
+     */
+    snapshotAndClaimBySnapshotBatch(request: SnapshotAndClaimBySnapshotBatchRequest): Promise<SnapshotAndClaimBySnapshotBatchResponse>;
 }
 //# sourceMappingURL=royalty.d.ts.map

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,EAAE,OAAO,EAAE,GAAG,EAAE,YAAY,EAAmC,MAAM,MAAM,CAAC;AAGnF,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,2BAA2B,EAC3B,4BAA4B,EAC5B,yBAAyB,EACzB,0BAA0B,EAC1B,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,oBAAoB,EACrB,sCAAmC;AACpC,OAAO,EACL,qBAAqB,EAErB,mBAAmB,EACnB,sBAAsB,EACtB,kBAAkB,EAEnB,4BAAyB;AAC1B,OAAO,EAAE,eAAe,EAAE,uBAAoB;AAG9C,qBAAa,aAAa;IACjB,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,eAAe,EAAE,eAAe,CAAC;IACxC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAS/D;;;;;;;;OAQG;IACU,oBAAoB,CAC/B,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,4BAA4B,CAAC;IA0CxC;;;;;;;;;OASG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IA0CtC;;;;;;;;OAQG;IACU,gBAAgB,CAC3B,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;IAoBpC;;;;;;;;;;OAUG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAqDtF;;;;;;;OAOG;IACU,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA8B1E;;;;OAIG;IACU,sBAAsB,CAAC,gBAAgB,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;CAe7E"}
+{"version":3,"file":"royalty.d.ts","sourceRoot":"../../../../src/resources","sources":["royalty.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,YAAY,EAAmC,MAAM,MAAM,CAAC;AAGnF,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC1B,eAAe,EACf,gBAAgB,EAChB,qDAAqD,EACrD,wDAAwD,EACxD,mCAAmC,EACnC,sCAAsC,EACtC,mBAAmB,EACnB,oBAAoB,EACpB,uCAAuC,EACvC,yDAAyD,EACzD,sDAAsD,EACtD,oCAAoC,EACrC,sCAAmC;AACpC,OAAO,EACL,qBAAqB,EACrB,wBAAwB,EACxB,6BAA6B,EAC7B,mBAAmB,EACnB,sBAAsB,EAKtB,kBAAkB,EAEnB,4BAAyB;AAC1B,OAAO,EAAE,eAAe,EAAE,uBAAoB;AAG9C,qBAAa,aAAa;IACjB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,eAAe,EAAE,eAAe,CAAC;IACjC,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,6BAA6B,EAAE,6BAA6B,CAAC;IACpE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAW/D;;;;;;;;;OASG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IA0CtC;;;;;;;;OAQG;IACU,gBAAgB,CAC3B,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;IAmBpC;;;;;;;;;;OAUG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAsDtF;;;;;;;OAOG;IACU,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA8B1E;;;;OAIG;IACU,sBAAsB,CAAC,gBAAgB,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAS5E;;;;;;;;;;;;;;OAcG;IACU,8CAA8C,CACzD,OAAO,EAAE,qDAAqD,GAC7D,OAAO,CAAC,sDAAsD,CAAC;IAuDlE;;;;;;;;;;;;;;;;OAgBG;IACU,iDAAiD,CAC5D,OAAO,EAAE,wDAAwD,GAChE,OAAO,CAAC,yDAAyD,CAAC;IA8DrE;;;;;;;;;;OAUG;IACU,4BAA4B,CACvC,OAAO,EAAE,mCAAmC,GAC3C,OAAO,CAAC,oCAAoC,CAAC;IA+ChD;;;;;;;;;;;OAWG;IACU,+BAA+B,CAC1C,OAAO,EAAE,sCAAsC,GAC9C,OAAO,CAAC,uCAAuC,CAAC;CAgDpD"}