@story-protocol/core-sdk 1.2.0-rc.1 → 1.2.0-rc.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (28) hide show
  1. package/dist/declarations/src/abi/generated.d.ts +5267 -1580
  2. package/dist/declarations/src/abi/generated.d.ts.map +1 -1
  3. package/dist/declarations/src/constants/common.d.ts +1 -0
  4. package/dist/declarations/src/constants/common.d.ts.map +1 -1
  5. package/dist/declarations/src/index.d.ts +3 -3
  6. package/dist/declarations/src/index.d.ts.map +1 -1
  7. package/dist/declarations/src/resources/group.d.ts +2 -2
  8. package/dist/declarations/src/resources/group.d.ts.map +1 -1
  9. package/dist/declarations/src/resources/ipAccount.d.ts +2 -2
  10. package/dist/declarations/src/resources/ipAccount.d.ts.map +1 -1
  11. package/dist/declarations/src/resources/ipAsset.d.ts +279 -41
  12. package/dist/declarations/src/resources/ipAsset.d.ts.map +1 -1
  13. package/dist/declarations/src/resources/permission.d.ts +2 -1
  14. package/dist/declarations/src/resources/permission.d.ts.map +1 -1
  15. package/dist/declarations/src/types/resources/ipAccount.d.ts +1 -1
  16. package/dist/declarations/src/types/resources/ipAccount.d.ts.map +1 -1
  17. package/dist/declarations/src/types/resources/ipAsset.d.ts +164 -26
  18. package/dist/declarations/src/types/resources/ipAsset.d.ts.map +1 -1
  19. package/dist/declarations/src/types/resources/permission.d.ts +14 -2
  20. package/dist/declarations/src/types/resources/permission.d.ts.map +1 -1
  21. package/dist/declarations/src/utils/chain.d.ts +1 -1
  22. package/dist/declarations/src/utils/chain.d.ts.map +1 -1
  23. package/dist/declarations/src/utils/sign.d.ts +16 -3
  24. package/dist/declarations/src/utils/sign.d.ts.map +1 -1
  25. package/dist/story-protocol-core-sdk.cjs.dev.js +2545 -933
  26. package/dist/story-protocol-core-sdk.cjs.prod.js +2545 -933
  27. package/dist/story-protocol-core-sdk.esm.js +2545 -934
  28. package/package.json +1 -1
@@ -10,17 +10,17 @@ export { IPAccountClient } from "./resources/ipAccount.js";
10
10
  export { RoyaltyClient } from "./resources/royalty.js";
11
11
  export { GroupClient } from "./resources/group.js";
12
12
  export type { StoryConfig, SupportedChainIds } from "./types/config.js";
13
- export type { RegisterRequest, RegisterIpResponse, RegisterDerivativeResponse, RegisterDerivativeRequest, RegisterDerivativeWithLicenseTokensRequest, RegisterDerivativeWithLicenseTokensResponse, CreateIpAssetWithPilTermsRequest, CreateIpAssetWithPilTermsResponse, RegisterIpAndMakeDerivativeRequest, RegisterIpAndMakeDerivativeResponse, RegisterIpAndAttachPilTermsRequest, RegisterIpAndAttachPilTermsResponse, MintAndRegisterIpAndMakeDerivativeRequest, GenerateCreatorMetadataParam, IpCreator, GenerateIpMetadataParam, IpMetadata, IpRelationship, IpAttribute, IpCreatorSocial, IpMedia, IPRobotTerms, StoryProtocolApp, MintAndRegisterIpRequest, RegisterPilTermsAndAttachRequest, RegisterPilTermsAndAttachResponse, MintAndRegisterIpAndMakeDerivativeWithLicenseTokensRequest, RegisterIpAndMakeDerivativeWithLicenseTokensRequest, } from "./types/resources/ipAsset.js";
13
+ 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";
14
14
  export type { RegisterNonComSocialRemixingPILRequest, RegisterCommercialUsePILRequest, RegisterCommercialRemixPILRequest, RegisterPILResponse, AttachLicenseTermsRequest, AttachLicenseTermsResponse, MintLicenseTokensRequest, MintLicenseTokensResponse, LicenseTermsId, LicenseTerms, PredictMintingLicenseFeeRequest, SetLicensingConfigRequest, SetLicensingConfigResponse, } from "./types/resources/license.js";
15
15
  export { PIL_TYPE } from "./types/resources/license.js";
16
16
  export type { PayRoyaltyOnBehalfRequest, PayRoyaltyOnBehalfResponse, SnapshotRequest, SnapshotResponse, ClaimableRevenueRequest, ClaimableRevenueResponse, SnapshotAndClaimBySnapshotBatchRequest, SnapshotAndClaimBySnapshotBatchResponse, SnapshotAndClaimByTokenBatchRequest, SnapshotAndClaimByTokenBatchResponse, TransferToVaultAndSnapshotAndClaimBySnapshotBatchRequest, TransferToVaultAndSnapshotAndClaimBySnapshotBatchResponse, TransferToVaultAndSnapshotAndClaimByTokenBatchRequest, TransferToVaultAndSnapshotAndClaimByTokenBatchResponse, } from "./types/resources/royalty.js";
17
- export type { SetPermissionsRequest, SetPermissionsResponse, CreateSetPermissionSignatureRequest, SetAllPermissionsRequest, SetBatchPermissionsRequest, CreateBatchPermissionSignatureRequest, PermissionSignatureRequest, PermissionSignatureResponse, } from "./types/resources/permission.js";
17
+ export type { SetPermissionsRequest, SetPermissionsResponse, CreateSetPermissionSignatureRequest, SetAllPermissionsRequest, SetBatchPermissionsRequest, CreateBatchPermissionSignatureRequest, PermissionSignatureRequest, SignatureRequest, SignatureResponse, } from "./types/resources/permission.js";
18
18
  export { AccessPermission } from "./types/resources/permission.js";
19
19
  export type { RaiseDisputeRequest, RaiseDisputeResponse, CancelDisputeRequest, CancelDisputeResponse, ResolveDisputeRequest, ResolveDisputeResponse, } from "./types/resources/dispute.js";
20
20
  export type { IPAccountExecuteRequest, IPAccountExecuteResponse, IPAccountExecuteWithSigRequest, IPAccountExecuteWithSigResponse, IpAccountStateResponse, TokenResponse, } from "./types/resources/ipAccount.js";
21
21
  export type { CreateNFTCollectionRequest, CreateNFTCollectionResponse, } from "./types/resources/nftClient.js";
22
22
  export type { RegisterGroupRequest, RegisterGroupResponse, RegisterGroupAndAttachLicenseRequest, RegisterGroupAndAttachLicenseResponse, RegisterGroupAndAttachLicenseAndAddIpsRequest, RegisterGroupAndAttachLicenseAndAddIpsResponse, MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest, MintAndRegisterIpAndAttachLicenseAndAddToGroupResponse, RegisterIpAndAttachLicenseAndAddToGroupRequest, RegisterIpAndAttachLicenseAndAddToGroupResponse, } from "./types/resources/group.js";
23
23
  export type { PiLicenseTemplateGetLicenseTermsResponse, IpAccountImplStateResponse, EncodedTxData, LicensingModulePredictMintingLicenseFeeResponse, } from "./abi/generated.js";
