@story-protocol/core-sdk 1.0.0-rc.2 → 1.0.0-rc.20

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

@@ -1,20 +1,112 @@
-import { PublicClient } from "viem";
+import { PublicClient, Address } from "viem";
 import { SupportedChainIds } from "../types/config.js";
-import { RegisterDerivativeRequest, RegisterDerivativeResponse, RegisterDerivativeWithLicenseTokensRequest, RegisterDerivativeWithLicenseTokensResponse, RegisterIpResponse, RegisterRequest } from "../types/resources/ipAsset.js";
-import { IpAssetRegistryClient, LicensingModuleClient, PiLicenseTemplateClient, SimpleWalletClient } from "../abi/generated.js";
+import { CreateIpAssetWithPilTermsRequest, CreateIpAssetWithPilTermsResponse, IpAttribute, IpCreator, IpCreatorSocial, IpMedia, IpMetadata, IpRelationship, IPRobotTerms, MintAndRegisterIpAndMakeDerivativeRequest, RegisterDerivativeRequest, RegisterDerivativeResponse, RegisterDerivativeWithLicenseTokensRequest, RegisterDerivativeWithLicenseTokensResponse, RegisterIpAndAttachPilTermsRequest, RegisterIpAndAttachPilTermsResponse, RegisterIpAndMakeDerivativeRequest, RegisterIpAndMakeDerivativeResponse, RegisterIpResponse, RegisterRequest, StoryProtocolApp } from "../types/resources/ipAsset.js";
+import { AccessControllerClient, CoreMetadataModuleClient, IpAssetRegistryClient, LicenseRegistryReadOnlyClient, LicenseTokenReadOnlyClient, LicensingModuleClient, PiLicenseTemplateClient, RoyaltyPolicyLapClient, SimpleWalletClient, SpgClient } from "../abi/generated.js";
 export declare class IPAssetClient {
-    private readonly rpcClient;
-    private readonly chainId;
-    ipAssetRegistryClient: IpAssetRegistryClient;
     licensingModuleClient: LicensingModuleClient;
+    ipAssetRegistryClient: IpAssetRegistryClient;
     licenseTemplateClient: PiLicenseTemplateClient;
+    licenseRegistryReadOnlyClient: LicenseRegistryReadOnlyClient;
+    licenseTokenReadOnlyClient: LicenseTokenReadOnlyClient;
+    royaltyPolicyLAPClient: RoyaltyPolicyLapClient;
+    accessControllerClient: AccessControllerClient;
+    coreMetadataModuleClient: CoreMetadataModuleClient;
+    spgClient: SpgClient;
+    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({ name, address, description, image, socialMedia, contributionPercent, role, }: {
+        name: string;
+        address: Address;
+        contributionPercent: number;
+        description?: string;
+        image?: string;
+        socialMedia?: IpCreatorSocial[];
+        role?: string;
+    }): 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({ title, description, ipType, relationships, createdAt, watermarkImg, creators, media, attributes, app, tags, robotTerms, ...additionalProperties }: {
+        title?: string;
+        description?: string;
+        ipType?: string;
+        relationships?: IpRelationship[];
+        createdAt?: string;
+        watermarkImg?: string;
+        creators?: IpCreator[];
+        media?: IpMedia[];
+        attributes?: IpAttribute[];
+        app?: StoryProtocolApp;
+        tags?: string[];
+        robotTerms?: IPRobotTerms;
+        additionalProperties?: {
+            [key: string]: unknown;
+        };
+    }): 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.tokenId The token identifier of the NFT.
-     *  @param request.txOptions [Optional] The transaction options.
+     * @param request - The request object that contains all data needed to register IP.
+     *   @param request.nftContract The address of the NFT.
+     *   @param request.tokenId The token identifier of the NFT.
+     *   @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] 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.
      * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, resolverAddr, metadataProviderAddress, metadata)
      */
