@story-protocol/core-sdk 1.3.0-beta.2 → 1.3.0-rc.1

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

@@ -28,6 +28,7 @@ export declare class StoryClient {
      * @param config - the configuration for the SDK client
      */
     private constructor();
+    private get chainId();
     /**
      * Factory method for creating a SDK client with a signer.
      *

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,EACL,WAAW,EAEX,qBAAqB,EACrB,oBAAoB,EACrB,0BAAuB;AACxB,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,CAA+C;IACtE,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;IAgCP;;;;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;;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"}

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

@@ -1,6 +1,6 @@
 export { StoryClient } from "./client.js";
-export { AddressZero, HashZero } from "./constants/common.js";
-export { aeneid } from "./utils/chain.js";
+export { AddressZero, HashZero, 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";
 export { LicenseClient } from "./resources/license.js";
@@ -9,11 +9,14 @@ export { NftClient } from "./resources/nftClient.js";
 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 { RegisterRequest, RegisterIpResponse, RegisterDerivativeResponse, RegisterDerivativeRequest, RegisterDerivativeWithLicenseTokensRequest, RegisterDerivativeWithLicenseTokensResponse, MintAndRegisterIpAssetWithPilTermsRequest, MintAndRegisterIpAssetWithPilTermsResponse, RegisterIpAndMakeDerivativeRequest, RegisterIpAndMakeDerivativeResponse, RegisterIpAndAttachPilTermsRequest, RegisterIpAndAttachPilTermsResponse, MintAndRegisterIpAndMakeDerivativeRequest, MintAndRegisterIpAndMakeDerivativeResponse, GenerateCreatorMetadataParam, IpCreator, GenerateIpMetadataParam, IpMetadata, IpRelationship, IpAttribute, IpCreatorSocial, IpMedia, IPRobotTerms, StoryProtocolApp, MintAndRegisterIpRequest, RegisterPilTermsAndAttachRequest, RegisterPilTermsAndAttachResponse, MintAndRegisterIpAndMakeDerivativeWithLicenseTokensRequest, RegisterIpAndMakeDerivativeWithLicenseTokensRequest, BatchMintAndRegisterIpAssetWithPilTermsRequest, BatchMintAndRegisterIpAssetWithPilTermsResponse, BatchMintAndRegisterIpAndMakeDerivativeRequest, BatchMintAndRegisterIpAndMakeDerivativeResponse, BatchRegisterRequest, BatchRegisterResponse, BatchRegisterDerivativeRequest, BatchRegisterDerivativeResponse, RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest, RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse, RoyaltyShare, RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest, RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse, MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensRequest, MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensResponse, MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensRequest, MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensResponse, } from "./types/resources/ipAsset.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/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 { PIL_TYPE } from "./types/resources/license.js";
-export type { PayRoyaltyOnBehalfRequest, PayRoyaltyOnBehalfResponse, SnapshotRequest, SnapshotResponse, ClaimableRevenueRequest, ClaimableRevenueResponse, SnapshotAndClaimBySnapshotBatchRequest, SnapshotAndClaimBySnapshotBatchResponse, SnapshotAndClaimByTokenBatchRequest, SnapshotAndClaimByTokenBatchResponse, TransferToVaultAndSnapshotAndClaimBySnapshotBatchRequest, TransferToVaultAndSnapshotAndClaimBySnapshotBatchResponse, TransferToVaultAndSnapshotAndClaimByTokenBatchRequest, TransferToVaultAndSnapshotAndClaimByTokenBatchResponse, } from "./types/resources/royalty.js";
+export type { PayRoyaltyOnBehalfRequest, PayRoyaltyOnBehalfResponse, ClaimableRevenueRequest, ClaimableRevenueResponse, ClaimAllRevenueRequest, ClaimAllRevenueResponse, BatchClaimAllRevenueRequest, BatchClaimAllRevenueResponse, } 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";
@@ -21,7 +24,9 @@ export type { IPAccountExecuteRequest, IPAccountExecuteResponse, IPAccountExecut
 export type { CreateNFTCollectionRequest, CreateNFTCollectionResponse, } from "./types/resources/nftClient.js";
 export type { RegisterGroupRequest, RegisterGroupResponse, RegisterGroupAndAttachLicenseRequest, RegisterGroupAndAttachLicenseResponse, RegisterGroupAndAttachLicenseAndAddIpsRequest, RegisterGroupAndAttachLicenseAndAddIpsResponse, MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest, MintAndRegisterIpAndAttachLicenseAndAddToGroupResponse, RegisterIpAndAttachLicenseAndAddToGroupRequest, RegisterIpAndAttachLicenseAndAddToGroupResponse, } 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 } from "./types/options.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,8BAA2B;AAC3D,OAAO,EAAE,MAAM,EAAE,yBAAsB;AACvC,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;AAEhD,YAAY,EAAE,WAAW,EAAE,iBAAiB,EAAE,0BAAuB;AAErE,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,4BAA4B,EAC5B,SAAS,EACT,uBAAuB,EACvB,UAAU,EACV,cAAc,EACd,WAAW,EACX,eAAe,EACf,OAAO,EACP,YAAY,EACZ,gBAAgB,EAChB,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,GACrE,qCAAkC;AAEnC,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,eAAe,EACf,gBAAgB,EAChB,uBAAuB,EACvB,wBAAwB,EACxB,sCAAsC,EACtC,uCAAuC,EACvC,mCAAmC,EACnC,oCAAoC,EACpC,wDAAwD,EACxD,yDAAyD,EACzD,qDAAqD,EACrD,sDAAsD,GACvD,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,GAChD,mCAAgC;AAEjC,YAAY,EACV,wCAAwC,EACxC,0BAA0B,EAC1B,aAAa,EACb,+CAA+C,GAChD,2BAAwB;AAEzB,OAAO,EAAE,sBAAsB,EAAE,YAAY,EAAE,wBAAqB;AAEpE,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,wBAAqB;AAE1E,YAAY,EAAE,SAAS,EAAE,2BAAwB"}
+{"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,GAC7B,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,GAChD,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"}

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

@@ -1,28 +1,22 @@
-import { PublicClient } from "viem";
-import { CancelDisputeRequest, CancelDisputeResponse, RaiseDisputeRequest, RaiseDisputeResponse, ResolveDisputeRequest, ResolveDisputeResponse } from "../types/resources/dispute.js";
-import { ArbitrationPolicyUmaReadOnlyClient, DisputeModuleClient, SimpleWalletClient } from "../abi/generated.js";
-import { SupportedChainIds } from "../types/config.js";
+import { Hex, PublicClient } from "viem";
+import { CancelDisputeRequest, CancelDisputeResponse, DisputeAssertionRequest, RaiseDisputeRequest, RaiseDisputeResponse, ResolveDisputeRequest, ResolveDisputeResponse, TagIfRelatedIpInfringedRequest } from "../types/resources/dispute.js";
+import { ArbitrationPolicyUmaClient, DisputeModuleClient, Multicall3Client, SimpleWalletClient } from "../abi/generated.js";
+import { ChainIds } from "../types/config.js";
+import { TransactionResponse } from "../types/options.js";
 export declare class DisputeClient {
     disputeModuleClient: DisputeModuleClient;
-    arbitrationPolicyUmaReadOnlyClient: ArbitrationPolicyUmaReadOnlyClient;
+    arbitrationPolicyUmaClient: ArbitrationPolicyUmaClient;
+    multicall3Client: Multicall3Client;
     private readonly rpcClient;
     private readonly chainId;
-    constructor(rpcClient: PublicClient, wallet: SimpleWalletClient, chainId: SupportedChainIds);
+    private readonly wallet;
+    constructor(rpcClient: PublicClient, wallet: SimpleWalletClient, chainId: ChainIds);
     /**
-     * Raises a dispute on a given ipId
-     * @param request - The request object containing necessary data to raise a dispute.
-     *   @param request.targetIpId The IP ID that is the target of the dispute.
-     *   @param request.targetTag The target tag of the dispute.
-     *   @param request.cid CID (Content Identifier) is a unique identifier in IPFS, including CID v0 (base58) and CID v1 (base32).
-     *   @param request.liveness The liveness time.
-     *   @param request.bond The bond size.
-     *   @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to a RaiseDisputeResponse containing the transaction hash.
-     * @throws `NotRegisteredIpId` if targetIpId is not registered in the IPA Registry.
-     * @throws `NotWhitelistedDisputeTag` if targetTag is not whitelisted.
-     * @throws `ZeroLinkToDisputeEvidence` if linkToDisputeEvidence is empty
-     * @calls raiseDispute(address _targetIpId, string memory _linkToDisputeEvidence, bytes32 _targetTag, bytes calldata _data) external nonReentrant returns (uint256) {
-     * @emits DisputeRaised (disputeId_, targetIpId, msg.sender, arbitrationPolicy, linkToDisputeEvidence, targetTag, calldata);
+     * 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.
      */
     raiseDispute(request: RaiseDisputeRequest): Promise<RaiseDisputeResponse>;
     /**
@@ -51,5 +45,24 @@ export declare class DisputeClient {
      * @emits DisputeResolved (_disputeId)
      */
     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.
+     */
+    tagIfRelatedIpInfringed(request: TagIfRelatedIpInfringedRequest): Promise<TransactionResponse[]>;
+    /**
+     * Counters a dispute that was raised by another party on an IP using counter evidence.
+     *
+     * 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.
+     *
+     * If you only have a `disputeId`, call {@link disputeIdToAssertionId} to get the `assertionId` needed here.
+     */
+    disputeAssertion(request: DisputeAssertionRequest): Promise<TransactionResponse>;
+    disputeIdToAssertionId(disputeId: number | bigint): Promise<Hex>;
 }
 //# sourceMappingURL=dispute.d.ts.map

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,YAAY,EAAoC,MAAM,MAAM,CAAC;AAGtE,OAAO,EACL,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACvB,sCAAmC;AACpC,OAAO,EACL,kCAAkC,EAClC,mBAAmB,EACnB,kBAAkB,EAEnB,4BAAyB;AAG1B,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAEpD,qBAAa,aAAa;IACjB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,kCAAkC,EAAE,kCAAkC,CAAC;IAC9E,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAO3F;;;;;;;;;;;;;;;OAeG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAgEtF;;;;;;;;;;;;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;CAwB7F"}
+{"version":3,"file":"dispute.d.ts","sourceRoot":"../../../../src/resources","sources":["dispute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,YAAY,EAAoC,MAAM,MAAM,CAAC;AAG3E,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,EAEnB,4BAAyB;AAG1B,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAE3C,OAAO,EAAE,mBAAmB,EAAE,4BAAyB;AAEvD,qBAAa,aAAa;IACjB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,gBAAgB,EAAE,gBAAgB,CAAC;IAC1C,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;IASlF;;;;;;OAMG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAgEtF;;;;;;;;;;;;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;IA6BhF,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAM9E"}

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

@@ -1,6 +1,6 @@
 import { PublicClient } from "viem";
 import { CoreMetadataModuleClient, GroupingModuleClient, GroupingModuleEventClient, GroupingWorkflowsClient, IpAssetRegistryClient, LicenseRegistryReadOnlyClient, LicenseTokenReadOnlyClient, LicensingModuleClient, PiLicenseTemplateClient, SimpleWalletClient } from "../abi/generated.js";
-import { SupportedChainIds } from "../types/config.js";
+import { ChainIds } from "../types/config.js";
 import { MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest, MintAndRegisterIpAndAttachLicenseAndAddToGroupResponse, RegisterGroupAndAttachLicenseAndAddIpsRequest, RegisterGroupAndAttachLicenseAndAddIpsResponse, RegisterGroupAndAttachLicenseRequest, RegisterGroupAndAttachLicenseResponse, RegisterGroupRequest, RegisterGroupResponse, RegisterIpAndAttachLicenseAndAddToGroupRequest, RegisterIpAndAttachLicenseAndAddToGroupResponse } from "../types/resources/group.js";
 export declare class GroupClient {
     groupingWorkflowsClient: GroupingWorkflowsClient;
@@ -15,7 +15,7 @@ export declare class GroupClient {
     private readonly rpcClient;
     private readonly wallet;
     private readonly chainId;
-    constructor(rpcClient: PublicClient, wallet: SimpleWalletClient, chainId: SupportedChainIds);
+    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.
@@ -24,113 +24,24 @@ export declare class GroupClient {
      * @emits PGroupRegistered (groupId, groupPool);
      */
     registerGroup(request: RegisterGroupRequest): Promise<RegisterGroupResponse>;
-    /**  Mint an NFT from a SPGNFT collection, register it with metadata as an IP, attach license terms to the registered IP, and add it to a group IP.
-     * @param request - The request object containing necessary data to mint and register Ip and attach license and add to group.
-     *   @param request.nftContract The address of the NFT collection.
-     *   @param request.groupId The ID of the group IP to add the newly registered IP.
-     *   @param request.maxAllowedRewardShare The maximum reward share percentage that can be allocated to each member IP.
-     *   @param {Array} request.licenseData licenseData The data of the license and its configuration to be attached to the new group IP.
-     *      @param request.licenseData.licenseTermsId The ID of the registered license terms that will be attached to the new group IP.
-     *      @param request.licenseData.licenseTemplate [Optional] The address of the license template to be attached to the new group IP, default value is Programmable IP License.
-     *      @param request.licenseData.licensingConfig The licensing configuration for the IP.
-     *     @param {Object} request.licenseTermsData.licensingConfig The PIL terms and licensing configuration data to attach to the IP.
-     *       @param request.licenseTermsData.licensingConfig.isSet Whether the configuration is set or not.
-     *       @param request.licenseTermsData.licensingConfig.mintingFee The minting fee to be paid when minting license tokens.
-     *       @param request.licenseTermsData.licensingConfig.licensingHook The hook contract address for the licensing module, or address(0) if none
-     *       @param request.licenseTermsData.licensingConfig.hookData The data to be used by the licensing hook.
-     *       @param request.licenseTermsData.licensingConfig.commercialRevShare The commercial revenue share percentage.
-     *       @param request.licenseTermsData.licensingConfig.disabled Whether the licensing is disabled or not.
-     *       @param request.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.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 address(0) if the IP does not want to be added to any group.
-     *   @param request.allowDuplicates Set to true to allow minting an NFT with a duplicate metadata hash.
-     *   @param request.recipient [Optional] The address of the recipient of the minted NFT,default value is your wallet address.
-     * . @param request.deadline [Optional] The deadline for the signature in seconds, default value is 1000s.
-     *   @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] 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)
+    /** 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.
      */
     mintAndRegisterIpAndAttachLicenseAndAddToGroup(request: MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest): Promise<MintAndRegisterIpAndAttachLicenseAndAddToGroupResponse>;
     /** Register an NFT as IP with metadata, attach license terms to the registered IP, and add it to a group IP.
-     * @param request - The request object containing necessary data to register ip and attach license and add to group.
-     *   @param request.spgNftContract The address of the NFT collection.
-     *   @param request.tokenId The ID of the NFT.
-     *   @param request.maxAllowedRewardShare The maximum reward share percentage that can be allocated to each member IP.
-     *   @param request.groupId The ID of the group IP to add the newly registered IP.
-     *    @param {Array} request.licenseData licenseData The data of the license and its configuration to be attached to the new group IP.
-     *      @param request.licenseData.licenseTermsId The ID of the registered license terms that will be attached to the new group IP.
-     *      @param request.licenseData.licenseTemplate [Optional] The address of the license template to be attached to the new group IP, default value is Programmable IP License.
-     *      @param request.licenseData.licensingConfig The licensing configuration for the IP.
-     *      @param {Object} request.licenseTermsData.licensingConfig The PIL terms and licensing configuration data to attach to the IP.
-     *        @param request.licenseTermsData.licensingConfig.isSet Whether the configuration is set or not.
-     *        @param request.licenseTermsData.licensingConfig.mintingFee The minting fee to be paid when minting license tokens.
-     *        @param request.licenseTermsData.licensingConfig.licensingHook The hook contract address for the licensing module, or address(0) if none
-     *        @param request.licenseTermsData.licensingConfig.hookData The data to be used by the licensing hook.
-     *        @param request.licenseTermsData.licensingConfig.commercialRevShare The commercial revenue share percentage.
-     *        @param request.licenseTermsData.licensingConfig.disabled Whether the licensing is disabled or not.
-     *        @param request.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.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 address(0) if the IP does not want to be added to any group.
-     * . @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
-     *   @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] 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)
+     * @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.
      */
     registerIpAndAttachLicenseAndAddToGroup(request: RegisterIpAndAttachLicenseAndAddToGroupRequest): Promise<RegisterIpAndAttachLicenseAndAddToGroupResponse>;
     /** Register a group IP with a group reward pool and attach license terms to the group IP.
-     * @param request - The request object containing necessary data to register group and attach license.
-     *   @param request.groupPool The address specifying how royalty will be split amongst the pool of IPs in the group.
-     *    @param {Object} request.licenseData licenseData The data of the license and its configuration to be attached to the new group IP.
-     *      @param request.licenseData.licenseTermsId The ID of the registered license terms that will be attached to the new group IP.
-     *      @param request.licenseData.licenseTemplate [Optional] The address of the license template to be attached to the new group IP, default value is Programmable IP License.
-     *      @param request.licenseData.licensingConfig The licensing configuration for the IP.
-     *      @param {Object} request.licenseTermsData.licensingConfig The PIL terms and licensing configuration data to attach to the IP.
-     *        @param request.licenseTermsData.licensingConfig.isSet Whether the configuration is set or not.
-     *        @param request.licenseTermsData.licensingConfig.mintingFee The minting fee to be paid when minting license tokens.
-     *        @param request.licenseTermsData.licensingConfig.licensingHook The hook contract address for the licensing module, or address(0) if none
-     *        @param request.licenseTermsData.licensingConfig.hookData The data to be used by the licensing hook.
-     *        @param request.licenseTermsData.licensingConfig.commercialRevShare The commercial revenue share percentage.
-     *        @param request.licenseTermsData.licensingConfig.disabled Whether the licensing is disabled or not.
-     *        @param request.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.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 address(0) if the IP does not want to be added to any group.
-     *   @param request.txOptions [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes group id.
-     * @emits PGroupRegistered (groupId, groupPool);
+     * @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 .
      */
     registerGroupAndAttachLicense(request: RegisterGroupAndAttachLicenseRequest): Promise<RegisterGroupAndAttachLicenseResponse>;
     /** Register a group IP with a group reward pool, attach license terms to the group IP, and add individual IPs to the group IP.
-     * @param request - The request object containing necessary data to register group and attach license and add ips.
-     *   @param request.ipIds The IP IDs of the IPs to be added to the group.
-     *   @param request.groupPool The address specifying how royalty will be split amongst the pool of IPs in the group.
-     *   @param request.maxAllowedRewardShare The maximum reward share percentage that can be allocated to each member IP.
-     *   @param {Object} request.licenseData licenseData The data of the license and its configuration to be attached to the new group IP.
-     *      @param request.licenseData.licenseTermsId The ID of the registered license terms that will be attached to the new group IP.
-     *      @param request.licenseData.licenseTemplate [Optional] The address of the license template to be attached to the new group IP, default value is Programmable IP License.
-     *      @param request.licenseData.licensingConfig The licensing configuration for the IP.
-     *      @param {Object} request.licenseTermsData.licensingConfig The PIL terms and licensing configuration data to attach to the IP.
-     *        @param request.licenseTermsData.licensingConfig.isSet Whether the configuration is set or not.
-     *        @param request.licenseTermsData.licensingConfig.mintingFee The minting fee to be paid when minting license tokens.
-     *        @param request.licenseTermsData.licensingConfig.licensingHook The hook contract address for the licensing module, or address(0) if none
-     *        @param request.licenseTermsData.licensingConfig.hookData The data to be used by the licensing hook.
-     *        @param request.licenseTermsData.licensingConfig.commercialRevShare The commercial revenue share percentage.
-     *        @param request.licenseTermsData.licensingConfig.disabled Whether the licensing is disabled or not.
-     *        @param request.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.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 address(0) if the IP does not want to be added to any group.
-     *   @param request.txOptions [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
-     * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes group id.
-     * @emits PGroupRegistered (groupId, groupPool);
+     * @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.
      */
     registerGroupAndAttachLicenseAndAddIps(request: RegisterGroupAndAttachLicenseAndAddIpsRequest): Promise<RegisterGroupAndAttachLicenseAndAddIpsResponse>;
     private getLicenseData;

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,EAAuB,MAAM,MAAM,CAAC;AAEzD,OAAO,EAEL,wBAAwB,EAExB,oBAAoB,EACpB,yBAAyB,EAEzB,uBAAuB,EAMvB,qBAAqB,EACrB,6BAA6B,EAC7B,0BAA0B,EAE1B,qBAAqB,EACrB,uBAAuB,EACvB,kBAAkB,EACnB,4BAAyB;AAK1B,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AACpD,OAAO,EAGL,qDAAqD,EACrD,sDAAsD,EACtD,6CAA6C,EAC7C,8CAA8C,EAC9C,oCAAoC,EACpC,qCAAqC,EACrC,oBAAoB,EACpB,qBAAqB,EACrB,8CAA8C,EAC9C,+CAA+C,EAChD,oCAAiC;AAMlC,qBAAa,WAAW;IACf,uBAAuB,EAAE,uBAAuB,CAAC;IACjD,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,6BAA6B,EAAE,6BAA6B,CAAC;IAEpE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAc3F;;;;;;OAMG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA0BzF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACU,8CAA8C,CACzD,OAAO,EAAE,qDAAqD,GAC7D,OAAO,CAAC,sDAAsD,CAAC;IAoElE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IAwG3D;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,6BAA6B,CACxC,OAAO,EAAE,oCAAoC,GAC5C,OAAO,CAAC,qCAAqC,CAAC;IA0BjD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACU,sCAAsC,CACjD,OAAO,EAAE,6CAA6C,GACrD,OAAO,CAAC,8CAA8C,CAAC;IAsD1D,OAAO,CAAC,cAAc;CAkBvB"}
+{"version":3,"file":"group.d.ts","sourceRoot":"../../../../src/resources","sources":["group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAuB,MAAM,MAAM,CAAC;AAEzD,OAAO,EAEL,wBAAwB,EAExB,oBAAoB,EACpB,yBAAyB,EAEzB,uBAAuB,EAMvB,qBAAqB,EACrB,6BAA6B,EAC7B,0BAA0B,EAE1B,qBAAqB,EACrB,uBAAuB,EACvB,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,EAChD,oCAAiC;AAOlC,qBAAa,WAAW;IACf,uBAAuB,EAAE,uBAAuB,CAAC;IACjD,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,6BAA6B,EAAE,6BAA6B,CAAC;IAEpE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;gBAEvB,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAclF;;;;;;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;IAsD1D,OAAO,CAAC,cAAc;CAkBvB"}

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

@@ -1,10 +1,12 @@
-import { Address, PublicClient } from "viem";
-import { IPAccountExecuteRequest, IPAccountExecuteResponse, IPAccountExecuteWithSigRequest, IPAccountExecuteWithSigResponse, IpAccountStateResponse, TokenResponse } from "../types/resources/ipAccount.js";
+import { Address, Hex, PublicClient } from "viem";
+import { IPAccountExecuteRequest, IPAccountExecuteResponse, IPAccountExecuteWithSigRequest, IPAccountExecuteWithSigResponse, IpAccountStateResponse, SetIpMetadataRequest, TokenResponse } from "../types/resources/ipAccount.js";
 import { SimpleWalletClient } from "../abi/generated.js";
+import { ChainIds } from "../types/config.js";
 export declare class IPAccountClient {
     private readonly wallet;
     private readonly rpcClient;
-    constructor(rpcClient: PublicClient, wallet: SimpleWalletClient);
+    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.
@@ -39,5 +41,9 @@ export declare class IPAccountClient {
      * @returns A Promise that resolves to an object containing the chain ID, token contract address, and token ID.
      */
     getToken(ipId: Address): Promise<TokenResponse>;
+    /**
+     * Sets the metadataURI for an IP asset.
+     */
+    setIpMetadata({ ipId, metadataURI, metadataHash, txOptions, }: SetIpMetadataRequest): Promise<Hex>;
 }
 //# sourceMappingURL=ipAccount.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ipAccount.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAE7C,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,8BAA8B,EAC9B,+BAA+B,EAC/B,sBAAsB,EACtB,aAAa,EACd,wCAAqC;AAEtC,OAAO,EAAuB,kBAAkB,EAAE,4BAAyB;AAG3E,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;gBAE7B,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAK/D;;;;;;;;;OASG;IACU,OAAO,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAgCzF;;;;;;;;;;;OAWG;IACU,cAAc,CACzB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC;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;CAiB7D"}
+{"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,EACd,wCAAqC;AAEtC,OAAO,EAIL,kBAAkB,EACnB,4BAAyB;AAE1B,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAE3C,qBAAa,eAAe;IAC1B,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;IAMlF;;;;;;;;;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;CAsBvC"}