npm - @story-protocol/core-sdk - Versions diffs - 1.3.0-rc.3 → 1.3.0 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (53) hide show

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

@@ -28,34 +28,14 @@ export declare class IPAssetClient {
     generateIpMetadata(metadata: IpMetadata): 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.nftContract The address of the NFT.
-     *   @param request.tokenId The token identifier of the NFT.
-     *   @param {Object} 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 seconds, default is 1000s.
-     *   @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)
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | `IPRegistered`} event.
      */
     register(request: RegisterRequest): Promise<RegisterIpResponse>;
     /**
      * Batch registers an NFT as IP, creating a corresponding IP record.
-     * @param request - The request object that contains all data needed to batch register IP.
-     *  @param {Array} request.args The array of objects containing the data needed to register IP.
-     *   @param request.args.nftContract The address of the NFT.
-     *   @param request.args.tokenId The token identifier of the NFT.
-     *   @param {Object} request.args.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
-     *    @param request.args.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
-     *    @param request.args.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
-     *    @param request.args.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
-     *    @param request.args.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, without encodedTxDataOnly option.
-     * @returns A Promise that resolves to a transaction hash, if waitForTransaction is true, return an array of containing IP ID, Token ID, NFT Contract.
-     * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, resolverAddr, metadataProviderAddress, metadata)
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | `IPRegistered`} event.
      */
     batchRegister(request: BatchRegisterRequest): Promise<BatchRegisterResponse>;
     /**
@@ -68,208 +48,100 @@ export declare class IPAssetClient {
     registerDerivative(request: RegisterDerivativeRequest): Promise<RegisterDerivativeResponse>;
     /**
      * Batch registers a derivative directly with parent IP's license terms.
-     * @param request - The request object that contains all data needed to batch register derivative IP.
-     *  @param {Array} request.args The array of objects containing the data needed to register derivative IP.
-     *    @param request.args.childIpId The derivative IP ID.
-     *    @param {Array} request.args.parentIpIds The parent IP IDs.
-     *    @param {Array} request.args.licenseTermsIds The IDs of the license terms that the parent IP supports.
-     *    @param request.args.maxMintingFee The maximum minting fee that the caller is willing to pay. if set to 0 then no limit.
-     *    @param request.args.maxRts The maximum number of royalty tokens that can be distributed to the external royalty policies (max: 100,000,000).
-     *    @param request.args.maxRevenueShare The maximum revenue share percentage allowed for minting the License Tokens. Must be between 0 and 100,000,000 (where 100,000,000 represents 100%).
-     *  @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
-     *  @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property, without encodedTxDataOnly option.
-     * @returns A Promise that resolves to a transaction hash.
      */
     batchRegisterDerivative(request: BatchRegisterDerivativeRequest): Promise<BatchRegisterDerivativeResponse>;
     /**
      * Registers a derivative with license tokens. 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 {Array} request.licenseTokenIds The IDs of the license tokens.
-     *    @param request.args.maxRts The maximum number of royalty tokens that can be distributed to the external royalty policies (max: 100,000,000).
-     *   @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>;
     /**
      * Mint an NFT from a collection and register it as an IP.
-     * it emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate).
-     * @see {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | IIPAssetRegistry}
-     * @see {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/licensing/ILicensingModule.sol#L19 | ILicensingModule}
-     * for a list of on-chain events emitted when an IP is minted and registered, and license terms are attached to an IP.
+     *
+     * Emits on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | `IPRegistered`} and {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/licensing/ILicensingModule.sol#L19 | `LicenseTermsAttached`} events.
      */
     mintAndRegisterIpAssetWithPilTerms(request: MintAndRegisterIpAssetWithPilTermsRequest): Promise<MintAndRegisterIpAssetWithPilTermsResponse>;
     /**
      * Batch mint an NFT from a collection and register it as an IP.
-     * @param request - The request object that contains all data needed to batch mint and register ip.
-     *   @param {Array} request.args The array of mint and register IP requests.
-     *     @param request.args.spgNftContract The address of the NFT collection.
-     *     @param request.allowDuplicates Indicates whether the license terms can be attached to the same IP ID or not.
-     *     @param {Array} request.args.licenseTermsData The PIL terms and licensing configuration data to be attached to the IP.
-     *       @param {Object} request.args.licenseTermsData.terms The PIL terms to be used for the licensing.
-     *         @param request.args.licenseTermsData.terms.transferable Indicates whether the license is transferable or not.
-     *         @param request.args.licenseTermsData.terms.royaltyPolicy The address of the royalty policy contract which required to StoryProtocol in advance.
-     *         @param request.args.licenseTermsData.terms.mintingFee The fee to be paid when minting a license.
-     *         @param request.args.licenseTermsData.terms.expiration The expiration period of the license.
-     *         @param request.args.licenseTermsData.terms.commercialUse Indicates whether the work can be used commercially or not, Commercial use is required to deploy a royalty vault.
-     *         @param request.args.licenseTermsData.terms.commercialAttribution Whether attribution is required when reproducing the work commercially or not.
-     *         @param request.args.licenseTermsData.terms.commercializerChecker Commercializers that are allowed to commercially exploit the work. If zero address, then no restrictions is enforced.
-     *         @param request.args.licenseTermsData.terms.commercializerCheckerData The data to be passed to the commercializer checker contract.
-     *         @param request.args.licenseTermsData.terms.commercialRevShare Percentage of revenue that must be shared with the licensor.
-     *         @param request.args.licenseTermsData.terms.commercialRevCeiling The maximum revenue that can be generated from the commercial use of the work.
-     *         @param request.args.licenseTermsData.terms.derivativesAllowed Indicates whether the licensee can create derivatives of his work or not.
-     *         @param request.args.licenseTermsData.terms.derivativesAttribution Indicates whether attribution is required for derivatives of the work or not.
-     *         @param request.args.licenseTermsData.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.args.licenseTermsData.terms.derivativesReciprocal Indicates whether the licensee must license derivatives of the work under the same terms or not.
-     *         @param request.args.licenseTermsData.terms.derivativeRevCeiling The maximum revenue that can be generated from the derivative use of the work.
-     *         @param request.args.licenseTermsData.terms.currency The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
-     *         @param request.args.licenseTermsData.terms.uri The URI of the license terms, which can be used to fetch the offchain license terms.
-     *       @param {Object} request.args.licenseTermsData.licensingConfig The PIL terms and licensing configuration data to attach to the IP.
-     *         @param request.args.licenseTermsData.licensingConfig.isSet Whether the configuration is set or not.
-     *         @param request.args.licenseTermsData.licensingConfig.mintingFee The minting fee to be paid when minting license tokens.
-     *         @param request.args.licenseTermsData.licensingConfig.licensingHook The hook contract address for the licensing module, or zero address if none
-     *         @param request.args.licenseTermsData.licensingConfig.hookData The data to be used by the licensing hook.
-     *         @param request.args.licenseTermsData.licensingConfig.commercialRevShare The commercial revenue share percentage.
-     *         @param request.args.licenseTermsData.licensingConfig.disabled Whether the licensing is disabled or not.
-     *         @param request.args.licenseTermsData.licensingConfig.expectMinimumGroupRewardShare The minimum percentage of the group's reward share (from 0 to 100%, represented as 100 * 10 ** 6) that can be allocated to the IP when it is added to the group.
-     *         If the remaining reward share in the group is less than the minimumGroupRewardShare,the IP cannot be added to the group.
-     *         @param request.args.licenseTermsData.licensingConfig.expectGroupRewardPool The address of the expected group reward pool. The IP can only be added to a group with this specified reward pool address, or zero address if the IP does not want to be added to any group.
-     *     @param {Object} request.args.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
-     *       @param request.args.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
-     *       @param request.args.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
-     *       @param request.args.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
-     *       @param request.args.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
-     *     @param request.args.recipient [Optional] The address of the recipient of the minted NFT,default value is your wallet address.
-     *    @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property, without encodedTxData option.
-     * @returns A Promise that resolves to a transaction hash, if waitForTransaction is true, return an array containing IP ID, Token ID, License Terms Ids, SPG NFT Contract.
-     * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
-     * @emits LicenseTermsAttached (caller, ipId, licenseTemplate, licenseTermsId)
+     *
+     * Emits on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | `IPRegistered`} and {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/licensing/ILicensingModule.sol#L19 | `LicenseTermsAttached`} events.
      */
     batchMintAndRegisterIpAssetWithPilTerms(request: BatchMintAndRegisterIpAssetWithPilTermsRequest): Promise<BatchMintAndRegisterIpAssetWithPilTermsResponse>;
     /**
      * Register a given NFT as an IP and attach Programmable IP License Terms.
-     * @see {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/licensing/ILicensingModule.sol#L19 | ILicensingModule}
-     * for a list of on-chain events emitted when an ip is registered and license terms are attached to it.
+     *
+     * Emits on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | `IPRegistered`} and {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/licensing/ILicensingModule.sol#L19 | `LicenseTermsAttached`} events.
      */
     registerIpAndAttachPilTerms(request: RegisterIpAndAttachPilTermsRequest): Promise<RegisterIpAndAttachPilTermsResponse>;
     /**
      * Register the given NFT as a derivative IP with metadata without using license tokens.
-     * @see {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | IIPAssetRegistry}
-     * for a list of on-chain events emitted when a derivative IP is registered.
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | `IPRegistered`} event.
      */
     registerDerivativeIp(request: RegisterIpAndMakeDerivativeRequest): Promise<RegisterIpAndMakeDerivativeResponse>;
     /**
      * Mint an NFT from a collection and register it as a derivative IP without license tokens.
-     * @see {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | IIPAssetRegistry}
-     * for a list of on-chain events emitted when a derivative IP is minted and registered.
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | `IPRegistered`} event.
      */
     mintAndRegisterIpAndMakeDerivative(request: MintAndRegisterIpAndMakeDerivativeRequest): Promise<MintAndRegisterIpAndMakeDerivativeResponse>;
     /**
      * Batch 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 batch mint and register ip and make derivative.
-     *  @param {Array} request.args The array of mint and register IP requests.
-     *   @param request.args.spgNftContract The address of the NFT collection.
-     *   @param {Object} request.args.derivData The derivative data to be used for registerDerivative.
-     *     @param {Array} request.args.derivData.parentIpIds The IDs of the parent IPs to link the registered derivative IP.
-     *     @param {Array} request.args.derivData.licenseTermsIds The IDs of the license terms to be used for the linking.
-     *     @param request.args.derivData.licenseTemplate [Optional] The address of the license template to be used for the linking.
-     *   @param {Object} request.args.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
-     *     @param request.args.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
-     *     @param request.args.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
-     *     @param request.args.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
-     *     @param request.args.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
-     *   @param request.arg.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, without encodedTxData option.
-     * @returns A Promise that resolves to a transaction hash, if waitForTransaction is true, return an array of containing IP ID and token ID, SPG NFT Contract.
-     * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | `IPRegistered`} event.
      */
     batchMintAndRegisterIpAndMakeDerivative(request: BatchMintAndRegisterIpAndMakeDerivativeRequest): Promise<BatchMintAndRegisterIpAndMakeDerivativeResponse>;
     /**
      * 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.allowDuplicates Set to true to allow minting an NFT with a duplicate metadata hash.
-     *   @param {Object} 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)
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | `IPRegistered`} event.
      */
     mintAndRegisterIp(request: MintAndRegisterIpRequest): Promise<RegisterIpResponse>;
     /**
      * Register Programmable IP License Terms (if unregistered) and attach it to IP.
-     * @see {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/licensing/ILicensingModule.sol#L19 | ILicensingModule}
-     * for a list of on-chain events emitted when a license terms is attached to an IP.
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/licensing/ILicensingModule.sol#L19 | `LicenseTermsAttached`} event.
      */
     registerPilTermsAndAttach(request: RegisterPilTermsAndAttachRequest): Promise<RegisterPilTermsAndAttachResponse>;
     /**
-     *  Mint an NFT from a collection and register it as a derivative IP using license tokens
+     * Mint an NFT from a collection and register it as a derivative IP using license tokens.
      * Requires caller to have the minter role or the SPG NFT to allow public minting. Caller must own the license tokens and have approved DerivativeWorkflows to transfer them.
-     * @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 {Array} request.licenseTokenIds The IDs of the license tokens to be burned for linking the IP to parent IPs.
-     *   @param request.allowDuplicates Set to true to allow minting an NFT with a duplicate metadata hash.
-     *   @param request.maxRts The maximum number of royalty tokens that can be distributed to the external royalty policies (max: 100,000,000).
-     *   @param {Object} 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)
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | `IPRegistered`} event.
      */
     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 {Array} 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 {Object} 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 seconds, default is 1000s.