@@ -25,11 +117,11 @@ export declare class IPAssetClient {
      * The license terms must be attached to the parent IP before calling this function.
      * All IPs attached default license terms by default.
      * The derivative IP owner must be the caller or an authorized operator.
-     * @param request The request object that contains all data needed to register derivative IP.
-     *  @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 - The request object that contains all data needed to register derivative IP.
+     *   @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.
      * @returns A Promise that resolves to an object containing the transaction hash.
      */
     registerDerivative(request: RegisterDerivativeRequest): Promise<RegisterDerivativeResponse>;
@@ -38,13 +130,94 @@ export declare class IPAssetClient {
      * the derivative IP is registered with license tokens minted from the parent IP's license terms.
      * the license terms of the parent IPs issued with license tokens are attached to the derivative IP.
      * the caller must be the derivative IP owner or an authorized operator.
-     * @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 - 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.
      * @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.nftContract 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.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] The transaction options.
+     * @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.
+     * @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] The transaction options.
+     * @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] 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.
+     * @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.nftContract 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.
+     *   @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.
+     * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
+     */
+    mintAndRegisterIpAndMakeDerivative(request: MintAndRegisterIpAndMakeDerivativeRequest): Promise<RegisterDerivativeResponse>;
+    private getIpIdAddress;
+    private isRegistered;
+    private getSigSignatureState;
+    private getLicenseTermsId;
 }
 //# 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,qBAAqB,EACrB,uBAAuB,EACvB,kBAAkB,EACnB,4BAAyB;AAE1B,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;IACrC,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,uBAAuB,CAAC;gBAE1C,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAQ3F;;;;;;;;OAQG;IACU,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAuB5E;;;;;;;;;;;;OAYG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IAoBtC;;;;;;;;;;OAUG;IACU,mCAAmC,CAC9C,OAAO,EAAE,0CAA0C,GAClD,OAAO,CAAC,2CAA2C,CAAC;YAkBzC,eAAe;CAS9B"}
+{"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,EAEZ,OAAO,EASR,MAAM,MAAM,CAAC;AAGd,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAEpD,OAAO,EACL,gCAAgC,EAChC,iCAAiC,EACjC,WAAW,EACX,SAAS,EACT,eAAe,EACf,OAAO,EACP,UAAU,EACV,cAAc,EACd,YAAY,EACZ,yCAAyC,EACzC,yBAAyB,EACzB,0BAA0B,EAC1B,0CAA0C,EAC1C,2CAA2C,EAC3C,kCAAkC,EAClC,mCAAmC,EACnC,kCAAkC,EAClC,mCAAmC,EACnC,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EACjB,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,EAC7B,IAAI,EACJ,OAAO,EACP,WAAgB,EAChB,KAAU,EACV,WAAgB,EAChB,mBAAmB,EACnB,IAAS,GACV,EAAE;QACD,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,OAAO,CAAC;QACjB,mBAAmB,EAAE,MAAM,CAAC;QAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,eAAe,EAAE,CAAC;QAChC,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,GAAG,SAAS;IAYb;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACI,kBAAkB,CAAC,EACxB,KAAU,EACV,WAAgB,EAChB,MAAW,EACX,aAAkB,EAClB,SAAc,EACd,YAAiB,EACjB,QAAa,EACb,KAAU,EACV,UAAe,EACf,GAAG,EACH,IAAS,EACT,UAAU,EACV,GAAG,oBAAoB,EACxB,EAAE;QACD,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,aAAa,CAAC,EAAE,cAAc,EAAE,CAAC;QACjC,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAC;QACvB,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;QAClB,UAAU,CAAC,EAAE,WAAW,EAAE,CAAC;QAC3B,GAAG,CAAC,EAAE,gBAAgB,CAAC;QACvB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;QAChB,UAAU,CAAC,EAAE,YAAY,CAAC;QAC1B,oBAAoB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;KACnD,GAAG,UAAU;IAkBd;;;;;;;;;;;;;;OAcG;IACU,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAiF5E;;;;;;;;;;;;OAYG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IAyDtC;;;;;;;;;;OAUG;IACU,mCAAmC,CAC9C,OAAO,EAAE,0CAA0C,GAClD,OAAO,CAAC,2CAA2C,CAAC;IAsCvD;;;;;;;;;;;;;;;;;;OAkBG;IACU,kCAAkC,CAC7C,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,iCAAiC,CAAC;IA8C7C;;;;;;;;;;;;;;;;;;OAkBG;IACU,2BAA2B,CACtC,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IAmG/C;;;;;;;;;;;;;;;;;;OAkBG;IACU,oBAAoB,CAC/B,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IA0H/C;;;;;;;;;;;;;;;;OAgBG;IACU,kCAAkC,CAC7C,OAAO,EAAE,yCAAyC,GACjD,OAAO,CAAC,0BAA0B,CAAC;YAyDxB,cAAc;YAYd,YAAY;IAI1B,OAAO,CAAC,oBAAoB;YA8Bd,iBAAiB;CAYhC"}

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

