@story-protocol/core-sdk 1.2.0-rc.0 → 1.2.0-rc.2
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/declarations/src/abi/generated.d.ts +1394 -1306
- package/dist/declarations/src/abi/generated.d.ts.map +1 -1
- package/dist/declarations/src/index.d.ts +7 -6
- package/dist/declarations/src/index.d.ts.map +1 -1
- package/dist/declarations/src/resources/dispute.d.ts +1 -1
- package/dist/declarations/src/resources/dispute.d.ts.map +1 -1
- package/dist/declarations/src/resources/group.d.ts +2 -2
- package/dist/declarations/src/resources/group.d.ts.map +1 -1
- package/dist/declarations/src/resources/ipAccount.d.ts +2 -2
- package/dist/declarations/src/resources/ipAccount.d.ts.map +1 -1
- package/dist/declarations/src/resources/ipAsset.d.ts +97 -21
- package/dist/declarations/src/resources/ipAsset.d.ts.map +1 -1
- package/dist/declarations/src/resources/license.d.ts +39 -8
- package/dist/declarations/src/resources/license.d.ts.map +1 -1
- package/dist/declarations/src/resources/permission.d.ts +2 -1
- package/dist/declarations/src/resources/permission.d.ts.map +1 -1
- package/dist/declarations/src/types/config.d.ts +1 -1
- package/dist/declarations/src/types/config.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/dispute.d.ts +2 -2
- package/dist/declarations/src/types/resources/dispute.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/ipAccount.d.ts +1 -1
- package/dist/declarations/src/types/resources/ipAccount.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/ipAsset.d.ts +56 -9
- package/dist/declarations/src/types/resources/ipAsset.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/license.d.ts +28 -1
- package/dist/declarations/src/types/resources/license.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/permission.d.ts +11 -1
- package/dist/declarations/src/types/resources/permission.d.ts.map +1 -1
- package/dist/declarations/src/utils/chain.d.ts +6 -7
- package/dist/declarations/src/utils/chain.d.ts.map +1 -1
- package/dist/declarations/src/utils/ipfs.d.ts +4 -0
- package/dist/declarations/src/utils/ipfs.d.ts.map +1 -0
- package/dist/declarations/src/utils/sign.d.ts +15 -2
- package/dist/declarations/src/utils/sign.d.ts.map +1 -1
- package/dist/story-protocol-core-sdk.cjs.dev.js +1851 -934
- package/dist/story-protocol-core-sdk.cjs.prod.js +1851 -934
- package/dist/story-protocol-core-sdk.esm.js +1845 -934
- package/package.json +3 -1
@@ -1,6 +1,6 @@
|
|
1
1
|
export { StoryClient } from "./client.js";
|
2
2
|
export { AddressZero, HashZero } from "./constants/common.js";
|
3
|
-
export {
|
3
|
+
export { odyssey } from "./utils/chain.js";
|
4
4
|
export { IPAssetClient } from "./resources/ipAsset.js";
|
5
5
|
export { PermissionClient } from "./resources/permission.js";
|
6
6
|
export { LicenseClient } from "./resources/license.js";
|
@@ -10,16 +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";
|
14
|
-
export type { RegisterNonComSocialRemixingPILRequest, RegisterCommercialUsePILRequest, RegisterCommercialRemixPILRequest, RegisterPILResponse, AttachLicenseTermsRequest, AttachLicenseTermsResponse, MintLicenseTokensRequest, MintLicenseTokensResponse, LicenseTermsId, LicenseTerms, } from "./types/resources/license.js";
|
13
|
+
export type { RegisterRequest, RegisterIpResponse, RegisterDerivativeResponse, RegisterDerivativeRequest, RegisterDerivativeWithLicenseTokensRequest, RegisterDerivativeWithLicenseTokensResponse, CreateIpAssetWithPilTermsRequest, CreateIpAssetWithPilTermsResponse, 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, } from "./types/resources/ipAsset.js";
|
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, PermissionSignatureResponse, 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
|
-
export type { PiLicenseTemplateGetLicenseTermsResponse, IpAccountImplStateResponse, EncodedTxData, } from "./abi/generated.js";
|
24
|
-
export { getPermissionSignature } from "./utils/sign.js";
|
23
|
+
export type { PiLicenseTemplateGetLicenseTermsResponse, IpAccountImplStateResponse, EncodedTxData, LicensingModulePredictMintingLicenseFeeResponse, } from "./abi/generated.js";
|
24
|
+
export { getPermissionSignature, getSignature } from "./utils/sign.js";
|
25
|
+
export { convertCIDtoHashIPFS, convertHashIPFStoCID } from "./utils/ipfs.js";
|
25
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,
|
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,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,GAChC,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,EAC3B,gBAAgB,EAChB,iBAAiB,GAClB,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,YAAY,EAAE,wBAAqB;AACpE,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,wBAAqB"}
|
@@ -10,7 +10,7 @@ export declare class DisputeClient {
|
|
10
10
|
* @param request - The request object containing necessary data to raise a dispute.
|
11
11
|
* @param request.targetIpId The IP ID that is the target of the dispute.
|
12
12
|
* @param request.targetTag The target tag of the dispute.
|
13
|
-
* @param request.
|
13
|
+
* @param request.cid CID (Content Identifier) is a unique identifier in IPFS, including CID v0 (base58) and CID v1 (base32).
|
14
14
|
* @param request.data The data to initialize the policy
|
15
15
|
* @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
16
16
|
* @returns A Promise that resolves to a RaiseDisputeResponse containing the transaction hash.
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"dispute.d.ts","sourceRoot":"../../../../src/resources","sources":["dispute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAe,MAAM,MAAM,CAAC;AAGjD,OAAO,EACL,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACvB,sCAAmC;AACpC,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,4BAAyB;
|
1
|
+
{"version":3,"file":"dispute.d.ts","sourceRoot":"../../../../src/resources","sources":["dispute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAe,MAAM,MAAM,CAAC;AAGjD,OAAO,EACL,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACvB,sCAAmC;AACpC,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,4BAAyB;AAI3E,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IAClC,mBAAmB,EAAE,mBAAmB,CAAC;gBAEpC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAK/D;;;;;;;;;;;;;;OAcG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAkCtF;;;;;;;;;;;;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"}
|
@@ -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
|
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
|
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;
|
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;IAuG3D;;;;;;;;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.
|
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;
|
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, CreateIpAssetWithPilTermsRequest, CreateIpAssetWithPilTermsResponse, GenerateCreatorMetadataParam, GenerateIpMetadataParam, IpCreator, IpMetadata, MintAndRegisterIpAndMakeDerivativeRequest, MintAndRegisterIpAndMakeDerivativeWithLicenseTokensRequest, MintAndRegisterIpRequest, RegisterDerivativeRequest, RegisterDerivativeResponse, RegisterDerivativeWithLicenseTokensRequest, RegisterDerivativeWithLicenseTokensResponse, RegisterIpAndAttachPilTermsRequest, RegisterIpAndAttachPilTermsResponse, RegisterIpAndMakeDerivativeRequest, RegisterIpAndMakeDerivativeResponse, RegisterIpAndMakeDerivativeWithLicenseTokensRequest, RegisterIpResponse, RegisterPilTermsAndAttachRequest, RegisterPilTermsAndAttachResponse, RegisterRequest, MintAndRegisterIpAndMakeDerivativeResponse } from "../types/resources/ipAsset.js";
|
4
|
+
import { AccessControllerClient, CoreMetadataModuleClient, DerivativeWorkflowsClient, IpAssetRegistryClient, LicenseAttachmentWorkflowsClient, LicenseRegistryReadOnlyClient, LicenseTokenReadOnlyClient, LicensingModuleClient, Multicall3Client, PiLicenseTemplateClient, RegistrationWorkflowsClient, SimpleWalletClient } from "../abi/generated.js";
|
5
5
|
export declare class IPAssetClient {
|
6
6
|
licensingModuleClient: LicensingModuleClient;
|
7
7
|
ipAssetRegistryClient: IpAssetRegistryClient;
|
@@ -13,9 +13,11 @@ export declare class IPAssetClient {
|
|
13
13
|
registrationWorkflowsClient: RegistrationWorkflowsClient;
|
14
14
|
licenseAttachmentWorkflowsClient: LicenseAttachmentWorkflowsClient;
|
15
15
|
derivativeWorkflowsClient: DerivativeWorkflowsClient;
|
16
|
+
multicall3Client: Multicall3Client;
|
16
17
|
private readonly rpcClient;
|
17
18
|
private readonly wallet;
|
18
19
|
private readonly chainId;
|
20
|
+
private defaultLicenseTermsId;
|
19
21
|
constructor(rpcClient: PublicClient, wallet: SimpleWalletClient, chainId: SupportedChainIds);
|
20
22
|
/**
|
21
23
|
* Create a new `IpCreator` object with the specified details.
|
@@ -82,12 +84,28 @@ export declare class IPAssetClient {
|
|
82
84
|
* @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
|
83
85
|
* @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
|
84
86
|
* @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
|
87
|
+
* @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
|
86
88
|
* @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
87
89
|
* @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
90
|
* @emits IPRegistered (ipId, chainId, tokenContract, tokenId, resolverAddr, metadataProviderAddress, metadata)
|
89
91
|
*/
|
90
92
|
register(request: RegisterRequest): Promise<RegisterIpResponse>;
|
93
|
+
/**
|
94
|
+
* Batch registers an NFT as IP, creating a corresponding IP record.
|
95
|
+
* @param request - The request object that contains all data needed to batch register IP.
|
96
|
+
* @param {Array} request.args The array of objects containing the data needed to register IP.
|
97
|
+
* @param request.args.nftContract The address of the NFT.
|
98
|
+
* @param request.args.tokenId The token identifier of the NFT.
|
99
|
+
* @param request.args.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
|
100
|
+
* @param request.args.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
|
101
|
+
* @param request.args.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
|
102
|
+
* @param request.args.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
|
103
|
+
* @param request.args.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
104
|
+
* @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
105
|
+
* @returns A Promise that resolves to a transaction hash, if waitForTransaction is true, includes IP ID, Token ID.
|
106
|
+
* @emits IPRegistered (ipId, chainId, tokenContract, tokenId, resolverAddr, metadataProviderAddress, metadata)
|
107
|
+
*/
|
108
|
+
batchRegister(request: BatchRegisterRequest): Promise<BatchRegisterResponse>;
|
91
109
|
/**
|
92
110
|
* Registers a derivative directly with parent IP's license terms, without needing license tokens,
|
93
111
|
* and attaches the license terms of the parent IPs to the derivative IP.
|
@@ -99,9 +117,21 @@ export declare class IPAssetClient {
|
|
99
117
|
* @param request.parentIpIds The parent IP IDs.
|
100
118
|
* @param request.licenseTermsIds The IDs of the license terms that the parent IP supports.
|
101
119
|
* @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
102
|
-
* @returns A Promise that resolves to
|
120
|
+
* @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data.
|
103
121
|
*/
|
104
122
|
registerDerivative(request: RegisterDerivativeRequest): Promise<RegisterDerivativeResponse>;
|
123
|
+
/**
|
124
|
+
* Batch registers a derivative directly with parent IP's license terms.
|
125
|
+
* @param request - The request object that contains all data needed to batch register derivative IP.
|
126
|
+
* @param {Array} request.args The array of objects containing the data needed to register derivative IP.
|
127
|
+
* @param request.args.childIpId The derivative IP ID.
|
128
|
+
* @param request.args.parentIpIds The parent IP IDs.
|
129
|
+
* @param request.args.licenseTermsIds The IDs of the license terms that the parent IP supports.
|
130
|
+
* @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
|
131
|
+
* @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property, without encodedTxDataOnly option.
|
132
|
+
* @returns A Promise that resolves to a transaction hash.
|
133
|
+
*/
|
134
|
+
batchRegisterDerivative(request: BatchRegisterDerivativeRequest): Promise<BatchRegisterDerivativeResponse>;
|
105
135
|
/**
|
106
136
|
* Registers a derivative with license tokens.
|
107
137
|
* the derivative IP is registered with license tokens minted from the parent IP's license terms.
|
@@ -124,6 +154,7 @@ export declare class IPAssetClient {
|
|
124
154
|
* @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
|
125
155
|
* @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
|
126
156
|
* @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
157
|
+
* @param request.royaltyPolicyAddress [Optional] The address of the royalty policy contract, default value is LAP.
|
127
158
|
* @param request.recipient [Optional] The address of the recipient of the minted NFT,default value is your wallet address.
|
128
159
|
* @param request.mintingFee [Optional] The fee to be paid when minting a license.
|
129
160
|
* @param request.commercialRevShare [Optional] Percentage of revenue that must be shared with the licensor.
|
@@ -134,6 +165,28 @@ export declare class IPAssetClient {
|
|
134
165
|
* @emits LicenseTermsAttached (caller, ipId, licenseTemplate, licenseTermsId)
|
135
166
|
*/
|
136
167
|
mintAndRegisterIpAssetWithPilTerms(request: CreateIpAssetWithPilTermsRequest): Promise<CreateIpAssetWithPilTermsResponse>;
|
168
|
+
/**
|
169
|
+
* Batch mint an NFT from a collection and register it as an IP.
|
170
|
+
* @param request - The request object that contains all data needed to batch mint and register ip.
|
171
|
+
* @param {Array} request.args The array of mint and register IP requests.
|
172
|
+
* @param request.args.spgNftContract The address of the NFT collection.
|
173
|
+
* @param request.args.pilType The type of the PIL.
|
174
|
+
* @param request.args.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
|
175
|
+
* @param request.args.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
|
176
|
+
* @param request.args.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
|
177
|
+
* @param request.args.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
|
178
|
+
* @param request.args.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
179
|
+
* @param request.args.royaltyPolicyAddress [Optional] The address of the royalty policy contract, default value is LAP.
|
180
|
+
* @param request.args.recipient [Optional] The address of the recipient of the minted NFT,default value is your wallet address.
|
181
|
+
* @param request.args.mintingFee [Optional] The fee to be paid when minting a license.
|
182
|
+
* @param request.args.commercialRevShare [Optional] Percentage of revenue that must be shared with the licensor.
|
183
|
+
* @param request.args.currency [Optional] The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
|
184
|
+
* @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property, without encodedTxData option.
|
185
|
+
* @returns A Promise that resolves to a transaction hash, if waitForTransaction is true, includes IP ID, Token ID, License Terms Id.
|
186
|
+
* @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
|
187
|
+
* @emits LicenseTermsAttached (caller, ipId, licenseTemplate, licenseTermsId)
|
188
|
+
*/
|
189
|
+
batchMintAndRegisterIpAssetWithPilTerms(request: BatchMintAndRegisterIpAssetWithPilTermsRequest): Promise<BatchMintAndRegisterIpAssetWithPilTermsResponse>;
|
137
190
|
/**
|
138
191
|
* Register a given NFT as an IP and attach Programmable IP License Terms.R.
|
139
192
|
* @param request - The request object that contains all data needed to mint and register ip.
|
@@ -145,12 +198,13 @@ export declare class IPAssetClient {
|
|
145
198
|
* @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
|
146
199
|
* @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
|
147
200
|
* @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
148
|
-
* @param request.
|
201
|
+
* @param request.royaltyPolicyAddress [Optional] The address of the royalty policy contract, default value is LAP.
|
202
|
+
* @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
|
149
203
|
* @param request.mintingFee [Optional] The fee to be paid when minting a license.
|
150
204
|
* @param request.commercialRevShare [Optional] Percentage of revenue that must be shared with the licensor.
|
151
205
|
* @param request.currency [Optional] The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
|
152
206
|
* @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
153
|
-
* @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.
|
207
|
+
* @returns A Promise that resolves to an object containing the transaction hash and optional IP ID,Token ID, License Terms Id if waitForTxn is set to true.
|
154
208
|
* @emits LicenseTermsAttached (caller, ipId, licenseTemplate, licenseTermsId)
|
155
209
|
*/
|
156
210
|
registerIpAndAttachPilTerms(request: RegisterIpAndAttachPilTermsRequest): Promise<RegisterIpAndAttachPilTermsResponse>;
|
@@ -168,9 +222,9 @@ export declare class IPAssetClient {
|
|
168
222
|
* @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
|
169
223
|
* @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
|
170
224
|
* @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
171
|
-
* @param request.deadline [Optional] The deadline for the signature in
|
225
|
+
* @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
|
172
226
|
* @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
173
|
-
* @returns A Promise that resolves to an object containing the transaction hash and optional IP ID if waitForTxn is set to true.
|
227
|
+
* @returns A Promise that resolves to an object containing the transaction hash and optional IP ID, token ID if waitForTxn is set to true.
|
174
228
|
* @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
|
175
229
|
*/
|
176
230
|
registerDerivativeIp(request: RegisterIpAndMakeDerivativeRequest): Promise<RegisterIpAndMakeDerivativeResponse>;
|
@@ -179,20 +233,40 @@ export declare class IPAssetClient {
|
|
179
233
|
* @param request - The request object that contains all data needed to mint and register ip and make derivative.
|
180
234
|
* @param request.spgNftContract The address of the NFT collection.
|
181
235
|
* @param request.derivData The derivative data to be used for registerDerivative.
|
182
|
-
*
|
183
|
-
*
|
184
|
-
*
|
236
|
+
* @param request.derivData.parentIpIds The IDs of the parent IPs to link the registered derivative IP.
|
237
|
+
* @param request.derivData.licenseTermsIds The IDs of the license terms to be used for the linking.
|
238
|
+
* @param request.derivData.licenseTemplate [Optional] The address of the license template to be used for the linking.
|
185
239
|
* @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
|
186
|
-
*
|
187
|
-
*
|
188
|
-
*
|
189
|
-
*
|
240
|
+
* @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
|
241
|
+
* @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
|
242
|
+
* @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
|
243
|
+
* @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
190
244
|
* @param request.recipient [Optional] The address of the recipient of the minted NFT,default value is your wallet address.
|
191
245
|
* @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
192
|
-
* @returns A Promise that resolves to
|
246
|
+
* @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.
|
247
|
+
* @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
|
248
|
+
*/
|
249
|
+
mintAndRegisterIpAndMakeDerivative(request: MintAndRegisterIpAndMakeDerivativeRequest): Promise<MintAndRegisterIpAndMakeDerivativeResponse>;
|
250
|
+
/**
|
251
|
+
* Batch mint an NFT from a collection and register it as a derivative IP without license tokens.
|
252
|
+
* @param request - The request object that contains all data needed to batch mint and register ip and make derivative.
|
253
|
+
* @param {Array} request.args The array of mint and register IP requests.
|
254
|
+
* @param request.args.spgNftContract The address of the NFT collection.
|
255
|
+
* @param request.args.derivData The derivative data to be used for registerDerivative.
|
256
|
+
* @param request.args.derivData.parentIpIds The IDs of the parent IPs to link the registered derivative IP.
|
257
|
+
* @param request.args.derivData.licenseTermsIds The IDs of the license terms to be used for the linking.
|
258
|
+
* @param request.args.derivData.licenseTemplate [Optional] The address of the license template to be used for the linking.
|
259
|
+
* @param request.args.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
|
260
|
+
* @param request.args.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
|
261
|
+
* @param request.args.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
|
262
|
+
* @param request.args.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
|
263
|
+
* @param request.args.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
264
|
+
* @param request.arg.recipient [Optional] The address of the recipient of the minted NFT,default value is your wallet address.
|
265
|
+
* @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property, without encodedTxData option.
|
266
|
+
* @returns A Promise that resolves to a transaction hash, if waitForTransaction is true, includes child ip id and token id.
|
193
267
|
* @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
|
194
268
|
*/
|
195
|
-
|
269
|
+
batchMintAndRegisterIpAndMakeDerivative(request: BatchMintAndRegisterIpAndMakeDerivativeRequest): Promise<BatchMintAndRegisterIpAndMakeDerivativeResponse>;
|
196
270
|
/**
|
197
271
|
* Mint an NFT from a SPGNFT collection and register it with metadata as an IP.
|
198
272
|
* @param request - The request object that contains all data needed to attach license terms.
|
@@ -230,7 +304,7 @@ export declare class IPAssetClient {
|
|
230
304
|
* @param request.terms.derivativeRevCeiling The maximum revenue that can be generated from the derivative use of the work.
|
231
305
|
* @param request.terms.currency The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
|
232
306
|
* @param request.terms.uri The URI of the license terms, which can be used to fetch the offchain license terms.
|
233
|
-
* @param request.deadline [Optional] The deadline for the signature in milliseconds,default is
|
307
|
+
* @param request.deadline [Optional] The deadline for the signature in milliseconds, default is 1000s.
|
234
308
|
* @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
235
309
|
* @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.
|
236
310
|
* @emits LicenseTermsAttached (caller, ipId, licenseTemplate, licenseTermsId)
|
@@ -258,20 +332,22 @@ export declare class IPAssetClient {
|
|
258
332
|
* @param request.nftContract The address of the NFT collection.
|
259
333
|
* @param request.licenseTokenIds The IDs of the license tokens to be burned for linking the IP to parent IPs.
|
260
334
|
* @param request.tokenId The ID of the NFT.
|
261
|
-
* @param request.deadline [Optional] The deadline for the signature in milliseconds, default is 1000ms.
|
262
335
|
* @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
|
263
336
|
* @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
|
264
337
|
* @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
|
265
338
|
* @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
|
266
339
|
* @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
340
|
+
* @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
|
267
341
|
* @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
268
342
|
* @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.
|
269
343
|
*/
|
270
344
|
registerIpAndMakeDerivativeWithLicenseTokens(request: RegisterIpAndMakeDerivativeWithLicenseTokensRequest): Promise<RegisterIpResponse>;
|
271
345
|
private getIpIdAddress;
|
272
|
-
|
346
|
+
isRegistered(ipId: Hex): Promise<boolean>;
|
273
347
|
private getSigSignatureState;
|
274
348
|
private getLicenseTermsId;
|
275
349
|
private validateLicenseTokenIds;
|
350
|
+
private getIpIdAndTokenIdFromEvent;
|
351
|
+
private getDefaultLicenseTerms;
|
276
352
|
}
|
277
353
|
//# sourceMappingURL=ipAsset.d.ts.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,
|
1
|
+
{"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,GAAG,EACH,YAAY,EAWb,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,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,EACf,0CAA0C,EAC3C,sCAAmC;AACpC,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,yBAAyB,EAMzB,qBAAqB,EACrB,gCAAgC,EAIhC,6BAA6B,EAC7B,0BAA0B,EAC1B,qBAAqB,EACrB,gBAAgB,EAChB,uBAAuB,EACvB,2BAA2B,EAG3B,kBAAkB,EAKnB,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;IACrD,gBAAgB,EAAE,gBAAgB,CAAC;IAE1C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;IAC5C,OAAO,CAAC,qBAAqB,CAAU;gBAE3B,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAkB3F;;;;;;;;;;;;;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;IA4CzF;;;;;;;;;;;;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;;;;;;;;;;;;;;;;;;;OAmBG;IACU,kCAAkC,CAC7C,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,iCAAiC,CAAC;IAwD7C;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IA0C3D;;;;;;;;;;;;;;;;;;;OAmBG;IACU,2BAA2B,CACtC,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IA0H/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,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;IAkE7C;;;;;;;;;;;;;;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;YAgGhB,cAAc;IAYf,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAItD,OAAO,CAAC,oBAAoB;IA+B5B,OAAO,CAAC,iBAAiB;YASX,uBAAuB;IAkBrC,OAAO,CAAC,0BAA0B;YAOpB,sBAAsB;CAKrC"}
|
@@ -1,6 +1,6 @@
|
|
1
1
|
import { PublicClient } from "viem";
|
2
|
-
import { IpAssetRegistryClient, LicenseRegistryEventClient, LicenseRegistryReadOnlyClient, LicensingModuleClient, PiLicenseTemplateClient, PiLicenseTemplateGetLicenseTermsResponse, PiLicenseTemplateReadOnlyClient, SimpleWalletClient } from "../abi/generated.js";
|
3
|
-
import { RegisterNonComSocialRemixingPILRequest, RegisterPILResponse, RegisterCommercialUsePILRequest, RegisterCommercialRemixPILRequest, AttachLicenseTermsRequest, MintLicenseTokensRequest, MintLicenseTokensResponse, AttachLicenseTermsResponse, LicenseTermsId, RegisterPILTermsRequest } from "../types/resources/license.js";
|
2
|
+
import { IpAssetRegistryClient, LicenseRegistryEventClient, LicenseRegistryReadOnlyClient, LicensingModuleClient, LicensingModulePredictMintingLicenseFeeResponse, ModuleRegistryReadOnlyClient, PiLicenseTemplateClient, PiLicenseTemplateGetLicenseTermsResponse, PiLicenseTemplateReadOnlyClient, SimpleWalletClient } from "../abi/generated.js";
|
3
|
+
import { RegisterNonComSocialRemixingPILRequest, RegisterPILResponse, RegisterCommercialUsePILRequest, RegisterCommercialRemixPILRequest, AttachLicenseTermsRequest, MintLicenseTokensRequest, MintLicenseTokensResponse, AttachLicenseTermsResponse, LicenseTermsId, RegisterPILTermsRequest, PredictMintingLicenseFeeRequest, SetLicensingConfigRequest, SetLicensingConfigResponse } from "../types/resources/license.js";
|
4
4
|
import { SupportedChainIds } from "../types/config.js";
|
5
5
|
export declare class LicenseClient {
|
6
6
|
licenseRegistryClient: LicenseRegistryEventClient;
|
@@ -9,6 +9,7 @@ export declare class LicenseClient {
|
|
9
9
|
piLicenseTemplateReadOnlyClient: PiLicenseTemplateReadOnlyClient;
|
10
10
|
licenseTemplateClient: PiLicenseTemplateClient;
|
11
11
|
licenseRegistryReadOnlyClient: LicenseRegistryReadOnlyClient;
|
12
|
+
moduleRegistryReadOnlyClient: ModuleRegistryReadOnlyClient;
|
12
13
|
private readonly rpcClient;
|
13
14
|
private readonly wallet;
|
14
15
|
private readonly chainId;
|
@@ -34,7 +35,7 @@ export declare class LicenseClient {
|
|
34
35
|
* @param request.currency The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
|
35
36
|
* @param request.uri The URI of the license terms, which can be used to fetch the offchain license terms.
|
36
37
|
* @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
37
|
-
* @returns A Promise that resolves to
|
38
|
+
* @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.
|
38
39
|
* @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
|
39
40
|
*/
|
40
41
|
registerPILTerms(request: RegisterPILTermsRequest): Promise<RegisterPILResponse>;
|
@@ -42,7 +43,7 @@ export declare class LicenseClient {
|
|
42
43
|
* Convenient function to register a PIL non commercial social remix license to the registry
|
43
44
|
* @param request - [Optional] The request object that contains all data needed to register a PIL non commercial social remix license.
|
44
45
|
* @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
45
|
-
* @returns A Promise that resolves to
|
46
|
+
* @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.
|
46
47
|
* @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
|
47
48
|
*/
|
48
49
|
registerNonComSocialRemixingPIL(request?: RegisterNonComSocialRemixingPILRequest): Promise<RegisterPILResponse>;
|
@@ -51,8 +52,9 @@ export declare class LicenseClient {
|
|
51
52
|
* @param request - The request object that contains all data needed to register a PIL commercial use license.
|
52
53
|
* @param request.defaultMintingFee The fee to be paid when minting a license.
|
53
54
|
* @param request.currency The ERC20 token to be used to pay the minting fee and the token must be registered in story protocol.
|
55
|
+
* @param request.royaltyPolicyAddress [Optional] The address of the royalty policy contract, default value is LAP.
|
54
56
|
* @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
55
|
-
* @returns A Promise that resolves to
|
57
|
+
* @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.
|
56
58
|
* @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
|
57
59
|
*/
|
58
60
|
registerCommercialUsePIL(request: RegisterCommercialUsePILRequest): Promise<RegisterPILResponse>;
|
@@ -62,8 +64,9 @@ export declare class LicenseClient {
|
|
62
64
|
* @param request.defaultMintingFee The fee to be paid when minting a license.
|
63
65
|
* @param request.commercialRevShare Percentage of revenue that must be shared with the licensor.
|
64
66
|
* @param request.currency The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
|
67
|
+
* @param request.royaltyPolicyAddress [Optional] The address of the royalty policy contract, default value is LAP.
|
65
68
|
* @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
66
|
-
* @returns A Promise that resolves to
|
69
|
+
* @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.
|
67
70
|
* @emits LicenseTermsRegistered (licenseTermsId, licenseTemplate, licenseTerms);
|
68
71
|
*/
|
69
72
|
registerCommercialRemixPIL(request: RegisterCommercialRemixPILRequest): Promise<RegisterPILResponse>;
|
@@ -74,7 +77,8 @@ export declare class LicenseClient {
|
|
74
77
|
* @param request.licenseTemplate The address of the license template.
|
75
78
|
* @param request.licenseTermsId The ID of the license terms.
|
76
79
|
* @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
77
|
-
* @returns A Promise that resolves to
|
80
|
+
* @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes success.
|
81
|
+
* If Ip have attached license terms, success will return false and txhash is empty.
|
78
82
|
*/
|
79
83
|
attachLicenseTerms(request: AttachLicenseTermsRequest): Promise<AttachLicenseTermsResponse>;
|
80
84
|
/**
|
@@ -96,7 +100,7 @@ export declare class LicenseClient {
|
|
96
100
|
* @param request.amount The amount of license tokens to mint.
|
97
101
|
* @param request.receiver The address of the receiver.
|
98
102
|
* @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
99
|
-
* @returns A Promise that resolves to
|
103
|
+
* @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes license token IDs.
|
100
104
|
* @emits LicenseTokensMinted (msg.sender, licensorIpId, licenseTemplate, licenseTermsId, amount, receiver, startLicenseTokenId);
|
101
105
|
*/
|
102
106
|
mintLicenseTokens(request: MintLicenseTokensRequest): Promise<MintLicenseTokensResponse>;
|
@@ -106,6 +110,33 @@ export declare class LicenseClient {
|
|
106
110
|
* @returns A Promise that resolves to an object containing the PILTerms associate with the given ID.
|
107
111
|
*/
|
108
112
|
getLicenseTerms(selectedLicenseTermsId: LicenseTermsId): Promise<PiLicenseTemplateGetLicenseTermsResponse>;
|
113
|
+
/**
|
114
|
+
* Pre-compute the minting license fee for the given IP and license terms. The function can be used to calculate the minting license fee before minting license tokens.
|
115
|
+
* @param request - The request object that contains all data needed to predict minting licenses fee.
|
116
|
+
* @param request.licensorIpId The IP ID of the licensor.
|
117
|
+
* @param request.licenseTermsId The ID of the license terms.
|
118
|
+
* @param request.amount The amount of license tokens to mint.
|
119
|
+
* @param request.licenseTemplate [Optional] The address of the license template,default value is Programmable IP License.
|
120
|
+
* @param request.receiver [Optional] The address of the receiver,default value is your wallet address.
|
121
|
+
* @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
122
|
+
* @returns A Promise that resolves to an object containing the currency token and token amount.
|
123
|
+
*/
|
124
|
+
predictMintingLicenseFee(request: PredictMintingLicenseFeeRequest): Promise<LicensingModulePredictMintingLicenseFeeResponse>;
|
125
|
+
/**
|
126
|
+
* Sets the licensing configuration for a specific license terms of an IP. If both licenseTemplate and licenseTermsId are not specified then the licensing config apply to all licenses of given IP.
|
127
|
+
* @param request - The request object that contains all data needed to set licensing config.
|
128
|
+
* @param request.ipId The address of the IP for which the configuration is being set.
|
129
|
+
* @param request.licenseTermsId The ID of the license terms within the license template.
|
130
|
+
* @param request.licenseTemplate The address of the license template used, If not specified, the configuration applies to all licenses.
|
131
|
+
* @param request.licensingConfig The licensing configuration for the license.
|
132
|
+
* @param request.licensingConfig.isSet Whether the configuration is set or not.
|
133
|
+
* @param request.licensingConfig.mintingFee The minting fee to be paid when minting license tokens.
|
134
|
+
* @param request.licensingConfig.hookData The data to be used by the licensing hook.
|
135
|
+
* @param request.licensingConfig.licensingHook The hook contract address for the licensing module, or address(0) if none.
|
136
|
+
* @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
137
|
+
* @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes success.
|
138
|
+
*/
|
139
|
+
setLicensingConfig(request: SetLicensingConfigRequest): Promise<SetLicensingConfigResponse>;
|
109
140
|
private getLicenseTermsId;
|
110
141
|
}
|
111
142
|
//# sourceMappingURL=license.d.ts.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"license.d.ts","sourceRoot":"../../../../src/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAe,MAAM,MAAM,CAAC;AAEjD,OAAO,EACL,qBAAqB,EACrB,0BAA0B,EAC1B,6BAA6B,EAC7B,qBAAqB,
|
1
|
+
{"version":3,"file":"license.d.ts","sourceRoot":"../../../../src/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAe,MAAM,MAAM,CAAC;AAEjD,OAAO,EACL,qBAAqB,EACrB,0BAA0B,EAC1B,6BAA6B,EAC7B,qBAAqB,EAErB,+CAA+C,EAE/C,4BAA4B,EAC5B,uBAAuB,EACvB,wCAAwC,EACxC,+BAA+B,EAC/B,kBAAkB,EAEnB,4BAAyB;AAC1B,OAAO,EAEL,sCAAsC,EACtC,mBAAmB,EACnB,+BAA+B,EAC/B,iCAAiC,EACjC,yBAAyB,EAEzB,wBAAwB,EACxB,yBAAyB,EAEzB,0BAA0B,EAC1B,cAAc,EACd,uBAAuB,EACvB,+BAA+B,EAC/B,yBAAyB,EACzB,0BAA0B,EAC3B,sCAAmC;AAIpC,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAEpD,qBAAa,aAAa;IACjB,qBAAqB,EAAE,0BAA0B,CAAC;IAClD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,+BAA+B,EAAE,+BAA+B,CAAC;IACjE,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,4BAA4B,EAAE,4BAA4B,CAAC;IAClE,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;IAY3F;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAiC7F;;;;;;OAMG;IACU,+BAA+B,CAC1C,OAAO,CAAC,EAAE,sCAAsC,GAC/C,OAAO,CAAC,mBAAmB,CAAC;IAiC/B;;;;;;;;;OASG;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,mBAAmB,CAAC;IAwC/B;;;;;;;;;;OAUG;IACU,0BAA0B,CACrC,OAAO,EAAE,iCAAiC,GACzC,OAAO,CAAC,mBAAmB,CAAC;IA0C/B;;;;;;;;;OASG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IAmDtC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC;IAiErC;;;;OAIG;IACU,eAAe,CAC1B,sBAAsB,EAAE,cAAc,GACrC,OAAO,CAAC,wCAAwC,CAAC;IAUpD;;;;;;;;;;OAUG;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,+CAA+C,CAAC;IAkC3D;;;;;;;;;;;;;OAaG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;YAuDxB,iBAAiB;CAIhC"}
|
@@ -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
|
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;
|
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"}
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"config.d.ts","sourceRoot":"../../../../src/types","sources":["config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAEnD,OAAO,EAAE,kBAAkB,EAAE,4BAAyB;AAEtD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"../../../../src/types","sources":["config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAEnD,OAAO,EAAE,kBAAkB,EAAE,4BAAyB;AAEtD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,SAAS,CAAC;AAEnD;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC;IACpC,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;KAAG,GAAG,IAAI,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAAE,CAAC"}
|
@@ -3,9 +3,9 @@ import { TxOptions } from "../options.js";
|
|
3
3
|
import { EncodedTxData } from "../../abi/generated.js";
|
4
4
|
export type RaiseDisputeRequest = {
|
5
5
|
targetIpId: Address;
|
6
|
-
|
6
|
+
cid: string;
|
7
7
|
targetTag: string;
|
8
|
-
data?:
|
8
|
+
data?: Hex;
|
9
9
|
txOptions?: TxOptions;
|
10
10
|
};
|
11
11
|
export type RaiseDisputeResponse = {
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"dispute.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["dispute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAEpD,MAAM,MAAM,mBAAmB,GAAG;IAChC,UAAU,EAAE,OAAO,CAAC;IACpB,
|
1
|
+
{"version":3,"file":"dispute.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["dispute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAEpD,MAAM,MAAM,mBAAmB,GAAG;IAChC,UAAU,EAAE,OAAO,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACpC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACpC,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC"}
|
@@ -15,11 +15,11 @@ export type IPAccountExecuteResponse = {
|
|
15
15
|
export type IPAccountExecuteWithSigRequest = {
|
16
16
|
ipId: Address;
|
17
17
|
to: Address;
|
18
|
-
value: number;
|
19
18
|
data: Address;
|
20
19
|
signer: Address;
|
21
20
|
deadline: number | bigint | string;
|
22
21
|
signature: Address;
|
22
|
+
value?: number | bigint | string;
|
23
23
|
txOptions?: TxOptions;
|
24
24
|
};
|
25
25
|
export type IPAccountExecuteWithSigResponse = {
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"ipAccount.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["ipAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAEpD,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,OAAO,CAAC;IACd,EAAE,EAAE,OAAO,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,OAAO,CAAC;IACd,EAAE,EAAE,OAAO,CAAC;IACZ,
|
1
|
+
{"version":3,"file":"ipAccount.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["ipAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAEpD,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,OAAO,CAAC;IACd,EAAE,EAAE,OAAO,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,OAAO,CAAC;IACd,EAAE,EAAE,OAAO,CAAC;IACZ,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACnC,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACjC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAEzC,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,OAAO,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}
|