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

package/README.md

@@ -1,113 +1,43 @@
-# Story Protocol SDK
+# Story Protocol SDK [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/storyprotocol/sdk/blob/main/LICENSE.md)[![npm version](https://img.shields.io/npm/v/@story-protocol/core-sdk)](https://www.npmjs.com/package/@story-protocol/core-sdk)[![npm downloads](https://img.shields.io/npm/dm/@story-protocol/core-sdk)](https://www.npmjs.com/package/@story-protocol/core-sdk)
 
-Welcome to the documents for Story Protocol SDK. The SDK provides the APIs for developers to build applications with Story Protocol. By using the SDK, developers can create the resources like IP assets and perform actions to interact with the resource.
+Welcome to the Story Protocol SDK - a comprehensive toolkit for building applications on Story Protocol. This SDK empowers developers to seamlessly interact with intellectual property (IP) assets on the blockchain through an intuitive API interface.
 
-## How to use Story Protocol SDK in Your Project
+Key Features:
 
-### Install Story Protocol core SDK
+- IP Asset Module: Register, and manage intellectual property assets on-chain
+- License Module: Create customizable license terms, attach them to IP assets, and mint transferable license tokens
+- Royalty Module: Claim royalties, and manage payment distributions
+- Dispute Module: Initiate, manage and resolve IP-related disputes through on-chain governance
+- Group Module: Create IP collections with shared revenue pools
+- WIP Module: Wrap native IP into ERC-20 tokens for DeFi integrations
+- NFT Client Module: Mint a new SPG collection for use with Story Protocol.
 
-Suppose you already have a node project or created a new node project. First, you need to install `@story-protocol/core-sdk` in your project. You can use one of the following command to install the package:
+The SDK provides robust support for the following networks:
 