@@ -1,65 +1,56 @@
 import { PublicClient } from "viem";
-import { StoryAPIClient } from "../clients/storyAPI.js";
-import { LicenseRegistryEventClient, LicensingModuleClient, SimpleWalletClient } from "../abi/generated.js";
-import { RegisterLicenseTermsRequest, RegisterLicenseTermsResponse as RegisterPILResponse, RegisterCommercialUsePILRequest, RegisterCommercialRemixPILRequest, AttachLicenseTermsRequest, MintLicenseTokensRequest, MintLicenseTokensResponse } from "../types/resources/license.js";
+import { IpAssetRegistryClient, LicenseRegistryEventClient, LicenseRegistryReadOnlyClient, LicensingModuleClient, PiLicenseTemplateClient, PiLicenseTemplateGetLicenseTermsResponse, PiLicenseTemplateReadOnlyClient, RoyaltyPolicyLapClient, SimpleWalletClient } from "../abi/generated.js";
+import { RegisterNonComSocialRemixingPILRequest, RegisterPILResponse, RegisterCommercialUsePILRequest, RegisterCommercialRemixPILRequest, AttachLicenseTermsRequest, MintLicenseTokensRequest, MintLicenseTokensResponse, AttachLicenseTermsResponse, LicenseTermsId } from "../types/resources/license.js";
 export declare class LicenseClient {
-    private readonly wallet;
-    private readonly rpcClient;
-    private readonly storyClient;
     licenseRegistryClient: LicenseRegistryEventClient;
     licensingModuleClient: LicensingModuleClient;
-    private licenseTemplateClient;
-    private royaltyPolicyLAPClient;
-    constructor(rpcClient: PublicClient, wallet: SimpleWalletClient, storyClient: StoryAPIClient);
-    private getLicenseTermsId;
+    ipAssetRegistryClient: IpAssetRegistryClient;
+    piLicenseTemplateReadOnlyClient: PiLicenseTemplateReadOnlyClient;
+    licenseTemplateClient: PiLicenseTemplateClient;
+    royaltyPolicyLAPClient: RoyaltyPolicyLapClient;
+    licenseRegistryReadOnlyClient: LicenseRegistryReadOnlyClient;
+    private readonly rpcClient;
+    private readonly wallet;
+    constructor(rpcClient: PublicClient, wallet: SimpleWalletClient);
     /**
      * Convenient function to register a PIL non commercial social remix license to the registry
-     * @param request The request object that contains all data needed to register a PIL non commercial social remix license.
-     *  @param request.txOptions [Optional] The transaction options.
-     * @returns A Promise that resolves to an object containing the optional transaction hash and optional license ID.
+     * @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.
+     * @returns A Promise that resolves to an object containing the optional transaction hash and optional license terms Id.
      * @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
      */
-    registerNonComSocialRemixingPIL(request: RegisterLicenseTermsRequest): Promise<RegisterPILResponse>;
+    registerNonComSocialRemixingPIL(request?: RegisterNonComSocialRemixingPILRequest): Promise<RegisterPILResponse>;
     /**
      * 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.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.
-     * @returns A Promise that resolves to an object containing the optional transaction hash and optional license ID.
+     * @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.currency The ERC20 token to be used to pay the minting fee and the token must be registered in story protocol.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that resolves to an object containing the optional transaction hash and optional license terms Id.
      * @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
      */
     registerCommercialUsePIL(request: RegisterCommercialUsePILRequest): Promise<RegisterPILResponse>;
     /**
      * 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.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.
-     * @returns A Promise that resolves to an object containing the optional transaction hash and optional license ID.
+     * @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.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.txOptions [Optional] The transaction options.
+     * @returns A Promise that resolves to an object containing the optional transaction hash and optional license terms Id.
      * @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
      */
     registerCommercialRemixPIL(request: RegisterCommercialRemixPILRequest): Promise<RegisterPILResponse>;
     /**
      * Attaches license terms to an IP.
-     * @param request The request object that contains all data needed to attach license terms.
-     @param request.ipId The IP ID.
-     @param request.tokenAddress The address of the NFT.
-     @param request.licenseTemplate The address of the license template.
-     @param request.licenseTermsId The ID of the license terms.
-        @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 - The request object that contains all data needed to attach license terms.
+     *   @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.
      * @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.
@@ -72,16 +63,23 @@ export declare class LicenseClient {
      * The minting fee is paid in the minting fee token specified in the license terms or configured by the IP owner.
      * IP owners can configure the minting fee of their IPs or
      * configure the minting fee module to determine the minting fee.
-     * @param request The request object that contains all data needed to mint license tokens.
-     *  @param request.licensorIpId The licensor IP ID.
-     *  @param request.licenseTemplate The address of the license template.
-     *  @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 - The request object that contains all data needed to mint license tokens.
+     *   @param request.licensorIpId The licensor IP ID.
+     *   @param request.licenseTemplate The address of the license template.
+     *   @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 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,EAAE,cAAc,EAAE,+BAA4B;AACrD,OAAO,EACL,0BAA0B,EAC1B,qBAAqB,EAGrB,kBAAkB,EACnB,4BAAyB;AAC1B,OAAO,EAEL,2BAA2B,EAC3B,4BAA4B,IAAI,mBAAmB,EACnD,+BAA+B,EAC/B,iCAAiC,EACjC,yBAAyB,EAEzB,wBAAwB,EACxB,yBAAyB,EAC1B,sCAAmC;AAGpC,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAiB;IACtC,qBAAqB,EAAE,0BAA0B,CAAC;IAClD,qBAAqB,EAAE,qBAAqB,CAAC;IACpD,OAAO,CAAC,qBAAqB,CAA0B;IACvD,OAAO,CAAC,sBAAsB,CAAyB;gBAE3C,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,WAAW,EAAE,cAAc;YAU9E,iBAAiB;IAK/B;;;;;;OAMG;IACU,+BAA+B,CAC1C,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,mBAAmB,CAAC;IAsC/B;;;;;;;;;;OAUG;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,mBAAmB,CAAC;IAsC/B;;;;;;;;;;OAUG;IACU,0BAA0B,CACrC,OAAO,EAAE,iCAAiC,GACzC,OAAO,CAAC,mBAAmB,CAAC;IAsC/B;;;;;;;;;;;;OAYG;IACU,kBAAkB,CAAC,OAAO,EAAE,yBAAyB;;;IAclE;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC;CAyBtC"}
+{"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,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,EACf,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,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;;;;;;OAMG;IACU,+BAA+B,CAC1C,OAAO,CAAC,EAAE,sCAAsC,GAC/C,OAAO,CAAC,mBAAmB,CAAC;IA8B/B;;;;;;;;OAQG;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,mBAAmB,CAAC;IAkC/B;;;;;;;;;OASG;IACU,0BAA0B,CACrC,OAAO,EAAE,iCAAiC,GACzC,OAAO,CAAC,mBAAmB,CAAC;IAoC/B;;;;;;;;OAQG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IAgDtC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC;IA8DrC;;;;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,24 @@
+import { PublicClient } from "viem";
+import { SimpleWalletClient, SpgClient } from "../abi/generated.js";
+import { CreateNFTCollectionRequest, CreateNFTCollectionResponse } from "../types/resources/nftClient.js";
+export declare class NftClient {
+    spgClient: SpgClient;
+    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.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 options.
+     * @returns A Promise that resolves to a CreateNFTCollectionResponse containing the transaction hash and collection address.
+     * @emits CollectionCreated (nftContract);
+     */
+    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,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;CAsCxC"}

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

@@ -1,11 +1,16 @@
 import { PublicClient } from "viem";
-import { SetPermissionsRequest, SetPermissionsResponse } from "../types/resources/permission.js";
-import { SimpleWalletClient } from "../abi/generated.js";
+import { CreateBatchPermissionSignatureRequest, CreateSetPermissionSignatureRequest, SetAllPermissionsRequest, SetBatchPermissionsRequest, SetPermissionsRequest, SetPermissionsResponse } from "../types/resources/permission.js";
+import { AccessControllerClient, CoreMetadataModuleClient, IpAssetRegistryClient, SimpleWalletClient, SpgClient } 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;
-    private accessControllerClient;
-    constructor(rpcClient: PublicClient, wallet: SimpleWalletClient);
+    private readonly chainId;
+    constructor(rpcClient: PublicClient, wallet: SimpleWalletClient, chainId: SupportedChainIds);
     /**
      * Sets the permission for a specific function call
      * Each policy is represented as a mapping from an IP account address to a signer address to a recipient
@@ -16,15 +21,72 @@ export declare class PermissionClient {
      * address(0) => wildcard
      * bytes4(0) => wildcard
      * Specific permission overrides wildcard permission.
-     * @param request The request object containing necessary data to set permissions.
-     *   @param request.ipAsset The address of the IP account that grants the permission for `signer`
+     * @param request - The request object containing necessary data to set `permission`.
+     *   @param request.ipId The IP ID that grants the permission for `signer`.
+     *   @param request.signer The address that can call `to` on behalf of the `ipAccount`.
+     *   @param request.to The address that can be called by the `signer` (currently only modules can be `to`).
+     *   @param request.permission The new permission level.
+     *   @param request.func [Optional] The function selector string of `to` that can be called by the `signer` on behalf of the `ipAccount`. Be default, it allows all functions.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that resolves to an object containing the transaction hash.
+     * @emits PermissionSet (ipAccountOwner, ipAccount, signer, to, func, permission)
+     */
+    setPermission(request: SetPermissionsRequest): Promise<SetPermissionsResponse>;
+    /**
+     * Specific permission overrides wildcard permission with signature.
+     * @param request - The request object containing necessary data to set permissions.
+     *   @param request.ipId The IP ID that grants the permission for `signer`
      *   @param request.signer The address that can call `to` on behalf of the `ipAccount`
      *   @param request.to The address that can be called by the `signer` (currently only modules can be `to`)
-     *   @param request.func Optional. The function selector string of `to` that can be called by the `signer` on behalf of the `ipAccount`. Be default, it allows all functions.
-     *   @param request.permission The new permission level
+     *   @param request.permission The new permission level.
+     *   @param request.func [Optional] The function selector string of `to` that can be called by the `signer` on behalf of the `ipAccount`. Be default, it allows all functions.
+     *   @param request.deadline [Optional] The deadline for the signature in milliseconds, default is 1000ms.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that resolves to an object containing the transaction hash.
+     * @emits PermissionSet (ipAccountOwner, ipAccount, signer, to, func, permission)
+     */
+    createSetPermissionSignature(request: CreateSetPermissionSignatureRequest): Promise<SetPermissionsResponse>;
+    /**
+     * Sets permission to a signer for all functions across all modules.
+     * @param request - The request object containing necessary data to set all permissions.
+     *   @param request.ipId The IP ID that grants the permission for `signer`
+     *   @param request.signer The address of the signer receiving the permissions.
+     *   @param request.permission The new permission.
+     *   @param request.txOptions [Optional] The transaction options.
      * @returns A Promise that resolves to an object containing the transaction hash
      * @emits PermissionSet (ipAccountOwner, ipAccount, signer, to, func, permission)
      */
-    setPermission(request: SetPermissionsRequest): Promise<SetPermissionsResponse>;
+    setAllPermissions(request: SetAllPermissionsRequest): Promise<SetPermissionsResponse>;
+    /**
+     * Sets a batch of permissions in a single transaction.
+     * @param request - The request object containing necessary data to set all permissions.
+     * @param {Array} request.permissions - An array of `Permission` structure, each representing the permission to be set.
+     *   @param request.permissions[].ipId The IP ID that grants the permission for `signer`.
+     *   @param request.permissions[].signer The address that can call `to` on behalf of the `ipAccount`.
+     *   @param request.permissions[].to The address that can be called by the `signer` (currently only modules can be `to`).
+     *   @param request.permissions[].permission The new permission level.
+     *   @param request.permissions[].func [Optional] The function selector string of `to` that can be called by the `signer` on behalf of the `ipAccount`. Be default, it allows all functions.
+     *   @param request.deadline [Optional] The deadline for the signature in milliseconds, default is 1000ms.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that resolves to an object containing the transaction hash
+     * @emits PermissionSet (ipAccountOwner, ipAccount, signer, to, func, permission)
+     */
+    setBatchPermissions(request: SetBatchPermissionsRequest): Promise<SetPermissionsResponse>;
+    /**
+     * Sets a batch of permissions in a single transaction with signature.
+     * @param request - The request object containing necessary data to set permissions.
+     *   @param request.ipId The IP ID that grants the permission for `signer`
+     *   @param {Array} request.permissions - An array of `Permission` structure, each representing the permission to be set.
+     *   @param request.permissions[].ipId The IP ID that grants the permission for `signer`.
+     *   @param request.permissions[].signer The address that can call `to` on behalf of the `ipAccount`.
+     *   @param request.permissions[].to The address that can be called by the `signer` (currently only modules can be `to`).
+     *   @param request.permissions[].permission The new permission level.
+     *   @param request.permissions[].func [Optional] The function selector string of `to` that can be called by the `signer` on behalf of the `ipAccount`. Be default, it allows all functions.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that resolves to an object containing the transaction hash.
+     * @emits PermissionSet (ipAccountOwner, ipAccount, signer, to, func, permission)
+     */
+    createBatchPermissionSignature(request: CreateBatchPermissionSignatureRequest): Promise<SetPermissionsResponse>;
+    private checkIsRegistered;
 }
 //# sourceMappingURL=permission.d.ts.map

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,EAAuC,MAAM,MAAM,CAAC;AAGzE,OAAO,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,yCAAsC;AAE9F,OAAO,EAIL,kBAAkB,EACnB,4BAAyB;AAE1B,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,sBAAsB,CAAyB;gBAE3C,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAM/D;;;;;;;;;;;;;;;;;;OAkBG;IACU,aAAa,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;CAkC5F"}
+{"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;IA2B3F;;;;;;;;;;;;OAYG;IACU,4BAA4B,CACvC,OAAO,EAAE,mCAAmC,GAC3C,OAAO,CAAC,sBAAsB,CAAC;IA2DlC;;;;;;;;;OASG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,sBAAsB,CAAC;IAuBlC;;;;;;;;;;;;;OAaG;IACU,mBAAmB,CAC9B,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,sBAAsB,CAAC;IA8BlC;;;;;;;;;;;;;OAaG;IACU,8BAA8B,CACzC,OAAO,EAAE,qCAAqC,GAC7C,OAAO,CAAC,sBAAsB,CAAC;YAuDpB,iBAAiB;CAQhC"}

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

