@story-protocol/core-sdk 1.0.0-rc.6 → 1.2.0-rc.0

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/ipAccount.d.ts

@@ -1,5 +1,5 @@
-import { PublicClient } from "viem";
-import { IPAccountExecuteRequest, IPAccountExecuteResponse, IPAccountExecuteWithSigRequest, IPAccountExecuteWithSigResponse } from "../types/resources/ipAccount.js";
+import { Address, PublicClient } from "viem";
+import { IPAccountExecuteRequest, IPAccountExecuteResponse, IPAccountExecuteWithSigRequest, IPAccountExecuteWithSigResponse, IpAccountStateResponse, TokenResponse } from "../types/resources/ipAccount.js";
 import { SimpleWalletClient } from "../abi/generated.js";
 export declare class IPAccountClient {
     private readonly wallet;
@@ -7,22 +7,37 @@ export declare class IPAccountClient {
     constructor(rpcClient: PublicClient, wallet: SimpleWalletClient);
     /** Executes a transaction from the IP Account.
      * @param request - The request object containing necessary data to execute IP Account a transaction.
+     *   @param request.ipId The Ip Id to get ip account.
      *   @param request.to The recipient of the transaction.
      *   @param request.value The amount of Ether to send.
+     *   @param request.accountAddress The ipId to send.
      *   @param request.data The data to send along with the transaction.
+     *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
      * @returns Tx hash for the transaction.
      */
     execute(request: IPAccountExecuteRequest): Promise<IPAccountExecuteResponse>;
     /** Executes a transaction from the IP Account.
      * @param request - The request object containing necessary data to execute IP Account a transaction.
+     *   @param request.ipId The Ip Id to get ip account.
      *   @param request.to The recipient of the transaction.
      *   @param request.value The amount of Ether to send.
      *   @param request.data The data to send along with the transaction.
      *   @param request.signer The signer of the transaction.
      *   @param request.deadline The deadline of the transaction signature.
      *   @param request.signature The signature of the transaction, EIP-712 encoded.
+     *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
      * @returns Tx hash for the transaction.
      */
     executeWithSig(request: IPAccountExecuteWithSigRequest): Promise<IPAccountExecuteWithSigResponse>;
+    /** Returns the IPAccount's internal nonce for transaction ordering.
+     * @param ipId The IP ID
+     * @returns A Promise that resolves to the IP Account's nonce.
+     */
+    getIpAccountNonce(ipId: Address): Promise<IpAccountStateResponse>;
+    /**
+     * Returns the identifier of the non-fungible token which owns the account
+     * @returns A Promise that resolves to an object containing the chain ID, token contract address, and token ID.
+     */
+    getToken(ipId: Address): Promise<TokenResponse>;
 }
 //# sourceMappingURL=ipAccount.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ipAccount.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAc,MAAM,MAAM,CAAC;AAEhD,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,8BAA8B,EAC9B,+BAA+B,EAChC,wCAAqC;AAGtC,OAAO,EAAuB,kBAAkB,EAAE,4BAAyB;AAE3E,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;gBAE7B,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAK/D;;;;;;OAMG;IACU,OAAO,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAuBzF;;;;;;;;;OASG;IACU,cAAc,CACzB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC;CAyB5C"}
+{"version":3,"file":"ipAccount.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAE7C,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,8BAA8B,EAC9B,+BAA+B,EAC/B,sBAAsB,EACtB,aAAa,EACd,wCAAqC;AAEtC,OAAO,EAAuB,kBAAkB,EAAE,4BAAyB;AAG3E,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;gBAE7B,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAK/D;;;;;;;;;OASG;IACU,OAAO,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAgCzF;;;;;;;;;;;OAWG;IACU,cAAc,CACzB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC;IAmC3C;;;OAGG;IACU,iBAAiB,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAc9E;;;OAGG;IACU,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;CAiB7D"}

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

@@ -1,23 +1,90 @@
 import { PublicClient } from "viem";
 import { SupportedChainIds } from "../types/config.js";
-import { RegisterDerivativeRequest, RegisterDerivativeResponse, RegisterDerivativeWithLicenseTokensRequest, RegisterDerivativeWithLicenseTokensResponse, RegisterIpResponse, RegisterRequest } from "../types/resources/ipAsset.js";
-import { IpAssetRegistryClient, LicenseRegistryReadOnlyClient, LicenseTokenReadOnlyClient, LicensingModuleClient, PiLicenseTemplateClient, SimpleWalletClient } 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;
+    accessControllerClient: AccessControllerClient;
+    coreMetadataModuleClient: CoreMetadataModuleClient;
+    registrationWorkflowsClient: RegistrationWorkflowsClient;
+    licenseAttachmentWorkflowsClient: LicenseAttachmentWorkflowsClient;
+    derivativeWorkflowsClient: DerivativeWorkflowsClient;
     private readonly rpcClient;
+    private readonly wallet;
     private readonly chainId;
     constructor(rpcClient: PublicClient, wallet: SimpleWalletClient, chainId: SupportedChainIds);
+    /**
+     * Create a new `IpCreator` object with the specified details.
+     * @param params - The parameters required to create the `IpCreator` object.
+     *   @param params.name The name of the creator.
+     *   @param params.address The wallet address of the creator.
+     *   @param params.description [Optional] A description of the creator.
+     *   @param params.image [Optional] The URL or path to an image representing the creator.
+     *   @param params.socialMedia [Optional] An array of social media profiles associated with the creator.
+     *     @param params.socialMedia[].platform The name of the social media platform.
+     *     @param params.socialMedia[].url The URL to the creator's profile on the platform.
+     *  @param params.contributionPercent The percentage of contribution by the creator, must add up to 100.
+     *  @param params.role [Optional] The role of the creator in relation to the IP.
+     * @returns An `IpCreator` object containing the provided details.
+     */
+    generateCreatorMetadata(param: GenerateCreatorMetadataParam): IpCreator;
+    /**
+     * Create a new `IpMetadata` object with the specified details.
+     * @param params - The parameters required to create the `IpMetadata` object.
+     *   @param params.title [Optional] The title of the IP.
+     *   @param params.description [Optional] A description of the IP.
+     *   @param params.ipType [Optional] The type of the IP asset (e.g., "character", "chapter").
+     *   @param params.relationships [Optional] An array of relationships between this IP and its parent IPs.
+     *     @param params.relationships[].ipId The ID of the parent IP.
+     *     @param params.relationships[].type The type of relationship (e.g., "APPEARS_IN").
+     *   @param params.createdAt [Optional] The creation date and time of the IP in ISO 8601 format.
+     *   @param params.watermarkImg [Optional] The URL or path to an image used as a watermark for the IP.
+     *   @param params.creators [Optional] An array of creators associated with the IP.
+     *     @param params.creators[].name The name of the creator.
+     *     @param params.creators[].address The address of the creator.
+     *     @param params.creators[].description [Optional] A description of the creator.
+     *     @param params.creators[].image [Optional] The URL or path to an image representing the creator.
+     *     @param params.creators[].socialMedia [Optional] An array of social media profiles for the creator.
+     *     @param params.creators[].socialMedia[].platform The social media platform name.
+     *     @param params.creators[].socialMedia[].url The URL to the creator's profile.
+     *     @param params.creators[].role [Optional] The role of the creator in relation to the IP.
+     *     @param params.creators[].contributionPercent The percentage of contribution by the creator.
+     *   @param params.media [Optional] An array of media related to the IP.
+     *     @param params.media[].name The name of the media.
+     *     @param params.media[].url The URL to the media.
+     *     @param params.media[].mimeType The MIME type of the media.
+     *   @param params.attributes [Optional] An array of key-value pairs providing additional metadata.
+     *     @param params.attributes[].key The key for the attribute.
+     *     @param params.attributes[].value The value for the attribute, can be a string or number.
+     *   @param params.app [Optional] Information about the application associated with the IP.
+     *     @param params.app.id The ID of the application.
+     *     @param params.app.name The name of the application.
+     *     @param params.app.website The website URL of the application.
+     *   @param params.tags [Optional] An array of tags associated with the IP.
+     *   @param params.robotTerms [Optional] Robot terms for the IP, specifying access rules.
+     *     @param params.robotTerms.userAgent The user agent for which the rules apply.
+     *     @param params.robotTerms.allow The rules allowing access.
+     *   @param params.additionalProperties [Optional] Any additional key-value pairs to include in the metadata.
+     * @returns An `IpMetadata` object containing the provided details and any additional properties.
+     */
+    generateIpMetadata(param: GenerateIpMetadataParam): IpMetadata;
     /**
      * Registers an NFT as IP, creating a corresponding IP record.
      * @param request - The request object that contains all data needed to register IP.
-     *   @param request.tokenContract The address of the NFT.
+     *   @param request.nftContract The address of the NFT.
      *   @param request.tokenId The token identifier of the NFT.
-     *   @param request.txOptions [Optional] The transaction options.
-     * @returns A Promise that resolves to an object containing the transaction hash and optional IP ID if waitForTxn is set to true.
+     *   @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.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 IP ID, token ID.
      * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, resolverAddr, metadataProviderAddress, metadata)
      */
     register(request: RegisterRequest): Promise<RegisterIpResponse>;
@@ -31,7 +98,7 @@ export declare class IPAssetClient {
      *   @param request.childIpId The derivative IP ID.
      *   @param request.parentIpIds The parent IP IDs.
      *   @param request.licenseTermsIds The IDs of the license terms that the parent IP supports.
-     *   @param request.txOptions [Optional] The transaction options.
+     *   @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.
      */
     registerDerivative(request: RegisterDerivativeRequest): Promise<RegisterDerivativeResponse>;
@@ -43,11 +110,168 @@ export declare class IPAssetClient {
      * @param request - The request object that contains all data needed to register derivative license tokens.
      *   @param request.childIpId The derivative IP ID.
      *   @param request.licenseTokenIds The IDs of the license tokens.
-     *   @param request.txOptions [Optional] The transaction options.
+     *   @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.
      */
     registerDerivativeWithLicenseTokens(request: RegisterDerivativeWithLicenseTokensRequest): Promise<RegisterDerivativeWithLicenseTokensResponse>;
-    private isNFTRegistered;
+    /**
+     * 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.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,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] 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)
+     */
+    mintAndRegisterIpAssetWithPilTerms(request: CreateIpAssetWithPilTermsRequest): Promise<CreateIpAssetWithPilTermsResponse>;
+    /**
+     * Register a given NFT as an IP and attach Programmable IP License Terms.R.
+     * @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.tokenId The ID of the NFT.
+     *   @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.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.
+     *   @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, License Terms Id if waitForTxn is set to true.
+     * @emits LicenseTermsAttached (caller, ipId, licenseTemplate, licenseTermsId)
+     */
+    registerIpAndAttachPilTerms(request: RegisterIpAndAttachPilTermsRequest): Promise<RegisterIpAndAttachPilTermsResponse>;
+    /**
+     * Register the given NFT as a derivative IP with metadata without using license tokens.
+     * @param request - The request object that contains all data needed to register derivative IP.
+     *   @param request.nftContract The address of the NFT collection.
+     *   @param request.tokenId The ID of the NFT.
+     *   @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.licenseTemplate [Optional] The address of the license template to be used for the linking.
+     *   @param request.derivData.licenseTermsIds The IDs of the license terms to be used for the linking.
+     *   @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.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.
+     * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
+     */
+    registerDerivativeIp(request: RegisterIpAndMakeDerivativeRequest): Promise<RegisterIpAndMakeDerivativeResponse>;
+    /**
+     * 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.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.
+     *   @param request.derivData.licenseTemplate [Optional] The address of the license template to be used for the linking.
+     *   @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,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.
+     * @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,EAAO,YAAY,EAA2B,MAAM,MAAM,CAAC;AAGlE,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAEpD,OAAO,EACL,yBAAyB,EACzB,0BAA0B,EAC1B,0CAA0C,EAC1C,2CAA2C,EAC3C,kBAAkB,EAClB,eAAe,EAChB,sCAAmC;AACpC,OAAO,EACL,qBAAqB,EACrB,6BAA6B,EAC7B,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACvB,kBAAkB,EACnB,4BAAyB;AAE1B,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;IAC9D,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;;;;;;;;OAQG;IACU,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAwB5E;;;;;;;;;;;;OAYG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IA+CtC;;;;;;;;;;OAUG;IACU,mCAAmC,CAC9C,OAAO,EAAE,0CAA0C,GAClD,OAAO,CAAC,2CAA2C,CAAC;YA8BzC,eAAe;YAUf,YAAY;CAG3B"}
+{"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;;;;;;;;;;;;;;;;;;OAkBG;IACU,kCAAkC,CAC7C,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,iCAAiC,CAAC;IAwD7C;;;;;;;;;;;;;;;;;;OAkBG;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,21 +1,47 @@
 import { PublicClient } from "viem";
-import { IpAssetRegistryClient, LicenseRegistryEventClient, LicenseRegistryReadOnlyClient, LicensingModuleClient, PiLicenseTemplateClient, PiLicenseTemplateReadOnlyClient, RoyaltyPolicyLapClient, SimpleWalletClient } from "../abi/generated.js";
-import { RegisterNonComSocialRemixingPILRequest, RegisterPILResponse, RegisterCommercialUsePILRequest, RegisterCommercialRemixPILRequest, AttachLicenseTermsRequest, MintLicenseTokensRequest, MintLicenseTokensResponse } from "../types/resources/license.js";
+import { IpAssetRegistryClient, LicenseRegistryEventClient, LicenseRegistryReadOnlyClient, LicensingModuleClient, PiLicenseTemplateClient, PiLicenseTemplateGetLicenseTermsResponse, PiLicenseTemplateReadOnlyClient, SimpleWalletClient } from "../abi/generated.js";
+import { RegisterNonComSocialRemixingPILRequest, RegisterPILResponse, RegisterCommercialUsePILRequest, RegisterCommercialRemixPILRequest, AttachLicenseTermsRequest, MintLicenseTokensRequest, MintLicenseTokensResponse, AttachLicenseTermsResponse, LicenseTermsId, RegisterPILTermsRequest } 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;
     licenseRegistryReadOnlyClient: LicenseRegistryReadOnlyClient;
     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.
+     *   @param request.transferable Indicates whether the license is transferable or not.
+     *   @param request.royaltyPolicy The address of the royalty policy contract which required to StoryProtocol in advance.
+     *   @param request.mintingFee The fee to be paid when minting a license.
+     *   @param request.expiration The expiration period of the license.
+     *   @param request.commercialUse Indicates whether the work can be used commercially or not.
+     *   @param request.commercialAttribution Whether attribution is required when reproducing the work commercially or not.
+     *   @param request.commercializerChecker Commercializers that are allowed to commercially exploit the work. If zero address, then no restrictions is enforced.
+     *   @param request.commercializerCheckerData The data to be passed to the commercializer checker contract.
+     *   @param request.commercialRevShare Percentage of revenue that must be shared with the licensor.
+     *   @param request.commercialRevCeiling The maximum revenue that can be generated from the commercial use of the work.
+     *   @param request.derivativesAllowed Indicates whether the licensee can create derivatives of his work or not.
+     *   @param request.derivativesAttribution Indicates whether attribution is required for derivatives of the work or not.
+     *   @param request.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.derivativesReciprocal Indicates whether the licensee must license derivatives of the work under the same terms or not.
+     *   @param request.derivativeRevCeiling The maximum revenue that can be generated from the derivative use of the work.
+     *   @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.
+     * @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
+     */
+    registerPILTerms(request: RegisterPILTermsRequest): Promise<RegisterPILResponse>;
     /**
      * 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] The transaction options.
+     *   @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.
      * @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
      */
@@ -23,10 +49,9 @@ export declare class LicenseClient {
     /**
      * Convenient function to register a PIL commercial use license to the registry.
      * @param request - The request object that contains all data needed to register a PIL commercial use license.
-     *   @param request.mintingFee The fee to be paid when minting a 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.royaltyPolicy The address of the royalty policy contract which required to StoryProtocol in advance.
-     *   @param request.txOptions [Optional] The transaction options.
+     *   @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.
      * @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
      */
@@ -34,11 +59,10 @@ export declare class LicenseClient {
     /**
      * Convenient function to register a PIL commercial Remix license to the registry.
      * @param request - The request object that contains all data needed to register license.
-     *   @param request.mintingFee The fee to be paid when minting a license.
+     *   @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.royaltyPolicy The address of the royalty policy contract which required to StoryProtocol in advance.
-     *   @param request.txOptions [Optional] The transaction options.
+     *   @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.
      * @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
      */
@@ -49,12 +73,10 @@ export declare class LicenseClient {
      *   @param request.ipId The address of the IP to which the license terms are attached.
      *   @param request.licenseTemplate The address of the license template.
      *   @param request.licenseTermsId The ID of the license terms.
-     *   @param request.txOptions [Optional] The transaction options.
+     *   @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.
      */
-    attachLicenseTerms(request: AttachLicenseTermsRequest): Promise<{
-        txHash: `0x${string}`;
-    }>;
+    attachLicenseTerms(request: AttachLicenseTermsRequest): Promise<AttachLicenseTermsResponse>;
     /**
      * Mints license tokens for the license terms attached to an IP.
      * The license tokens are minted to the receiver.
@@ -73,11 +95,17 @@ export declare class LicenseClient {
      *   @param request.licenseTermsId The ID of the license terms within the license template.
      *   @param request.amount The amount of license tokens to mint.
      *   @param request.receiver The address of the receiver.
-     *   @param request.txOptions [Optional] The transaction options.
-     * @returns A Promise that resolves to an object containing the transaction hash and optional license token ID if waitForTxn is set to true.
+     *   @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.
      * @emits LicenseTokensMinted (msg.sender, licensorIpId, licenseTemplate, licenseTermsId, amount, receiver, startLicenseTokenId);
      */
     mintLicenseTokens(request: MintLicenseTokensRequest): Promise<MintLicenseTokensResponse>;
+    /**
+     * Gets license terms of the given ID.
+     * @param selectedLicenseTermsId The ID of the license terms.
+     * @returns A Promise that resolves to an object containing the PILTerms associate with the given ID.
+     */
+    getLicenseTerms(selectedLicenseTermsId: LicenseTermsId): Promise<PiLicenseTemplateGetLicenseTermsResponse>;
     private getLicenseTermsId;
 }
 //# 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,+BAA+B,EAC/B,sBAAsB,EACtB,kBAAkB,EACnB,4BAAyB;AAC1B,OAAO,EAEL,sCAAsC,EACtC,mBAAmB,EACnB,+BAA+B,EAC/B,iCAAiC,EACjC,yBAAyB,EAEzB,wBAAwB,EACxB,yBAAyB,EAC1B,sCAAmC;AAGpC,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,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;;;;;;OAMG;IACU,+BAA+B,CAC1C,OAAO,CAAC,EAAE,sCAAsC,GAC/C,OAAO,CAAC,mBAAmB,CAAC;IAqC/B;;;;;;;;;OASG;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,mBAAmB,CAAC;IAqC/B;;;;;;;;;;OAUG;IACU,0BAA0B,CACrC,OAAO,EAAE,iCAAiC,GACzC,OAAO,CAAC,mBAAmB,CAAC;IAsC/B;;;;;;;;OAQG;IACU,kBAAkB,CAAC,OAAO,EAAE,yBAAyB;;;IAuClE;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC;YAiDvB,iBAAiB;CAIhC"}
+{"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,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,EACxB,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;IACpE,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;IAW3F;;;;;;;;;;;;;;;;;;;;;;;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;;;;;;;;OAQG;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,mBAAmB,CAAC;IAwC/B;;;;;;;;;OASG;IACU,0BAA0B,CACrC,OAAO,EAAE,iCAAiC,GACzC,OAAO,CAAC,mBAAmB,CAAC;IA0C/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;CAIhC"}

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

@@ -0,0 +1,29 @@
+import { PublicClient } from "viem";
+import { RegistrationWorkflowsClient, SimpleWalletClient } from "../abi/generated.js";
+import { CreateNFTCollectionRequest, CreateNFTCollectionResponse } from "../types/resources/nftClient.js";
+export declare class NftClient {
+    registrationWorkflowsClient: RegistrationWorkflowsClient;
+    private readonly rpcClient;
+    private readonly wallet;
+    constructor(rpcClient: PublicClient, wallet: SimpleWalletClient);
+    /**
+     * Creates a new SPG NFT Collection.
+     * @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.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>;
+}
+//# sourceMappingURL=nftClient.d.ts.map

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

@@ -0,0 +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,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"}