-Use `npm`:
+- [aeneid](https://docs.story.foundation/network/network-info/aeneid) - A dedicated testnet environment for development and testing
+- [mainnet](https://docs.story.foundation/network/network-info/mainnet) - The production network for live deployments
 
-```
-npm install --save @story-protocol/core-sdk viem@1.21.4
-```
+# Documentation
 
-Use `pnpm`:
+For more detailed information on using the SDK, refer to the [TypeScript SDK Guide](https://docs.story.foundation/developers/typescript-sdk/overview).
 
-```
-pnpm install @story-protocol/core-sdk viem@1.21.4
-```
+The documentation is divided into the following sections:
 
-Use `yarn`:
-
-```
-yarn add @story-protocol/core-sdk viem@1.21.4
-```
-
-Besides the Story Protocol SDK package `@story-protocol/core-sdk`, we also require the package `viem` (https://www.npmjs.com/package/viem) to access the DeFi wallet accounts.
-
-# Initiate SDK Client
-
-Next we can initiate the SDK Client by first setting up our wallet and then the client itself.
-
-## Set up your wallet
-
-The SDK supports using `viem` for initiating SDK client. Create a typescript file and write the following code to initiate the client with a private key:
-
-> :information-source: Make sure to have WALLET_PRIVATE_KEY set up in your .env file.
-
-```typescript index.ts
-import { privateKeyToAccount } from "viem/accounts";
-
-const WALLET_PRIVATE_KEY = process.env.WALLET_PRIVATE_KEY || "0x";
-const account = privateKeyToAccount(WALLET_PRIVATE_KEY as Address);
-```
-
-The preceding code created the `account` object for creating the SDK client.
-
-## Set up SDK client
-
-To set up the SDK client, import `StoryClient` and `StoryConfig` from `@story-protocol/core-sdk`. Write the following code, utilizing the `account` we created previously.
-
-> :information-source: Make sure to have RPC_PROVIDER_URL for your desired chain set up in your .env file. We recommend using the Iliad network with `RPC_PROVIDER_URL=https://rpc.partner.testnet.storyprotocol.net`.
-
-```typescript index.ts
-import { StoryClient, StoryConfig } from "@story-protocol/core-sdk";
-
-const config: StoryConfig = {
-  transport: http(process.env.RPC_PROVIDER_URL),
-  account: account,
-};
-const client = StoryClient.newClient(config);
-```
-
-## How To Build and Test Story Protocol SDK for local testing
-
-This section provides the instructions on how to build Story Protocol SDK from source code.
-
-### Prerequisite
-
-- Install PNPM: Execute `npm install -g pnpm`
-- Install TypeScript: Run `pnpm add typescript -D`
-- Install Yalc: Use `npm install -g yalc`
-
-### Steps for Using Yalc for Local Testing of Core-SDK
-
-For manual testing of the core-sdk, set up a separate web project. The guide below uses `yalc` to link the `core-sdk` locally, enabling its installation and import for testing.
-
-Under the `typescript-sdk/packages/core-sdk` directory:
-
-- Navigate to the `core-sdk` directory.
-- Execute `npm run build` to build your latest code.
-- Run `yalc publish`. You should see a message like `@story-protocol/core-sdk@<version> published in store.` (Note: The version number may vary).
-
-To set up your testing environment (e.g., a new Next.js project), use `yalc add @story-protocol/core-sdk@<version>` (ensure the version number is updated accordingly).
-
-- Run `pnpm install`. This installs `@story-protocol/core-sdk@<version>` with your local changes.
-
-### Steps to Refresh the Changes
-
-Under the `typescript-sdk/packages/core-sdk` directory:
-
-- Execute `npm run build` to build your latest code.
-- Run `yalc push`.
-
-In your testing environment:
-
-- Run `yalc update` to pull the latest changes.
-
-## Steps to pull and compile latest Protocol Core & Periphery v1 Smart Contract ABIs (Currently pulls from the protocol-core-v1 and protocol-periphery-v1 `release-v1.x.x` branch)
-
-- run `cd packages/wagmi-generator && npm run generate`
+- [Overview](https://docs.story.foundation/developers/typescript-sdk/overview)
+- [Setup](https://docs.story.foundation/developers/typescript-sdk/setup)
+- [Register an IP Asset](https://docs.story.foundation/developers/typescript-sdk/register-ip-asset)
+- [Attach Terms to an IPA](https://docs.story.foundation/developers/typescript-sdk/attach-terms)
+- [Mint a License Token](https://docs.story.foundation/developers/typescript-sdk/mint-license)
+- [Register a Derivative](https://docs.story.foundation/developers/typescript-sdk/register-derivative)
+- [Pay an IPA](https://docs.story.foundation/developers/typescript-sdk/pay-ipa)
+- [Claim Revenue](https://docs.story.foundation/developers/typescript-sdk/claim-revenue)
+- [Raise a Dispute](https://docs.story.foundation/developers/typescript-sdk/raise-dispute)
 
 ## Release
 
-| Package                           | Description                                     |
-| :-------------------------------- | :---------------------------------------------- |
-| [core-sdk](./packages/core-sdk)   | The core sdk for interacting with the protocol  |
-| [react-sdk](./packages/react-sdk) | The react sdk for interacting with the protocol |
+| Package                         | Description                                    |
+| :------------------------------ | :--------------------------------------------- |
+| [core-sdk](./packages/core-sdk) | The core sdk for interacting with the protocol |
 
 ## Contributing
 
@@ -118,6 +48,4 @@ Please make sure to update tests as appropriate.
 
 ## License
 
-[MIT License](/LICENSE.md)
-
-## Contact Us
+[Copyright (c) 2023-Present Story Protocol Inc.](/LICENSE.md)

package/dist/declarations/src/client.d.ts

@@ -24,83 +24,59 @@ export declare class StoryClient {
     private _nftClient;
     private _group;
     private _wip;
-    /**
-     * @param config - the configuration for the SDK client
-     */
     private constructor();
     private get chainId();
     /**
-     * Factory method for creating a SDK client with a signer.
+     * Factory method for creating an SDK client with a signer.
      *
-     * @param config StoryClient - the configuration for a new SDK client
      */
     static newClient(config: StoryConfig): StoryClient;
     /**
-     * Factory method for creating a SDK client with a signer.
-     *
-     * @param config WalletClientConfig - the configuration for a new SDK client
+     * Factory method for creating an SDK client with a signer.
      */
     static newClientUseWallet(config: UseWalletStoryConfig): StoryClient;
     /**
-     * Factory method for creating a SDK client with a signer.
-     *
-     * @param config UseAccountStoryConfig - the configuration for a new SDK client
+     * Factory method for creating an SDK client with a signer.
      */
     static newClientUseAccount(config: UseAccountStoryConfig): StoryClient;
     /**
      * Getter for the ip asset client. The client is lazily created when
      * this method is called.
-     *
-     * @returns the IPAssetClient instance
      */
     get ipAsset(): IPAssetClient;
     /**
      * Getter for the permission client. The client is lazily created when
      * this method is called.
-     *
-     * @returns the PermissionClient instance
      */
     get permission(): PermissionClient;
     /**
      * Getter for the license client. The client is lazily created when
      * this method is called.
-     *
-     * @returns the LicenseClient instance
      */
     get license(): LicenseClient;
     /**
      * Getter for the dispute client. The client is lazily created when
      * this method is called.
-     *
-     * @returns the DisputeClient instance
      */
     get dispute(): DisputeClient;
     /**
      * Getter for the ip account client. The client is lazily created when
      * this method is called.
-     *
-     * @returns the IPAccountClient instance
      */
     get ipAccount(): IPAccountClient;
     /**
      * Getter for the royalty client. The client is lazily created when
      * this method is called.
-     *
-     * @returns the RoyaltyClient instance
      */
     get royalty(): RoyaltyClient;
     /**
      * Getter for the NFT client. The client is lazily created when
      * this method is called.
-     *
-     * @returns the NftClient instance
      */
     get nftClient(): NftClient;
     /**
      * Getter for the group client. The client is lazily created when
      * this method is called.
-     *
-     * @returns the GroupClient instance
      */
     get groupClient(): GroupClient;
     get wipClient(): WipClient;

package/dist/declarations/src/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"../../../src","sources":["client.ts"],"names":[],"mappings":"AAGA,OAAO,EAAY,WAAW,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,0BAAuB;AACpG,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,gBAAgB,EAAE,kCAA+B;AAC1D,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,eAAe,EAAE,iCAA8B;AAExD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,SAAS,EAAE,iCAA8B;AAClD,OAAO,EAAE,WAAW,EAAE,6BAA0B;AAEhD,OAAO,EAAE,SAAS,EAAE,2BAAwB;AAK5C;;GAEG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAA8B;IAC9C,OAAO,CAAC,WAAW,CAAiC;IACpD,OAAO,CAAC,QAAQ,CAA8B;IAC9C,OAAO,CAAC,QAAQ,CAA8B;IAC9C,OAAO,CAAC,UAAU,CAAgC;IAClD,OAAO,CAAC,QAAQ,CAA8B;IAC9C,OAAO,CAAC,UAAU,CAA0B;IAC5C,OAAO,CAAC,MAAM,CAA4B;IAC1C,OAAO,CAAC,IAAI,CAA0B;IAEtC;;OAEG;IACH,OAAO;IA+BP,OAAO,KAAK,OAAO,GAElB;IACD;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW;IAIlD;;;;OAIG;IACH,MAAM,CAAC,kBAAkB,CAAC,MAAM,EAAE,oBAAoB,GAAG,WAAW;IAQpE;;;;OAIG;IACH,MAAM,CAAC,mBAAmB,CAAC,MAAM,EAAE,qBAAqB,GAAG,WAAW;IAQtE;;;;;OAKG;IACH,IAAW,OAAO,IAAI,aAAa,CAMlC;IAED;;;;;OAKG;IACH,IAAW,UAAU,IAAI,gBAAgB,CAMxC;IAED;;;;;OAKG;IACH,IAAW,OAAO,IAAI,aAAa,CAMlC;IAED;;;;;OAKG;IACH,IAAW,OAAO,IAAI,aAAa,CAMlC;IAED;;;;;OAKG;IACH,IAAW,SAAS,IAAI,eAAe,CAMtC;IAED;;;;;OAKG;IACH,IAAW,OAAO,IAAI,aAAa,CAMlC;IAED;;;;;OAKG;IACH,IAAW,SAAS,IAAI,SAAS,CAMhC;IAED;;;;;OAKG;IACH,IAAW,WAAW,IAAI,WAAW,CAMpC;IAED,IAAW,SAAS,IAAI,SAAS,CAKhC;IAEY,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAOnC,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAM1D"}
+{"version":3,"file":"client.d.ts","sourceRoot":"../../../src","sources":["client.ts"],"names":[],"mappings":"AAGA,OAAO,EAAY,WAAW,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,0BAAuB;AACpG,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,gBAAgB,EAAE,kCAA+B;AAC1D,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,eAAe,EAAE,iCAA8B;AAExD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,SAAS,EAAE,iCAA8B;AAClD,OAAO,EAAE,WAAW,EAAE,6BAA0B;AAEhD,OAAO,EAAE,SAAS,EAAE,2BAAwB;AAK5C;;GAEG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAA8B;IAC9C,OAAO,CAAC,WAAW,CAAiC;IACpD,OAAO,CAAC,QAAQ,CAA8B;IAC9C,OAAO,CAAC,QAAQ,CAA8B;IAC9C,OAAO,CAAC,UAAU,CAAgC;IAClD,OAAO,CAAC,QAAQ,CAA8B;IAC9C,OAAO,CAAC,UAAU,CAA0B;IAC5C,OAAO,CAAC,MAAM,CAA4B;IAC1C,OAAO,CAAC,IAAI,CAA0B;IAEtC,OAAO;IA+BP,OAAO,KAAK,OAAO,GAElB;IACD;;;OAGG;IACH,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW;IAIlD;;OAEG;IACH,MAAM,CAAC,kBAAkB,CAAC,MAAM,EAAE,oBAAoB,GAAG,WAAW;IAQpE;;OAEG;IACH,MAAM,CAAC,mBAAmB,CAAC,MAAM,EAAE,qBAAqB,GAAG,WAAW;IAQtE;;;OAGG;IACH,IAAW,OAAO,IAAI,aAAa,CAMlC;IAED;;;OAGG;IACH,IAAW,UAAU,IAAI,gBAAgB,CAMxC;IAED;;;OAGG;IACH,IAAW,OAAO,IAAI,aAAa,CAMlC;IAED;;;OAGG;IACH,IAAW,OAAO,IAAI,aAAa,CAMlC;IAED;;;OAGG;IACH,IAAW,SAAS,IAAI,eAAe,CAMtC;IAED;;;OAGG;IACH,IAAW,OAAO,IAAI,aAAa,CAMlC;IAED;;;OAGG;IACH,IAAW,SAAS,IAAI,SAAS,CAMhC;IAED;;;OAGG;IACH,IAAW,WAAW,IAAI,WAAW,CAMpC;IAED,IAAW,SAAS,IAAI,SAAS,CAKhC;IAEY,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAOnC,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAM1D"}

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

@@ -1,9 +1,6 @@
 import { Hex } from "viem";
-export declare const AddressZero = "0x0000000000000000000000000000000000000000";
-export declare const HashZero = "0x0000000000000000000000000000000000000000000000000000000000000000";
 export declare const defaultFunctionSelector: Hex;
 export declare const royaltySharesTotalSupply: number;
 export declare const MAX_ROYALTY_TOKEN = 100000000;
-/** Address for the WIP contract. This address is fixed */
-export declare const WIP_TOKEN_ADDRESS = "0x1514000000000000000000000000000000000000";
+export declare const WIP_TOKEN_ADDRESS: "0x1514000000000000000000000000000000000000";
 //# sourceMappingURL=common.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"../../../../src/constants","sources":["common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAE3B,eAAO,MAAM,WAAW,+CAA+C,CAAC;AACxE,eAAO,MAAM,QAAQ,uEAAuE,CAAC;AAC7F,eAAO,MAAM,uBAAuB,EAAE,GAAkB,CAAC;AACzD,eAAO,MAAM,wBAAwB,EAAE,MAAoB,CAAC;AAC5D,eAAO,MAAM,iBAAiB,YAAc,CAAC;AAE7C,0DAA0D;AAC1D,eAAO,MAAM,iBAAiB,+CAA+C,CAAC"}
+{"version":3,"file":"common.d.ts","sourceRoot":"../../../../src/constants","sources":["common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAK3B,eAAO,MAAM,uBAAuB,EAAE,GAAkB,CAAC;AACzD,eAAO,MAAM,wBAAwB,EAAE,MAAoB,CAAC;AAC5D,eAAO,MAAM,iBAAiB,YAAc,CAAC;AAC7C,eAAO,MAAM,iBAAiB,8CAA+B,CAAC"}

package/dist/declarations/src/index.d.ts

@@ -1,5 +1,5 @@
 export { StoryClient } from "./client.js";
-export { AddressZero, HashZero, WIP_TOKEN_ADDRESS } from "./constants/common.js";
+export { WIP_TOKEN_ADDRESS } from "./constants/common.js";
 export { aeneid, mainnet } from "./utils/chain.js";
 export { IPAssetClient } from "./resources/ipAsset.js";
 export { PermissionClient } from "./resources/permission.js";
@@ -10,23 +10,23 @@ export { IPAccountClient } from "./resources/ipAccount.js";
 export { RoyaltyClient } from "./resources/royalty.js";
 export { GroupClient } from "./resources/group.js";
 export { WipClient } from "./resources/wip.js";
-export type { StoryConfig, SupportedChainIds } from "./types/config.js";
-export type { LicensingConfig } from "./types/common.js";
-export type { RegisterRequest, RegisterIpResponse, RegisterDerivativeResponse, RegisterDerivativeRequest, RegisterDerivativeWithLicenseTokensRequest, RegisterDerivativeWithLicenseTokensResponse, MintAndRegisterIpAssetWithPilTermsRequest, MintAndRegisterIpAssetWithPilTermsResponse, RegisterIpAndMakeDerivativeRequest, RegisterIpAndMakeDerivativeResponse, RegisterIpAndAttachPilTermsRequest, RegisterIpAndAttachPilTermsResponse, MintAndRegisterIpAndMakeDerivativeRequest, MintAndRegisterIpAndMakeDerivativeResponse, MintAndRegisterIpRequest, RegisterPilTermsAndAttachRequest, RegisterPilTermsAndAttachResponse, MintAndRegisterIpAndMakeDerivativeWithLicenseTokensRequest, RegisterIpAndMakeDerivativeWithLicenseTokensRequest, BatchMintAndRegisterIpAssetWithPilTermsRequest, BatchMintAndRegisterIpAssetWithPilTermsResponse, BatchMintAndRegisterIpAndMakeDerivativeRequest, BatchMintAndRegisterIpAndMakeDerivativeResponse, BatchRegisterRequest, BatchRegisterResponse, BatchRegisterDerivativeRequest, BatchRegisterDerivativeResponse, RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest, RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse, RoyaltyShare, RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest, RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse, MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensRequest, MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensResponse, MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensRequest, MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensResponse, LicenseTermsData, } from "./types/resources/ipAsset.js";
+export * from "./types/config.js";
+export * from "./types/common.js";
+export * from "./types/options.js";
+export * from "./types/resources/ipAsset.js";
 export * from "./types/resources/ipMetadata.js";
-export type { RegisterNonComSocialRemixingPILRequest, RegisterCommercialUsePILRequest, RegisterCommercialRemixPILRequest, RegisterPILTermsRequest, RegisterPILResponse, AttachLicenseTermsRequest, AttachLicenseTermsResponse, MintLicenseTokensRequest, MintLicenseTokensResponse, LicenseTermsId, LicenseTerms, PredictMintingLicenseFeeRequest, SetLicensingConfigRequest, SetLicensingConfigResponse, } from "./types/resources/license.js";
+export * from "./types/resources/license.js";
+export * from "./types/resources/royalty.js";
+export * from "./types/resources/permission.js";
+export * from "./types/resources/dispute.js";
+export * from "./types/resources/ipAccount.js";
+export * from "./types/resources/nftClient.js";
+export * from "./types/resources/group.js";
+export * from "./types/resources/wip.js";
 export { PIL_TYPE } from "./types/resources/license.js";
-export type { PayRoyaltyOnBehalfRequest, PayRoyaltyOnBehalfResponse, ClaimableRevenueRequest, ClaimableRevenueResponse, ClaimAllRevenueRequest, ClaimAllRevenueResponse, BatchClaimAllRevenueRequest, BatchClaimAllRevenueResponse, NativeRoyaltyPolicy, TransferToVaultRequest, RoyaltyPolicyInput, } from "./types/resources/royalty.js";
-export type { SetPermissionsRequest, SetPermissionsResponse, CreateSetPermissionSignatureRequest, SetAllPermissionsRequest, SetBatchPermissionsRequest, CreateBatchPermissionSignatureRequest, PermissionSignatureRequest, SignatureRequest, SignatureResponse, } from "./types/resources/permission.js";
 export { AccessPermission } from "./types/resources/permission.js";
-export type { RaiseDisputeRequest, RaiseDisputeResponse, CancelDisputeRequest, CancelDisputeResponse, ResolveDisputeRequest, ResolveDisputeResponse, } from "./types/resources/dispute.js";
-export type { IPAccountExecuteRequest, IPAccountExecuteResponse, IPAccountExecuteWithSigRequest, IPAccountExecuteWithSigResponse, IpAccountStateResponse, TokenResponse, } from "./types/resources/ipAccount.js";
-export type { CreateNFTCollectionRequest, CreateNFTCollectionResponse, } from "./types/resources/nftClient.js";
-export type { RegisterGroupRequest, RegisterGroupResponse, RegisterGroupAndAttachLicenseRequest, RegisterGroupAndAttachLicenseResponse, RegisterGroupAndAttachLicenseAndAddIpsRequest, RegisterGroupAndAttachLicenseAndAddIpsResponse, MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest, MintAndRegisterIpAndAttachLicenseAndAddToGroupResponse, RegisterIpAndAttachLicenseAndAddToGroupRequest, RegisterIpAndAttachLicenseAndAddToGroupResponse, CollectAndDistributeGroupRoyaltiesRequest, CollectAndDistributeGroupRoyaltiesResponse, } from "./types/resources/group.js";
 export type { PiLicenseTemplateGetLicenseTermsResponse, IpAccountImplStateResponse, EncodedTxData, LicensingModulePredictMintingLicenseFeeResponse, } from "./abi/generated.js";
 export { royaltyPolicyLapAddress, royaltyPolicyLrpAddress } from "./abi/generated.js";
-export type { DepositRequest, WithdrawRequest, ApproveRequest, TransferRequest, TransferFromRequest, } from "./types/resources/wip.js";
 export { getPermissionSignature, getSignature } from "./utils/sign.js";
 export { convertCIDtoHashIPFS, convertHashIPFStoCID } from "./utils/ipfs.js";
-export type { TxOptions, TransactionResponse, WipOptions, ERC20Options } from "./types/options.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/declarations/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"../../../src","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,oBAAiB;AACvC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,iBAAiB,EAAE,8BAA2B;AAC9E,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,yBAAsB;AAChD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,gBAAgB,EAAE,kCAA+B;AAC1D,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,SAAS,EAAE,iCAA8B;AAClD,OAAO,EAAE,eAAe,EAAE,iCAA8B;AACxD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,WAAW,EAAE,6BAA0B;AAChD,OAAO,EAAE,SAAS,EAAE,2BAAwB;AAE5C,YAAY,EAAE,WAAW,EAAE,iBAAiB,EAAE,0BAAuB;AAErE,YAAY,EAAE,eAAe,EAAE,0BAAuB;AAEtD,YAAY,EACV,eAAe,EACf,kBAAkB,EAClB,0BAA0B,EAC1B,yBAAyB,EACzB,0CAA0C,EAC1C,2CAA2C,EAC3C,yCAAyC,EACzC,0CAA0C,EAC1C,kCAAkC,EAClC,mCAAmC,EACnC,kCAAkC,EAClC,mCAAmC,EACnC,yCAAyC,EACzC,0CAA0C,EAC1C,wBAAwB,EACxB,gCAAgC,EAChC,iCAAiC,EACjC,0DAA0D,EAC1D,mDAAmD,EACnD,8CAA8C,EAC9C,+CAA+C,EAC/C,8CAA8C,EAC9C,+CAA+C,EAC/C,oBAAoB,EACpB,qBAAqB,EACrB,8BAA8B,EAC9B,+BAA+B,EAC/B,gEAAgE,EAChE,iEAAiE,EACjE,YAAY,EACZ,wEAAwE,EACxE,yEAAyE,EACzE,mEAAmE,EACnE,oEAAoE,EACpE,mEAAmE,EACnE,oEAAoE,EACpE,gBAAgB,GACjB,qCAAkC;AAEnC,gDAA6C;AAE7C,YAAY,EACV,sCAAsC,EACtC,+BAA+B,EAC/B,iCAAiC,EACjC,uBAAuB,EACvB,mBAAmB,EACnB,yBAAyB,EACzB,0BAA0B,EAC1B,wBAAwB,EACxB,yBAAyB,EACzB,cAAc,EACd,YAAY,EACZ,+BAA+B,EAC/B,yBAAyB,EACzB,0BAA0B,GAC3B,qCAAkC;AAEnC,OAAO,EAAE,QAAQ,EAAE,qCAAkC;AAErD,YAAY,EACV,yBAAyB,EACzB,0BAA0B,EAC1B,uBAAuB,EACvB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,2BAA2B,EAC3B,4BAA4B,EAC5B,mBAAmB,EACnB,sBAAsB,EACtB,kBAAkB,GACnB,qCAAkC;AAEnC,YAAY,EACV,qBAAqB,EACrB,sBAAsB,EACtB,mCAAmC,EACnC,wBAAwB,EACxB,0BAA0B,EAC1B,qCAAqC,EACrC,0BAA0B,EAC1B,gBAAgB,EAChB,iBAAiB,GAClB,wCAAqC;AAEtC,OAAO,EAAE,gBAAgB,EAAE,wCAAqC;AAEhE,YAAY,EACV,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,GACvB,qCAAkC;AAEnC,YAAY,EACV,uBAAuB,EACvB,wBAAwB,EACxB,8BAA8B,EAC9B,+BAA+B,EAC/B,sBAAsB,EACtB,aAAa,GACd,uCAAoC;AAErC,YAAY,EACV,0BAA0B,EAC1B,2BAA2B,GAC5B,uCAAoC;AAErC,YAAY,EACV,oBAAoB,EACpB,qBAAqB,EACrB,oCAAoC,EACpC,qCAAqC,EACrC,6CAA6C,EAC7C,8CAA8C,EAC9C,qDAAqD,EACrD,sDAAsD,EACtD,8CAA8C,EAC9C,+CAA+C,EAC/C,yCAAyC,EACzC,0CAA0C,GAC3C,mCAAgC;AAEjC,YAAY,EACV,wCAAwC,EACxC,0BAA0B,EAC1B,aAAa,EACb,+CAA+C,GAChD,2BAAwB;AAEzB,OAAO,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,2BAAwB;AAEnF,YAAY,EACV,cAAc,EACd,eAAe,EACf,cAAc,EACd,eAAe,EACf,mBAAmB,GACpB,iCAA8B;AAE/B,OAAO,EAAE,sBAAsB,EAAE,YAAY,EAAE,wBAAqB;AAEpE,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,wBAAqB;AAE1E,YAAY,EAAE,SAAS,EAAE,mBAAmB,EAAE,UAAU,EAAE,YAAY,EAAE,2BAAwB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"../../../src","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,oBAAiB;AACvC,OAAO,EAAE,iBAAiB,EAAE,8BAA2B;AACvD,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,yBAAsB;AAChD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,gBAAgB,EAAE,kCAA+B;AAC1D,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,SAAS,EAAE,iCAA8B;AAClD,OAAO,EAAE,eAAe,EAAE,iCAA8B;AACxD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,WAAW,EAAE,6BAA0B;AAChD,OAAO,EAAE,SAAS,EAAE,2BAAwB;AAE5C,kCAA+B;AAC/B,kCAA+B;AAC/B,mCAAgC;AAEhC,6CAA0C;AAC1C,gDAA6C;AAC7C,6CAA0C;AAC1C,6CAA0C;AAC1C,gDAA6C;AAC7C,6CAA0C;AAC1C,+CAA4C;AAC5C,+CAA4C;AAC5C,2CAAwC;AACxC,yCAAsC;AAEtC,OAAO,EAAE,QAAQ,EAAE,qCAAkC;AAErD,OAAO,EAAE,gBAAgB,EAAE,wCAAqC;AAEhE,YAAY,EACV,wCAAwC,EACxC,0BAA0B,EAC1B,aAAa,EACb,+CAA+C,GAChD,2BAAwB;AAEzB,OAAO,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,2BAAwB;AAEnF,OAAO,EAAE,sBAAsB,EAAE,YAAY,EAAE,wBAAqB;AAEpE,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,wBAAqB"}

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

@@ -15,53 +15,37 @@ export declare class DisputeClient {
     /**
      * Raises a dispute on a given ipId.
      *
-     * Submits a {@link DisputeRaised} event.
-     * @see {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/dispute/IDisputeModule.sol#L64 | IDisputeModule.sol}
-     * for a list of on-chain events emitted when a dispute is raised.
-     *
-     * @remarks `WipOptions.useMulticallWhenPossible` is disabled for this function due to disputeInitiator issue. It will be executed sequentially with several transactions.
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/dispute/IDisputeModule.sol#L64 | `DisputeRaised`} event.
      */
     raiseDispute(request: RaiseDisputeRequest): Promise<RaiseDisputeResponse>;
     /**
      * Cancels an ongoing dispute
-     * @param request - The request object containing details to cancel the dispute.
-     *   @param request.disputeId The ID of the dispute to be cancelled.
-     *   @param request.data [Optional] additional data used in the cancellation process.
-     *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to a CancelDisputeResponse containing the transaction hash.
-     * @throws NotInDisputeState, if the currentTag of the Dispute is not being disputed
-     * @throws NotDisputeInitiator, if the transaction executor is not the one that initiated the dispute
-     * @throws error if the Dispute's ArbitrationPolicy contract is not valid
-     * @calls cancelDispute(uint256 _disputeId, bytes calldata _data) external nonReentrant {
-     * @emits DisputeCancelled (_disputeId, _data);
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/dispute/IDisputeModule.sol#L84 | `DisputeCancelled`} event.
      */
     cancelDispute(request: CancelDisputeRequest): Promise<CancelDisputeResponse>;
     /**
-     * Resolves a dispute after it has been judged
-     * @param request - The request object containing details to resolve the dispute.
-     *   @param request.disputeId The ID of the dispute to be resolved.
-     *   @param request.data The data to resolve the dispute.
-     *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to a ResolveDisputeResponse.
-     * @throws NotAbleToResolve, if currentTag is still in dispute (i.e still needs a judgement to be set)
-     * @throws NotDisputeInitiator, if the transaction executor is not the one that initiated the dispute
-     * @emits DisputeResolved (_disputeId)
+     * Resolves a dispute after it has been judged.
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/dispute/IDisputeModule.sol#L104 | `DisputeResolved`} event.
      */
     resolveDispute(request: ResolveDisputeRequest): Promise<ResolveDisputeResponse>;
     /**
      * Tags a derivative if a parent has been tagged with an infringement tag
      * or a group ip if a group member has been tagged with an infringement tag.
      *
-     * @see {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/dispute/IDisputeModule.sol#L93 | IDisputeModule.sol}
-     * for a list of on-chain events emitted when a derivative is tagged on an infringement.
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/dispute/IDisputeModule.sol#L93 | `IpTaggedOnRelatedIpInfringement`} event.
      */
     tagIfRelatedIpInfringed(request: TagIfRelatedIpInfringedRequest): Promise<TransactionResponse[]>;
     /**
      * Counters a dispute that was raised by another party on an IP using counter evidence.
+     * The counter evidence (e.g., documents, images) should be uploaded to IPFS,
+     * and its corresponding CID is converted to a hash for the request.
      *
-     * This method can only be called by the IP's owner to counter a dispute by providing
-     * counter evidence. The counter evidence (e.g., documents, images) should be
-     * uploaded to IPFS, and its corresponding CID is converted to a hash for the request.
+     * @remarks
+     *  The liveness period is split in two parts:
+     *  - the first part of the liveness period in which only the IP's owner can be called the method.
+     *  - a second part in which any address can be called the method.
      *
      * If you only have a `disputeId`, call {@link disputeIdToAssertionId} to get the `assertionId` needed here.
      */

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

@@ -1 +1 @@
-{"version":3,"file":"dispute.d.ts","sourceRoot":"../../../../src/resources","sources":["dispute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,YAAY,EAAgD,MAAM,MAAM,CAAC;AAGvF,OAAO,EACL,oBAAoB,EACpB,qBAAqB,EACrB,uBAAuB,EACvB,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACtB,8BAA8B,EAC/B,sCAAmC;AACpC,OAAO,EACL,0BAA0B,EAC1B,mBAAmB,EAGnB,gBAAgB,EAChB,kBAAkB,EAElB,eAAe,EAChB,4BAAyB;AAG1B,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAE3C,OAAO,EAAE,mBAAmB,EAAE,4BAAyB;AAIvD,qBAAa,aAAa;IACjB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,eAAe,EAAE,eAAe,CAAC;IACxC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;IACnC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAUlF;;;;;;;;OAQG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAmFtF;;;;;;;;;;;;OAYG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAyBzF;;;;;;;;;;OAUG;IACU,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAwB5F;;;;;;OAMG;IACU,uBAAuB,CAClC,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAuCjC;;;;;;;;OAQG;IACU,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAyGhF,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAM9E"}
+{"version":3,"file":"dispute.d.ts","sourceRoot":"../../../../src/resources","sources":["dispute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,YAAY,EAAgD,MAAM,MAAM,CAAC;AAGvF,OAAO,EACL,oBAAoB,EACpB,qBAAqB,EACrB,uBAAuB,EACvB,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACtB,8BAA8B,EAC/B,sCAAmC;AACpC,OAAO,EACL,0BAA0B,EAC1B,mBAAmB,EAGnB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EAChB,4BAAyB;AAG1B,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAE3C,OAAO,EAAE,mBAAmB,EAAE,4BAAyB;AAKvD,qBAAa,aAAa;IACjB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,eAAe,EAAE,eAAe,CAAC;IACxC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;IACnC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAUlF;;;;OAIG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAmFtF;;;;OAIG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAyBzF;;;;OAIG;IACU,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAwB5F;;;;;OAKG;IACU,uBAAuB,CAClC,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAwCjC;;;;;;;;;;;OAWG;IACU,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAyGhF,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAM9E"}

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

@@ -18,31 +18,28 @@ export declare class GroupClient {
     private readonly chainId;
     constructor(rpcClient: PublicClient, wallet: SimpleWalletClient, chainId: ChainIds);
     /** Registers a Group IPA.
-     * @param request - The request object containing necessary data to register group.
-     *   @param request.groupPool The address specifying how royalty will be split amongst the pool of IPs in the group.
-     *   @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes group id.
-     * @emits PGroupRegistered (groupId, groupPool);
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/grouping/IGroupingModule.sol#L14 | `IPGroupRegistered`} event.
      */
     registerGroup(request: RegisterGroupRequest): Promise<RegisterGroupResponse>;
     /** Mint an NFT from a SPGNFT collection, register it with metadata as an IP, attach license terms to the registered IP, and add it to a group IP.
-     * @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, license terms are attached to an IP, and it is added to a group.
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | `IPRegistered`} event.
      */
     mintAndRegisterIpAndAttachLicenseAndAddToGroup(request: MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest): Promise<MintAndRegisterIpAndAttachLicenseAndAddToGroupResponse>;
     /** Register an NFT as IP with metadata, attach license terms to the registered IP, and add it to a group IP.
-     * @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 registered, license terms are attached to an IP, and it is added to a group.
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/registries/IIPAssetRegistry.sol#L17 | `IPRegistered`} event.
      */
     registerIpAndAttachLicenseAndAddToGroup(request: RegisterIpAndAttachLicenseAndAddToGroupRequest): Promise<RegisterIpAndAttachLicenseAndAddToGroupResponse>;
     /** Register a group IP with a group reward pool and attach license terms to the group IP.
-     * @see {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/grouping/IGroupingModule.sol#L14 | IGroupingModule}
-     * for a list of on-chain events emitted when a group IP is registered, license terms are attached to a group IP .
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/grouping/IGroupingModule.sol#L14 | `IPGroupRegistered`} event.
      */
     registerGroupAndAttachLicense(request: RegisterGroupAndAttachLicenseRequest): Promise<RegisterGroupAndAttachLicenseResponse>;
     /** Register a group IP with a group reward pool, attach license terms to the group IP, and add individual IPs to the group IP.
-     * @see {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/grouping/IGroupingModule.sol#L14 | IGroupingModule}
-     * for a list of on-chain events emitted when a group IP is registered, license terms are attached to a group IP, and individual IPs are added to a group.
+     *
+     * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/grouping/IGroupingModule.sol#L14 | `IPGroupRegistered`} event.
      */
     registerGroupAndAttachLicenseAndAddIps(request: RegisterGroupAndAttachLicenseAndAddIpsRequest): Promise<RegisterGroupAndAttachLicenseAndAddIpsResponse>;
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"group.d.ts","sourceRoot":"../../../../src/resources","sources":["group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAoC,MAAM,MAAM,CAAC;AAEtE,OAAO,EAEL,wBAAwB,EAExB,oBAAoB,EACpB,yBAAyB,EAEzB,uBAAuB,EAMvB,qBAAqB,EACrB,6BAA6B,EAC7B,0BAA0B,EAE1B,qBAAqB,EACrB,uBAAuB,EACvB,wBAAwB,EACxB,kBAAkB,EACnB,4BAAyB;AAK1B,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAC3C,OAAO,EAGL,qDAAqD,EACrD,sDAAsD,EACtD,6CAA6C,EAC7C,8CAA8C,EAC9C,oCAAoC,EACpC,qCAAqC,EACrC,oBAAoB,EACpB,qBAAqB,EACrB,8CAA8C,EAC9C,+CAA+C,EAC/C,yCAAyC,EACzC,0CAA0C,EAC3C,oCAAiC;AAQlC,qBAAa,WAAW;IACf,uBAAuB,EAAE,uBAAuB,CAAC;IACjD,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,wBAAwB,EAAE,wBAAwB,CAAC;IAE1D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;gBAEvB,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAelF;;;;;;OAMG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA0BzF;;;OAGG;IACU,8CAA8C,CACzD,OAAO,EAAE,qDAAqD,GAC7D,OAAO,CAAC,sDAAsD,CAAC;IAuElE;;;OAGG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IA0G3D;;;OAGG;IACU,6BAA6B,CACxC,OAAO,EAAE,oCAAoC,GAC5C,OAAO,CAAC,qCAAqC,CAAC;IA0BjD;;;OAGG;IACU,sCAAsC,CACjD,OAAO,EAAE,6CAA6C,GACrD,OAAO,CAAC,8CAA8C,CAAC;IAqD1D;;;;OAIG;IACU,kCAAkC,CAAC,EAC9C,SAAS,EACT,cAAc,EACd,WAAW,EACX,SAAS,GACV,EAAE,yCAAyC,GAAG,OAAO,CAAC,0CAA0C,CAAC;IAkElG,OAAO,CAAC,cAAc;CAkBvB"}
+{"version":3,"file":"group.d.ts","sourceRoot":"../../../../src/resources","sources":["group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAoC,MAAM,MAAM,CAAC;AAEtE,OAAO,EAEL,wBAAwB,EAExB,oBAAoB,EACpB,yBAAyB,EAEzB,uBAAuB,EAMvB,qBAAqB,EACrB,6BAA6B,EAC7B,0BAA0B,EAE1B,qBAAqB,EACrB,uBAAuB,EACvB,wBAAwB,EACxB,kBAAkB,EACnB,4BAAyB;AAK1B,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAC3C,OAAO,EAGL,qDAAqD,EACrD,sDAAsD,EACtD,6CAA6C,EAC7C,8CAA8C,EAC9C,oCAAoC,EACpC,qCAAqC,EACrC,oBAAoB,EACpB,qBAAqB,EACrB,8CAA8C,EAC9C,+CAA+C,EAC/C,yCAAyC,EACzC,0CAA0C,EAC3C,oCAAiC;AAQlC,qBAAa,WAAW;IACf,uBAAuB,EAAE,uBAAuB,CAAC;IACjD,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,wBAAwB,EAAE,wBAAwB,CAAC;IAE1D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;gBAEvB,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAelF;;;OAGG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA0BzF;;;OAGG;IACU,8CAA8C,CACzD,OAAO,EAAE,qDAAqD,GAC7D,OAAO,CAAC,sDAAsD,CAAC;IAsElE;;;OAGG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IA0G3D;;;OAGG;IACU,6BAA6B,CACxC,OAAO,EAAE,oCAAoC,GAC5C,OAAO,CAAC,qCAAqC,CAAC;IA0BjD;;;OAGG;IACU,sCAAsC,CACjD,OAAO,EAAE,6CAA6C,GACrD,OAAO,CAAC,8CAA8C,CAAC;IAqD1D;;;;OAIG;IACU,kCAAkC,CAAC,EAC9C,SAAS,EACT,cAAc,EACd,WAAW,EACX,SAAS,GACV,EAAE,yCAAyC,GAAG,OAAO,CAAC,0CAA0C,CAAC;IAmElG,OAAO,CAAC,cAAc;CAYvB"}

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"ipAccount.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAsB,YAAY,EAAE,MAAM,MAAM,CAAC;AAEtE,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,8BAA8B,EAC9B,+BAA+B,EAC/B,sBAAsB,EACtB,oBAAoB,EACpB,aAAa,EACb,oBAAoB,EACrB,wCAAqC;AAEtC,OAAO,EAGL,WAAW,EAEX,kBAAkB,EAClB,eAAe,EAChB,4BAAyB;AAE1B,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAE3C,OAAO,EAAE,mBAAmB,EAAE,4BAAyB;AAGvD,qBAAa,eAAe;IACnB,eAAe,EAAE,eAAe,CAAC;IACjC,WAAW,EAAE,WAAW,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;gBACvB,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAQlF;;;;;;;;;OASG;IACU,OAAO,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAgCzF;;;;;;;;;;;OAWG;IACU,cAAc,CACzB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC;IAkC3C;;;OAGG;IACU,iBAAiB,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAc9E;;;OAGG;IACU,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;IAiB5D;;OAEG;IACU,aAAa,CAAC,EACzB,IAAI,EACJ,WAAW,EACX,YAAY,EACZ,SAAS,GACV,EAAE,oBAAoB,GAAG,OAAO,CAAC,GAAG,CAAC;IAuBtC;;OAEG;IACU,aAAa,CAAC,EACzB,IAAI,EACJ,MAAM,EACN,SAAS,GACV,EAAE,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAgCvD"}
+{"version":3,"file":"ipAccount.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAsB,YAAY,EAAE,MAAM,MAAM,CAAC;AAEtE,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,8BAA8B,EAC9B,+BAA+B,EAC/B,sBAAsB,EACtB,oBAAoB,EACpB,aAAa,EACb,oBAAoB,EACrB,wCAAqC;AAEtC,OAAO,EAGL,WAAW,EAEX,kBAAkB,EAClB,eAAe,EAChB,4BAAyB;AAE1B,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAE3C,OAAO,EAAE,mBAAmB,EAAE,4BAAyB;AAGvD,qBAAa,eAAe;IACnB,eAAe,EAAE,eAAe,CAAC;IACjC,WAAW,EAAE,WAAW,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;gBACvB,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAQlF;;OAEG;IACU,OAAO,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAgCzF;;OAEG;IACU,cAAc,CACzB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC;IAkC3C;;OAEG;IACU,iBAAiB,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAU9E;;OAEG;IACU,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;IAa5D;;OAEG;IACU,aAAa,CAAC,EACzB,IAAI,EACJ,WAAW,EACX,YAAY,EACZ,SAAS,GACV,EAAE,oBAAoB,GAAG,OAAO,CAAC,GAAG,CAAC;IAuBtC;;OAEG;IACU,aAAa,CAAC,EACzB,IAAI,EACJ,MAAM,EACN,SAAS,GACV,EAAE,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAgCvD"}