-     *   @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, Token ID.
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | `IPRegistered`} event.
      */
     registerIpAndMakeDerivativeWithLicenseTokens(request: RegisterIpAndMakeDerivativeWithLicenseTokensRequest): Promise<RegisterIpResponse>;
     /**
-     * Register the given NFT and attach license terms and distribute royalty tokens. In order to successfully distribute royalty tokens, the first license terms attached to the IP must be
-     * a commercial license.
-     * @see {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | IIPAssetRegistry}
-     * @see {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/royalty/IRoyaltyModule.sol#L88 | IRoyaltyModule}
-     * for a list of on-chain events emitted when an IP is registered, license terms are attached to an IP, and royalty tokens are distributed.
+     * Register the given NFT and attach license terms and distribute royalty
+     * tokens. In order to successfully distribute royalty tokens, the first
+     * license terms attached to the IP must be a commercial license.
+     *
+     * Emits on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | `IPRegistered`} and {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/royalty/IRoyaltyModule.sol#L88 | `IpRoyaltyVaultDeployed`} events.
      */
     registerIPAndAttachLicenseTermsAndDistributeRoyaltyTokens(request: RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest): Promise<RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse>;
     /**
      * Register the given NFT as a derivative IP and attach license terms and distribute royalty tokens.  In order to successfully distribute royalty tokens, the license terms attached to the IP must be
      * a commercial license.
-     * @see {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | IIPAssetRegistry}
-     * @see {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/royalty/IRoyaltyModule.sol#L88| IRoyaltyModule}
-     * for a list of on-chain events emitted when a derivative IP is registered, license terms are attached to an IP, and royalty tokens are distributed.
+     *
+     * Emits on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | `IPRegistered`} and {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/royalty/IRoyaltyModule.sol#L88| `IpRoyaltyVaultDeployed`} events.
      */
     registerDerivativeIpAndAttachLicenseTermsAndDistributeRoyaltyTokens(request: RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest): Promise<RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse>;
     /**
      * Mint an NFT and register the IP, attach PIL terms, and distribute royalty tokens.
-     * @see {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | IIPAssetRegistry}
-     * @see {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/royalty/IRoyaltyModule.sol#L88| IRoyaltyModule}
-     * for a list of on-chain events emitted when an IP is minted and registered, PIL terms are attached to an IP, and royalty tokens are distributed.
+     *
+     * Emits on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | `IPRegistered`} and {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/royalty/IRoyaltyModule.sol#L88| `IpRoyaltyVaultDeployed`} events.
      */
     mintAndRegisterIpAndAttachPilTermsAndDistributeRoyaltyTokens(request: MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensRequest): Promise<MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensResponse>;
     /**
      * Mint an NFT and register the IP, make a derivative, and distribute royalty tokens.
-     * @see {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | IIPAssetRegistry}
-     * for a list of on-chain events emitted when an IP is minted and registered, a derivative IP is made, and royalty tokens are distributed.
+     *
+     * Emits on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | `IPRegistered`} event.
      */
     mintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokens(request: MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensRequest): Promise<MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensResponse>;
     private getRoyaltyShares;

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

	@@ -1 +1 @@