@@ -1,23 +1,25 @@
-import { PublicClient } from "viem";
-import { CollectRoyaltyTokensRequest, CollectRoyaltyTokensResponse, PayRoyaltyOnBehalfRequest, PayRoyaltyOnBehalfResponse } from "../types/resources/royalty.js";
-import { IpRoyaltyVaultImplClient, RoyaltyModuleClient, RoyaltyPolicyLapClient, SimpleWalletClient } from "../abi/generated.js";
+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 { IPAccountClient } from "./ipAccount.js";
 export declare class RoyaltyClient {
-    private readonly wallet;
-    private readonly rpcClient;
-    royaltyVaultImplClient: IpRoyaltyVaultImplClient;
-    royaltyPolicyLAPClient: RoyaltyPolicyLapClient;
+    royaltyPolicyLapClient: RoyaltyPolicyLapClient;
     royaltyModuleClient: RoyaltyModuleClient;
+    ipAssetRegistryClient: IpAssetRegistryClient;
+    ipAccountClient: IPAccountClient;
+    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 licensing parameters for the Programmable IP License v1 (PIL) standard.
-     *   @param request.ancestorIpId The ip id of the ancestor to whom the royalty tokens belong to.
+     * @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] The transaction options.
-     * @returns Tx hash for the transaction.
-     * @emits RoyaltyTokensCollected (ancestorIpId, ancestorsRoyalty)
+     * @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>;
-    private getProxyAddress;
     /**
      * 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.
@@ -27,8 +29,45 @@ export declare class RoyaltyClient {
      *   @param request.amount The amount to pay.
      *   @param request.txOptions [Optional] The transaction options.
      * @returns A Promise that resolves to an object containing the transaction hash.
-     * @emits RoyaltyPaid (receiverIpId, payerIpId, msg.sender, token, amount)
      */
     payRoyaltyOnBehalf(request: PayRoyaltyOnBehalfRequest): Promise<PayRoyaltyOnBehalfResponse>;