24
- export { getPermissionSignature } from "./utils/sign.js";
24
+ export { getPermissionSignature, getSignature } from "./utils/sign.js";
25
25
  export { convertCIDtoHashIPFS, convertHashIPFStoCID } from "./utils/ipfs.js";
26
26
  //# sourceMappingURL=index.d.ts.map
@@ -1 +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,OAAO,EAAE,yBAAsB;AACxC,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,gCAAgC,EAChC,iCAAiC,EACjC,kCAAkC,EAClC,mCAAmC,EACnC,kCAAkC,EAClC,mCAAmC,EACnC,yCAAyC,EACzC,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,GACpD,qCAAkC;AAEnC,YAAY,EACV,sCAAsC,EACtC,+BAA+B,EAC/B,iCAAiC,EACjC,mBAAmB,EACnB,yBAAyB,EACzB,0BAA0B,EAC1B,wBAAwB,EACxB,yBAAyB,EACzB,cAAc,EACd,YAAY,EACZ,+BAA+B,EAC/B,yBAAyB,EACzB,0BAA0B,GAC3B,qCAAkC;AACnC,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,2BAA2B,GAC5B,wCAAqC;AACtC,OAAO,EAAE,gBAAgB,EAAE,wCAAqC;AAChE,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;AACjC,YAAY,EACV,wCAAwC,EACxC,0BAA0B,EAC1B,aAAa,EACb,+CAA+C,GAChD,2BAAwB;AAEzB,OAAO,EAAE,sBAAsB,EAAE,wBAAqB;AACtD,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,wBAAqB"}
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,OAAO,EAAE,yBAAsB;AACxC,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,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"}
@@ -31,7 +31,7 @@ export declare class GroupClient {
31
31
  * @param request.licenseTermsId The ID of the registered license terms that will be attached to the new IP.
32
32
  * @param request.recipient [Optional] The address of the recipient of the minted NFT,default value is your wallet address.
33
33
  * @param request.licenseTemplate [Optional] The address of the license template to be attached to the new group IP,default value is Programmable IP License.
34
- * . @param request.deadline [Optional] The deadline for the signature in milliseconds,default value is 1000ms.
34
+ * . @param request.deadline [Optional] The deadline for the signature in seconds, default value is 1000s.
35
35
  * @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
36
36
  * @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
37
37
  * @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
@@ -49,7 +49,7 @@ export declare class GroupClient {
49
49
  * @param request.groupId The ID of the group IP to add the newly registered IP.
50
50
  * @param request.licenseTermsId The ID of the registered license terms that will be attached to the new IP.
51
51
  * @param request.licenseTemplate [Optional] The address of the license template to be attached to the new group IP,default value is Programmable IP License.
52
- * . @param request.deadline [Optional] The deadline for the signature in milliseconds,default is 1000ms.
52
+ * . @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
53
53
  * @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
54
54
  * @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
55
55
  * @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
@@ -1 +1 @@
1
- {"version":3,"file":"group.d.ts","sourceRoot":"../../../../src/resources","sources":["group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAiC,MAAM,MAAM,CAAC;AAEnE,OAAO,EACL,wBAAwB,EACxB,oBAAoB,EACpB,yBAAyB,EAEzB,uBAAuB,EAKvB,qBAAqB,EACrB,6BAA6B,EAC7B,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACvB,kBAAkB,EACnB,4BAAyB;AAK1B,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AACpD,OAAO,EACL,qDAAqD,EACrD,sDAAsD,EACtD,6CAA6C,EAC7C,8CAA8C,EAC9C,oCAAoC,EACpC,qCAAqC,EACrC,oBAAoB,EACpB,qBAAqB,EACrB,8CAA8C,EAC9C,+CAA+C,EAChD,oCAAiC;AAElC,qBAAa,WAAW;IACf,uBAAuB,EAAE,uBAAuB,CAAC;IACjD,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,6BAA6B,EAAE,6BAA6B,CAAC;IAEpE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAc3F;;;;;;OAMG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA0BzF;;;;;;;;;;;;;;;;OAgBG;IACU,8CAA8C,CACzD,OAAO,EAAE,qDAAqD,GAC7D,OAAO,CAAC,sDAAsD,CAAC;IA0ElE;;;;;;;;;;;;;;;;OAgBG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IAsG3D;;;;;;;;OAQG;IACU,6BAA6B,CACxC,OAAO,EAAE,oCAAoC,GAC5C,OAAO,CAAC,qCAAqC,CAAC;IA8BjD;;;;;;;;;OASG;IACU,sCAAsC,CACjD,OAAO,EAAE,6CAA6C,GACrD,OAAO,CAAC,8CAA8C,CAAC;CAyD3D"}
1
+ {"version":3,"file":"group.d.ts","sourceRoot":"../../../../src/resources","sources":["group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAiC,MAAM,MAAM,CAAC;AAEnE,OAAO,EACL,wBAAwB,EACxB,oBAAoB,EACpB,yBAAyB,EAEzB,uBAAuB,EAKvB,qBAAqB,EACrB,6BAA6B,EAC7B,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACvB,kBAAkB,EACnB,4BAAyB;AAK1B,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AACpD,OAAO,EACL,qDAAqD,EACrD,sDAAsD,EACtD,6CAA6C,EAC7C,8CAA8C,EAC9C,oCAAoC,EACpC,qCAAqC,EACrC,oBAAoB,EACpB,qBAAqB,EACrB,8CAA8C,EAC9C,+CAA+C,EAChD,oCAAiC;AAElC,qBAAa,WAAW;IACf,uBAAuB,EAAE,uBAAuB,CAAC;IACjD,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,6BAA6B,EAAE,6BAA6B,CAAC;IAEpE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAc3F;;;;;;OAMG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA0BzF;;;;;;;;;;;;;;;;OAgBG;IACU,8CAA8C,CACzD,OAAO,EAAE,qDAAqD,GAC7D,OAAO,CAAC,sDAAsD,CAAC;IA2ElE;;;;;;;;;;;;;;;;OAgBG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IAyG3D;;;;;;;;OAQG;IACU,6BAA6B,CACxC,OAAO,EAAE,oCAAoC,GAC5C,OAAO,CAAC,qCAAqC,CAAC;IA8BjD;;;;;;;;;OASG;IACU,sCAAsC,CACjD,OAAO,EAAE,6CAA6C,GACrD,OAAO,CAAC,8CAA8C,CAAC;CAyD3D"}
@@ -20,12 +20,12 @@ export declare class IPAccountClient {
20
20
  * @param request - The request object containing necessary data to execute IP Account a transaction.
21
21
  * @param request.ipId The Ip Id to get ip account.
22
22
  * @param request.to The recipient of the transaction.
23
- * @param request.value The amount of Ether to send.
24
23
  * @param request.data The data to send along with the transaction.
25
24
  * @param request.signer The signer of the transaction.
26
25
  * @param request.deadline The deadline of the transaction signature.
27
26
  * @param request.signature The signature of the transaction, EIP-712 encoded.
28
- * @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
27
+ * @param request.value [Optional] The amount of Ether to send.
28
+ * @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
29
29
  * @returns Tx hash for the transaction.
30
30
  */
31
31
  executeWithSig(request: IPAccountExecuteWithSigRequest): Promise<IPAccountExecuteWithSigResponse>;
@@ -1 +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;IAmC3C;;;OAGG;IACU,iBAAiB,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAc9E;;;OAGG;IACU,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;CAiB7D"}
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"}
@@ -1,7 +1,7 @@
1
- import { PublicClient } from "viem";
1
+ import { Hex, PublicClient } from "viem";
2
2
  import { SupportedChainIds } from "../types/config.js";
3
- import { CreateIpAssetWithPilTermsRequest, CreateIpAssetWithPilTermsResponse, GenerateCreatorMetadataParam, GenerateIpMetadataParam, IpCreator, IpMetadata, MintAndRegisterIpAndMakeDerivativeRequest, MintAndRegisterIpAndMakeDerivativeWithLicenseTokensRequest, MintAndRegisterIpRequest, RegisterDerivativeRequest, RegisterDerivativeResponse, RegisterDerivativeWithLicenseTokensRequest, RegisterDerivativeWithLicenseTokensResponse, RegisterIpAndAttachPilTermsRequest, RegisterIpAndAttachPilTermsResponse, RegisterIpAndMakeDerivativeRequest, RegisterIpAndMakeDerivativeResponse, RegisterIpAndMakeDerivativeWithLicenseTokensRequest, RegisterIpResponse, RegisterPilTermsAndAttachRequest, RegisterPilTermsAndAttachResponse, RegisterRequest } from "../types/resources/ipAsset.js";
4
- import { AccessControllerClient, CoreMetadataModuleClient, DerivativeWorkflowsClient, IpAssetRegistryClient, LicenseAttachmentWorkflowsClient, LicenseRegistryReadOnlyClient, LicenseTokenReadOnlyClient, LicensingModuleClient, PiLicenseTemplateClient, RegistrationWorkflowsClient, SimpleWalletClient } from "../abi/generated.js";
3
+ import { BatchMintAndRegisterIpAndMakeDerivativeRequest, BatchMintAndRegisterIpAndMakeDerivativeResponse, BatchMintAndRegisterIpAssetWithPilTermsRequest, BatchMintAndRegisterIpAssetWithPilTermsResponse, BatchRegisterDerivativeRequest, BatchRegisterDerivativeResponse, BatchRegisterRequest, BatchRegisterResponse, MintAndRegisterIpAssetWithPilTermsRequest, MintAndRegisterIpAssetWithPilTermsResponse, GenerateCreatorMetadataParam, GenerateIpMetadataParam, IpCreator, IpMetadata, MintAndRegisterIpAndMakeDerivativeRequest, MintAndRegisterIpAndMakeDerivativeWithLicenseTokensRequest, MintAndRegisterIpRequest, RegisterDerivativeRequest, RegisterDerivativeResponse, RegisterDerivativeWithLicenseTokensRequest, RegisterDerivativeWithLicenseTokensResponse, RegisterIpAndAttachPilTermsRequest, RegisterIpAndAttachPilTermsResponse, RegisterIpAndMakeDerivativeRequest, RegisterIpAndMakeDerivativeResponse, RegisterIpAndMakeDerivativeWithLicenseTokensRequest, RegisterIpResponse, RegisterPilTermsAndAttachRequest, RegisterPilTermsAndAttachResponse, RegisterRequest, MintAndRegisterIpAndMakeDerivativeResponse, RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest, RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse, RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest, RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse, MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensRequest, MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensRequest, MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensResponse, MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensResponse } from "../types/resources/ipAsset.js";
4
+ import { AccessControllerClient, CoreMetadataModuleClient, DerivativeWorkflowsClient, IpAssetRegistryClient, LicenseAttachmentWorkflowsClient, LicenseRegistryReadOnlyClient, LicenseTokenReadOnlyClient, LicensingModuleClient, Multicall3Client, PiLicenseTemplateClient, RegistrationWorkflowsClient, RoyaltyModuleEventClient, RoyaltyTokenDistributionWorkflowsClient, SimpleWalletClient } from "../abi/generated.js";
5
5
  export declare class IPAssetClient {
6
6
  licensingModuleClient: LicensingModuleClient;
7
7
  ipAssetRegistryClient: IpAssetRegistryClient;
@@ -13,6 +13,9 @@ export declare class IPAssetClient {
13
13
  registrationWorkflowsClient: RegistrationWorkflowsClient;
14
14
  licenseAttachmentWorkflowsClient: LicenseAttachmentWorkflowsClient;
15
15
  derivativeWorkflowsClient: DerivativeWorkflowsClient;
16
+ multicall3Client: Multicall3Client;
17
+ royaltyTokenDistributionWorkflowsClient: RoyaltyTokenDistributionWorkflowsClient;
18
+ royaltyModuleEventClient: RoyaltyModuleEventClient;
16
19
  private readonly rpcClient;
17
20
  private readonly wallet;
18
21
  private readonly chainId;
@@ -82,12 +85,28 @@ export declare class IPAssetClient {
82
85
  * @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
83
86
  * @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
84
87
  * @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
85
- * @param request.deadline [Optional] The deadline for the signature in milliseconds, default is 1000ms.
88
+ * @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
86
89
  * @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
87
90
  * @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.
88
91
  * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, resolverAddr, metadataProviderAddress, metadata)
89
92
  */
90
93
  register(request: RegisterRequest): Promise<RegisterIpResponse>;
94
+ /**
95
+ * Batch registers an NFT as IP, creating a corresponding IP record.
96
+ * @param request - The request object that contains all data needed to batch register IP.
97
+ * @param {Array} request.args The array of objects containing the data needed to register IP.
98
+ * @param request.args.nftContract The address of the NFT.
99
+ * @param request.args.tokenId The token identifier of the NFT.
100
+ * @param request.args.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
101
+ * @param request.args.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
102
+ * @param request.args.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
103
+ * @param request.args.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
104
+ * @param request.args.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
105
+ * @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property, without encodedTxDataOnly option.
106
+ * @returns A Promise that resolves to a transaction hash, if waitForTransaction is true, return an array of containing IP ID, Token ID, NFT Contract.
107
+ * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, resolverAddr, metadataProviderAddress, metadata)
108
+ */
109
+ batchRegister(request: BatchRegisterRequest): Promise<BatchRegisterResponse>;
91
110
  /**
92
111
  * Registers a derivative directly with parent IP's license terms, without needing license tokens,
93
112
  * and attaches the license terms of the parent IPs to the derivative IP.
@@ -99,9 +118,21 @@ export declare class IPAssetClient {
99
118
  * @param request.parentIpIds The parent IP IDs.
100
119
  * @param request.licenseTermsIds The IDs of the license terms that the parent IP supports.
101
120
  * @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
102
- * @returns A Promise that resolves to an object containing the transaction hash.
121
+ * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data.
103
122
  */
104
123
  registerDerivative(request: RegisterDerivativeRequest): Promise<RegisterDerivativeResponse>;
124
+ /**
125
+ * Batch registers a derivative directly with parent IP's license terms.
126
+ * @param request - The request object that contains all data needed to batch register derivative IP.
127
+ * @param {Array} request.args The array of objects containing the data needed to register derivative IP.
128
+ * @param request.args.childIpId The derivative IP ID.
129
+ * @param request.args.parentIpIds The parent IP IDs.
130
+ * @param request.args.licenseTermsIds The IDs of the license terms that the parent IP supports.
131
+ * @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
132
+ * @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property, without encodedTxDataOnly option.
133
+ * @returns A Promise that resolves to a transaction hash.
134
+ */
135
+ batchRegisterDerivative(request: BatchRegisterDerivativeRequest): Promise<BatchRegisterDerivativeResponse>;
105
136
  /**
106
137
  * Registers a derivative with license tokens.
107
138
  * the derivative IP is registered with license tokens minted from the parent IP's license terms.
@@ -118,41 +149,102 @@ export declare class IPAssetClient {
118
149
  * Mint an NFT from a collection and register it as an IP.
119
150
  * @param request - The request object that contains all data needed to mint and register ip.
120
151
  * @param request.spgNftContract The address of the NFT collection.
121
- * @param request.pilType The type of the PIL.
152
+ * @param {Array} request.terms The array of license terms to be attached.
153
+ * @param request.terms.transferable Indicates whether the license is transferable or not.
154
+ * @param request.terms.royaltyPolicy The address of the royalty policy contract which required to StoryProtocol in advance.
155
+ * @param request.terms.mintingFee The fee to be paid when minting a license.
156
+ * @param request.terms.expiration The expiration period of the license.
157
+ * @param request.terms.commercialUse Indicates whether the work can be used commercially or not.
158
+ * @param request.terms.commercialAttribution Whether attribution is required when reproducing the work commercially or not.
159
+ * @param request.terms.commercializerChecker Commercializers that are allowed to commercially exploit the work. If zero address, then no restrictions is enforced.
160
+ * @param request.terms.commercializerCheckerData The data to be passed to the commercializer checker contract.
161
+ * @param request.terms.commercialRevShare Percentage of revenue that must be shared with the licensor.
162
+ * @param request.terms.commercialRevCeiling The maximum revenue that can be generated from the commercial use of the work.
163
+ * @param request.terms.derivativesAllowed Indicates whether the licensee can create derivatives of his work or not.
164
+ * @param request.terms.derivativesAttribution Indicates whether attribution is required for derivatives of the work or not.
165
+ * @param request.terms.derivativesApproval Indicates whether the licensor must approve derivatives of the work before they can be linked to the licensor IP ID or not.
166
+ * @param request.terms.derivativesReciprocal Indicates whether the licensee must license derivatives of the work under the same terms or not.
167
+ * @param request.terms.derivativeRevCeiling The maximum revenue that can be generated from the derivative use of the work.
168
+ * @param request.terms.currency The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
169
+ * @param request.terms.uri The URI of the license terms, which can be used to fetch the offchain license terms.
122
170
  * @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
123
- * @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
124
- * @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
125
- * @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
126
- * @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
127
- * @param request.royaltyPolicyAddress [Optional] The address of the royalty policy contract, default value is LAP.
171
+ * @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
172
+ * @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
173
+ * @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
174
+ * @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
128
175
  * @param request.recipient [Optional] The address of the recipient of the minted NFT,default value is your wallet address.
129
- * @param request.mintingFee [Optional] The fee to be paid when minting a license.
130
- * @param request.commercialRevShare [Optional] Percentage of revenue that must be shared with the licensor.
131
- * @param request.currency [Optional] The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
132
176
  * @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
133
- * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes IP ID, Token ID, License Terms Id.
177
+ * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, including IP ID, Token ID, License Terms Ids.
178
+ * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
179
+ * @emits LicenseTermsAttached (caller, ipId, licenseTemplate, licenseTermsId)
180
+ */
181
+ mintAndRegisterIpAssetWithPilTerms(request: MintAndRegisterIpAssetWithPilTermsRequest): Promise<MintAndRegisterIpAssetWithPilTermsResponse>;
182
+ /**
183
+ * Batch mint an NFT from a collection and register it as an IP.
184
+ * @param request - The request object that contains all data needed to batch mint and register ip.
185
+ * @param {Array} request.args The array of mint and register IP requests.
186
+ * @param request.args.spgNftContract The address of the NFT collection.
187
+ * @param {Array} request.args.terms The array of license terms to be attached.
188
+ * @param request.args.terms.transferable Indicates whether the license is transferable or not.
189
+ * @param request.args.terms.royaltyPolicy The address of the royalty policy contract which required to StoryProtocol in advance.
190
+ * @param request.args.terms.mintingFee The fee to be paid when minting a license.
191
+ * @param request.args.terms.expiration The expiration period of the license.
192
+ * @param request.args.terms.commercialUse Indicates whether the work can be used commercially or not.
193
+ * @param request.args.terms.commercialAttribution Whether attribution is required when reproducing the work commercially or not.
194
+ * @param request.args.terms.commercializerChecker Commercializers that are allowed to commercially exploit the work. If zero address, then no restrictions is enforced.
195
+ * @param request.args.terms.commercializerCheckerData The data to be passed to the commercializer checker contract.
196
+ * @param request.args.terms.commercialRevShare Percentage of revenue that must be shared with the licensor.
197
+ * @param request.args.terms.commercialRevCeiling The maximum revenue that can be generated from the commercial use of the work.
198
+ * @param request.args.terms.derivativesAllowed Indicates whether the licensee can create derivatives of his work or not.
199
+ * @param request.args.terms.derivativesAttribution Indicates whether attribution is required for derivatives of the work or not.
200
+ * @param request.args.terms.derivativesApproval Indicates whether the licensor must approve derivatives of the work before they can be linked to the licensor IP ID or not.
201
+ * @param request.args.terms.derivativesReciprocal Indicates whether the licensee must license derivatives of the work under the same terms or not.
202
+ * @param request.args.terms.derivativeRevCeiling The maximum revenue that can be generated from the derivative use of the work.
203
+ * @param request.args.terms.currency The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
204
+ * @param request.args.terms.uri The URI of the license terms, which can be used to fetch the offchain license terms.
205
+ * @param request.args.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
206
+ * @param request.args.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
207
+ * @param request.args.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
208
+ * @param request.args.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
209
+ * @param request.args.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
210
+ * @param request.args.recipient [Optional] The address of the recipient of the minted NFT,default value is your wallet address.
211
+ * @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property, without encodedTxData option.
212
+ * @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.
134
213
  * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
135
214
  * @emits LicenseTermsAttached (caller, ipId, licenseTemplate, licenseTermsId)
136
215
  */
137
- mintAndRegisterIpAssetWithPilTerms(request: CreateIpAssetWithPilTermsRequest): Promise<CreateIpAssetWithPilTermsResponse>;
216
+ batchMintAndRegisterIpAssetWithPilTerms(request: BatchMintAndRegisterIpAssetWithPilTermsRequest): Promise<BatchMintAndRegisterIpAssetWithPilTermsResponse>;
138
217
  /**
139
218
  * Register a given NFT as an IP and attach Programmable IP License Terms.R.
140
219
  * @param request - The request object that contains all data needed to mint and register ip.
141
220
  * @param request.nftContract The address of the NFT collection.
142
221
  * @param request.tokenId The ID of the NFT.
143
- * @param request.pilType The type of the PIL.
222
+ * @param {Array} request.terms The array of license terms to be attached.
223
+ * @param request.terms.transferable Indicates whether the license is transferable or not.
224
+ * @param request.terms.royaltyPolicy The address of the royalty policy contract which required to StoryProtocol in advance.
225
+ * @param request.terms.mintingFee The fee to be paid when minting a license.
226
+ * @param request.terms.expiration The expiration period of the license.
227
+ * @param request.terms.commercialUse Indicates whether the work can be used commercially or not.
228
+ * @param request.terms.commercialAttribution Whether attribution is required when reproducing the work commercially or not.
229
+ * @param request.terms.commercializerChecker Commercializers that are allowed to commercially exploit the work. If zero address, then no restrictions is enforced.
230
+ * @param request.terms.commercializerCheckerData The data to be passed to the commercializer checker contract.
231
+ * @param request.terms.commercialRevShare Percentage of revenue that must be shared with the licensor.
232
+ * @param request.terms.commercialRevCeiling The maximum revenue that can be generated from the commercial use of the work.
233
+ * @param request.terms.derivativesAllowed Indicates whether the licensee can create derivatives of his work or not.
234
+ * @param request.terms.derivativesAttribution Indicates whether attribution is required for derivatives of the work or not.
235
+ * @param request.terms.derivativesApproval Indicates whether the licensor must approve derivatives of the work before they can be linked to the licensor IP ID or not.
236
+ * @param request.terms.derivativesReciprocal Indicates whether the licensee must license derivatives of the work under the same terms or not.
237
+ * @param request.terms.derivativeRevCeiling The maximum revenue that can be generated from the derivative use of the work.
238
+ * @param request.terms.currency The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
239
+ * @param request.terms.uri The URI of the license terms, which can be used to fetch the offchain license terms.
144
240
  * @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
145
241
  * @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
146
242
  * @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
147
243
  * @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
148
244
  * @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
149
- * @param request.royaltyPolicyAddress [Optional] The address of the royalty policy contract, default value is LAP.
150
- * @param request.deadline [Optional] The deadline for the signature in milliseconds, default is 1000ms.
151
- * @param request.mintingFee [Optional] The fee to be paid when minting a license.
152
- * @param request.commercialRevShare [Optional] Percentage of revenue that must be shared with the licensor.
153
- * @param request.currency [Optional] The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
245
+ * @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
154
246
  * @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
155
- * @returns A Promise that resolves to an object containing the transaction hash and optional IP ID, License Terms Id if waitForTxn is set to true.
247
+ * @returns A Promise that resolves to a transaction hash, if waitForTransaction is true, including IP ID, token ID and License terms IDs.
156
248
  * @emits LicenseTermsAttached (caller, ipId, licenseTemplate, licenseTermsId)
157
249
  */
158
250
  registerIpAndAttachPilTerms(request: RegisterIpAndAttachPilTermsRequest): Promise<RegisterIpAndAttachPilTermsResponse>;
@@ -170,9 +262,9 @@ export declare class IPAssetClient {
170
262
  * @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
171
263
  * @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
172
264
  * @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
173
- * @param request.deadline [Optional] The deadline for the signature in milliseconds,default is 1000ms.
265
+ * @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
174
266
  * @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
175
- * @returns A Promise that resolves to an object containing the transaction hash and optional IP ID if waitForTxn is set to true.
267
+ * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, included IP ID, Token ID.
176
268
  * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
177
269
  */
178
270
  registerDerivativeIp(request: RegisterIpAndMakeDerivativeRequest): Promise<RegisterIpAndMakeDerivativeResponse>;
@@ -181,20 +273,40 @@ export declare class IPAssetClient {
181
273
  * @param request - The request object that contains all data needed to mint and register ip and make derivative.
182
274
  * @param request.spgNftContract The address of the NFT collection.
183
275
  * @param request.derivData The derivative data to be used for registerDerivative.
184
- * @param request.derivData.parentIpIds The IDs of the parent IPs to link the registered derivative IP.
185
- * @param request.derivData.licenseTermsIds The IDs of the license terms to be used for the linking.
186
- * @param request.derivData.licenseTemplate [Optional] The address of the license template to be used for the linking.
276
+ * @param request.derivData.parentIpIds The IDs of the parent IPs to link the registered derivative IP.
277
+ * @param request.derivData.licenseTermsIds The IDs of the license terms to be used for the linking.
278
+ * @param request.derivData.licenseTemplate [Optional] The address of the license template to be used for the linking.
187
279
  * @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
188
- * @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
189
- * @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
190
- * @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
191
- * @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
280
+ * @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
281
+ * @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
282
+ * @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
283
+ * @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
192
284
  * @param request.recipient [Optional] The address of the recipient of the minted NFT,default value is your wallet address.
193
285
  * @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
194
- * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes child ip id and token id.
286
+ * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes child IP ID and token ID.
287
+ * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
288
+ */
289
+ mintAndRegisterIpAndMakeDerivative(request: MintAndRegisterIpAndMakeDerivativeRequest): Promise<MintAndRegisterIpAndMakeDerivativeResponse>;
290
+ /**
291
+ * Batch mint an NFT from a collection and register it as a derivative IP without license tokens.
292
+ * @param request - The request object that contains all data needed to batch mint and register ip and make derivative.
293
+ * @param {Array} request.args The array of mint and register IP requests.
294
+ * @param request.args.spgNftContract The address of the NFT collection.
295
+ * @param request.args.derivData The derivative data to be used for registerDerivative.
296
+ * @param request.args.derivData.parentIpIds The IDs of the parent IPs to link the registered derivative IP.
297
+ * @param request.args.derivData.licenseTermsIds The IDs of the license terms to be used for the linking.
298
+ * @param request.args.derivData.licenseTemplate [Optional] The address of the license template to be used for the linking.
299
+ * @param request.args.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
300
+ * @param request.args.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
301
+ * @param request.args.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
302
+ * @param request.args.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
303
+ * @param request.args.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
304
+ * @param request.arg.recipient [Optional] The address of the recipient of the minted NFT,default value is your wallet address.
305
+ * @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property, without encodedTxData option.
306
+ * @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.
195
307
  * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
196
308
  */
197
- mintAndRegisterIpAndMakeDerivative(request: MintAndRegisterIpAndMakeDerivativeRequest): Promise<RegisterDerivativeResponse>;
309
+ batchMintAndRegisterIpAndMakeDerivative(request: BatchMintAndRegisterIpAndMakeDerivativeRequest): Promise<BatchMintAndRegisterIpAndMakeDerivativeResponse>;
198
310
  /**
199
311
  * Mint an NFT from a SPGNFT collection and register it with metadata as an IP.
200
312
  * @param request - The request object that contains all data needed to attach license terms.
@@ -214,7 +326,7 @@ export declare class IPAssetClient {
214
326
  * Register Programmable IP License Terms (if unregistered) and attach it to IP.
215
327
  * @param request - The request object that contains all data needed to attach license terms.
216
328
  * @param request.ipId The ID of the IP.
217
- * @param request.terms The PIL terms to be registered.
329
+ * @param {Array} request.terms The array of license terms to be attached.
218
330
  * @param request.terms.transferable Indicates whether the license is transferable or not.
219
331
  * @param request.terms.royaltyPolicy The address of the royalty policy contract which required to StoryProtocol in advance.
220
332
  * @param request.terms.mintingFee The fee to be paid when minting a license.
@@ -232,9 +344,9 @@ export declare class IPAssetClient {
232
344
  * @param request.terms.derivativeRevCeiling The maximum revenue that can be generated from the derivative use of the work.
233
345
  * @param request.terms.currency The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
234
346
  * @param request.terms.uri The URI of the license terms, which can be used to fetch the offchain license terms.
235
- * @param request.deadline [Optional] The deadline for the signature in milliseconds,default is 1000ms.
347
+ * @param request.deadline [Optional] The deadline for the signature in milliseconds, default is 1000s.
236
348
  * @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
237
- * @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.
349
+ * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, returns an array containing the license terms ID.
238
350
  * @emits LicenseTermsAttached (caller, ipId, licenseTemplate, licenseTermsId)
239
351
  */
240
352
  registerPilTermsAndAttach(request: RegisterPilTermsAndAttachRequest): Promise<RegisterPilTermsAndAttachResponse>;
@@ -260,20 +372,146 @@ export declare class IPAssetClient {
260
372
  * @param request.nftContract The address of the NFT collection.
261
373
  * @param request.licenseTokenIds The IDs of the license tokens to be burned for linking the IP to parent IPs.
262
374
  * @param request.tokenId The ID of the NFT.
263
- * @param request.deadline [Optional] The deadline for the signature in milliseconds, default is 1000ms.
264
375
  * @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
265
376
  * @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
266
377
  * @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
267
378
  * @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
268
379
  * @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
380
+ * @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
269
381
  * @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
270
- * @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.
382
+ * @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.
271
383
  */
272
384
  registerIpAndMakeDerivativeWithLicenseTokens(request: RegisterIpAndMakeDerivativeWithLicenseTokensRequest): Promise<RegisterIpResponse>;
385
+ /**
386
+ * Register the given NFT and attach license terms and distribute royalty tokens. In order to successfully distribute royalty tokens, the license terms attached to the IP must be
387
+ * a commercial license.
388
+ * @param request - The request object that contains all data needed to register ip and attach license terms and distribute royalty tokens.
389
+ * @param request.nftContract The address of the NFT collection.
390
+ * @param request.tokenId The ID of the NFT.
391
+ * @param request.terms The array of license terms to be attached.
392
+ * @param request.terms.transferable Indicates whether the license is transferable or not.
393
+ * @param request.terms.royaltyPolicy The address of the royalty policy contract which required to StoryProtocol in advance.
394
+ * @param request.terms.mintingFee The fee to be paid when minting a license.
395
+ * @param request.terms.expiration The expiration period of the license.
396
+ * @param request.terms.commercialUse Indicates whether the work can be used commercially or not, Commercial use is required to deploy a royalty vault.
397
+ * @param request.terms.commercialAttribution Whether attribution is required when reproducing the work commercially or not.
398
+ * @param request.terms.commercializerChecker Commercializers that are allowed to commercially exploit the work. If zero address, then no restrictions is enforced.
399
+ * @param request.terms.commercializerCheckerData The data to be passed to the commercializer checker contract.
400
+ * @param request.terms.commercialRevShare Percentage of revenue that must be shared with the licensor.
401
+ * @param request.terms.commercialRevCeiling The maximum revenue that can be generated from the commercial use of the work.
402
+ * @param request.terms.derivativesAllowed Indicates whether the licensee can create derivatives of his work or not.
403
+ * @param request.terms.derivativesAttribution Indicates whether attribution is required for derivatives of the work or not.
404
+ * @param request.terms.derivativesApproval Indicates whether the licensor must approve derivatives of the work before they can be linked to the licensor IP ID or not.
405
+ * @param request.terms.derivativesReciprocal Indicates whether the licensee must license derivatives of the work under the same terms or not.
406
+ * @param request.terms.derivativeRevCeiling The maximum revenue that can be generated from the derivative use of the work.
407
+ * @param request.terms.currency The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
408
+ * @param request.terms.uri The URI of the license terms, which can be used to fetch the offchain license terms.
409
+ * @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
410
+ * @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
411
+ * @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
412
+ * @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
413
+ * @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
414
+ * @param {Array} request.royaltyShares Authors of the IP and their shares of the royalty tokens.
415
+ * @param request.royaltyShares.author The address of the author.
416
+ * @param request.royaltyShares.percentage The percentage of the royalty share, 10 represents 10%.
417
+ * @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
418
+ * @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property, without encodedTxData option.
419
+ * @returns A Promise that resolves to a transaction hashes, IP ID, License terms ID, and IP royalty vault.
420
+ * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
421
+ * @emits IpRoyaltyVaultDeployed (ipId, ipRoyaltyVault)
422
+ */
423
+ registerIPAndAttachLicenseTermsAndDistributeRoyaltyTokens(request: RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest): Promise<RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse>;
424
+ /**
425
+ * 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
426
+ * a commercial license.
427
+ * @param request - The request object that contains all data needed to register derivative IP and distribute royalty tokens.
428
+ * @param request.nftContract The address of the NFT collection.
429
+ * @param request.tokenId The ID of the NFT.
430
+ * @param request.derivData The derivative data to be used for registerDerivative.
431
+ * @param request.derivData.parentIpIds The IDs of the parent IPs to link the registered derivative IP.
432
+ * @param request.derivData.licenseTemplate [Optional] The address of the license template to be used for the linking.
433
+ * @param request.derivData.licenseTermsIds The IDs of the license terms to be used for the linking.
434
+ * @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
435
+ * @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
436
+ * @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
437
+ * @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
438
+ * @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
439
+ * @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
440
+ * @param {Array} request.royaltyShares Authors of the IP and their shares of the royalty tokens.
441
+ * @param request.royaltyShares.author The address of the author.
442
+ * @param request.royaltyShares.percentage The percentage of the royalty share, 10 represents 10%.
443
+ * @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property, without encodedTxData option.
444
+ * @returns A Promise that resolves to a transaction hashes, IP ID and IP royalty vault, token ID.
445
+ * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
446
+ * @emits IpRoyaltyVaultDeployed (ipId, ipRoyaltyVault)
447
+ */
448
+ registerDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokens(request: RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest): Promise<RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse>;
449
+ /**
450
+ * Mint an NFT and register the IP, attach PIL terms, and distribute royalty tokens. In order to successfully distribute royalty tokens, the license terms attached to the IP must be
451
+ * a commercial license.
452
+ * @param request - The request object that contains all data needed to mint an NFT and register the IP, attach PIL terms, and distribute royalty tokens.
453
+ * @param request.spgNftContract The address of the SPG NFT contract.
454
+ * @param request.terms The array of license terms to be attached.
455
+ * @param request.terms.transferable Indicates whether the license is transferable or not.
456
+ * @param request.terms.royaltyPolicy The address of the royalty policy contract which required to StoryProtocol in advance.
457
+ * @param request.terms.mintingFee The fee to be paid when minting a license.
458
+ * @param request.terms.expiration The expiration period of the license.
459
+ * @param request.terms.commercialUse Indicates whether the work can be used commercially or not, Commercial use is required to deploy a royalty vault.
460
+ * @param request.terms.commercialAttribution Whether attribution is required when reproducing the work commercially or not.
461
+ * @param request.terms.commercializerChecker Commercializers that are allowed to commercially exploit the work. If zero address, then no restrictions is enforced.
462
+ * @param request.terms.commercializerCheckerData The data to be passed to the commercializer checker contract.
463
+ * @param request.terms.commercialRevShare Percentage of revenue that must be shared with the licensor.
464
+ * @param request.terms.commercialRevCeiling The maximum revenue that can be generated from the commercial use of the work.
465
+ * @param request.terms.derivativesAllowed Indicates whether the licensee can create derivatives of his work or not.
466
+ * @param request.terms.derivativesAttribution Indicates whether attribution is required for derivatives of the work or not.
467
+ * @param request.terms.derivativesApproval Indicates whether the licensor must approve derivatives of the work before they can be linked to the licensor IP ID or not.
468
+ * @param request.terms.derivativesReciprocal Indicates whether the licensee must license derivatives of the work under the same terms or not.
469
+ * @param request.terms.derivativeRevCeiling The maximum revenue that can be generated from the derivative use of the work.
470
+ * @param request.terms.currency The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
471
+ * @param request.terms.uri The URI of the license terms, which can be used to fetch the offchain license terms.
472
+ * @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
473
+ * @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
474
+ * @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
475
+ * @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
476
+ * @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
477
+ * @param {Array} request.royaltyShares Authors of the IP and their shares of the royalty tokens.
478
+ * @param request.royaltyShares.author The address of the author.
479
+ * @param request.royaltyShares.percentage The percentage of the royalty share, 10 represents 10%.
480
+ * @param request.recipient - [Optional] The address to receive the minted NFT,default value is your wallet address.
481
+ * @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property, without encodedTxData option.
482
+ * @returns A Promise that resolves to a transaction hash, IP ID, License terms ID, and IP royalty vault, Token ID.
483
+ * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
484
+ */
485
+ mintAndRegisterIpAndAttachPilTermsAndDistributeRoyaltyTokens(request: MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensRequest): Promise<MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensResponse>;
486
+ /**
487
+ * Mint an NFT and register the IP, make a derivative, and distribute royalty tokens. In order to successfully distribute royalty tokens, the license terms attached to the IP must be
488
+ * a commercial license.
489
+ * @param request - The request object that contains all data needed to mint an NFT and register the IP, make a derivative, and distribute royalty tokens.
490
+ * @param request.spgNftContract The address of the SPG NFT collection.
491
+ * @param request.derivData The derivative data to be used for registerDerivative.
492
+ * @param request.derivData.parentIpIds The IDs of the parent IPs to link the registered derivative IP.
493
+ * @param request.derivData.licenseTemplate [Optional] The address of the license template to be used for the linking.
494
+ * @param request.derivData.licenseTermsIds The IDs of the license terms to be used for the linking.
495
+ * @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
496
+ * @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
497
+ * @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
498
+ * @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
499
+ * @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
500
+ * @param {Array} request.royaltyShares Authors of the IP and their shares of the royalty tokens.
501
+ * @param request.royaltyShares.author The address of the author.
502
+ * @param request.royaltyShares.percentage The percentage of the royalty share, 10 represents 10%.
503
+ * @param request.recipient - [Optional] The address to receive the minted NFT,default value is your wallet address.
504
+ * @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property, without encodedTxData option..
505
+ * @returns A Promise that resolves to a transaction hash, IP ID and token ID.
506
+ * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
507
+ */
508
+ mintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokens(request: MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensRequest): Promise<MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensResponse>;
509
+ private getRoyaltyShares;
510
+ private distributeRoyaltyTokens;
273
511
  private getIpIdAddress;
274
- private isRegistered;
275
- private getSigSignatureState;
512
+ isRegistered(ipId: Hex): Promise<boolean>;
276
513
  private getLicenseTermsId;
277
514
  private validateLicenseTokenIds;
515
+ private getIpIdAndTokenIdsFromEvent;
278
516
  }
279
517
  //# sourceMappingURL=ipAsset.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,EAWb,MAAM,MAAM,CAAC;AAGd,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAEpD,OAAO,EACL,gCAAgC,EAChC,iCAAiC,EACjC,4BAA4B,EAC5B,uBAAuB,EACvB,SAAS,EACT,UAAU,EACV,yCAAyC,EACzC,0DAA0D,EAC1D,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC1B,0CAA0C,EAC1C,2CAA2C,EAC3C,kCAAkC,EAClC,mCAAmC,EACnC,kCAAkC,EAClC,mCAAmC,EACnC,mDAAmD,EACnD,kBAAkB,EAClB,gCAAgC,EAChC,iCAAiC,EACjC,eAAe,EAChB,sCAAmC;AACpC,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,yBAAyB,EAMzB,qBAAqB,EACrB,gCAAgC,EAIhC,6BAA6B,EAC7B,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACvB,2BAA2B,EAG3B,kBAAkB,EAInB,4BAAyB;AAK1B,qBAAa,aAAa;IACjB,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,2BAA2B,EAAE,2BAA2B,CAAC;IACzD,gCAAgC,EAAE,gCAAgC,CAAC;IACnE,yBAAyB,EAAE,yBAAyB,CAAC;IAE5D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAgB3F;;;;;;;;;;;;;OAaG;IACI,uBAAuB,CAAC,KAAK,EAAE,4BAA4B,GAAG,SAAS;IAqB9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACI,kBAAkB,CAAC,KAAK,EAAE,uBAAuB,GAAG,UAAU;IAiCrE;;;;;;;;;;;;;;OAcG;IACU,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAuF5E;;;;;;;;;;;;OAYG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IA4DtC;;;;;;;;;;OAUG;IACU,mCAAmC,CAC9C,OAAO,EAAE,0CAA0C,GAClD,OAAO,CAAC,2CAA2C,CAAC;IAiCvD;;;;;;;;;;;;;;;;;;;OAmBG;IACU,kCAAkC,CAC7C,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,iCAAiC,CAAC;IAwD7C;;;;;;;;;;;;;;;;;;;OAmBG;IACU,2BAA2B,CACtC,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IAoH/C;;;;;;;;;;;;;;;;;;OAkBG;IACU,oBAAoB,CAC/B,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IA+H/C;;;;;;;;;;;;;;;;;OAiBG;IACU,kCAAkC,CAC7C,OAAO,EAAE,yCAAyC,GACjD,OAAO,CAAC,0BAA0B,CAAC;IAiEtC;;;;;;;;;;;;;OAaG;IACU,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAgC9F;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,yBAAyB,CACpC,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,iCAAiC,CAAC;IAiE7C;;;;;;;;;;;;;;OAcG;IACU,mDAAmD,CAC9D,OAAO,EAAE,0DAA0D,GAClE,OAAO,CAAC,kBAAkB,CAAC;IA4C9B;;;;;;;;;;;;;;OAcG;IACU,4CAA4C,CACvD,OAAO,EAAE,mDAAmD,GAC3D,OAAO,CAAC,kBAAkB,CAAC;YA+FhB,cAAc;YAYd,YAAY;IAI1B,OAAO,CAAC,oBAAoB;YA+Bd,iBAAiB;YAajB,uBAAuB;CAiBtC"}
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;AAGd,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAEpD,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,4BAA4B,EAC5B,uBAAuB,EACvB,SAAS,EACT,UAAU,EACV,yCAAyC,EACzC,0DAA0D,EAC1D,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC1B,0CAA0C,EAC1C,2CAA2C,EAC3C,kCAAkC,EAClC,mCAAmC,EACnC,kCAAkC,EAClC,mCAAmC,EACnC,mDAAmD,EACnD,kBAAkB,EAClB,gCAAgC,EAChC,iCAAiC,EACjC,eAAe,EACf,0CAA0C,EAC1C,gEAAgE,EAGhE,iEAAiE,EAGjE,wEAAwE,EACxE,yEAAyE,EACzE,mEAAmE,EACnE,mEAAmE,EACnE,oEAAoE,EACpE,oEAAoE,EACrE,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,EACvC,kBAAkB,EAInB,4BAAyB;AAO1B,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;IAE1D,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;IAsB3F;;;;;;;;;;;;;OAaG;IACI,uBAAuB,CAAC,KAAK,EAAE,4BAA4B,GAAG,SAAS;IAqB9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACI,kBAAkB,CAAC,KAAK,EAAE,uBAAuB,GAAG,UAAU;IAiCrE;;;;;;;;;;;;;;OAcG;IACU,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA0F5E;;;;;;;;;;;;;;OAcG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAwCzF;;;;;;;;;;;;OAYG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IA4DtC;;;;;;;;;;OAUG;IACU,uBAAuB,CAClC,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC;IA+E3C;;;;;;;;;;OAUG;IACU,mCAAmC,CAC9C,OAAO,EAAE,0CAA0C,GAClD,OAAO,CAAC,2CAA2C,CAAC;IAiCvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACU,kCAAkC,CAC7C,OAAO,EAAE,yCAAyC,GACjD,OAAO,CAAC,0CAA0C,CAAC;IAgDtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IAiD3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACU,2BAA2B,CACtC,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IAwG/C;;;;;;;;;;;;;;;;;;OAkBG;IACU,oBAAoB,CAC/B,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IA8H/C;;;;;;;;;;;;;;;;;OAiBG;IACU,kCAAkC,CAC7C,OAAO,EAAE,yCAAyC,GACjD,OAAO,CAAC,0CAA0C,CAAC;IAiEtD;;;;;;;;;;;;;;;;;;OAkBG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IAkC3D;;;;;;;;;;;;;OAaG;IACU,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAgC9F;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,yBAAyB,CACpC,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,iCAAiC,CAAC;IAoE7C;;;;;;;;;;;;;;OAcG;IACU,mDAAmD,CAC9D,OAAO,EAAE,0DAA0D,GAClE,OAAO,CAAC,kBAAkB,CAAC;IA4C9B;;;;;;;;;;;;;;OAcG;IACU,4CAA4C,CACvD,OAAO,EAAE,mDAAmD,GAC3D,OAAO,CAAC,kBAAkB,CAAC;IA6F9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACU,yDAAyD,CACpE,OAAO,EAAE,gEAAgE,GACxE,OAAO,CAAC,iEAAiE,CAAC;IAoH7E;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,iEAAiE,CAC5E,OAAO,EAAE,wEAAwE,GAChF,OAAO,CAAC,yEAAyE,CAAC;IAmHrF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACU,4DAA4D,CACvE,OAAO,EAAE,mEAAmE,GAC3E,OAAO,CAAC,oEAAoE,CAAC;IAiDhF;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,4DAA4D,CACvE,OAAO,EAAE,mEAAmE,GAC3E,OAAO,CAAC,oEAAoE,CAAC;IA4DhF,OAAO,CAAC,gBAAgB;YAqBV,uBAAuB;YAyCvB,cAAc;IAYf,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;YAIxC,iBAAiB;YAWjB,uBAAuB;IAkBrC,OAAO,CAAC,2BAA2B;CAgBpC"}
@@ -39,7 +39,7 @@ export declare class PermissionClient {
39
39
  * @param request.to The address that can be called by the `signer` (currently only modules can be `to`)
40
40
  * @param request.permission The new permission level.
41
41
  * @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.
42
- * @param request.deadline [Optional] The deadline for the signature in milliseconds, default is 1000ms.
42
+ * @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
43
43
  * @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
44
44
  * @returns A Promise that resolves to an object containing the transaction hash.
45
45
  * @emits PermissionSet (ipAccountOwner, ipAccount, signer, to, func, permission)
@@ -81,6 +81,7 @@ export declare class PermissionClient {
81
81
  * @param request.permissions[].to The address that can be called by the `signer` (currently only modules can be `to`).
82
82
  * @param request.permissions[].permission The new permission level.
83
83
  * @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.
84
+ * @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
84
85
  * @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
85
86
  * @returns A Promise that resolves to an object containing the transaction hash.
86
87
  * @emits PermissionSet (ipAccountOwner, ipAccount, signer, to, func, permission)
@@ -1 +1 @@
1
- {"version":3,"file":"permission.d.ts","sourceRoot":"../../../../src/resources","sources":["permission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAiE,MAAM,MAAM,CAAC;AAGnG,OAAO,EACL,qCAAqC,EACrC,mCAAmC,EACnC,wBAAwB,EACxB,0BAA0B,EAC1B,qBAAqB,EACrB,sBAAsB,EACvB,yCAAsC;AACvC,OAAO,EAEL,sBAAsB,EACtB,wBAAwB,EAExB,qBAAqB,EACrB,kBAAkB,EACnB,4BAAyB;AAE1B,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAIpD,qBAAa,gBAAgB;IACpB,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,wBAAwB,EAAE,wBAAwB,CAAC;IAC1D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAS3F;;;;;;;;;;;;;;;;;;;OAmBG;IACU,aAAa,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IA8B3F;;;;;;;;;;;;OAYG;IACU,4BAA4B,CACvC,OAAO,EAAE,mCAAmC,GAC3C,OAAO,CAAC,sBAAsB,CAAC;IA6DlC;;;;;;;;;OASG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,sBAAsB,CAAC;IA0BlC;;;;;;;;;;;;;OAaG;IACU,mBAAmB,CAC9B,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,sBAAsB,CAAC;IAiClC;;;;;;;;;;;;;OAaG;IACU,8BAA8B,CACzC,OAAO,EAAE,qCAAqC,GAC7C,OAAO,CAAC,sBAAsB,CAAC;YA0DpB,iBAAiB;CAQhC"}
1
+ {"version":3,"file":"permission.d.ts","sourceRoot":"../../../../src/resources","sources":["permission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAiE,MAAM,MAAM,CAAC;AAGnG,OAAO,EACL,qCAAqC,EACrC,mCAAmC,EACnC,wBAAwB,EACxB,0BAA0B,EAC1B,qBAAqB,EACrB,sBAAsB,EACvB,yCAAsC;AACvC,OAAO,EAEL,sBAAsB,EACtB,wBAAwB,EAExB,qBAAqB,EACrB,kBAAkB,EACnB,4BAAyB;AAE1B,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAIpD,qBAAa,gBAAgB;IACpB,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,wBAAwB,EAAE,wBAAwB,CAAC;IAC1D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAS3F;;;;;;;;;;;;;;;;;;;OAmBG;IACU,aAAa,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IA8B3F;;;;;;;;;;;;OAYG;IACU,4BAA4B,CACvC,OAAO,EAAE,mCAAmC,GAC3C,OAAO,CAAC,sBAAsB,CAAC;IA8DlC;;;;;;;;;OASG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,sBAAsB,CAAC;IA0BlC;;;;;;;;;;;;;OAaG;IACU,mBAAmB,CAC9B,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,sBAAsB,CAAC;IAiClC;;;;;;;;;;;;;;OAcG;IACU,8BAA8B,CACzC,OAAO,EAAE,qCAAqC,GAC7C,OAAO,CAAC,sBAAsB,CAAC;YA2DpB,iBAAiB;CAQhC"}