1	- {"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,GAAG,EACH,YAAY,EAQb,MAAM,MAAM,CAAC;AAId,OAAO,EACL,8CAA8C,EAC9C,+CAA+C,EAC/C,8CAA8C,EAC9C,+CAA+C,EAC/C,8BAA8B,EAC9B,+BAA+B,EAC/B,oBAAoB,EACpB,qBAAqB,EACrB,yCAAyC,EACzC,0CAA0C,EAC1C,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,EACf,0CAA0C,EAC1C,gEAAgE,EAGhE,iEAAiE,EAGjE,wEAAwE,EACxE,yEAAyE,EACzE,mEAAmE,EACnE,mEAAmE,EACnE,oEAAoE,EACpE,oEAAoE,EAOrE,sCAAmC;AACpC,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,yBAAyB,EAMzB,qBAAqB,EAErB,gCAAgC,EAIhC,6BAA6B,EAC7B,0BAA0B,EAC1B,qBAAqB,EACrB,gBAAgB,EAChB,uBAAuB,EACvB,2BAA2B,EAG3B,wBAAwB,EACxB,uCAAuC,EAIvC,kBAAkB,EAClB,wBAAwB,EACxB,eAAe,EAKhB,4BAAyB;AAgB1B,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAC3C,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,yCAAsC;AAEtE,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;IACrD,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,uCAAuC,EAAE,uCAAuC,CAAC;IACjF,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,SAAS,EAAE,eAAe,CAAC;IAC3B,YAAY,EAAE,wBAAwB,CAAC;IAE9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;IACnC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAU;gBAE5B,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAyB3E,uBAAuB,CAAC,OAAO,EAAE,SAAS,GAAG,SAAS;IAItD,kBAAkB,CAAC,QAAQ,EAAE,UAAU,GAAG,UAAU;IAI3D~~;;;;;;;;;;;;;;OAcG~~;IACU,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC;~~IAoF5E;;;;;;;;;;;;;;OAcG~~;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAkEzF;;;;;;OAMG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IAoCtC~~;;;;;;;;;;;;;OAaG~~;IACU,uBAAuB,CAClC,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC;~~IAkF3C;;;;;;;;;;OAUG~~;IACU,mCAAmC,CAC9C,OAAO,EAAE,0CAA0C,GAClD,OAAO,CAAC,2CAA2C,CAAC;IAsCvD~~;;;;;;OAMG~~;IACU,kCAAkC,CAC7C,OAAO,EAAE,yCAAyC,GACjD,OAAO,CAAC,0CAA0C,CAAC;~~IA2CtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG~~;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IAkD3D;;;;OAIG;IACU,2BAA2B,CACtC,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;~~IAwF~~/C;;;;OAIG;IACU,oBAAoB,CAC/B,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IAoE/C;;;;OAIG;IACU,kCAAkC,CAC7C,OAAO,EAAE,yCAAyC,GACjD,OAAO,CAAC,0CAA0C,CAAC;~~IAqCtD;;;;;;;;;;;;;;;;;;OAkBG~~;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IAkC3D~~;;;;;;;;;;;;;;OAcG~~;IACU,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,kBAAkB,CAAC;~~IAgC9F~~;;;;OAIG;IACU,yBAAyB,CACpC,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,iCAAiC,CAAC;~~IA2E7C;;;;;;;;;;;;;;;;;OAiBG~~;IACU,mDAAmD,CAC9D,OAAO,EAAE,0DAA0D,GAClE,OAAO,CAAC,kBAAkB,CAAC;~~IA+C9B;;;;;;;;;;;;;;OAcG~~;IACU,4CAA4C,CACvD,OAAO,EAAE,mDAAmD,GAC3D,OAAO,CAAC,kBAAkB,CAAC;IAwE9B;;;;;;OAMG;IACU,yDAAyD,CACpE,OAAO,EAAE,gEAAgE,GACxE,OAAO,CAAC,iEAAiE,CAAC;~~IAkG7E;;;;;;OAMG~~;IACU,mEAAmE,CAC9E,OAAO,EAAE,wEAAwE,GAChF,OAAO,CAAC,yEAAyE,CAAC;~~IAyGrF;;;;;OAKG~~;IACU,4DAA4D,CACvE,OAAO,EAAE,mEAAmE,GAC3E,OAAO,CAAC,oEAAoE,CAAC;~~IAuDhF~~;;;;OAIG;IACU,4DAA4D,CACvE,OAAO,EAAE,mEAAmE,GAC3E,OAAO,CAAC,oEAAoE,CAAC;~~IA2ChF~~,OAAO,CAAC,gBAAgB;YAqBV,uBAAuB;~~YA8CvB~~,cAAc;IAYf,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;YAIxC,iBAAiB;YAWjB,uBAAuB;IAkBrC,OAAO,CAAC,2BAA2B;YAgBrB,qBAAqB;IAKnC,OAAO,CAAC,cAAc;YASR,sBAAsB;~~YAmEtB~~,wBAAwB;~~YAyBxB~~,0BAA0B;~~CAgFzC~~"}
1	+ {"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,GAAG,EACH,YAAY,EAQb,MAAM,MAAM,CAAC;AAId,OAAO,EACL,8CAA8C,EAC9C,+CAA+C,EAC/C,8CAA8C,EAC9C,+CAA+C,EAC/C,8BAA8B,EAC9B,+BAA+B,EAC/B,oBAAoB,EACpB,qBAAqB,EACrB,yCAAyC,EACzC,0CAA0C,EAC1C,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,EACf,0CAA0C,EAC1C,gEAAgE,EAGhE,iEAAiE,EAGjE,wEAAwE,EACxE,yEAAyE,EACzE,mEAAmE,EACnE,mEAAmE,EACnE,oEAAoE,EACpE,oEAAoE,EAOrE,sCAAmC;AACpC,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,yBAAyB,EAMzB,qBAAqB,EAErB,gCAAgC,EAIhC,6BAA6B,EAC7B,0BAA0B,EAC1B,qBAAqB,EACrB,gBAAgB,EAChB,uBAAuB,EACvB,2BAA2B,EAG3B,wBAAwB,EACxB,uCAAuC,EAIvC,kBAAkB,EAClB,wBAAwB,EACxB,eAAe,EAKhB,4BAAyB;AAgB1B,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAC3C,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,yCAAsC;AAEtE,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;IACrD,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,uCAAuC,EAAE,uCAAuC,CAAC;IACjF,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,SAAS,EAAE,eAAe,CAAC;IAC3B,YAAY,EAAE,wBAAwB,CAAC;IAE9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;IACnC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAU;gBAE5B,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAyB3E,uBAAuB,CAAC,OAAO,EAAE,SAAS,GAAG,SAAS;IAItD,kBAAkB,CAAC,QAAQ,EAAE,UAAU,GAAG,UAAU;IAI3D;;;;OAIG;IACU,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAiF5E;;;;OAIG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAkEzF;;;;;;OAMG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IAoCtC;;OAEG;IACU,uBAAuB,CAClC,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC;IA+E3C;;;;OAIG;IACU,mCAAmC,CAC9C,OAAO,EAAE,0CAA0C,GAClD,OAAO,CAAC,2CAA2C,CAAC;IAsCvD;;;;OAIG;IACU,kCAAkC,CAC7C,OAAO,EAAE,yCAAyC,GACjD,OAAO,CAAC,0CAA0C,CAAC;IAyCtD;;;;OAIG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IAkD3D;;;;OAIG;IACU,2BAA2B,CACtC,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IAkF/C;;;;OAIG;IACU,oBAAoB,CAC/B,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IAoE/C;;;;OAIG;IACU,kCAAkC,CAC7C,OAAO,EAAE,yCAAyC,GACjD,OAAO,CAAC,0CAA0C,CAAC;IAmCtD;;;;OAIG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IAkC3D;;;;OAIG;IACU,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA8B9F;;;;OAIG;IACU,yBAAyB,CACpC,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,iCAAiC,CAAC;IAqE7C;;;;;OAKG;IACU,mDAAmD,CAC9D,OAAO,EAAE,0DAA0D,GAClE,OAAO,CAAC,kBAAkB,CAAC;IA6C9B;;;;OAIG;IACU,4CAA4C,CACvD,OAAO,EAAE,mDAAmD,GAC3D,OAAO,CAAC,kBAAkB,CAAC;IAwE9B;;;;;;OAMG;IACU,yDAAyD,CACpE,OAAO,EAAE,gEAAgE,GACxE,OAAO,CAAC,iEAAiE,CAAC;IA+F7E;;;;;OAKG;IACU,mEAAmE,CAC9E,OAAO,EAAE,wEAAwE,GAChF,OAAO,CAAC,yEAAyE,CAAC;IAsGrF;;;;OAIG;IACU,4DAA4D,CACvE,OAAO,EAAE,mEAAmE,GAC3E,OAAO,CAAC,oEAAoE,CAAC;IAqDhF;;;;OAIG;IACU,4DAA4D,CACvE,OAAO,EAAE,mEAAmE,GAC3E,OAAO,CAAC,oEAAoE,CAAC;IAyChF,OAAO,CAAC,gBAAgB;YAqBV,uBAAuB;YA0CvB,cAAc;IAYf,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;YAIxC,iBAAiB;YAWjB,uBAAuB;IAkBrC,OAAO,CAAC,2BAA2B;YAgBrB,qBAAqB;IAKnC,OAAO,CAAC,cAAc;YASR,sBAAsB;YA6DtB,wBAAwB;YAuBxB,0BAA0B;CAoFzC"}

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

