@story-protocol/core-sdk 1.2.0-rc.2 → 1.2.0-rc.3
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 +3946 -1041
- 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 +2 -2
- package/dist/declarations/src/index.d.ts.map +1 -1
- package/dist/declarations/src/resources/group.d.ts.map +1 -1
- package/dist/declarations/src/resources/ipAsset.d.ts +204 -40
- package/dist/declarations/src/resources/ipAsset.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/ipAsset.d.ts +121 -27
- package/dist/declarations/src/types/resources/ipAsset.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/permission.d.ts +4 -2
- package/dist/declarations/src/types/resources/permission.d.ts.map +1 -1
- package/dist/declarations/src/utils/sign.d.ts +2 -2
- package/dist/declarations/src/utils/sign.d.ts.map +1 -1
- package/dist/story-protocol-core-sdk.cjs.dev.js +1644 -673
- package/dist/story-protocol-core-sdk.cjs.prod.js +1644 -673
- package/dist/story-protocol-core-sdk.esm.js +1644 -673
- package/package.json +1 -1
@@ -10,11 +10,11 @@ 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,
|
13
|
+
export type { RegisterRequest, RegisterIpResponse, RegisterDerivativeResponse, RegisterDerivativeRequest, RegisterDerivativeWithLicenseTokensRequest, RegisterDerivativeWithLicenseTokensResponse, MintAndRegisterIpAssetWithPilTermsRequest, MintAndRegisterIpAssetWithPilTermsResponse, RegisterIpAndMakeDerivativeRequest, RegisterIpAndMakeDerivativeResponse, RegisterIpAndAttachPilTermsRequest, RegisterIpAndAttachPilTermsResponse, MintAndRegisterIpAndMakeDerivativeRequest, MintAndRegisterIpAndMakeDerivativeResponse, GenerateCreatorMetadataParam, IpCreator, GenerateIpMetadataParam, IpMetadata, IpRelationship, IpAttribute, IpCreatorSocial, IpMedia, IPRobotTerms, StoryProtocolApp, MintAndRegisterIpRequest, RegisterPilTermsAndAttachRequest, RegisterPilTermsAndAttachResponse, MintAndRegisterIpAndMakeDerivativeWithLicenseTokensRequest, RegisterIpAndMakeDerivativeWithLicenseTokensRequest, BatchMintAndRegisterIpAssetWithPilTermsRequest, BatchMintAndRegisterIpAssetWithPilTermsResponse, BatchMintAndRegisterIpAndMakeDerivativeRequest, BatchMintAndRegisterIpAndMakeDerivativeResponse, BatchRegisterRequest, BatchRegisterResponse, BatchRegisterDerivativeRequest, BatchRegisterDerivativeResponse, RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest, RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse, RoyaltyShare, RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest, RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse, MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensRequest, MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensResponse, MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensRequest, MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensResponse, } from "./types/resources/ipAsset.js";
|
14
14
|
export type { RegisterNonComSocialRemixingPILRequest, RegisterCommercialUsePILRequest, RegisterCommercialRemixPILRequest, RegisterPILResponse, AttachLicenseTermsRequest, AttachLicenseTermsResponse, MintLicenseTokensRequest, MintLicenseTokensResponse, LicenseTermsId, LicenseTerms, PredictMintingLicenseFeeRequest, SetLicensingConfigRequest, SetLicensingConfigResponse, } from "./types/resources/license.js";
|
15
15
|
export { PIL_TYPE } from "./types/resources/license.js";
|
16
16
|
export type { PayRoyaltyOnBehalfRequest, PayRoyaltyOnBehalfResponse, SnapshotRequest, SnapshotResponse, ClaimableRevenueRequest, ClaimableRevenueResponse, SnapshotAndClaimBySnapshotBatchRequest, SnapshotAndClaimBySnapshotBatchResponse, SnapshotAndClaimByTokenBatchRequest, SnapshotAndClaimByTokenBatchResponse, TransferToVaultAndSnapshotAndClaimBySnapshotBatchRequest, TransferToVaultAndSnapshotAndClaimBySnapshotBatchResponse, TransferToVaultAndSnapshotAndClaimByTokenBatchRequest, TransferToVaultAndSnapshotAndClaimByTokenBatchResponse, } from "./types/resources/royalty.js";
|
17
|
-
export type { SetPermissionsRequest, SetPermissionsResponse, CreateSetPermissionSignatureRequest, SetAllPermissionsRequest, SetBatchPermissionsRequest, CreateBatchPermissionSignatureRequest, PermissionSignatureRequest,
|
17
|
+
export type { SetPermissionsRequest, SetPermissionsResponse, CreateSetPermissionSignatureRequest, SetAllPermissionsRequest, SetBatchPermissionsRequest, CreateBatchPermissionSignatureRequest, PermissionSignatureRequest, SignatureRequest, SignatureResponse, } from "./types/resources/permission.js";
|
18
18
|
export { AccessPermission } from "./types/resources/permission.js";
|
19
19
|
export type { RaiseDisputeRequest, RaiseDisputeResponse, CancelDisputeRequest, CancelDisputeResponse, ResolveDisputeRequest, ResolveDisputeResponse, } from "./types/resources/dispute.js";
|
20
20
|
export type { IPAccountExecuteRequest, IPAccountExecuteResponse, IPAccountExecuteWithSigRequest, IPAccountExecuteWithSigResponse, IpAccountStateResponse, TokenResponse, } from "./types/resources/ipAccount.js";
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"../../../src","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,oBAAiB;AACvC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,8BAA2B;AAC3D,OAAO,EAAE,OAAO,EAAE,yBAAsB;AACxC,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,gBAAgB,EAAE,kCAA+B;AAC1D,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,SAAS,EAAE,iCAA8B;AAClD,OAAO,EAAE,eAAe,EAAE,iCAA8B;AACxD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,WAAW,EAAE,6BAA0B;AAEhD,YAAY,EAAE,WAAW,EAAE,iBAAiB,EAAE,0BAAuB;AAErE,YAAY,EACV,eAAe,EACf,kBAAkB,EAClB,0BAA0B,EAC1B,yBAAyB,EACzB,0CAA0C,EAC1C,2CAA2C,EAC3C,
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"../../../src","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,oBAAiB;AACvC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,8BAA2B;AAC3D,OAAO,EAAE,OAAO,EAAE,yBAAsB;AACxC,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,gBAAgB,EAAE,kCAA+B;AAC1D,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,SAAS,EAAE,iCAA8B;AAClD,OAAO,EAAE,eAAe,EAAE,iCAA8B;AACxD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,WAAW,EAAE,6BAA0B;AAEhD,YAAY,EAAE,WAAW,EAAE,iBAAiB,EAAE,0BAAuB;AAErE,YAAY,EACV,eAAe,EACf,kBAAkB,EAClB,0BAA0B,EAC1B,yBAAyB,EACzB,0CAA0C,EAC1C,2CAA2C,EAC3C,yCAAyC,EACzC,0CAA0C,EAC1C,kCAAkC,EAClC,mCAAmC,EACnC,kCAAkC,EAClC,mCAAmC,EACnC,yCAAyC,EACzC,0CAA0C,EAC1C,4BAA4B,EAC5B,SAAS,EACT,uBAAuB,EACvB,UAAU,EACV,cAAc,EACd,WAAW,EACX,eAAe,EACf,OAAO,EACP,YAAY,EACZ,gBAAgB,EAChB,wBAAwB,EACxB,gCAAgC,EAChC,iCAAiC,EACjC,0DAA0D,EAC1D,mDAAmD,EACnD,8CAA8C,EAC9C,+CAA+C,EAC/C,8CAA8C,EAC9C,+CAA+C,EAC/C,oBAAoB,EACpB,qBAAqB,EACrB,8BAA8B,EAC9B,+BAA+B,EAC/B,gEAAgE,EAChE,iEAAiE,EACjE,YAAY,EACZ,wEAAwE,EACxE,yEAAyE,EACzE,mEAAmE,EACnE,oEAAoE,EACpE,mEAAmE,EACnE,oEAAoE,GACrE,qCAAkC;AAEnC,YAAY,EACV,sCAAsC,EACtC,+BAA+B,EAC/B,iCAAiC,EACjC,mBAAmB,EACnB,yBAAyB,EACzB,0BAA0B,EAC1B,wBAAwB,EACxB,yBAAyB,EACzB,cAAc,EACd,YAAY,EACZ,+BAA+B,EAC/B,yBAAyB,EACzB,0BAA0B,GAC3B,qCAAkC;AAEnC,OAAO,EAAE,QAAQ,EAAE,qCAAkC;AAErD,YAAY,EACV,yBAAyB,EACzB,0BAA0B,EAC1B,eAAe,EACf,gBAAgB,EAChB,uBAAuB,EACvB,wBAAwB,EACxB,sCAAsC,EACtC,uCAAuC,EACvC,mCAAmC,EACnC,oCAAoC,EACpC,wDAAwD,EACxD,yDAAyD,EACzD,qDAAqD,EACrD,sDAAsD,GACvD,qCAAkC;AAEnC,YAAY,EACV,qBAAqB,EACrB,sBAAsB,EACtB,mCAAmC,EACnC,wBAAwB,EACxB,0BAA0B,EAC1B,qCAAqC,EACrC,0BAA0B,EAC1B,gBAAgB,EAChB,iBAAiB,GAClB,wCAAqC;AAEtC,OAAO,EAAE,gBAAgB,EAAE,wCAAqC;AAEhE,YAAY,EACV,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,GACvB,qCAAkC;AAEnC,YAAY,EACV,uBAAuB,EACvB,wBAAwB,EACxB,8BAA8B,EAC9B,+BAA+B,EAC/B,sBAAsB,EACtB,aAAa,GACd,uCAAoC;AAErC,YAAY,EACV,0BAA0B,EAC1B,2BAA2B,GAC5B,uCAAoC;AAErC,YAAY,EACV,oBAAoB,EACpB,qBAAqB,EACrB,oCAAoC,EACpC,qCAAqC,EACrC,6CAA6C,EAC7C,8CAA8C,EAC9C,qDAAqD,EACrD,sDAAsD,EACtD,8CAA8C,EAC9C,+CAA+C,GAChD,mCAAgC;AAEjC,YAAY,EACV,wCAAwC,EACxC,0BAA0B,EAC1B,aAAa,EACb,+CAA+C,GAChD,2BAAwB;AAEzB,OAAO,EAAE,sBAAsB,EAAE,YAAY,EAAE,wBAAqB;AAEpE,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,wBAAqB"}
|
@@ -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;IA2ElE;;;;;;;;;;;;;;;;OAgBG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,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;IAyG3D;;;;;;;;OAQG;IACU,6BAA6B,CACxC,OAAO,EAAE,oCAAoC,GAC5C,OAAO,CAAC,qCAAqC,CAAC;IA8BjD;;;;;;;;;OASG;IACU,sCAAsC,CACjD,OAAO,EAAE,6CAA6C,GACrD,OAAO,CAAC,8CAA8C,CAAC;CAyD3D"}
|
@@ -1,7 +1,7 @@
|
|
1
1
|
import { Hex, PublicClient } from "viem";
|
2
2
|
import { SupportedChainIds } from "../types/config.js";
|
3
|
-
import { BatchMintAndRegisterIpAndMakeDerivativeRequest, BatchMintAndRegisterIpAndMakeDerivativeResponse, BatchMintAndRegisterIpAssetWithPilTermsRequest, BatchMintAndRegisterIpAssetWithPilTermsResponse, BatchRegisterDerivativeRequest, BatchRegisterDerivativeResponse, BatchRegisterRequest, BatchRegisterResponse,
|
4
|
-
import { AccessControllerClient, CoreMetadataModuleClient, DerivativeWorkflowsClient, IpAssetRegistryClient, LicenseAttachmentWorkflowsClient, LicenseRegistryReadOnlyClient, LicenseTokenReadOnlyClient, LicensingModuleClient, Multicall3Client, PiLicenseTemplateClient, RegistrationWorkflowsClient, SimpleWalletClient } from "../abi/generated.js";
|
3
|
+
import { BatchMintAndRegisterIpAndMakeDerivativeRequest, BatchMintAndRegisterIpAndMakeDerivativeResponse, BatchMintAndRegisterIpAssetWithPilTermsRequest, BatchMintAndRegisterIpAssetWithPilTermsResponse, BatchRegisterDerivativeRequest, BatchRegisterDerivativeResponse, BatchRegisterRequest, BatchRegisterResponse, MintAndRegisterIpAssetWithPilTermsRequest, MintAndRegisterIpAssetWithPilTermsResponse, GenerateCreatorMetadataParam, GenerateIpMetadataParam, IpCreator, IpMetadata, MintAndRegisterIpAndMakeDerivativeRequest, MintAndRegisterIpAndMakeDerivativeWithLicenseTokensRequest, MintAndRegisterIpRequest, RegisterDerivativeRequest, RegisterDerivativeResponse, RegisterDerivativeWithLicenseTokensRequest, RegisterDerivativeWithLicenseTokensResponse, RegisterIpAndAttachPilTermsRequest, RegisterIpAndAttachPilTermsResponse, RegisterIpAndMakeDerivativeRequest, RegisterIpAndMakeDerivativeResponse, RegisterIpAndMakeDerivativeWithLicenseTokensRequest, RegisterIpResponse, RegisterPilTermsAndAttachRequest, RegisterPilTermsAndAttachResponse, RegisterRequest, MintAndRegisterIpAndMakeDerivativeResponse, RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest, RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse, RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest, RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse, MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensRequest, MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensRequest, MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensResponse, MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensResponse } from "../types/resources/ipAsset.js";
|
4
|
+
import { AccessControllerClient, CoreMetadataModuleClient, DerivativeWorkflowsClient, IpAssetRegistryClient, LicenseAttachmentWorkflowsClient, LicenseRegistryReadOnlyClient, LicenseTokenReadOnlyClient, LicensingModuleClient, Multicall3Client, PiLicenseTemplateClient, RegistrationWorkflowsClient, RoyaltyModuleEventClient, RoyaltyTokenDistributionWorkflowsClient, SimpleWalletClient } from "../abi/generated.js";
|
5
5
|
export declare class IPAssetClient {
|
6
6
|
licensingModuleClient: LicensingModuleClient;
|
7
7
|
ipAssetRegistryClient: IpAssetRegistryClient;
|
@@ -14,10 +14,11 @@ export declare class IPAssetClient {
|
|
14
14
|
licenseAttachmentWorkflowsClient: LicenseAttachmentWorkflowsClient;
|
15
15
|
derivativeWorkflowsClient: DerivativeWorkflowsClient;
|
16
16
|
multicall3Client: Multicall3Client;
|
17
|
+
royaltyTokenDistributionWorkflowsClient: RoyaltyTokenDistributionWorkflowsClient;
|
18
|
+
royaltyModuleEventClient: RoyaltyModuleEventClient;
|
17
19
|
private readonly rpcClient;
|
18
20
|
private readonly wallet;
|
19
21
|
private readonly chainId;
|
20
|
-
private defaultLicenseTermsId;
|
21
22
|
constructor(rpcClient: PublicClient, wallet: SimpleWalletClient, chainId: SupportedChainIds);
|
22
23
|
/**
|
23
24
|
* Create a new `IpCreator` object with the specified details.
|
@@ -101,8 +102,8 @@ export declare class IPAssetClient {
|
|
101
102
|
* @param request.args.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
|
102
103
|
* @param request.args.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
|
103
104
|
* @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,
|
105
|
+
* @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property, without encodedTxDataOnly option.
|
106
|
+
* @returns A Promise that resolves to a transaction hash, if waitForTransaction is true, return an array of containing IP ID, Token ID, NFT Contract.
|
106
107
|
* @emits IPRegistered (ipId, chainId, tokenContract, tokenId, resolverAddr, metadataProviderAddress, metadata)
|
107
108
|
*/
|
108
109
|
batchRegister(request: BatchRegisterRequest): Promise<BatchRegisterResponse>;
|
@@ -148,41 +149,67 @@ export declare class IPAssetClient {
|
|
148
149
|
* Mint an NFT from a collection and register it as an IP.
|
149
150
|
* @param request - The request object that contains all data needed to mint and register ip.
|
150
151
|
* @param request.spgNftContract The address of the NFT collection.
|
151
|
-
* @param request.
|
152
|
+
* @param {Array} request.terms The array of license terms to be attached.
|
153
|
+
* @param request.terms.transferable Indicates whether the license is transferable or not.
|
154
|
+
* @param request.terms.royaltyPolicy The address of the royalty policy contract which required to StoryProtocol in advance.
|
155
|
+
* @param request.terms.mintingFee The fee to be paid when minting a license.
|
156
|
+
* @param request.terms.expiration The expiration period of the license.
|
157
|
+
* @param request.terms.commercialUse Indicates whether the work can be used commercially or not.
|
158
|
+
* @param request.terms.commercialAttribution Whether attribution is required when reproducing the work commercially or not.
|
159
|
+
* @param request.terms.commercializerChecker Commercializers that are allowed to commercially exploit the work. If zero address, then no restrictions is enforced.
|
160
|
+
* @param request.terms.commercializerCheckerData The data to be passed to the commercializer checker contract.
|
161
|
+
* @param request.terms.commercialRevShare Percentage of revenue that must be shared with the licensor.
|
162
|
+
* @param request.terms.commercialRevCeiling The maximum revenue that can be generated from the commercial use of the work.
|
163
|
+
* @param request.terms.derivativesAllowed Indicates whether the licensee can create derivatives of his work or not.
|
164
|
+
* @param request.terms.derivativesAttribution Indicates whether attribution is required for derivatives of the work or not.
|
165
|
+
* @param request.terms.derivativesApproval Indicates whether the licensor must approve derivatives of the work before they can be linked to the licensor IP ID or not.
|
166
|
+
* @param request.terms.derivativesReciprocal Indicates whether the licensee must license derivatives of the work under the same terms or not.
|
167
|
+
* @param request.terms.derivativeRevCeiling The maximum revenue that can be generated from the derivative use of the work.
|
168
|
+
* @param request.terms.currency The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
|
169
|
+
* @param request.terms.uri The URI of the license terms, which can be used to fetch the offchain license terms.
|
152
170
|
* @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
|
153
|
-
*
|
154
|
-
*
|
155
|
-
*
|
156
|
-
*
|
157
|
-
* @param request.royaltyPolicyAddress [Optional] The address of the royalty policy contract, default value is LAP.
|
171
|
+
* @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
|
172
|
+
* @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
|
173
|
+
* @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
|
174
|
+
* @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
158
175
|
* @param request.recipient [Optional] The address of the recipient of the minted NFT,default value is your wallet address.
|
159
|
-
* @param request.mintingFee [Optional] The fee to be paid when minting a license.
|
160
|
-
* @param request.commercialRevShare [Optional] Percentage of revenue that must be shared with the licensor.
|
161
|
-
* @param request.currency [Optional] The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
|
162
176
|
* @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
163
|
-
* @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true,
|
177
|
+
* @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, including IP ID, Token ID, License Terms Ids.
|
164
178
|
* @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
|
165
179
|
* @emits LicenseTermsAttached (caller, ipId, licenseTemplate, licenseTermsId)
|
166
180
|
*/
|
167
|
-
mintAndRegisterIpAssetWithPilTerms(request:
|
181
|
+
mintAndRegisterIpAssetWithPilTerms(request: MintAndRegisterIpAssetWithPilTermsRequest): Promise<MintAndRegisterIpAssetWithPilTermsResponse>;
|
168
182
|
/**
|
169
183
|
* Batch mint an NFT from a collection and register it as an IP.
|
170
184
|
* @param request - The request object that contains all data needed to batch mint and register ip.
|
171
185
|
* @param {Array} request.args The array of mint and register IP requests.
|
172
186
|
* @param request.args.spgNftContract The address of the NFT collection.
|
173
|
-
* @param request.args.
|
187
|
+
* @param {Array} request.args.terms The array of license terms to be attached.
|
188
|
+
* @param request.args.terms.transferable Indicates whether the license is transferable or not.
|
189
|
+
* @param request.args.terms.royaltyPolicy The address of the royalty policy contract which required to StoryProtocol in advance.
|
190
|
+
* @param request.args.terms.mintingFee The fee to be paid when minting a license.
|
191
|
+
* @param request.args.terms.expiration The expiration period of the license.
|
192
|
+
* @param request.args.terms.commercialUse Indicates whether the work can be used commercially or not.
|
193
|
+
* @param request.args.terms.commercialAttribution Whether attribution is required when reproducing the work commercially or not.
|
194
|
+
* @param request.args.terms.commercializerChecker Commercializers that are allowed to commercially exploit the work. If zero address, then no restrictions is enforced.
|
195
|
+
* @param request.args.terms.commercializerCheckerData The data to be passed to the commercializer checker contract.
|
196
|
+
* @param request.args.terms.commercialRevShare Percentage of revenue that must be shared with the licensor.
|
197
|
+
* @param request.args.terms.commercialRevCeiling The maximum revenue that can be generated from the commercial use of the work.
|
198
|
+
* @param request.args.terms.derivativesAllowed Indicates whether the licensee can create derivatives of his work or not.
|
199
|
+
* @param request.args.terms.derivativesAttribution Indicates whether attribution is required for derivatives of the work or not.
|
200
|
+
* @param request.args.terms.derivativesApproval Indicates whether the licensor must approve derivatives of the work before they can be linked to the licensor IP ID or not.
|
201
|
+
* @param request.args.terms.derivativesReciprocal Indicates whether the licensee must license derivatives of the work under the same terms or not.
|
202
|
+
* @param request.args.terms.derivativeRevCeiling The maximum revenue that can be generated from the derivative use of the work.
|
203
|
+
* @param request.args.terms.currency The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
|
204
|
+
* @param request.args.terms.uri The URI of the license terms, which can be used to fetch the offchain license terms.
|
174
205
|
* @param request.args.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
|
175
206
|
* @param request.args.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
|
176
|
-
*
|
177
|
-
*
|
178
|
-
*
|
179
|
-
* @param request.args.royaltyPolicyAddress [Optional] The address of the royalty policy contract, default value is LAP.
|
207
|
+
* @param request.args.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
|
208
|
+
* @param request.args.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
|
209
|
+
* @param request.args.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
180
210
|
* @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
211
|
* @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,
|
212
|
+
* @returns A Promise that resolves to a transaction hash, if waitForTransaction is true, return an array containing IP ID, Token ID, License Terms Ids, SPG NFT Contract.
|
186
213
|
* @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
|
187
214
|
* @emits LicenseTermsAttached (caller, ipId, licenseTemplate, licenseTermsId)
|
188
215
|
*/
|
@@ -192,19 +219,32 @@ export declare class IPAssetClient {
|
|
192
219
|
* @param request - The request object that contains all data needed to mint and register ip.
|
193
220
|
* @param request.nftContract The address of the NFT collection.
|
194
221
|
* @param request.tokenId The ID of the NFT.
|
195
|
-
* @param request.
|
222
|
+
* @param {Array} request.terms The array of license terms to be attached.
|
223
|
+
* @param request.terms.transferable Indicates whether the license is transferable or not.
|
224
|
+
* @param request.terms.royaltyPolicy The address of the royalty policy contract which required to StoryProtocol in advance.
|
225
|
+
* @param request.terms.mintingFee The fee to be paid when minting a license.
|
226
|
+
* @param request.terms.expiration The expiration period of the license.
|
227
|
+
* @param request.terms.commercialUse Indicates whether the work can be used commercially or not.
|
228
|
+
* @param request.terms.commercialAttribution Whether attribution is required when reproducing the work commercially or not.
|
229
|
+
* @param request.terms.commercializerChecker Commercializers that are allowed to commercially exploit the work. If zero address, then no restrictions is enforced.
|
230
|
+
* @param request.terms.commercializerCheckerData The data to be passed to the commercializer checker contract.
|
231
|
+
* @param request.terms.commercialRevShare Percentage of revenue that must be shared with the licensor.
|
232
|
+
* @param request.terms.commercialRevCeiling The maximum revenue that can be generated from the commercial use of the work.
|
233
|
+
* @param request.terms.derivativesAllowed Indicates whether the licensee can create derivatives of his work or not.
|
234
|
+
* @param request.terms.derivativesAttribution Indicates whether attribution is required for derivatives of the work or not.
|
235
|
+
* @param request.terms.derivativesApproval Indicates whether the licensor must approve derivatives of the work before they can be linked to the licensor IP ID or not.
|
236
|
+
* @param request.terms.derivativesReciprocal Indicates whether the licensee must license derivatives of the work under the same terms or not.
|
237
|
+
* @param request.terms.derivativeRevCeiling The maximum revenue that can be generated from the derivative use of the work.
|
238
|
+
* @param request.terms.currency The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
|
239
|
+
* @param request.terms.uri The URI of the license terms, which can be used to fetch the offchain license terms.
|
196
240
|
* @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
|
197
241
|
* @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
|
198
242
|
* @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
|
199
243
|
* @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
|
200
244
|
* @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
201
|
-
* @param request.royaltyPolicyAddress [Optional] The address of the royalty policy contract, default value is LAP.
|
202
245
|
* @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
|
203
|
-
* @param request.mintingFee [Optional] The fee to be paid when minting a license.
|
204
|
-
* @param request.commercialRevShare [Optional] Percentage of revenue that must be shared with the licensor.
|
205
|
-
* @param request.currency [Optional] The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
|
206
246
|
* @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
207
|
-
* @returns A Promise that resolves to
|
247
|
+
* @returns A Promise that resolves to a transaction hash, if waitForTransaction is true, including IP ID, token ID and License terms IDs.
|
208
248
|
* @emits LicenseTermsAttached (caller, ipId, licenseTemplate, licenseTermsId)
|
209
249
|
*/
|
210
250
|
registerIpAndAttachPilTerms(request: RegisterIpAndAttachPilTermsRequest): Promise<RegisterIpAndAttachPilTermsResponse>;
|
@@ -224,7 +264,7 @@ export declare class IPAssetClient {
|
|
224
264
|
* @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
225
265
|
* @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
|
226
266
|
* @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
227
|
-
* @returns A Promise that resolves to
|
267
|
+
* @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, included IP ID, Token ID.
|
228
268
|
* @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
|
229
269
|
*/
|
230
270
|
registerDerivativeIp(request: RegisterIpAndMakeDerivativeRequest): Promise<RegisterIpAndMakeDerivativeResponse>;
|
@@ -243,7 +283,7 @@ export declare class IPAssetClient {
|
|
243
283
|
* @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
244
284
|
* @param request.recipient [Optional] The address of the recipient of the minted NFT,default value is your wallet address.
|
245
285
|
* @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
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
|
286
|
+
* @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes child IP ID and token ID.
|
247
287
|
* @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
|
248
288
|
*/
|
249
289
|
mintAndRegisterIpAndMakeDerivative(request: MintAndRegisterIpAndMakeDerivativeRequest): Promise<MintAndRegisterIpAndMakeDerivativeResponse>;
|
@@ -263,7 +303,7 @@ export declare class IPAssetClient {
|
|
263
303
|
* @param request.args.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
264
304
|
* @param request.arg.recipient [Optional] The address of the recipient of the minted NFT,default value is your wallet address.
|
265
305
|
* @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,
|
306
|
+
* @returns A Promise that resolves to a transaction hash, if waitForTransaction is true, return an array of containing IP ID and token ID, SPG NFT Contract.
|
267
307
|
* @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
|
268
308
|
*/
|
269
309
|
batchMintAndRegisterIpAndMakeDerivative(request: BatchMintAndRegisterIpAndMakeDerivativeRequest): Promise<BatchMintAndRegisterIpAndMakeDerivativeResponse>;
|
@@ -286,7 +326,7 @@ export declare class IPAssetClient {
|
|
286
326
|
* Register Programmable IP License Terms (if unregistered) and attach it to IP.
|
287
327
|
* @param request - The request object that contains all data needed to attach license terms.
|
288
328
|
* @param request.ipId The ID of the IP.
|
289
|
-
* @param request.terms The
|
329
|
+
* @param {Array} request.terms The array of license terms to be attached.
|
290
330
|
* @param request.terms.transferable Indicates whether the license is transferable or not.
|
291
331
|
* @param request.terms.royaltyPolicy The address of the royalty policy contract which required to StoryProtocol in advance.
|
292
332
|
* @param request.terms.mintingFee The fee to be paid when minting a license.
|
@@ -306,7 +346,7 @@ export declare class IPAssetClient {
|
|
306
346
|
* @param request.terms.uri The URI of the license terms, which can be used to fetch the offchain license terms.
|
307
347
|
* @param request.deadline [Optional] The deadline for the signature in milliseconds, default is 1000s.
|
308
348
|
* @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
309
|
-
* @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true,
|
349
|
+
* @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, returns an array containing the license terms ID.
|
310
350
|
* @emits LicenseTermsAttached (caller, ipId, licenseTemplate, licenseTermsId)
|
311
351
|
*/
|
312
352
|
registerPilTermsAndAttach(request: RegisterPilTermsAndAttachRequest): Promise<RegisterPilTermsAndAttachResponse>;
|
@@ -339,15 +379,139 @@ export declare class IPAssetClient {
|
|
339
379
|
* @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
340
380
|
* @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
|
341
381
|
* @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
|
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.
|
382
|
+
* @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, or if waitForTransaction is true, includes IP ID, Token ID.
|
343
383
|
*/
|
344
384
|
registerIpAndMakeDerivativeWithLicenseTokens(request: RegisterIpAndMakeDerivativeWithLicenseTokensRequest): Promise<RegisterIpResponse>;
|
385
|
+
/**
|
386
|
+
* Register the given NFT and attach license terms and distribute royalty tokens. In order to successfully distribute royalty tokens, the license terms attached to the IP must be
|
387
|
+
* a commercial license.
|
388
|
+
* @param request - The request object that contains all data needed to register ip and attach license terms and distribute royalty tokens.
|
389
|
+
* @param request.nftContract The address of the NFT collection.
|
390
|
+
* @param request.tokenId The ID of the NFT.
|
391
|
+
* @param request.terms The array of license terms to be attached.
|
392
|
+
* @param request.terms.transferable Indicates whether the license is transferable or not.
|
393
|
+
* @param request.terms.royaltyPolicy The address of the royalty policy contract which required to StoryProtocol in advance.
|
394
|
+
* @param request.terms.mintingFee The fee to be paid when minting a license.
|
395
|
+
* @param request.terms.expiration The expiration period of the license.
|
396
|
+
* @param request.terms.commercialUse Indicates whether the work can be used commercially or not, Commercial use is required to deploy a royalty vault.
|
397
|
+
* @param request.terms.commercialAttribution Whether attribution is required when reproducing the work commercially or not.
|
398
|
+
* @param request.terms.commercializerChecker Commercializers that are allowed to commercially exploit the work. If zero address, then no restrictions is enforced.
|
399
|
+
* @param request.terms.commercializerCheckerData The data to be passed to the commercializer checker contract.
|
400
|
+
* @param request.terms.commercialRevShare Percentage of revenue that must be shared with the licensor.
|
401
|
+
* @param request.terms.commercialRevCeiling The maximum revenue that can be generated from the commercial use of the work.
|
402
|
+
* @param request.terms.derivativesAllowed Indicates whether the licensee can create derivatives of his work or not.
|
403
|
+
* @param request.terms.derivativesAttribution Indicates whether attribution is required for derivatives of the work or not.
|
404
|
+
* @param request.terms.derivativesApproval Indicates whether the licensor must approve derivatives of the work before they can be linked to the licensor IP ID or not.
|
405
|
+
* @param request.terms.derivativesReciprocal Indicates whether the licensee must license derivatives of the work under the same terms or not.
|
406
|
+
* @param request.terms.derivativeRevCeiling The maximum revenue that can be generated from the derivative use of the work.
|
407
|
+
* @param request.terms.currency The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
|
408
|
+
* @param request.terms.uri The URI of the license terms, which can be used to fetch the offchain license terms.
|
409
|
+
* @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
|
410
|
+
* @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
|
411
|
+
* @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
|
412
|
+
* @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
|
413
|
+
* @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
414
|
+
* @param {Array} request.royaltyShares Authors of the IP and their shares of the royalty tokens.
|
415
|
+
* @param request.royaltyShares.author The address of the author.
|
416
|
+
* @param request.royaltyShares.percentage The percentage of the royalty share, 10 represents 10%.
|
417
|
+
* @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
|
418
|
+
* @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property, without encodedTxData option.
|
419
|
+
* @returns A Promise that resolves to a transaction hashes, IP ID, License terms ID, and IP royalty vault.
|
420
|
+
* @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
|
421
|
+
* @emits IpRoyaltyVaultDeployed (ipId, ipRoyaltyVault)
|
422
|
+
*/
|
423
|
+
registerIPAndAttachLicenseTermsAndDistributeRoyaltyTokens(request: RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest): Promise<RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse>;
|
424
|
+
/**
|
425
|
+
* Register the given NFT as a derivative IP and attach license terms and distribute royalty tokens. In order to successfully distribute royalty tokens, the license terms attached to the IP must be
|
426
|
+
* a commercial license.
|
427
|
+
* @param request - The request object that contains all data needed to register derivative IP and distribute royalty tokens.
|
428
|
+
* @param request.nftContract The address of the NFT collection.
|
429
|
+
* @param request.tokenId The ID of the NFT.
|
430
|
+
* @param request.derivData The derivative data to be used for registerDerivative.
|
431
|
+
* @param request.derivData.parentIpIds The IDs of the parent IPs to link the registered derivative IP.
|
432
|
+
* @param request.derivData.licenseTemplate [Optional] The address of the license template to be used for the linking.
|
433
|
+
* @param request.derivData.licenseTermsIds The IDs of the license terms to be used for the linking.
|
434
|
+
* @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
|
435
|
+
* @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
|
436
|
+
* @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
|
437
|
+
* @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
|
438
|
+
* @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
439
|
+
* @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
|
440
|
+
* @param {Array} request.royaltyShares Authors of the IP and their shares of the royalty tokens.
|
441
|
+
* @param request.royaltyShares.author The address of the author.
|
442
|
+
* @param request.royaltyShares.percentage The percentage of the royalty share, 10 represents 10%.
|
443
|
+
* @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property, without encodedTxData option.
|
444
|
+
* @returns A Promise that resolves to a transaction hashes, IP ID and IP royalty vault, token ID.
|
445
|
+
* @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
|
446
|
+
* @emits IpRoyaltyVaultDeployed (ipId, ipRoyaltyVault)
|
447
|
+
*/
|
448
|
+
registerDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokens(request: RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest): Promise<RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse>;
|
449
|
+
/**
|
450
|
+
* Mint an NFT and register the IP, attach PIL terms, and distribute royalty tokens. In order to successfully distribute royalty tokens, the license terms attached to the IP must be
|
451
|
+
* a commercial license.
|
452
|
+
* @param request - The request object that contains all data needed to mint an NFT and register the IP, attach PIL terms, and distribute royalty tokens.
|
453
|
+
* @param request.spgNftContract The address of the SPG NFT contract.
|
454
|
+
* @param request.terms The array of license terms to be attached.
|
455
|
+
* @param request.terms.transferable Indicates whether the license is transferable or not.
|
456
|
+
* @param request.terms.royaltyPolicy The address of the royalty policy contract which required to StoryProtocol in advance.
|
457
|
+
* @param request.terms.mintingFee The fee to be paid when minting a license.
|
458
|
+
* @param request.terms.expiration The expiration period of the license.
|
459
|
+
* @param request.terms.commercialUse Indicates whether the work can be used commercially or not, Commercial use is required to deploy a royalty vault.
|
460
|
+
* @param request.terms.commercialAttribution Whether attribution is required when reproducing the work commercially or not.
|
461
|
+
* @param request.terms.commercializerChecker Commercializers that are allowed to commercially exploit the work. If zero address, then no restrictions is enforced.
|
462
|
+
* @param request.terms.commercializerCheckerData The data to be passed to the commercializer checker contract.
|
463
|
+
* @param request.terms.commercialRevShare Percentage of revenue that must be shared with the licensor.
|
464
|
+
* @param request.terms.commercialRevCeiling The maximum revenue that can be generated from the commercial use of the work.
|
465
|
+
* @param request.terms.derivativesAllowed Indicates whether the licensee can create derivatives of his work or not.
|
466
|
+
* @param request.terms.derivativesAttribution Indicates whether attribution is required for derivatives of the work or not.
|
467
|
+
* @param request.terms.derivativesApproval Indicates whether the licensor must approve derivatives of the work before they can be linked to the licensor IP ID or not.
|
468
|
+
* @param request.terms.derivativesReciprocal Indicates whether the licensee must license derivatives of the work under the same terms or not.
|
469
|
+
* @param request.terms.derivativeRevCeiling The maximum revenue that can be generated from the derivative use of the work.
|
470
|
+
* @param request.terms.currency The ERC20 token to be used to pay the minting fee. the token must be registered in story protocol.
|
471
|
+
* @param request.terms.uri The URI of the license terms, which can be used to fetch the offchain license terms.
|
472
|
+
* @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
|
473
|
+
* @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
|
474
|
+
* @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
|
475
|
+
* @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
|
476
|
+
* @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
477
|
+
* @param {Array} request.royaltyShares Authors of the IP and their shares of the royalty tokens.
|
478
|
+
* @param request.royaltyShares.author The address of the author.
|
479
|
+
* @param request.royaltyShares.percentage The percentage of the royalty share, 10 represents 10%.
|
480
|
+
* @param request.recipient - [Optional] The address to receive the minted NFT,default value is your wallet address.
|
481
|
+
* @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property, without encodedTxData option.
|
482
|
+
* @returns A Promise that resolves to a transaction hash, IP ID, License terms ID, and IP royalty vault, Token ID.
|
483
|
+
* @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
|
484
|
+
*/
|
485
|
+
mintAndRegisterIpAndAttachPilTermsAndDistributeRoyaltyTokens(request: MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensRequest): Promise<MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensResponse>;
|
486
|
+
/**
|
487
|
+
* Mint an NFT and register the IP, make a derivative, and distribute royalty tokens. In order to successfully distribute royalty tokens, the license terms attached to the IP must be
|
488
|
+
* a commercial license.
|
489
|
+
* @param request - The request object that contains all data needed to mint an NFT and register the IP, make a derivative, and distribute royalty tokens.
|
490
|
+
* @param request.spgNftContract The address of the SPG NFT collection.
|
491
|
+
* @param request.derivData The derivative data to be used for registerDerivative.
|
492
|
+
* @param request.derivData.parentIpIds The IDs of the parent IPs to link the registered derivative IP.
|
493
|
+
* @param request.derivData.licenseTemplate [Optional] The address of the license template to be used for the linking.
|
494
|
+
* @param request.derivData.licenseTermsIds The IDs of the license terms to be used for the linking.
|
495
|
+
* @param request.ipMetadata - [Optional] The desired metadata for the newly minted NFT and newly registered IP.
|
496
|
+
* @param request.ipMetadata.ipMetadataURI [Optional] The URI of the metadata for the IP.
|
497
|
+
* @param request.ipMetadata.ipMetadataHash [Optional] The hash of the metadata for the IP.
|
498
|
+
* @param request.ipMetadata.nftMetadataURI [Optional] The URI of the metadata for the NFT.
|
499
|
+
* @param request.ipMetadata.nftMetadataHash [Optional] The hash of the metadata for the IP NFT.
|
500
|
+
* @param {Array} request.royaltyShares Authors of the IP and their shares of the royalty tokens.
|
501
|
+
* @param request.royaltyShares.author The address of the author.
|
502
|
+
* @param request.royaltyShares.percentage The percentage of the royalty share, 10 represents 10%.
|
503
|
+
* @param request.recipient - [Optional] The address to receive the minted NFT,default value is your wallet address.
|
504
|
+
* @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property, without encodedTxData option..
|
505
|
+
* @returns A Promise that resolves to a transaction hash, IP ID and token ID.
|
506
|
+
* @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
|
507
|
+
*/
|
508
|
+
mintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokens(request: MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensRequest): Promise<MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensResponse>;
|
509
|
+
private getRoyaltyShares;
|
510
|
+
private distributeRoyaltyTokens;
|
345
511
|
private getIpIdAddress;
|
346
512
|
isRegistered(ipId: Hex): Promise<boolean>;
|
347
|
-
private getSigSignatureState;
|
348
513
|
private getLicenseTermsId;
|
349
514
|
private validateLicenseTokenIds;
|
350
|
-
private
|
351
|
-
private getDefaultLicenseTerms;
|
515
|
+
private getIpIdAndTokenIdsFromEvent;
|
352
516
|
}
|
353
517
|
//# sourceMappingURL=ipAsset.d.ts.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,GAAG,EACH,YAAY,
|
1
|
+
{"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,GAAG,EACH,YAAY,EAQb,MAAM,MAAM,CAAC;AAGd,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAEpD,OAAO,EACL,8CAA8C,EAC9C,+CAA+C,EAC/C,8CAA8C,EAC9C,+CAA+C,EAC/C,8BAA8B,EAC9B,+BAA+B,EAC/B,oBAAoB,EACpB,qBAAqB,EACrB,yCAAyC,EACzC,0CAA0C,EAC1C,4BAA4B,EAC5B,uBAAuB,EACvB,SAAS,EACT,UAAU,EACV,yCAAyC,EACzC,0DAA0D,EAC1D,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC1B,0CAA0C,EAC1C,2CAA2C,EAC3C,kCAAkC,EAClC,mCAAmC,EACnC,kCAAkC,EAClC,mCAAmC,EACnC,mDAAmD,EACnD,kBAAkB,EAClB,gCAAgC,EAChC,iCAAiC,EACjC,eAAe,EACf,0CAA0C,EAC1C,gEAAgE,EAGhE,iEAAiE,EAGjE,wEAAwE,EACxE,yEAAyE,EACzE,mEAAmE,EACnE,mEAAmE,EACnE,oEAAoE,EACpE,oEAAoE,EACrE,sCAAmC;AACpC,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,yBAAyB,EAMzB,qBAAqB,EAErB,gCAAgC,EAIhC,6BAA6B,EAC7B,0BAA0B,EAC1B,qBAAqB,EACrB,gBAAgB,EAChB,uBAAuB,EACvB,2BAA2B,EAG3B,wBAAwB,EACxB,uCAAuC,EACvC,kBAAkB,EAInB,4BAAyB;AAO1B,qBAAa,aAAa;IACjB,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,2BAA2B,EAAE,2BAA2B,CAAC;IACzD,gCAAgC,EAAE,gCAAgC,CAAC;IACnE,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,uCAAuC,EAAE,uCAAuC,CAAC;IACjF,wBAAwB,EAAE,wBAAwB,CAAC;IAE1D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAsB3F;;;;;;;;;;;;;OAaG;IACI,uBAAuB,CAAC,KAAK,EAAE,4BAA4B,GAAG,SAAS;IAqB9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACI,kBAAkB,CAAC,KAAK,EAAE,uBAAuB,GAAG,UAAU;IAiCrE;;;;;;;;;;;;;;OAcG;IACU,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA0F5E;;;;;;;;;;;;;;OAcG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAwCzF;;;;;;;;;;;;OAYG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IA4DtC;;;;;;;;;;OAUG;IACU,uBAAuB,CAClC,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC;IA+E3C;;;;;;;;;;OAUG;IACU,mCAAmC,CAC9C,OAAO,EAAE,0CAA0C,GAClD,OAAO,CAAC,2CAA2C,CAAC;IAiCvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACU,kCAAkC,CAC7C,OAAO,EAAE,yCAAyC,GACjD,OAAO,CAAC,0CAA0C,CAAC;IAgDtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IAiD3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACU,2BAA2B,CACtC,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IAwG/C;;;;;;;;;;;;;;;;;;OAkBG;IACU,oBAAoB,CAC/B,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IA8H/C;;;;;;;;;;;;;;;;;OAiBG;IACU,kCAAkC,CAC7C,OAAO,EAAE,yCAAyC,GACjD,OAAO,CAAC,0CAA0C,CAAC;IAiEtD;;;;;;;;;;;;;;;;;;OAkBG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IAkC3D;;;;;;;;;;;;;OAaG;IACU,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAgC9F;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,yBAAyB,CACpC,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,iCAAiC,CAAC;IAoE7C;;;;;;;;;;;;;;OAcG;IACU,mDAAmD,CAC9D,OAAO,EAAE,0DAA0D,GAClE,OAAO,CAAC,kBAAkB,CAAC;IA4C9B;;;;;;;;;;;;;;OAcG;IACU,4CAA4C,CACvD,OAAO,EAAE,mDAAmD,GAC3D,OAAO,CAAC,kBAAkB,CAAC;IA6F9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACU,yDAAyD,CACpE,OAAO,EAAE,gEAAgE,GACxE,OAAO,CAAC,iEAAiE,CAAC;IAoH7E;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,iEAAiE,CAC5E,OAAO,EAAE,wEAAwE,GAChF,OAAO,CAAC,yEAAyE,CAAC;IAmHrF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACU,4DAA4D,CACvE,OAAO,EAAE,mEAAmE,GAC3E,OAAO,CAAC,oEAAoE,CAAC;IAiDhF;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,4DAA4D,CACvE,OAAO,EAAE,mEAAmE,GAC3E,OAAO,CAAC,oEAAoE,CAAC;IA4DhF,OAAO,CAAC,gBAAgB;YAqBV,uBAAuB;YAyCvB,cAAc;IAYf,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;YAIxC,iBAAiB;YAWjB,uBAAuB;IAkBrC,OAAO,CAAC,2BAA2B;CAgBpC"}
|