+    /**
+     * Calculates the amount of revenue token claimable by a token holder at certain snapshot.
+     * @param request - The request object that contains all data needed to claim Revenue.
+     *   @param request.royaltyVaultIpId The id of the royalty vault.
+     *   @param request.account The address of the token holder.
+     *   @param request.snapshotId The snapshot id.
+     *   @param request.token The revenue token to claim.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that contains the amount of revenue token claimable
+     */
+    claimableRevenue(request: ClaimableRevenueRequest): Promise<ClaimableRevenueResponse>;
+    /**
+     * Allows token holders to claim by a list of snapshot ids based on the token balance at certain snapshot
+     * @param request - The request object that contains all data needed to claim revenue.
+     *   @param request.snapshotIds The list of snapshot ids.
+     *   @param request.royaltyVaultIpId The id of the royalty vault.
+     *   @param request.token The revenue token to claim.
+     *   @param request.account [Optional] The ipId to send.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that resolves to an object containing the transaction hash and optional claimableToken if waitForTxn is set to true.
+     * @emits RevenueTokenClaimed (claimer, token, amount).
+     */
+    claimRevenue(request: ClaimRevenueRequest): Promise<ClaimRevenueResponse>;
+    /**
+     * Snapshots the claimable revenue and royalty token amounts.
+     * @param request - The request object that contains all data needed to snapshot.
+     *   @param request.royaltyVaultIpId The id of the royalty vault.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that resolves to an object containing the transaction hash and optional snapshotId if waitForTxn is set to true.
+     * @emits SnapshotCompleted (snapshotId, snapshotTimestamp, unclaimedTokens).
+     */
+    snapshot(request: SnapshotRequest): Promise<SnapshotResponse>;
+    /**
+     * Get the royalty vault proxy address of given royaltyVaultIpId.
+     * @param royaltyVaultIpId the id of the royalty vault.
+     * @returns A Promise that resolves to an object containing the royalty vault address.
+     */
+    getRoyaltyVaultAddress(royaltyVaultIpId: Hex): Promise<Address>;
 }
 //# sourceMappingURL=royalty.d.ts.map