@@ -19,112 +19,54 @@ export declare class LicenseClient {
     constructor(rpcClient: PublicClient, wallet: SimpleWalletClient, chainId: ChainIds);
     /**
      * 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 a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes license terms Id.
-     * @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/licensing/ILicenseTemplate.sol#L19 | `LicenseTermsRegistered`} event.
      */
     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] 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 license terms Id.
-     * @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/licensing/ILicenseTemplate.sol#L19 | `LicenseTermsRegistered`} event.
      */
     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.defaultMintingFee The fee to be paid when minting a license.
-     *   @param request.currency The ERC20 token to be used to pay the minting fee and the token must be registered in story protocol.
-     *   @param request.royaltyPolicyAddress [Optional] The address of the royalty policy contract, default value is LAP.
-     *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes license terms Id.
-     * @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/licensing/ILicenseTemplate.sol#L19 | `LicenseTermsRegistered`} event.
      */
     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.defaultMintingFee The fee to be paid when minting a license.
-     *   @param request.commercialRevShare Percentage of revenue that must be shared with the licensor.
-     *   @param request.currency The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
-     *   @param request.royaltyPolicyAddress [Optional] The address of the royalty policy contract, default value is LAP.
-     *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes license terms Id.
-     * @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/licensing/ILicenseTemplate.sol#L19 | `LicenseTermsRegistered`} event.
      */
     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 address of the IP to which the license terms are attached.
