@story-protocol/core-sdk 1.2.0-rc.3 → 1.3.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/declarations/src/abi/generated.d.ts +12699 -4314
- package/dist/declarations/src/abi/generated.d.ts.map +1 -1
- package/dist/declarations/src/constants/common.d.ts +1 -0
- package/dist/declarations/src/constants/common.d.ts.map +1 -1
- package/dist/declarations/src/index.d.ts +3 -2
- package/dist/declarations/src/index.d.ts.map +1 -1
- package/dist/declarations/src/resources/dispute.d.ts +8 -4
- package/dist/declarations/src/resources/dispute.d.ts.map +1 -1
- package/dist/declarations/src/resources/group.d.ts +73 -20
- package/dist/declarations/src/resources/group.d.ts.map +1 -1
- package/dist/declarations/src/resources/ipAsset.d.ts +304 -209
- package/dist/declarations/src/resources/ipAsset.d.ts.map +1 -1
- package/dist/declarations/src/resources/license.d.ts +11 -3
- package/dist/declarations/src/resources/license.d.ts.map +1 -1
- package/dist/declarations/src/resources/nftClient.d.ts +1 -1
- package/dist/declarations/src/resources/nftClient.d.ts.map +1 -1
- package/dist/declarations/src/resources/permission.d.ts.map +1 -1
- package/dist/declarations/src/resources/royalty.d.ts +5 -87
- package/dist/declarations/src/resources/royalty.d.ts.map +1 -1
- package/dist/declarations/src/types/common.d.ts +18 -7
- package/dist/declarations/src/types/common.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 +3 -2
- package/dist/declarations/src/types/resources/dispute.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/group.d.ts +19 -9
- package/dist/declarations/src/types/resources/group.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/ipAsset.d.ts +57 -43
- package/dist/declarations/src/types/resources/ipAsset.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/license.d.ts +10 -7
- package/dist/declarations/src/types/resources/license.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/permission.d.ts +0 -1
- package/dist/declarations/src/types/resources/permission.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/royalty.d.ts +1 -2
- package/dist/declarations/src/types/resources/royalty.d.ts.map +1 -1
- package/dist/declarations/src/utils/chain.d.ts +5 -5
- package/dist/declarations/src/utils/chain.d.ts.map +1 -1
- package/dist/declarations/src/utils/getIpMetadataForWorkflow.d.ts +9 -0
- package/dist/declarations/src/utils/getIpMetadataForWorkflow.d.ts.map +1 -0
- package/dist/declarations/src/utils/sign.d.ts +0 -1
- package/dist/declarations/src/utils/sign.d.ts.map +1 -1
- package/dist/story-protocol-core-sdk.cjs.dev.js +2114 -2548
- package/dist/story-protocol-core-sdk.cjs.prod.js +2114 -2548
- package/dist/story-protocol-core-sdk.esm.js +2115 -2549
- package/package.json +1 -1
@@ -3,4 +3,5 @@ export declare const AddressZero = "0x0000000000000000000000000000000000000000";
|
|
3
3
|
export declare const HashZero = "0x0000000000000000000000000000000000000000000000000000000000000000";
|
4
4
|
export declare const defaultFunctionSelector: Hex;
|
5
5
|
export declare const royaltySharesTotalSupply: number;
|
6
|
+
export declare const MAX_ROYALTY_TOKEN = 100000000;
|
6
7
|
//# sourceMappingURL=common.d.ts.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"common.d.ts","sourceRoot":"../../../../src/constants","sources":["common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAE3B,eAAO,MAAM,WAAW,+CAA+C,CAAC;AACxE,eAAO,MAAM,QAAQ,uEAAuE,CAAC;AAC7F,eAAO,MAAM,uBAAuB,EAAE,GAAkB,CAAC;AACzD,eAAO,MAAM,wBAAwB,EAAE,MAAkB,CAAC"}
|
1
|
+
{"version":3,"file":"common.d.ts","sourceRoot":"../../../../src/constants","sources":["common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAE3B,eAAO,MAAM,WAAW,+CAA+C,CAAC;AACxE,eAAO,MAAM,QAAQ,uEAAuE,CAAC;AAC7F,eAAO,MAAM,uBAAuB,EAAE,GAAkB,CAAC;AACzD,eAAO,MAAM,wBAAwB,EAAE,MAAkB,CAAC;AAC1D,eAAO,MAAM,iBAAiB,YAAY,CAAC"}
|
@@ -1,6 +1,6 @@
|
|
1
1
|
export { StoryClient } from "./client.js";
|
2
2
|
export { AddressZero, HashZero } from "./constants/common.js";
|
3
|
-
export {
|
3
|
+
export { homer } 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";
|
@@ -11,7 +11,7 @@ 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
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
|
-
export type { RegisterNonComSocialRemixingPILRequest, RegisterCommercialUsePILRequest, RegisterCommercialRemixPILRequest, RegisterPILResponse, AttachLicenseTermsRequest, AttachLicenseTermsResponse, MintLicenseTokensRequest, MintLicenseTokensResponse, LicenseTermsId, LicenseTerms, PredictMintingLicenseFeeRequest, SetLicensingConfigRequest, SetLicensingConfigResponse, } from "./types/resources/license.js";
|
14
|
+
export type { RegisterNonComSocialRemixingPILRequest, RegisterCommercialUsePILRequest, RegisterCommercialRemixPILRequest, RegisterPILTermsRequest, 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
17
|
export type { SetPermissionsRequest, SetPermissionsResponse, CreateSetPermissionSignatureRequest, SetAllPermissionsRequest, SetBatchPermissionsRequest, CreateBatchPermissionSignatureRequest, PermissionSignatureRequest, SignatureRequest, SignatureResponse, } from "./types/resources/permission.js";
|
@@ -23,4 +23,5 @@ export type { RegisterGroupRequest, RegisterGroupResponse, RegisterGroupAndAttac
|
|
23
23
|
export type { PiLicenseTemplateGetLicenseTermsResponse, IpAccountImplStateResponse, EncodedTxData, LicensingModulePredictMintingLicenseFeeResponse, } from "./abi/generated.js";
|
24
24
|
export { getPermissionSignature, getSignature } from "./utils/sign.js";
|
25
25
|
export { convertCIDtoHashIPFS, convertHashIPFStoCID } from "./utils/ipfs.js";
|
26
|
+
export type { TxOptions } from "./types/options.js";
|
26
27
|
//# 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,KAAK,EAAE,yBAAsB;AACtC,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,gBAAgB,EAAE,kCAA+B;AAC1D,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,SAAS,EAAE,iCAA8B;AAClD,OAAO,EAAE,eAAe,EAAE,iCAA8B;AACxD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,WAAW,EAAE,6BAA0B;AAEhD,YAAY,EAAE,WAAW,EAAE,iBAAiB,EAAE,0BAAuB;AAErE,YAAY,EACV,eAAe,EACf,kBAAkB,EAClB,0BAA0B,EAC1B,yBAAyB,EACzB,0CAA0C,EAC1C,2CAA2C,EAC3C,yCAAyC,EACzC,0CAA0C,EAC1C,kCAAkC,EAClC,mCAAmC,EACnC,kCAAkC,EAClC,mCAAmC,EACnC,yCAAyC,EACzC,0CAA0C,EAC1C,4BAA4B,EAC5B,SAAS,EACT,uBAAuB,EACvB,UAAU,EACV,cAAc,EACd,WAAW,EACX,eAAe,EACf,OAAO,EACP,YAAY,EACZ,gBAAgB,EAChB,wBAAwB,EACxB,gCAAgC,EAChC,iCAAiC,EACjC,0DAA0D,EAC1D,mDAAmD,EACnD,8CAA8C,EAC9C,+CAA+C,EAC/C,8CAA8C,EAC9C,+CAA+C,EAC/C,oBAAoB,EACpB,qBAAqB,EACrB,8BAA8B,EAC9B,+BAA+B,EAC/B,gEAAgE,EAChE,iEAAiE,EACjE,YAAY,EACZ,wEAAwE,EACxE,yEAAyE,EACzE,mEAAmE,EACnE,oEAAoE,EACpE,mEAAmE,EACnE,oEAAoE,GACrE,qCAAkC;AAEnC,YAAY,EACV,sCAAsC,EACtC,+BAA+B,EAC/B,iCAAiC,EACjC,uBAAuB,EACvB,mBAAmB,EACnB,yBAAyB,EACzB,0BAA0B,EAC1B,wBAAwB,EACxB,yBAAyB,EACzB,cAAc,EACd,YAAY,EACZ,+BAA+B,EAC/B,yBAAyB,EACzB,0BAA0B,GAC3B,qCAAkC;AAEnC,OAAO,EAAE,QAAQ,EAAE,qCAAkC;AAErD,YAAY,EACV,yBAAyB,EACzB,0BAA0B,EAC1B,eAAe,EACf,gBAAgB,EAChB,uBAAuB,EACvB,wBAAwB,EACxB,sCAAsC,EACtC,uCAAuC,EACvC,mCAAmC,EACnC,oCAAoC,EACpC,wDAAwD,EACxD,yDAAyD,EACzD,qDAAqD,EACrD,sDAAsD,GACvD,qCAAkC;AAEnC,YAAY,EACV,qBAAqB,EACrB,sBAAsB,EACtB,mCAAmC,EACnC,wBAAwB,EACxB,0BAA0B,EAC1B,qCAAqC,EACrC,0BAA0B,EAC1B,gBAAgB,EAChB,iBAAiB,GAClB,wCAAqC;AAEtC,OAAO,EAAE,gBAAgB,EAAE,wCAAqC;AAEhE,YAAY,EACV,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,GACvB,qCAAkC;AAEnC,YAAY,EACV,uBAAuB,EACvB,wBAAwB,EACxB,8BAA8B,EAC9B,+BAA+B,EAC/B,sBAAsB,EACtB,aAAa,GACd,uCAAoC;AAErC,YAAY,EACV,0BAA0B,EAC1B,2BAA2B,GAC5B,uCAAoC;AAErC,YAAY,EACV,oBAAoB,EACpB,qBAAqB,EACrB,oCAAoC,EACpC,qCAAqC,EACrC,6CAA6C,EAC7C,8CAA8C,EAC9C,qDAAqD,EACrD,sDAAsD,EACtD,8CAA8C,EAC9C,+CAA+C,GAChD,mCAAgC;AAEjC,YAAY,EACV,wCAAwC,EACxC,0BAA0B,EAC1B,aAAa,EACb,+CAA+C,GAChD,2BAAwB;AAEzB,OAAO,EAAE,sBAAsB,EAAE,YAAY,EAAE,wBAAqB;AAEpE,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,wBAAqB;AAE1E,YAAY,EAAE,SAAS,EAAE,2BAAwB"}
|
@@ -1,17 +1,21 @@
|
|
1
1
|
import { PublicClient } from "viem";
|
2
2
|
import { CancelDisputeRequest, CancelDisputeResponse, RaiseDisputeRequest, RaiseDisputeResponse, ResolveDisputeRequest, ResolveDisputeResponse } from "../types/resources/dispute.js";
|
3
|
-
import { DisputeModuleClient, SimpleWalletClient } from "../abi/generated.js";
|
3
|
+
import { ArbitrationPolicyUmaReadOnlyClient, DisputeModuleClient, SimpleWalletClient } from "../abi/generated.js";
|
4
|
+
import { SupportedChainIds } from "../types/config.js";
|
4
5
|
export declare class DisputeClient {
|
5
|
-
private readonly rpcClient;
|
6
6
|
disputeModuleClient: DisputeModuleClient;
|
7
|
-
|
7
|
+
arbitrationPolicyUmaReadOnlyClient: ArbitrationPolicyUmaReadOnlyClient;
|
8
|
+
private readonly rpcClient;
|
9
|
+
private readonly chainId;
|
10
|
+
constructor(rpcClient: PublicClient, wallet: SimpleWalletClient, chainId: SupportedChainIds);
|
8
11
|
/**
|
9
12
|
* Raises a dispute on a given ipId
|
10
13
|
* @param request - The request object containing necessary data to raise a dispute.
|
11
14
|
* @param request.targetIpId The IP ID that is the target of the dispute.
|
12
15
|
* @param request.targetTag The target tag of the dispute.
|
13
16
|
* @param request.cid CID (Content Identifier) is a unique identifier in IPFS, including CID v0 (base58) and CID v1 (base32).
|
14
|
-
* @param request.
|
17
|
+
* @param request.liveness The liveness time.
|
18
|
+
* @param request.bond The bond size.
|
15
19
|
* @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
16
20
|
* @returns A Promise that resolves to a RaiseDisputeResponse containing the transaction hash.
|
17
21
|
* @throws `NotRegisteredIpId` if targetIpId is not registered in the IPA Registry.
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"dispute.d.ts","sourceRoot":"../../../../src/resources","sources":["dispute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,
|
1
|
+
{"version":3,"file":"dispute.d.ts","sourceRoot":"../../../../src/resources","sources":["dispute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAoC,MAAM,MAAM,CAAC;AAGtE,OAAO,EACL,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACvB,sCAAmC;AACpC,OAAO,EACL,kCAAkC,EAClC,mBAAmB,EACnB,kBAAkB,EAEnB,4BAAyB;AAG1B,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAEpD,qBAAa,aAAa;IACjB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,kCAAkC,EAAE,kCAAkC,CAAC;IAC9E,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAO3F;;;;;;;;;;;;;;;OAeG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAgEtF;;;;;;;;;;;;OAYG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAyBzF;;;;;;;;;;OAUG;IACU,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;CAwB7F"}
|
@@ -24,19 +24,33 @@ export declare class GroupClient {
|
|
24
24
|
* @emits PGroupRegistered (groupId, groupPool);
|
25
25
|
*/
|
26
26
|
registerGroup(request: RegisterGroupRequest): Promise<RegisterGroupResponse>;
|
27
|
-
/**
|
27
|
+
/** Mint an NFT from a SPGNFT collection, register it with metadata as an IP, attach license terms to the registered IP, and add it to a group IP.
|
28
28
|
* @param request - The request object containing necessary data to mint and register Ip and attach license and add to group.
|
29
29
|
* @param request.nftContract The address of the NFT collection.
|
30
30
|
* @param request.groupId The ID of the group IP to add the newly registered IP.
|
31
|
-
* @param request.
|
31
|
+
* @param request.maxAllowedRewardShare The maximum reward share percentage that can be allocated to each member IP.
|
32
|
+
* @param {Array} request.licenseData licenseData The data of the license and its configuration to be attached to the new group IP.
|
33
|
+
* @param request.licenseData.licenseTermsId The ID of the registered license terms that will be attached to the new group IP.
|
34
|
+
* @param request.licenseData.licenseTemplate [Optional] The address of the license template to be attached to the new group IP, default value is Programmable IP License.
|
35
|
+
* @param request.licenseData.licensingConfig The licensing configuration for the IP.
|
36
|
+
* @param {Object} request.licenseTermsData.licensingConfig The PIL terms and licensing configuration data to attach to the IP.
|
37
|
+
* @param request.licenseTermsData.licensingConfig.isSet Whether the configuration is set or not.
|
38
|
+
* @param request.licenseTermsData.licensingConfig.mintingFee The minting fee to be paid when minting license tokens.
|
39
|
+
* @param request.licenseTermsData.licensingConfig.licensingHook The hook contract address for the licensing module, or address(0) if none
|
40
|
+
* @param request.licenseTermsData.licensingConfig.hookData The data to be used by the licensing hook.
|
41
|
+
* @param request.licenseTermsData.licensingConfig.commercialRevShare The commercial revenue share percentage.
|
42
|
+
* @param request.licenseTermsData.licensingConfig.disabled Whether the licensing is disabled or not.
|
43
|
+
* @param request.licenseTermsData.licensingConfig.expectMinimumGroupRewardShare The minimum percentage of the group’s reward share (from 0 to 100%, represented as 100 * 10 ** 6) that can be allocated to the IP when it is added to the group.
|
44
|
+
* If the remaining reward share in the group is less than the minimumGroupRewardShare,the IP cannot be added to the group.
|
45
|
+
* @param request.licenseTermsData.licensingConfig.expectGroupRewardPool The address of the expected group reward pool. The IP can only be added to a group with this specified reward pool address, or address(0) if the IP does not want to be added to any group.
|
46
|
+
* @param request.allowDuplicates Set to true to allow minting an NFT with a duplicate metadata hash.
|
32
47
|
* @param request.recipient [Optional] The address of the recipient of the minted NFT,default value is your wallet address.
|
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
48
|
* . @param request.deadline [Optional] The deadline for the signature in seconds, default value is 1000s.
|
35
|
-
* @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
|
36
|
-
*
|
37
|
-
*
|
38
|
-
*
|
39
|
-
*
|
49
|
+
* @param {Object} request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
|
50
|
+
* @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
|
51
|
+
* @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
|
52
|
+
* @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
|
53
|
+
* @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
40
54
|
* @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
41
55
|
* @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.
|
42
56
|
* @emits IPRegistered (ipId, chainId, tokenContract, tokenId, resolverAddr, metadataProviderAddress, metadata)
|
@@ -46,15 +60,28 @@ export declare class GroupClient {
|
|
46
60
|
* @param request - The request object containing necessary data to register ip and attach license and add to group.
|
47
61
|
* @param request.spgNftContract The address of the NFT collection.
|
48
62
|
* @param request.tokenId The ID of the NFT.
|
63
|
+
* @param request.maxAllowedRewardShare The maximum reward share percentage that can be allocated to each member IP.
|
49
64
|
* @param request.groupId The ID of the group IP to add the newly registered IP.
|
50
|
-
*
|
51
|
-
*
|
65
|
+
* @param {Array} request.licenseData licenseData The data of the license and its configuration to be attached to the new group IP.
|
66
|
+
* @param request.licenseData.licenseTermsId The ID of the registered license terms that will be attached to the new group IP.
|
67
|
+
* @param request.licenseData.licenseTemplate [Optional] The address of the license template to be attached to the new group IP, default value is Programmable IP License.
|
68
|
+
* @param request.licenseData.licensingConfig The licensing configuration for the IP.
|
69
|
+
* @param {Object} request.licenseTermsData.licensingConfig The PIL terms and licensing configuration data to attach to the IP.
|
70
|
+
* @param request.licenseTermsData.licensingConfig.isSet Whether the configuration is set or not.
|
71
|
+
* @param request.licenseTermsData.licensingConfig.mintingFee The minting fee to be paid when minting license tokens.
|
72
|
+
* @param request.licenseTermsData.licensingConfig.licensingHook The hook contract address for the licensing module, or address(0) if none
|
73
|
+
* @param request.licenseTermsData.licensingConfig.hookData The data to be used by the licensing hook.
|
74
|
+
* @param request.licenseTermsData.licensingConfig.commercialRevShare The commercial revenue share percentage.
|
75
|
+
* @param request.licenseTermsData.licensingConfig.disabled Whether the licensing is disabled or not.
|
76
|
+
* @param request.licenseTermsData.licensingConfig.expectMinimumGroupRewardShare The minimum percentage of the group’s reward share (from 0 to 100%, represented as 100 * 10 ** 6) that can be allocated to the IP when it is added to the group.
|
77
|
+
* If the remaining reward share in the group is less than the minimumGroupRewardShare,the IP cannot be added to the group.
|
78
|
+
* @param request.licenseTermsData.licensingConfig.expectGroupRewardPool The address of the expected group reward pool. The IP can only be added to a group with this specified reward pool address, or address(0) if the IP does not want to be added to any group.
|
52
79
|
* . @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
|
53
|
-
* @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
|
54
|
-
*
|
55
|
-
*
|
56
|
-
*
|
57
|
-
*
|
80
|
+
* @param {Object} request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
|
81
|
+
* @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
|
82
|
+
* @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
|
83
|
+
* @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
|
84
|
+
* @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
58
85
|
* @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
59
86
|
* @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.
|
60
87
|
* @emits IPRegistered (ipId, chainId, tokenContract, tokenId, resolverAddr, metadataProviderAddress, metadata)
|
@@ -63,8 +90,20 @@ export declare class GroupClient {
|
|
63
90
|
/** Register a group IP with a group reward pool and attach license terms to the group IP.
|
64
91
|
* @param request - The request object containing necessary data to register group and attach license.
|
65
92
|
* @param request.groupPool The address specifying how royalty will be split amongst the pool of IPs in the group.
|
66
|
-
*
|
67
|
-
*
|
93
|
+
* @param {Object} request.licenseData licenseData The data of the license and its configuration to be attached to the new group IP.
|
94
|
+
* @param request.licenseData.licenseTermsId The ID of the registered license terms that will be attached to the new group IP.
|
95
|
+
* @param request.licenseData.licenseTemplate [Optional] The address of the license template to be attached to the new group IP, default value is Programmable IP License.
|
96
|
+
* @param request.licenseData.licensingConfig The licensing configuration for the IP.
|
97
|
+
* @param {Object} request.licenseTermsData.licensingConfig The PIL terms and licensing configuration data to attach to the IP.
|
98
|
+
* @param request.licenseTermsData.licensingConfig.isSet Whether the configuration is set or not.
|
99
|
+
* @param request.licenseTermsData.licensingConfig.mintingFee The minting fee to be paid when minting license tokens.
|
100
|
+
* @param request.licenseTermsData.licensingConfig.licensingHook The hook contract address for the licensing module, or address(0) if none
|
101
|
+
* @param request.licenseTermsData.licensingConfig.hookData The data to be used by the licensing hook.
|
102
|
+
* @param request.licenseTermsData.licensingConfig.commercialRevShare The commercial revenue share percentage.
|
103
|
+
* @param request.licenseTermsData.licensingConfig.disabled Whether the licensing is disabled or not.
|
104
|
+
* @param request.licenseTermsData.licensingConfig.expectMinimumGroupRewardShare The minimum percentage of the group’s reward share (from 0 to 100%, represented as 100 * 10 ** 6) that can be allocated to the IP when it is added to the group.
|
105
|
+
* If the remaining reward share in the group is less than the minimumGroupRewardShare,the IP cannot be added to the group.
|
106
|
+
* @param request.licenseTermsData.licensingConfig.expectGroupRewardPool The address of the expected group reward pool. The IP can only be added to a group with this specified reward pool address, or address(0) if the IP does not want to be added to any group.
|
68
107
|
* @param request.txOptions [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
69
108
|
* @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes group id.
|
70
109
|
* @emits PGroupRegistered (groupId, groupPool);
|
@@ -72,14 +111,28 @@ export declare class GroupClient {
|
|
72
111
|
registerGroupAndAttachLicense(request: RegisterGroupAndAttachLicenseRequest): Promise<RegisterGroupAndAttachLicenseResponse>;
|
73
112
|
/** Register a group IP with a group reward pool, attach license terms to the group IP, and add individual IPs to the group IP.
|
74
113
|
* @param request - The request object containing necessary data to register group and attach license and add ips.
|
75
|
-
* @param request.
|
114
|
+
* @param request.ipIds The IP IDs of the IPs to be added to the group.
|
76
115
|
* @param request.groupPool The address specifying how royalty will be split amongst the pool of IPs in the group.
|
77
|
-
* @param request.
|
78
|
-
* @param request.
|
116
|
+
* @param request.maxAllowedRewardShare The maximum reward share percentage that can be allocated to each member IP.
|
117
|
+
* @param {Object} request.licenseData licenseData The data of the license and its configuration to be attached to the new group IP.
|
118
|
+
* @param request.licenseData.licenseTermsId The ID of the registered license terms that will be attached to the new group IP.
|
119
|
+
* @param request.licenseData.licenseTemplate [Optional] The address of the license template to be attached to the new group IP, default value is Programmable IP License.
|
120
|
+
* @param request.licenseData.licensingConfig The licensing configuration for the IP.
|
121
|
+
* @param {Object} request.licenseTermsData.licensingConfig The PIL terms and licensing configuration data to attach to the IP.
|
122
|
+
* @param request.licenseTermsData.licensingConfig.isSet Whether the configuration is set or not.
|
123
|
+
* @param request.licenseTermsData.licensingConfig.mintingFee The minting fee to be paid when minting license tokens.
|
124
|
+
* @param request.licenseTermsData.licensingConfig.licensingHook The hook contract address for the licensing module, or address(0) if none
|
125
|
+
* @param request.licenseTermsData.licensingConfig.hookData The data to be used by the licensing hook.
|
126
|
+
* @param request.licenseTermsData.licensingConfig.commercialRevShare The commercial revenue share percentage.
|
127
|
+
* @param request.licenseTermsData.licensingConfig.disabled Whether the licensing is disabled or not.
|
128
|
+
* @param request.licenseTermsData.licensingConfig.expectMinimumGroupRewardShare The minimum percentage of the group’s reward share (from 0 to 100%, represented as 100 * 10 ** 6) that can be allocated to the IP when it is added to the group.
|
129
|
+
* If the remaining reward share in the group is less than the minimumGroupRewardShare,the IP cannot be added to the group.
|
130
|
+
* @param request.licenseTermsData.licensingConfig.expectGroupRewardPool The address of the expected group reward pool. The IP can only be added to a group with this specified reward pool address, or address(0) if the IP does not want to be added to any group.
|
79
131
|
* @param request.txOptions [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
80
132
|
* @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes group id.
|
81
133
|
* @emits PGroupRegistered (groupId, groupPool);
|
82
134
|
*/
|
83
135
|
registerGroupAndAttachLicenseAndAddIps(request: RegisterGroupAndAttachLicenseAndAddIpsRequest): Promise<RegisterGroupAndAttachLicenseAndAddIpsResponse>;
|
136
|
+
private getLicenseData;
|
84
137
|
}
|
85
138
|
//# sourceMappingURL=group.d.ts.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"group.d.ts","sourceRoot":"../../../../src/resources","sources":["group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,
|
1
|
+
{"version":3,"file":"group.d.ts","sourceRoot":"../../../../src/resources","sources":["group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAuB,MAAM,MAAM,CAAC;AAEzD,OAAO,EAEL,wBAAwB,EAExB,oBAAoB,EACpB,yBAAyB,EAEzB,uBAAuB,EAMvB,qBAAqB,EACrB,6BAA6B,EAC7B,0BAA0B,EAE1B,qBAAqB,EACrB,uBAAuB,EACvB,kBAAkB,EACnB,4BAAyB;AAK1B,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AACpD,OAAO,EAGL,qDAAqD,EACrD,sDAAsD,EACtD,6CAA6C,EAC7C,8CAA8C,EAC9C,oCAAoC,EACpC,qCAAqC,EACrC,oBAAoB,EACpB,qBAAqB,EACrB,8CAA8C,EAC9C,+CAA+C,EAChD,oCAAiC;AAMlC,qBAAa,WAAW;IACf,uBAAuB,EAAE,uBAAuB,CAAC;IACjD,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,6BAA6B,EAAE,6BAA6B,CAAC;IAEpE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAc3F;;;;;;OAMG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA0BzF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACU,8CAA8C,CACzD,OAAO,EAAE,qDAAqD,GAC7D,OAAO,CAAC,sDAAsD,CAAC;IAoElE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IAwG3D;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,6BAA6B,CACxC,OAAO,EAAE,oCAAoC,GAC5C,OAAO,CAAC,qCAAqC,CAAC;IA0BjD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACU,sCAAsC,CACjD,OAAO,EAAE,6CAA6C,GACrD,OAAO,CAAC,8CAA8C,CAAC;IAsD1D,OAAO,CAAC,cAAc;CAkBvB"}
|