-     *   @param request.licenseTemplate The address of the license template, default value is Programmable IP License.
-     *   @param request.licenseTermsId The ID of the license terms.
-     *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes success.
-     * If Ip have attached license terms, success will return false and txhash is empty.
      */
     attachLicenseTerms(request: AttachLicenseTermsRequest): Promise<AttachLicenseTermsResponse>;
     /**
      * Mints license tokens for the license terms attached to an IP.
-     * The license tokens are minted to the receiver.
-     * The license terms must be attached to the IP before calling this function.
-     * But it can mint license token of default license terms without attaching the default license terms,
-     * since it is attached to all IPs by default.
-     * IP owners can mint license tokens for their IPs for arbitrary license terms
-     * without attaching the license terms to IP.
      * It might require the caller pay the minting fee, depending on the license terms or configured by the iP owner.
      * 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, default value is Programmable IP License.
-     *   @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.maxMintingFee The maximum minting fee that the caller is willing to pay. if set to 0 then no limit.
-     *   @param request.maxRevenueShare The maximum revenue share percentage allowed for minting the License Tokens. Must be between 0 and 100,000,000 (where 100,000,000 represents 100%).
-     *   @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 license token IDs.
-     * @emits LicenseTokensMinted (msg.sender, licensorIpId, licenseTemplate, licenseTermsId, amount, receiver, startLicenseTokenId);
+     * IP owners can configure the minting fee of their IPs or configure the minting fee module to determine the minting fee.
+     *
+     * @remarks
+     * Before minting license tokens, the license terms must be attached to the IP, with two exceptions:
+     * 1. Default license terms can be minted without explicit attachment since they are automatically
+     *    attached to all IPs by default
+     * 2. IP owners have special privileges and can mint license tokens for their own IPs using any
+     *    license terms, even if those terms are not explicitly attached
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/licensing/ILicensingModule.sol#L34 | `LicenseTokensMinted`} event.
      */
     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>;
     /**
      * Pre-compute the minting license fee for the given IP and license terms. The function can be used to calculate the minting license fee before minting license tokens.
-     * @param request - The request object that contains all data needed to predict minting licenses fee.
-     *   @param request.licensorIpId The IP ID of the licensor.
-     *   @param request.licenseTermsId The ID of the license terms.
-     *   @param request.amount The amount of license tokens to mint.
-     *   @param request.licenseTemplate [Optional] The address of the license template, default value is Programmable IP License.
-     *   @param request.receiver [Optional] The address of the receiver,default value is your wallet address.
-     *   @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to an object containing the currency token and token amount.
      */
     predictMintingLicenseFee(request: PredictMintingLicenseFeeRequest): Promise<LicensingModulePredictMintingLicenseFeeResponse>;
     /**

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

	@@ -1 +1 @@
1	- {"version":3,"file":"license.d.ts","sourceRoot":"../../../../src/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,YAAY,EAAe,MAAM,MAAM,CAAC;AAE1D,OAAO,~~EACL~~,qBAAqB,EACrB,0BAA0B,EAC1B,6BAA6B,EAC7B,qBAAqB,EAGrB,+CAA+C,EAE/C,4BAA4B,EAC5B,gBAAgB,EAChB,uBAAuB,EACvB,wCAAwC,EACxC,+BAA+B,EAC/B,kBAAkB,EAClB,eAAe,EAGhB,4BAAyB;AAC1B,OAAO,EAEL,sCAAsC,EACtC,mBAAmB,EACnB,+BAA+B,EAC/B,iCAAiC,EACjC,yBAAyB,EAEzB,wBAAwB,EACxB,yBAAyB,EAEzB,0BAA0B,EAC1B,cAAc,EACd,uBAAuB,EACvB,+BAA+B,EAC/B,yBAAyB,EACzB,0BAA0B,EAC3B,sCAAmC;AAQpC,OAAO,EAAE,QAAQ,EAAE,2BAAwB;~~AAM3C~~,qBAAa,aAAa;IACjB,qBAAqB,EAAE,0BAA0B,CAAC;IAClD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,+BAA+B,EAAE,+BAA+B,CAAC;IACjE,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,4BAA4B,EAAE,4BAA4B,CAAC;IAC3D,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,SAAS,EAAE,eAAe,CAAC;IAClC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;IACnC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAU;gBAE5B,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAelF~~;;;;;;;;;;;;;;;;;;;;;;;OAuBG~~;IACU,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAiC7F~~;;;;;;OAMG~~;IACU,+BAA+B,CAC1C,OAAO,CAAC,EAAE,sCAAsC,GAC/C,OAAO,CAAC,mBAAmB,CAAC;IAiC/B~~;;;;;;;;;OASG~~;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,mBAAmB,CAAC;~~IAwC~~/B~~;;;;;;;;;;OAUG~~;IACU,0BAA0B,CACrC,OAAO,EAAE,iCAAiC,GACzC,OAAO,CAAC,mBAAmB,CAAC;~~IA0C~~/B~~;;;;;;;;;OASG~~;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;~~IAmDtC;;;;;;;;;;;;;;;;;;;;;;;OAuBG~~;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC;~~IAmGrC;;;;OAIG~~;IACU,eAAe,CAC1B,sBAAsB,EAAE,cAAc,GACrC,OAAO,CAAC,wCAAwC,CAAC;IAUpD~~;;;;;;;;;;OAUG~~;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,+CAA+C,CAAC;~~IAkC3D~~;;OAEG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;YAsDxB,iBAAiB;CAIhC"}
1	+ {"version":3,"file":"license.d.ts","sourceRoot":"../../../../src/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,YAAY,EAAe,MAAM,MAAM,CAAC;AAE1D,OAAO,EAEL,qBAAqB,EACrB,0BAA0B,EAC1B,6BAA6B,EAC7B,qBAAqB,EAGrB,+CAA+C,EAE/C,4BAA4B,EAC5B,gBAAgB,EAChB,uBAAuB,EACvB,wCAAwC,EACxC,+BAA+B,EAC/B,kBAAkB,EAClB,eAAe,EAGhB,4BAAyB;AAC1B,OAAO,EAEL,sCAAsC,EACtC,mBAAmB,EACnB,+BAA+B,EAC/B,iCAAiC,EACjC,yBAAyB,EAEzB,wBAAwB,EACxB,yBAAyB,EAEzB,0BAA0B,EAC1B,cAAc,EACd,uBAAuB,EACvB,+BAA+B,EAC/B,yBAAyB,EACzB,0BAA0B,EAC3B,sCAAmC;AAQpC,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAO3C,qBAAa,aAAa;IACjB,qBAAqB,EAAE,0BAA0B,CAAC;IAClD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,+BAA+B,EAAE,+BAA+B,CAAC;IACjE,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,4BAA4B,EAAE,4BAA4B,CAAC;IAC3D,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,SAAS,EAAE,eAAe,CAAC;IAClC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;IACnC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAU;gBAE5B,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAelF;;;;OAIG;IACU,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAiC7F;;;;OAIG;IACU,+BAA+B,CAC1C,OAAO,CAAC,EAAE,sCAAsC,GAC/C,OAAO,CAAC,mBAAmB,CAAC;IAiC/B;;;;OAIG;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,mBAAmB,CAAC;IAuC/B;;;;OAIG;IACU,0BAA0B,CACrC,OAAO,EAAE,iCAAiC,GACzC,OAAO,CAAC,mBAAmB,CAAC;IAyC/B;;OAEG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IAkDtC;;;;;;;;;;;;;;OAcG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC;IAgGrC;;OAEG;IACU,eAAe,CAC1B,sBAAsB,EAAE,cAAc,GACrC,OAAO,CAAC,wCAAwC,CAAC;IAUpD;;OAEG;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,+CAA+C,CAAC;IAoC3D;;OAEG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;YAsDxB,iBAAiB;CAIhC"}

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

@@ -8,21 +8,9 @@ export declare class NftClient {
     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.contractURI - 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);
+     *
+     * Emits an on-chain `CollectionCreated` event.
+     * @see {@link https://github.com/storyprotocol/protocol-periphery-v1/blob/v1.3.1/contracts/interfaces/workflows/IRegistrationWorkflows.sol#L12 | IRegistrationWorkflows}
      */
     createNFTCollection(request: CreateNFTCollectionRequest): Promise<CreateNFTCollectionResponse>;
     /**

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

	@@ -1 +1 @@
1	- {"version":3,"file":"nftClient.d.ts","sourceRoot":"../../../../src/resources","sources":["nftClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAqC,MAAM,MAAM,CAAC;AAEhF,OAAO,EACL,2BAA2B,EAE3B,kBAAkB,EAEnB,4BAAyB;AAC1B,OAAO,EACL,0BAA0B,EAC1B,2BAA2B,EAC5B,wCAAqC;AAItC,qBAAa,SAAS;IACb,2BAA2B,EAAE,2BAA2B,CAAC;IAEhE,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;~~IAqDvC~~;;OAEG;IACU,eAAe,CAAC,cAAc,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAQvE;;OAEG;IACU,UAAU,CAAC,cAAc,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;CAOlE"}
1	+ {"version":3,"file":"nftClient.d.ts","sourceRoot":"../../../../src/resources","sources":["nftClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAqC,MAAM,MAAM,CAAC;AAEhF,OAAO,EACL,2BAA2B,EAE3B,kBAAkB,EAEnB,4BAAyB;AAC1B,OAAO,EACL,0BAA0B,EAC1B,2BAA2B,EAC5B,wCAAqC;AAItC,qBAAa,SAAS;IACb,2BAA2B,EAAE,2BAA2B,CAAC;IAEhE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAM/D;;;;;OAKG;IACU,mBAAmB,CAC9B,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,2BAA2B,CAAC;IAmDvC;;OAEG;IACU,eAAe,CAAC,cAAc,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAQvE;;OAEG;IACU,UAAU,CAAC,cAAc,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;CAOlE"}

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

@@ -11,80 +11,37 @@ export declare class PermissionClient {
     private readonly chainId;
     constructor(rpcClient: PublicClient, wallet: SimpleWalletClient, chainId: ChainIds);
     /**
-     * Sets the permission for a specific function call
+     * 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
-     * address to a function selector to a permission level. The permission level can be 0 (ABSTAIN), 1 (ALLOW), or
-     * 2 (DENY).
-     * By default, all policies are set to 0 (ABSTAIN), which means that the permission is not set.
+     * address to a function selector to a permission level. The permission level is an enum of `AccessPermission`.
+     * By default, all policies are set to ABSTAIN, which means that the permission is not set.
      * The owner of ipAccount by default has all permission.
-     * address(0) => wildcard
-     * bytes4(0) => wildcard
-     * Specific permission overrides wildcard permission.
-     * @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] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to an object containing the transaction hash.
-     * @emits PermissionSet (ipAccountOwner, ipAccount, signer, to, func, permission)
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/access/IAccessController.sol#L13 | `PermissionSet`} event.
      */
     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.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 seconds, default is 1000s.
-     *   @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.
-     * @emits PermissionSet (ipAccountOwner, ipAccount, signer, to, func, permission)
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/access/IAccessController.sol#L13 | `PermissionSet`} event.
      */
     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] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to an object containing the transaction hash
-     * @emits PermissionSet (ipAccountOwner, ipAccount, signer, to, func, permission)
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/access/IAccessController.sol#L13 | `PermissionSet`} event.
      */
     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] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to an object containing the transaction hash
-     * @emits PermissionSet (ipAccountOwner, ipAccount, signer, to, func, permission)
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/access/IAccessController.sol#L13 | `PermissionSet`} event.
      */
     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.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
-     *   @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.
-     * @emits PermissionSet (ipAccountOwner, ipAccount, signer, to, func, permission)
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/access/IAccessController.sol#L13 | `PermissionSet`} event.
      */
     createBatchPermissionSignature(request: CreateBatchPermissionSignatureRequest): Promise<SetPermissionsResponse>;
     private checkIsRegistered;