@story-protocol/core-sdk 1.3.1-beta → 1.3.2
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 +996 -3811
- package/dist/declarations/src/abi/generated.d.ts.map +1 -1
- package/dist/declarations/src/client.d.ts +6 -6
- package/dist/declarations/src/client.d.ts.map +1 -1
- package/dist/declarations/src/index.d.ts +2 -3
- 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 +22 -1
- package/dist/declarations/src/resources/group.d.ts.map +1 -1
- package/dist/declarations/src/resources/ipAccount.d.ts +1 -1
- package/dist/declarations/src/resources/ipAccount.d.ts.map +1 -1
- package/dist/declarations/src/resources/ipAsset.d.ts +1 -1
- package/dist/declarations/src/resources/ipAsset.d.ts.map +1 -1
- package/dist/declarations/src/resources/license.d.ts +18 -2
- package/dist/declarations/src/resources/license.d.ts.map +1 -1
- package/dist/declarations/src/resources/nftClient.d.ts +13 -1
- package/dist/declarations/src/resources/nftClient.d.ts.map +1 -1
- package/dist/declarations/src/resources/permission.d.ts +1 -1
- package/dist/declarations/src/resources/permission.d.ts.map +1 -1
- package/dist/declarations/src/resources/royalty.d.ts +4 -4
- package/dist/declarations/src/resources/royalty.d.ts.map +1 -1
- package/dist/declarations/src/resources/wip.d.ts +6 -5
- package/dist/declarations/src/resources/wip.d.ts.map +1 -1
- package/dist/declarations/src/types/config.d.ts +2 -2
- package/dist/declarations/src/types/config.d.ts.map +1 -1
- package/dist/declarations/src/types/options.d.ts +15 -8
- package/dist/declarations/src/types/options.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/dispute.d.ts +34 -8
- package/dist/declarations/src/types/resources/dispute.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/group.d.ts +39 -7
- package/dist/declarations/src/types/resources/group.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/ipAccount.d.ts +4 -4
- package/dist/declarations/src/types/resources/ipAccount.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/ipAsset.d.ts +23 -22
- package/dist/declarations/src/types/resources/ipAsset.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/license.d.ts +17 -7
- package/dist/declarations/src/types/resources/license.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/nftClient.d.ts +14 -3
- package/dist/declarations/src/types/resources/nftClient.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/permission.d.ts +6 -5
- package/dist/declarations/src/types/resources/permission.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/royalty.d.ts +10 -6
- package/dist/declarations/src/types/resources/royalty.d.ts.map +1 -1
- package/dist/declarations/src/types/utils/wip.d.ts +4 -3
- package/dist/declarations/src/types/utils/wip.d.ts.map +1 -1
- package/dist/declarations/src/utils/oov3.d.ts +29 -0
- package/dist/declarations/src/utils/oov3.d.ts.map +1 -0
- package/dist/declarations/src/utils/sign.d.ts.map +1 -1
- package/dist/declarations/src/utils/token.d.ts +1 -1
- package/dist/declarations/src/utils/token.d.ts.map +1 -1
- package/dist/story-protocol-core-sdk.cjs.dev.js +8671 -8962
- package/dist/story-protocol-core-sdk.cjs.prod.js +8671 -8962
- package/dist/story-protocol-core-sdk.esm.js +8648 -8939
- package/package.json +7 -4
@@ -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,iBAAiB,EAAE,8BAA2B;AACvD,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,yBAAsB;AAChD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,gBAAgB,EAAE,kCAA+B;AAC1D,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,SAAS,EAAE,iCAA8B;AAClD,OAAO,EAAE,eAAe,EAAE,iCAA8B;AACxD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,WAAW,EAAE,6BAA0B;AAChD,OAAO,EAAE,SAAS,EAAE,2BAAwB;AAE5C,kCAA+B;AAC/B,kCAA+B;AAC/B,mCAAgC;AAEhC,6CAA0C;AAC1C,gDAA6C;AAC7C,6CAA0C;AAC1C,6CAA0C;AAC1C,gDAA6C;AAC7C,6CAA0C;AAC1C,+CAA4C;AAC5C,+CAA4C;AAC5C,2CAAwC;AACxC,yCAAsC;AAEtC,
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"../../../src","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,oBAAiB;AACvC,OAAO,EAAE,iBAAiB,EAAE,8BAA2B;AACvD,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,yBAAsB;AAChD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,gBAAgB,EAAE,kCAA+B;AAC1D,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,SAAS,EAAE,iCAA8B;AAClD,OAAO,EAAE,eAAe,EAAE,iCAA8B;AACxD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,WAAW,EAAE,6BAA0B;AAChD,OAAO,EAAE,SAAS,EAAE,2BAAwB;AAE5C,kCAA+B;AAC/B,kCAA+B;AAC/B,mCAAgC;AAEhC,6CAA0C;AAC1C,gDAA6C;AAC7C,6CAA0C;AAC1C,6CAA0C;AAC1C,gDAA6C;AAC7C,6CAA0C;AAC1C,+CAA4C;AAC5C,+CAA4C;AAC5C,2CAAwC;AACxC,yCAAsC;AAEtC,YAAY,EACV,aAAa,EACb,0BAA0B,EAC1B,+CAA+C,EAC/C,wCAAwC,GACzC,2BAAwB;AAEzB,OAAO,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,2BAAwB;AAEnF,OAAO,EAAE,sBAAsB,EAAE,YAAY,EAAE,wBAAqB;AAEpE,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,wBAAqB;AAE1E,OAAO,EAAE,eAAe,EAAE,wBAAqB"}
|
@@ -1,8 +1,8 @@
|
|
1
1
|
import { Hex, PublicClient } from "viem";
|
2
|
-
import { CancelDisputeRequest, CancelDisputeResponse, DisputeAssertionRequest, RaiseDisputeRequest, RaiseDisputeResponse, ResolveDisputeRequest, ResolveDisputeResponse, TagIfRelatedIpInfringedRequest } from "../types/resources/dispute.js";
|
3
2
|
import { ArbitrationPolicyUmaClient, DisputeModuleClient, Multicall3Client, SimpleWalletClient, WrappedIpClient } from "../abi/generated.js";
|
4
3
|
import { ChainIds } from "../types/config.js";
|
5
4
|
import { TransactionResponse } from "../types/options.js";
|
5
|
+
import { CancelDisputeRequest, CancelDisputeResponse, DisputeAssertionRequest, RaiseDisputeRequest, RaiseDisputeResponse, ResolveDisputeRequest, ResolveDisputeResponse, TagIfRelatedIpInfringedRequest } from "../types/resources/dispute.js";
|
6
6
|
export declare class DisputeClient {
|
7
7
|
disputeModuleClient: DisputeModuleClient;
|
8
8
|
arbitrationPolicyUmaClient: ArbitrationPolicyUmaClient;
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"dispute.d.ts","sourceRoot":"../../../../src/resources","sources":["dispute.ts"],"names":[],"mappings":"AAAA,OAAO,
|
1
|
+
{"version":3,"file":"dispute.d.ts","sourceRoot":"../../../../src/resources","sources":["dispute.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6B,GAAG,EAAc,YAAY,EAAe,MAAM,MAAM,CAAC;AAE7F,OAAO,EACL,0BAA0B,EAC1B,mBAAmB,EAGnB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EAChB,4BAAyB;AAE1B,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAC3C,OAAO,EAAE,mBAAmB,EAAE,4BAAyB;AACvD,OAAO,EACL,oBAAoB,EACpB,qBAAqB,EACrB,uBAAuB,EACvB,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACtB,8BAA8B,EAC/B,sCAAmC;AAQpC,qBAAa,aAAa;IACjB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,eAAe,EAAE,eAAe,CAAC;IACxC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;IACnC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAUlF;;;;OAIG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAmFtF;;;;OAIG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAqBzF;;;;OAIG;IACU,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAsB5F;;;;;OAKG;IACU,uBAAuB,CAClC,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAwCjC;;;;;;;;;;;OAWG;IACU,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA0GhF,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAM9E"}
|
@@ -1,8 +1,8 @@
|
|
1
1
|
import { PublicClient } from "viem";
|
2
2
|
import { CoreMetadataModuleClient, GroupingModuleClient, GroupingModuleEventClient, GroupingWorkflowsClient, IpAssetRegistryClient, LicenseRegistryReadOnlyClient, LicenseTokenReadOnlyClient, LicensingModuleClient, PiLicenseTemplateClient, RoyaltyModuleEventClient, SimpleWalletClient } from "../abi/generated.js";
|
3
3
|
import { ChainIds } from "../types/config.js";
|
4
|
-
import { MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest, MintAndRegisterIpAndAttachLicenseAndAddToGroupResponse, RegisterGroupAndAttachLicenseAndAddIpsRequest, RegisterGroupAndAttachLicenseAndAddIpsResponse, RegisterGroupAndAttachLicenseRequest, RegisterGroupAndAttachLicenseResponse, RegisterGroupRequest, RegisterGroupResponse, RegisterIpAndAttachLicenseAndAddToGroupRequest, RegisterIpAndAttachLicenseAndAddToGroupResponse, CollectAndDistributeGroupRoyaltiesRequest, CollectAndDistributeGroupRoyaltiesResponse, AddIpRequest } from "../types/resources/group.js";
|
5
4
|
import { TransactionResponse } from "../types/options.js";
|
5
|
+
import { AddIpRequest, ClaimRewardRequest, ClaimRewardResponse, CollectAndDistributeGroupRoyaltiesRequest, CollectAndDistributeGroupRoyaltiesResponse, CollectRoyaltiesRequest, CollectRoyaltiesResponse, GetClaimableRewardRequest, MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest, MintAndRegisterIpAndAttachLicenseAndAddToGroupResponse, RegisterGroupAndAttachLicenseAndAddIpsRequest, RegisterGroupAndAttachLicenseAndAddIpsResponse, RegisterGroupAndAttachLicenseRequest, RegisterGroupAndAttachLicenseResponse, RegisterGroupRequest, RegisterGroupResponse, RegisterIpAndAttachLicenseAndAddToGroupRequest, RegisterIpAndAttachLicenseAndAddToGroupResponse, RemoveIpsFromGroupRequest } from "../types/resources/group.js";
|
6
6
|
export declare class GroupClient {
|
7
7
|
groupingWorkflowsClient: GroupingWorkflowsClient;
|
8
8
|
groupingModuleEventClient: GroupingModuleEventClient;
|
@@ -54,6 +54,27 @@ export declare class GroupClient {
|
|
54
54
|
* The function must be called by the Group IP owner or an authorized operator.
|
55
55
|
*/
|
56
56
|
addIpsToGroup({ groupIpId, ipIds, maxAllowedRewardSharePercentage, txOptions, }: AddIpRequest): Promise<TransactionResponse>;
|
57
|
+
/**
|
58
|
+
* Returns the available reward for each IP in the group.
|
59
|
+
*/
|
60
|
+
getClaimableReward({ groupIpId, currencyToken, memberIpIds, }: GetClaimableRewardRequest): Promise<bigint[]>;
|
61
|
+
/**
|
62
|
+
* Removes IPs from group.
|
63
|
+
* The function must be called by the Group IP owner or an authorized operator.
|
64
|
+
*/
|
65
|
+
removeIpsFromGroup({ groupIpId, ipIds, txOptions, }: RemoveIpsFromGroupRequest): Promise<TransactionResponse>;
|
66
|
+
/**
|
67
|
+
* Claims reward.
|
68
|
+
*
|
69
|
+
* Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/grouping/IGroupingModule.sol#L31 | `ClaimedReward`} event.
|
70
|
+
*/
|
71
|
+
claimReward({ groupIpId, currencyToken, memberIpIds, txOptions, }: ClaimRewardRequest): Promise<ClaimRewardResponse>;
|
72
|
+
/**
|
73
|
+
* Collects royalties into the pool, making them claimable by group member IPs.
|
74
|
+
*
|
75
|
+
* Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/grouping/IGroupingModule.sol#L38 | `CollectedRoyaltiesToGroupPool`} event.
|
76
|
+
*/
|
77
|
+
collectRoyalties({ groupIpId, currencyToken, txOptions, }: CollectRoyaltiesRequest): Promise<CollectRoyaltiesResponse>;
|
57
78
|
private getLicenseData;
|
58
79
|
}
|
59
80
|
//# 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,EAAoC,MAAM,MAAM,CAAC;AAEtE,OAAO,EAEL,wBAAwB,
|
1
|
+
{"version":3,"file":"group.d.ts","sourceRoot":"../../../../src/resources","sources":["group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAoC,MAAM,MAAM,CAAC;AAEtE,OAAO,EAEL,wBAAwB,EAIxB,oBAAoB,EAEpB,yBAAyB,EAGzB,uBAAuB,EAMvB,qBAAqB,EACrB,6BAA6B,EAC7B,0BAA0B,EAE1B,qBAAqB,EACrB,uBAAuB,EACvB,wBAAwB,EACxB,kBAAkB,EACnB,4BAAyB;AAE1B,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAC3C,OAAO,EAAE,mBAAmB,EAAE,4BAAyB;AACvD,OAAO,EACL,YAAY,EACZ,kBAAkB,EAClB,mBAAmB,EACnB,yCAAyC,EACzC,0CAA0C,EAC1C,uBAAuB,EACvB,wBAAwB,EACxB,yBAAyB,EAGzB,qDAAqD,EACrD,sDAAsD,EACtD,6CAA6C,EAC7C,8CAA8C,EAC9C,oCAAoC,EACpC,qCAAqC,EACrC,oBAAoB,EACpB,qBAAqB,EACrB,8CAA8C,EAC9C,+CAA+C,EAC/C,yBAAyB,EAC1B,oCAAiC;AAWlC,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;IAC7D,wBAAwB,EAAE,wBAAwB,CAAC;IAE1D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;gBAEvB,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAgBlF;;;OAGG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAwBzF;;;OAGG;IACU,8CAA8C,CACzD,OAAO,EAAE,qDAAqD,GAC7D,OAAO,CAAC,sDAAsD,CAAC;IAsElE;;;OAGG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IAwG3D;;;OAGG;IACU,6BAA6B,CACxC,OAAO,EAAE,oCAAoC,GAC5C,OAAO,CAAC,qCAAqC,CAAC;IAwBjD;;;OAGG;IACU,sCAAsC,CACjD,OAAO,EAAE,6CAA6C,GACrD,OAAO,CAAC,8CAA8C,CAAC;IAoD1D;;;;OAIG;IACU,kCAAkC,CAAC,EAC9C,SAAS,EACT,cAAc,EACd,WAAW,EACX,SAAS,GACV,EAAE,yCAAyC,GAAG,OAAO,CAAC,0CAA0C,CAAC;IAqElG;;;OAGG;IACU,aAAa,CAAC,EACzB,SAAS,EACT,KAAK,EACL,+BAA+B,EAC/B,SAAS,GACV,EAAE,YAAY,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAuB9C;;OAEG;IACU,kBAAkB,CAAC,EAC9B,SAAS,EACT,aAAa,EACb,WAAW,GACZ,EAAE,yBAAyB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAchD;;;OAGG;IACU,kBAAkB,CAAC,EAC9B,SAAS,EACT,KAAK,EACL,SAAS,GACV,EAAE,yBAAyB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAiB3D;;;;OAIG;IACU,WAAW,CAAC,EACvB,SAAS,EACT,aAAa,EACb,WAAW,EACX,SAAS,GACV,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAuBpD;;;;OAIG;IACU,gBAAgB,CAAC,EAC5B,SAAS,EACT,aAAa,EACb,SAAS,GACV,EAAE,uBAAuB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAuB9D,OAAO,CAAC,cAAc;CAYvB"}
|
@@ -1,8 +1,8 @@
|
|
1
1
|
import { Address, Hex, PublicClient } from "viem";
|
2
|
-
import { IPAccountExecuteRequest, IPAccountExecuteResponse, IPAccountExecuteWithSigRequest, IPAccountExecuteWithSigResponse, IpAccountStateResponse, SetIpMetadataRequest, TokenResponse, TransferErc20Request } from "../types/resources/ipAccount.js";
|
3
2
|
import { Erc20Client, SimpleWalletClient, WrappedIpClient } from "../abi/generated.js";
|
4
3
|
import { ChainIds } from "../types/config.js";
|
5
4
|
import { TransactionResponse } from "../types/options.js";
|
5
|
+
import { IPAccountExecuteRequest, IPAccountExecuteResponse, IPAccountExecuteWithSigRequest, IPAccountExecuteWithSigResponse, IpAccountStateResponse, SetIpMetadataRequest, TokenResponse, TransferErc20Request } from "../types/resources/ipAccount.js";
|
6
6
|
export declare class IPAccountClient {
|
7
7
|
wrappedIpClient: WrappedIpClient;
|
8
8
|
erc20Client: Erc20Client;
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"ipAccount.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,
|
1
|
+
{"version":3,"file":"ipAccount.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAsB,GAAG,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAEtE,OAAO,EAGL,WAAW,EAEX,kBAAkB,EAClB,eAAe,EAChB,4BAAyB;AAE1B,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAC3C,OAAO,EAAE,mBAAmB,EAAE,4BAAyB;AACvD,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,8BAA8B,EAC9B,+BAA+B,EAC/B,sBAAsB,EACtB,oBAAoB,EACpB,aAAa,EACb,oBAAoB,EACrB,wCAAqC;AAKtC,qBAAa,eAAe;IACnB,eAAe,EAAE,eAAe,CAAC;IACjC,WAAW,EAAE,WAAW,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;gBACvB,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAQlF;;OAEG;IACU,OAAO,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IA8BzF;;OAEG;IACU,cAAc,CACzB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC;IA+B3C;;OAEG;IACU,iBAAiB,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAU9E;;OAEG;IACU,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;IAc5D;;OAEG;IACU,aAAa,CAAC,EACzB,IAAI,EACJ,WAAW,EACX,YAAY,EACZ,SAAS,GACV,EAAE,oBAAoB,GAAG,OAAO,CAAC,GAAG,CAAC;IAuBtC;;OAEG;IACU,aAAa,CAAC,EACzB,IAAI,EACJ,MAAM,EACN,SAAS,GACV,EAAE,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAgCvD"}
|
@@ -1,7 +1,7 @@
|
|
1
1
|
import { Hex, PublicClient } from "viem";
|
2
|
-
import { BatchMintAndRegisterIpAndMakeDerivativeRequest, BatchMintAndRegisterIpAndMakeDerivativeResponse, BatchMintAndRegisterIpAssetWithPilTermsRequest, BatchMintAndRegisterIpAssetWithPilTermsResponse, BatchRegisterDerivativeRequest, BatchRegisterDerivativeResponse, BatchRegisterRequest, BatchRegisterResponse, MintAndRegisterIpAssetWithPilTermsRequest, MintAndRegisterIpAssetWithPilTermsResponse, 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, BatchRegisterIpAssetsWithOptimizedWorkflowsRequest, BatchRegisterIpAssetsWithOptimizedWorkflowsResponse } from "../types/resources/ipAsset.js";
|
3
2
|
import { AccessControllerClient, CoreMetadataModuleClient, DerivativeWorkflowsClient, IpAssetRegistryClient, LicenseAttachmentWorkflowsClient, LicenseRegistryReadOnlyClient, LicenseTokenReadOnlyClient, LicensingModuleClient, Multicall3Client, PiLicenseTemplateClient, RegistrationWorkflowsClient, RoyaltyModuleEventClient, RoyaltyTokenDistributionWorkflowsClient, SimpleWalletClient, SpgnftImplReadOnlyClient, WrappedIpClient } from "../abi/generated.js";
|
4
3
|
import { ChainIds } from "../types/config.js";
|
4
|
+
import { BatchMintAndRegisterIpAndMakeDerivativeRequest, BatchMintAndRegisterIpAndMakeDerivativeResponse, BatchMintAndRegisterIpAssetWithPilTermsRequest, BatchMintAndRegisterIpAssetWithPilTermsResponse, BatchRegisterDerivativeRequest, BatchRegisterDerivativeResponse, BatchRegisterIpAssetsWithOptimizedWorkflowsRequest, BatchRegisterIpAssetsWithOptimizedWorkflowsResponse, BatchRegisterRequest, BatchRegisterResponse, MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensRequest, MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensResponse, MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensRequest, MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensResponse, MintAndRegisterIpAndMakeDerivativeRequest, MintAndRegisterIpAndMakeDerivativeResponse, MintAndRegisterIpAndMakeDerivativeWithLicenseTokensRequest, MintAndRegisterIpAssetWithPilTermsRequest, MintAndRegisterIpAssetWithPilTermsResponse, MintAndRegisterIpRequest, RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest, RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse, RegisterDerivativeRequest, RegisterDerivativeResponse, RegisterDerivativeWithLicenseTokensRequest, RegisterDerivativeWithLicenseTokensResponse, RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest, RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse, RegisterIpAndAttachPilTermsRequest, RegisterIpAndAttachPilTermsResponse, RegisterIpAndMakeDerivativeRequest, RegisterIpAndMakeDerivativeResponse, RegisterIpAndMakeDerivativeWithLicenseTokensRequest, RegisterIpResponse, RegisterPilTermsAndAttachRequest, RegisterPilTermsAndAttachResponse, RegisterRequest } from "../types/resources/ipAsset.js";
|
5
5
|
import { IpCreator, IpMetadata } from "../types/resources/ipMetadata.js";
|
6
6
|
export declare class IPAssetClient {
|
7
7
|
licensingModuleClient: LicensingModuleClient;
|
@@ -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,EAIL,GAAG,EACH,YAAY,EAIb,MAAM,MAAM,CAAC;AAEd,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,yBAAyB,EAOzB,qBAAqB,EACrB,gCAAgC,EAIhC,6BAA6B,EAC7B,0BAA0B,EAE1B,qBAAqB,EACrB,gBAAgB,EAChB,uBAAuB,EACvB,2BAA2B,EAG3B,wBAAwB,EACxB,uCAAuC,EAMvC,kBAAkB,EAClB,wBAAwB,EACxB,eAAe,EAChB,4BAAyB;AAG1B,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAC3C,OAAO,EACL,8CAA8C,EAC9C,+CAA+C,EAC/C,8CAA8C,EAC9C,+CAA+C,EAE/C,8BAA8B,EAC9B,+BAA+B,EAC/B,kDAAkD,EAClD,mDAAmD,EACnD,oBAAoB,EACpB,qBAAqB,EAMrB,mEAAmE,EACnE,oEAAoE,EACpE,mEAAmE,EACnE,oEAAoE,EACpE,yCAAyC,EACzC,0CAA0C,EAC1C,0DAA0D,EAC1D,yCAAyC,EACzC,0CAA0C,EAC1C,wBAAwB,EACxB,wEAAwE,EACxE,yEAAyE,EACzE,yBAAyB,EACzB,0BAA0B,EAC1B,0CAA0C,EAC1C,2CAA2C,EAC3C,gEAAgE,EAChE,iEAAiE,EACjE,kCAAkC,EAClC,mCAAmC,EACnC,kCAAkC,EAClC,mCAAmC,EACnC,mDAAmD,EACnD,kBAAkB,EAClB,gCAAgC,EAChC,iCAAiC,EACjC,eAAe,EAEhB,sCAAmC;AACpC,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,yCAAsC;AA2BtE,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;IACnD,SAAS,EAAE,eAAe,CAAC;IAC3B,YAAY,EAAE,wBAAwB,CAAC;IAE9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;IACnC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAU;gBAE5B,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAyB3E,uBAAuB,CAAC,OAAO,EAAE,SAAS,GAAG,SAAS;IAItD,kBAAkB,CAAC,QAAQ,EAAE,UAAU,GAAG,UAAU;IAI3D;;;;OAIG;IACU,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA4E5E;;;;OAIG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAmEzF;;;;;;OAMG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IAyCtC;;OAEG;IACU,uBAAuB,CAClC,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC;IA4E3C;;;;OAIG;IACU,mCAAmC,CAC9C,OAAO,EAAE,0CAA0C,GAClD,OAAO,CAAC,2CAA2C,CAAC;IAoCvD;;;;OAIG;IACU,kCAAkC,CAC7C,OAAO,EAAE,yCAAyC,GACjD,OAAO,CAAC,0CAA0C,CAAC;IAiDtD;;;;OAIG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IA6C3D;;;;OAIG;IACU,2BAA2B,CACtC,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IAsD/C;;;;OAIG;IACU,oBAAoB,CAC/B,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IA+C/C;;;;OAIG;IACU,kCAAkC,CAC7C,OAAO,EAAE,yCAAyC,GACjD,OAAO,CAAC,0CAA0C,CAAC;IAoCtD;;;;OAIG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IAgC3D;;;;OAIG;IACU,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAiC9F;;;;OAIG;IACU,yBAAyB,CACpC,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,iCAAiC,CAAC;IAoD7C;;;;;OAKG;IACU,mDAAmD,CAC9D,OAAO,EAAE,0DAA0D,GAClE,OAAO,CAAC,kBAAkB,CAAC;IAkD9B;;;;OAIG;IACU,4CAA4C,CACvD,OAAO,EAAE,mDAAmD,GAC3D,OAAO,CAAC,kBAAkB,CAAC;IA2D9B;;;;;;OAMG;IACU,yDAAyD,CACpE,OAAO,EAAE,gEAAgE,GACxE,OAAO,CAAC,iEAAiE,CAAC;IAmE7E;;;;;OAKG;IACU,mEAAmE,CAC9E,OAAO,EAAE,wEAAwE,GAChF,OAAO,CAAC,yEAAyE,CAAC;IA8ErF;;;;OAIG;IACU,4DAA4D,CACvE,OAAO,EAAE,mEAAmE,GAC3E,OAAO,CAAC,oEAAoE,CAAC;IAsDhF;;;;OAIG;IACU,4DAA4D,CACvE,OAAO,EAAE,mEAAmE,GAC3E,OAAO,CAAC,oEAAoE,CAAC;YAuClE,uBAAuB;IAoBxB,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAItD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACU,2CAA2C,CACtD,OAAO,EAAE,kDAAkD,GAC1D,OAAO,CAAC,mDAAmD,CAAC;YAiGjD,iBAAiB;YAWjB,uBAAuB;IAkBrC,OAAO,CAAC,2BAA2B;YAiBrB,0BAA0B;CAuFzC"}
|
@@ -1,8 +1,8 @@
|
|
1
1
|
import { PublicClient } from "viem";
|
2
2
|
import { IpAssetRegistryClient, LicenseRegistryReadOnlyClient, LicensingModuleClient, LicensingModulePredictMintingLicenseFeeResponse, ModuleRegistryReadOnlyClient, Multicall3Client, PiLicenseTemplateClient, PiLicenseTemplateGetLicenseTermsResponse, PiLicenseTemplateReadOnlyClient, SimpleWalletClient, WrappedIpClient } from "../abi/generated.js";
|
3
|
-
import { RegisterNonComSocialRemixingPILRequest, RegisterPILResponse, RegisterCommercialUsePILRequest, RegisterCommercialRemixPILRequest, AttachLicenseTermsRequest, MintLicenseTokensRequest, MintLicenseTokensResponse, AttachLicenseTermsResponse, LicenseTermsId, RegisterPILTermsRequest, PredictMintingLicenseFeeRequest, SetLicensingConfigRequest, SetLicensingConfigResponse, GetLicensingConfigRequest } from "../types/resources/license.js";
|
4
|
-
import { ChainIds } from "../types/config.js";
|
5
3
|
import { LicensingConfig } from "../types/common.js";
|
4
|
+
import { ChainIds } from "../types/config.js";
|
5
|
+
import { AttachLicenseTermsRequest, AttachLicenseTermsResponse, GetLicensingConfigRequest, LicenseTermsId, MintLicenseTokensRequest, MintLicenseTokensResponse, PredictMintingLicenseFeeRequest, RegisterCommercialRemixPILRequest, RegisterCommercialUsePILRequest, RegisterCreativeCommonsAttributionPILRequest, RegisterNonComSocialRemixingPILRequest, RegisterPILResponse, RegisterPILTermsRequest, SetLicensingConfigRequest, SetLicensingConfigResponse } from "../types/resources/license.js";
|
6
6
|
export declare class LicenseClient {
|
7
7
|
licensingModuleClient: LicensingModuleClient;
|
8
8
|
ipAssetRegistryClient: IpAssetRegistryClient;
|
@@ -26,21 +26,36 @@ export declare class LicenseClient {
|
|
26
26
|
/**
|
27
27
|
* Convenient function to register a PIL non commercial social remix license to the registry
|
28
28
|
*
|
29
|
+
* For more details, see {@link https://docs.story.foundation/concepts/programmable-ip-license/pil-flavors#flavor-%231%3A-non-commercial-social-remixing | Non Commercial Social Remixing}.
|
30
|
+
*
|
29
31
|
* Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/licensing/ILicenseTemplate.sol#L19 | `LicenseTermsRegistered`} event.
|
30
32
|
*/
|
31
33
|
registerNonComSocialRemixingPIL(request?: RegisterNonComSocialRemixingPILRequest): Promise<RegisterPILResponse>;
|
32
34
|
/**
|
33
35
|
* Convenient function to register a PIL commercial use license to the registry.
|
34
36
|
*
|
37
|
+
* For more details, see {@link https://docs.story.foundation/concepts/programmable-ip-license/pil-flavors#flavor-%232%3A-commercial-use | Commercial Use}.
|
38
|
+
*
|
35
39
|
* Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/licensing/ILicenseTemplate.sol#L19 | `LicenseTermsRegistered`} event.
|
36
40
|
*/
|
37
41
|
registerCommercialUsePIL(request: RegisterCommercialUsePILRequest): Promise<RegisterPILResponse>;
|
38
42
|
/**
|
39
43
|
* Convenient function to register a PIL commercial Remix license to the registry.
|
40
44
|
*
|
45
|
+
* For more details, see {@link https://docs.story.foundation/concepts/programmable-ip-license/pil-flavors#flavor-%233%3A-commercial-remix | Commercial Remix }.
|
46
|
+
*
|
41
47
|
* Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/licensing/ILicenseTemplate.sol#L19 | `LicenseTermsRegistered`} event.
|
42
48
|
*/
|
43
49
|
registerCommercialRemixPIL(request: RegisterCommercialRemixPILRequest): Promise<RegisterPILResponse>;
|
50
|
+
/**
|
51
|
+
* Convenient function to register a PIL creative commons attribution license to the registry.
|
52
|
+
* Creates a Creative Commons Attribution (CC-BY) license terms flavor.
|
53
|
+
*
|
54
|
+
* For more details, see {@link https://docs.story.foundation/concepts/programmable-ip-license/pil-flavors#flavor-%234%3A-creative-commons-attribution | Creative Commons Attribution}.
|
55
|
+
*
|
56
|
+
* Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/modules/licensing/ILicenseTemplate.sol#L19 | `LicenseTermsRegistered`} event.
|
57
|
+
*/
|
58
|
+
registerCreativeCommonsAttributionPIL({ currency, royaltyPolicyAddress, txOptions, }: RegisterCreativeCommonsAttributionPILRequest): Promise<RegisterPILResponse>;
|
44
59
|
/**
|
45
60
|
* Attaches license terms to an IP.
|
46
61
|
*/
|
@@ -75,5 +90,6 @@ export declare class LicenseClient {
|
|
75
90
|
setLicensingConfig(request: SetLicensingConfigRequest): Promise<SetLicensingConfigResponse>;
|
76
91
|
getLicensingConfig(request: GetLicensingConfigRequest): Promise<LicensingConfig>;
|
77
92
|
private getLicenseTermsId;
|
93
|
+
private registerPILTermsHelper;
|
78
94
|
}
|
79
95
|
//# sourceMappingURL=license.d.ts.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"license.d.ts","sourceRoot":"../../../../src/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,YAAY,EAAe,MAAM,MAAM,CAAC;AAE1D,OAAO,EAEL,qBAAqB,EAErB,6BAA6B,EAC7B,qBAAqB,EAGrB,+CAA+C,EAE/C,4BAA4B,EAC5B,gBAAgB,EAChB,uBAAuB,EACvB,wCAAwC,EACxC,+BAA+B,
|
1
|
+
{"version":3,"file":"license.d.ts","sourceRoot":"../../../../src/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,YAAY,EAAe,MAAM,MAAM,CAAC;AAE1D,OAAO,EAEL,qBAAqB,EAErB,6BAA6B,EAC7B,qBAAqB,EAGrB,+CAA+C,EAE/C,4BAA4B,EAC5B,gBAAgB,EAChB,uBAAuB,EACvB,wCAAwC,EACxC,+BAA+B,EAG/B,kBAAkB,EAClB,eAAe,EAChB,4BAAyB;AAC1B,OAAO,EAAE,eAAe,EAAgB,2BAAwB;AAChE,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAE3C,OAAO,EACL,yBAAyB,EACzB,0BAA0B,EAC1B,yBAAyB,EAEzB,cAAc,EAEd,wBAAwB,EACxB,yBAAyB,EAEzB,+BAA+B,EAC/B,iCAAiC,EACjC,+BAA+B,EAC/B,4CAA4C,EAC5C,sCAAsC,EACtC,mBAAmB,EACnB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAC3B,sCAAmC;AAcpC,qBAAa,aAAa;IACjB,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;IAC3D,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,SAAS,EAAE,eAAe,CAAC;IAClC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;IACnC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAU;gBAE5B,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAelF;;;;OAIG;IACU,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAa7F;;;;;;OAMG;IACU,+BAA+B,CAC1C,OAAO,CAAC,EAAE,sCAAsC,GAC/C,OAAO,CAAC,mBAAmB,CAAC;IAS/B;;;;;;OAMG;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,mBAAmB,CAAC;IAe/B;;;;;;OAMG;IACU,0BAA0B,CACrC,OAAO,EAAE,iCAAiC,GACzC,OAAO,CAAC,mBAAmB,CAAC;IAgB/B;;;;;;;OAOG;IACU,qCAAqC,CAAC,EACjD,QAAQ,EACR,oBAAoB,EACpB,SAAS,GACV,EAAE,4CAA4C,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAc9E;;OAEG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IA8CtC;;;;;;;;;;;;;;OAcG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC;IA8FrC;;OAEG;IACU,eAAe,CAC1B,sBAAsB,EAAE,cAAc,GACrC,OAAO,CAAC,wCAAwC,CAAC;IAUpD;;OAEG;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,+CAA+C,CAAC;IAoC3D;;OAEG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IAwDzB,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,eAAe,CAAC;YAe/E,iBAAiB;YAKjB,sBAAsB;CA+BrC"}
|
@@ -1,6 +1,7 @@
|
|
1
1
|
import { Address, PublicClient } from "viem";
|
2
2
|
import { RegistrationWorkflowsClient, SimpleWalletClient } from "../abi/generated.js";
|
3
|
-
import {
|
3
|
+
import { TransactionResponse } from "../types/options.js";
|
4
|
+
import { CreateNFTCollectionRequest, CreateNFTCollectionResponse, GetTokenURIRequest, SetTokenURIRequest } from "../types/resources/nftClient.js";
|
4
5
|
export declare class NftClient {
|
5
6
|
registrationWorkflowsClient: RegistrationWorkflowsClient;
|
6
7
|
private readonly rpcClient;
|
@@ -21,5 +22,16 @@ export declare class NftClient {
|
|
21
22
|
* Returns the current mint fee of the collection.
|
22
23
|
*/
|
23
24
|
getMintFee(spgNftContract: Address): Promise<bigint>;
|
25
|
+
/**
|
26
|
+
* Sets the token URI for a specific token id.
|
27
|
+
*
|
28
|
+
* @remarks
|
29
|
+
* Only callable by the owner of the token.
|
30
|
+
*/
|
31
|
+
setTokenURI({ tokenId, tokenURI, spgNftContract, txOptions, }: SetTokenURIRequest): Promise<TransactionResponse>;
|
32
|
+
/**
|
33
|
+
* Returns the token URI for a specific token id.
|
34
|
+
*/
|
35
|
+
getTokenURI({ tokenId, spgNftContract }: GetTokenURIRequest): Promise<string>;
|
24
36
|
}
|
25
37
|
//# sourceMappingURL=nftClient.d.ts.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"nftClient.d.ts","sourceRoot":"../../../../src/resources","sources":["nftClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,
|
1
|
+
{"version":3,"file":"nftClient.d.ts","sourceRoot":"../../../../src/resources","sources":["nftClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAwB,YAAY,EAAe,MAAM,MAAM,CAAC;AAEhF,OAAO,EACL,2BAA2B,EAE3B,kBAAkB,EAGnB,4BAAyB;AAC1B,OAAO,EAAE,mBAAmB,EAAE,4BAAyB;AACvD,OAAO,EACL,0BAA0B,EAC1B,2BAA2B,EAC3B,kBAAkB,EAClB,kBAAkB,EACnB,wCAAqC;AAKtC,qBAAa,SAAS;IACb,2BAA2B,EAAE,2BAA2B,CAAC;IAEhE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAM/D;;;;;OAKG;IACU,mBAAmB,CAC9B,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,2BAA2B,CAAC;IAiDvC;;OAEG;IACU,eAAe,CAAC,cAAc,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAQvE;;OAEG;IACU,UAAU,CAAC,cAAc,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAQjE;;;;;OAKG;IACU,WAAW,CAAC,EACvB,OAAO,EACP,QAAQ,EACR,cAAc,EACd,SAAS,GACV,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAqBpD;;OAEG;IACU,WAAW,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;CAI3F"}
|
@@ -1,7 +1,7 @@
|
|
1
1
|
import { PublicClient } from "viem";
|
2
|
-
import { CreateBatchPermissionSignatureRequest, CreateSetPermissionSignatureRequest, SetAllPermissionsRequest, SetBatchPermissionsRequest, SetPermissionsRequest, SetPermissionsResponse } from "../types/resources/permission.js";
|
3
2
|
import { AccessControllerClient, CoreMetadataModuleClient, IpAssetRegistryClient, SimpleWalletClient } from "../abi/generated.js";
|
4
3
|
import { ChainIds } from "../types/config.js";
|
4
|
+
import { CreateBatchPermissionSignatureRequest, CreateSetPermissionSignatureRequest, SetAllPermissionsRequest, SetBatchPermissionsRequest, SetPermissionsRequest, SetPermissionsResponse } from "../types/resources/permission.js";
|
5
5
|
export declare class PermissionClient {
|
6
6
|
accessControllerClient: AccessControllerClient;
|
7
7
|
ipAssetRegistryClient: IpAssetRegistryClient;
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"permission.d.ts","sourceRoot":"../../../../src/resources","sources":["permission.ts"],"names":[],"mappings":"AAAA,OAAO,
|
1
|
+
{"version":3,"file":"permission.d.ts","sourceRoot":"../../../../src/resources","sources":["permission.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+B,YAAY,EAAoC,MAAM,MAAM,CAAC;AAEnG,OAAO,EAEL,sBAAsB,EACtB,wBAAwB,EAExB,qBAAqB,EACrB,kBAAkB,EACnB,4BAAyB;AAE1B,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAC3C,OAAO,EACL,qCAAqC,EACrC,mCAAmC,EACnC,wBAAwB,EACxB,0BAA0B,EAC1B,qBAAqB,EACrB,sBAAsB,EACvB,yCAAsC;AAKvC,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,CAAW;gBAEvB,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IASlF;;;;;;;;OAQG;IACU,aAAa,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IA2B3F;;;;OAIG;IACU,4BAA4B,CACvC,OAAO,EAAE,mCAAmC,GAC3C,OAAO,CAAC,sBAAsB,CAAC;IA2DlC;;;;OAIG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,sBAAsB,CAAC;IAuBlC;;;;OAIG;IACU,mBAAmB,CAC9B,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,sBAAsB,CAAC;IA8BlC;;;;OAIG;IACU,8BAA8B,CACzC,OAAO,EAAE,qCAAqC,GAC7C,OAAO,CAAC,sBAAsB,CAAC;YAsDpB,iBAAiB;CAQhC"}
|
@@ -1,8 +1,8 @@
|
|
1
1
|
import { Address, Hex, PublicClient } from "viem";
|
2
|
-
import { BatchClaimAllRevenueRequest, BatchClaimAllRevenueResponse, ClaimableRevenueRequest, ClaimableRevenueResponse, ClaimAllRevenueRequest, ClaimAllRevenueResponse, PayRoyaltyOnBehalfRequest, PayRoyaltyOnBehalfResponse, TransferToVaultRequest } from "../types/resources/royalty.js";
|
3
2
|
import { IpAssetRegistryClient, IpRoyaltyVaultImplEventClient, IpRoyaltyVaultImplReadOnlyClient, Multicall3Client, RoyaltyModuleClient, RoyaltyWorkflowsClient, SimpleWalletClient, WrappedIpClient } from "../abi/generated.js";
|
4
|
-
import { TransactionResponse } from "../types/options.js";
|
5
3
|
import { ChainIds } from "../types/config.js";
|
4
|
+
import { TransactionResponse } from "../types/options.js";
|
5
|
+
import { BatchClaimAllRevenueRequest, BatchClaimAllRevenueResponse, ClaimableRevenueRequest, ClaimableRevenueResponse, ClaimAllRevenueRequest, ClaimAllRevenueResponse, PayRoyaltyOnBehalfRequest, PayRoyaltyOnBehalfResponse, TransferToVaultRequest } from "../types/resources/royalty.js";
|
6
6
|
export declare class RoyaltyClient {
|
7
7
|
royaltyModuleClient: RoyaltyModuleClient;
|
8
8
|
ipAssetRegistryClient: IpAssetRegistryClient;
|
@@ -49,9 +49,9 @@ export declare class RoyaltyClient {
|
|
49
49
|
*/
|
50
50
|
claimableRevenue(request: ClaimableRevenueRequest): Promise<ClaimableRevenueResponse>;
|
51
51
|
/**
|
52
|
-
* Get the royalty vault proxy address of given
|
52
|
+
* Get the royalty vault proxy address of given ip id of the royalty vault.
|
53
53
|
*/
|
54
|
-
getRoyaltyVaultAddress(
|
54
|
+
getRoyaltyVaultAddress(ipId: Hex): Promise<Address>;
|
55
55
|
/**
|
56
56
|
* Transfers to vault an amount of revenue tokens claimable via a royalty policy.
|
57
57
|
*/
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"royalty.d.ts","sourceRoot":"../../../../src/resources","sources":["royalty.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,
|
1
|
+
{"version":3,"file":"royalty.d.ts","sourceRoot":"../../../../src/resources","sources":["royalty.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EAIP,GAAG,EACH,YAAY,EAGb,MAAM,MAAM,CAAC;AAEd,OAAO,EAEL,qBAAqB,EACrB,6BAA6B,EAC7B,gCAAgC,EAEhC,gBAAgB,EAChB,mBAAmB,EAEnB,sBAAsB,EACtB,kBAAkB,EAClB,eAAe,EAChB,4BAAyB;AAE1B,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAC3C,OAAO,EAAE,mBAAmB,EAAE,4BAAyB;AACvD,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,uBAAuB,EACvB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EAEvB,yBAAyB,EACzB,0BAA0B,EAE1B,sBAAsB,EACvB,sCAAmC;AAQpC,qBAAa,aAAa;IACjB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,gCAAgC,EAAE,gCAAgC,CAAC;IACnE,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,eAAe,EAAE,eAAe,CAAC;IACxC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAU;IACxC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;gBAEvB,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAclF;;;;;;;;;OASG;IACU,eAAe,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IA+C3F;;;;;;;;;;OAUG;IACU,oBAAoB,CAC/B,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,4BAA4B,CAAC;IAqHxC;;OAEG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IAqEtC;;;OAGG;IACU,gBAAgB,CAC3B,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;IAapC;;OAEG;IACU,sBAAsB,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAUhE;;OAEG;IACU,eAAe,CAAC,EAC3B,SAAS,EACT,IAAI,EACJ,aAAa,EACb,YAAY,EACZ,KAAK,GACN,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC;YAsB1C,mCAAmC;YAuBnC,cAAc;IAa5B;;;OAGG;YACW,eAAe;CAiB9B"}
|
@@ -1,5 +1,6 @@
|
|
1
1
|
import { Address, PublicClient } from "viem";
|
2
2
|
import { SimpleWalletClient, WrappedIpClient } from "../abi/generated.js";
|
3
|
+
import { TransactionResponse } from "../types/options.js";
|
3
4
|
import { ApproveRequest, DepositRequest, TransferFromRequest, TransferRequest, WithdrawRequest } from "../types/resources/wip.js";
|
4
5
|
export declare class WipClient {
|
5
6
|
wrappedIpClient: WrappedIpClient;
|
@@ -10,15 +11,15 @@ export declare class WipClient {
|
|
10
11
|
* Wraps the selected amount of IP to WIP.
|
11
12
|
* The WIP will be deposited to the wallet that transferred the IP.
|
12
13
|
*/
|
13
|
-
deposit({ amount, txOptions }: DepositRequest): Promise<
|
14
|
+
deposit({ amount, txOptions }: DepositRequest): Promise<TransactionResponse>;
|
14
15
|
/**
|
15
16
|
* Unwraps the selected amount of WIP to IP.
|
16
17
|
*/
|
17
|
-
withdraw({ amount, txOptions }: WithdrawRequest): Promise<
|
18
|
+
withdraw({ amount, txOptions }: WithdrawRequest): Promise<TransactionResponse>;
|
18
19
|
/**
|
19
20
|
* Approve a spender to use the wallet's WIP balance.
|
20
21
|
*/
|
21
|
-
approve(req: ApproveRequest): Promise<
|
22
|
+
approve(req: ApproveRequest): Promise<TransactionResponse>;
|
22
23
|
/**
|
23
24
|
* Returns the balance of WIP for an address.
|
24
25
|
*/
|
@@ -26,10 +27,10 @@ export declare class WipClient {
|
|
26
27
|
/**
|
27
28
|
* Transfers `amount` of WIP to a recipient `to`.
|
28
29
|
*/
|
29
|
-
transfer(request: TransferRequest): Promise<
|
30
|
+
transfer(request: TransferRequest): Promise<TransactionResponse>;
|
30
31
|
/**
|
31
32
|
* Transfers `amount` of WIP from `from` to a recipient `to`.
|
32
33
|
*/
|
33
|
-
transferFrom(request: TransferFromRequest): Promise<
|
34
|
+
transferFrom(request: TransferFromRequest): Promise<TransactionResponse>;
|
34
35
|
}
|
35
36
|
//# sourceMappingURL=wip.d.ts.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"wip.d.ts","sourceRoot":"../../../../src/resources","sources":["wip.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,YAAY,EAA2B,MAAM,MAAM,CAAC;
|
1
|
+
{"version":3,"file":"wip.d.ts","sourceRoot":"../../../../src/resources","sources":["wip.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,YAAY,EAA2B,MAAM,MAAM,CAAC;AAEtE,OAAO,EAAE,kBAAkB,EAAgB,eAAe,EAAE,4BAAyB;AAErF,OAAO,EAAE,mBAAmB,EAAE,4BAAyB;AACvD,OAAO,EACL,cAAc,EACd,cAAc,EACd,mBAAmB,EACnB,eAAe,EACf,eAAe,EAChB,kCAA+B;AAKhC,qBAAa,SAAS;IACb,eAAe,EAAE,eAAe,CAAC;IACxC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAM/D;;;OAGG;IACU,OAAO,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAuBzF;;OAEG;IACU,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAiB3F;;OAEG;IACU,OAAO,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAqBvE;;OAEG;IACU,SAAS,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAMtD;;OAEG;IACU,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAoB7E;;OAEG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAoBtF"}
|
@@ -1,4 +1,4 @@
|
|
1
|
-
import { Account,
|
1
|
+
import { Account, Address, Transport } from "viem";
|
2
2
|
import { SimpleWalletClient } from "../abi/generated.js";
|
3
3
|
/**
|
4
4
|
* Supported chains. For convenience, both name or chain ID are supported.
|
@@ -45,5 +45,5 @@ export type StoryConfig = {
|
|
45
45
|
export type ContractAddress = {
|
46
46
|
[key in SupportedChainIds]: Record<string, string>;
|
47
47
|
};
|
48
|
-
export type ChainIds =
|
48
|
+
export type ChainIds = 1315 | 1514;
|
49
49
|
//# sourceMappingURL=config.d.ts.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"config.d.ts","sourceRoot":"../../../../src/types","sources":["config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"../../../../src/types","sources":["config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAEnD,OAAO,EAAE,kBAAkB,EAAE,4BAAyB;AAEtD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC;IACpC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;OAIG;IACH,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;;;;OAIG;IACH,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;AAErF,MAAM,MAAM,QAAQ,GAAG,IAAI,GAAG,IAAI,CAAC"}
|
@@ -1,10 +1,5 @@
|
|
1
1
|
import { Hash, PublicClient, TransactionReceipt, WaitForTransactionReceiptParameters } from "viem";
|
2
2
|
export type TxOptions = Omit<WaitForTransactionReceiptParameters, "hash"> & {
|
3
|
-
/**
|
4
|
-
* Whether or not to wait for the transaction so you can receive a transaction receipt in return
|
5
|
-
* (which contains data about the transaction and return values).
|
6
|
-
*/
|
7
|
-
waitForTransaction?: boolean;
|
8
3
|
/**
|
9
4
|
* When this option is set, the transaction will not submit and execute.
|
10
5
|
* It will only encode the ABI and function data and return.
|
@@ -28,7 +23,9 @@ export type ERC20Options = {
|
|
28
23
|
* Options to override the default behavior of the auto approve logic
|
29
24
|
*/
|
30
25
|
export type WithERC20Options = {
|
31
|
-
|
26
|
+
options?: {
|
27
|
+
erc20Options?: ERC20Options;
|
28
|
+
};
|
32
29
|
};
|
33
30
|
export type WipOptions = {
|
34
31
|
/**
|
@@ -59,8 +56,18 @@ export type WipOptions = {
|
|
59
56
|
* and auto approve logic.
|
60
57
|
*/
|
61
58
|
export type WithWipOptions = {
|
62
|
-
|
63
|
-
|
59
|
+
options?: {
|
60
|
+
/** options to configure WIP behavior */
|
61
|
+
wipOptions?: WipOptions;
|
62
|
+
};
|
63
|
+
};
|
64
|
+
export type WithErc20AndWipOptions = {
|
65
|
+
options?: {
|
66
|
+
/** options to configure ERC20 behavior */
|
67
|
+
erc20Options?: ERC20Options;
|
68
|
+
/** options to configure WIP behavior */
|
69
|
+
wipOptions?: WipOptions;
|
70
|
+
};
|
64
71
|
};
|
65
72
|
export type WaitForTransactionReceiptRequest = {
|
66
73
|
txHash: Hash;
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"options.d.ts","sourceRoot":"../../../../src/types","sources":["options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,kBAAkB,EAAE,mCAAmC,EAAE,MAAM,MAAM,CAAC;AAEnG,MAAM,MAAM,SAAS,GAAG,IAAI,CAAC,mCAAmC,EAAE,MAAM,CAAC,GAAG;IAC1E;;;OAGG;IACH,
|
1
|
+
{"version":3,"file":"options.d.ts","sourceRoot":"../../../../src/types","sources":["options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,kBAAkB,EAAE,mCAAmC,EAAE,MAAM,MAAM,CAAC;AAEnG,MAAM,MAAM,SAAS,GAAG,IAAI,CAAC,mCAAmC,EAAE,MAAM,CAAC,GAAG;IAC1E;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,CAAC,EAAE;QACR,YAAY,CAAC,EAAE,YAAY,CAAC;KAC7B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AACF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,CAAC,EAAE;QACR,wCAAwC;QACxC,UAAU,CAAC,EAAE,UAAU,CAAC;KACzB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,CAAC,EAAE;QACR,0CAA0C;QAC1C,YAAY,CAAC,EAAE,YAAY,CAAC;QAC5B,wCAAwC;QACxC,UAAU,CAAC,EAAE,UAAU,CAAC;KACzB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,MAAM,EAAE,IAAI,CAAC;IACb,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,SAAS,EAAE,YAAY,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,QAAQ,EAAE,IAAI,EAAE,CAAC;IACjB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,SAAS,EAAE,YAAY,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,IAAI,CAAC;IAEb,+EAA+E;IAC/E,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAC9B,CAAC"}
|
@@ -1,6 +1,6 @@
|
|
1
|
-
import { Address, Hex } from "viem";
|
2
|
-
import { TxOptions, WipOptions, WithTxOptions } from "../options.js";
|
1
|
+
import { Address, Hash, Hex } from "viem";
|
3
2
|
import { EncodedTxData } from "../../abi/generated.js";
|
3
|
+
import { TxOptions, WipOptions, WithTxOptions } from "../options.js";
|
4
4
|
export type RaiseDisputeRequest = WithTxOptions & {
|
5
5
|
/** The IP ID that is the target of the dispute. */
|
6
6
|
targetIpId: Address;
|
@@ -12,10 +12,10 @@ export type RaiseDisputeRequest = WithTxOptions & {
|
|
12
12
|
cid: string;
|
13
13
|
/**
|
14
14
|
* The target tag of the dispute.
|
15
|
-
* @see https://docs.story.foundation/docs/dispute-module#dispute-tags
|
16
|
-
* @example
|
15
|
+
* @see {@link https://docs.story.foundation/docs/dispute-module#dispute-tags | Dispute Tags}
|
16
|
+
* @example {@link DisputeTargetTag.IMPROPER_REGISTRATION}
|
17
17
|
*/
|
18
|
-
targetTag:
|
18
|
+
targetTag: DisputeTargetTag;
|
19
19
|
/** The liveness is the time window (in seconds) in which a counter dispute can be presented (30days). */
|
20
20
|
liveness: bigint | number | string;
|
21
21
|
/**
|
@@ -32,7 +32,7 @@ export type RaiseDisputeRequest = WithTxOptions & {
|
|
32
32
|
wipOptions?: Omit<WipOptions, "useMulticallWhenPossible">;
|
33
33
|
};
|
34
34
|
export type RaiseDisputeResponse = {
|
35
|
-
txHash?:
|
35
|
+
txHash?: Hash;
|
36
36
|
encodedTxData?: EncodedTxData;
|
37
37
|
disputeId?: bigint;
|
38
38
|
};
|
@@ -47,7 +47,7 @@ export type CancelDisputeRequest = {
|
|
47
47
|
txOptions?: TxOptions;
|
48
48
|
};
|
49
49
|
export type CancelDisputeResponse = {
|
50
|
-
txHash?:
|
50
|
+
txHash?: Hash;
|
51
51
|
encodedTxData?: EncodedTxData;
|
52
52
|
};
|
53
53
|
export type ResolveDisputeRequest = {
|
@@ -61,7 +61,7 @@ export type ResolveDisputeRequest = {
|
|
61
61
|
txOptions?: TxOptions;
|
62
62
|
};
|
63
63
|
export type ResolveDisputeResponse = {
|
64
|
-
txHash?:
|
64
|
+
txHash?: Hash;
|
65
65
|
encodedTxData?: EncodedTxData;
|
66
66
|
};
|
67
67
|
export type TagIfRelatedIpInfringedRequest = {
|
@@ -105,4 +105,30 @@ export type DisputeAssertionRequest = {
|
|
105
105
|
*/
|
106
106
|
wipOptions?: Omit<WipOptions, "useMulticallWhenPossible">;
|
107
107
|
} & WithTxOptions;
|
108
|
+
/**
|
109
|
+
* Tags refer to the “labels” that can be applied to IP Assets in the protocol when raising a dispute.
|
110
|
+
* Tags must be whitelisted by protocol governance to be used in a dispute.
|
111
|
+
* @see {@link https://docs.story.foundation/docs/dispute-module#dispute-tags | Dispute Tags}
|
112
|
+
*/
|
113
|
+
export declare enum DisputeTargetTag {
|
114
|
+
/** Refers to registration of IP that already exists. */
|
115
|
+
IMPROPER_REGISTRATION = "IMPROPER_REGISTRATION",
|
116
|
+
/**
|
117
|
+
* Refers to improper use of an IP Asset across multiple items.
|
118
|
+
* For more details, @see {@link https://docs.story.foundation/concepts/programmable-ip-license/overview | Programmable IP License (PIL)} documentation.
|
119
|
+
*/
|
120
|
+
IMPROPER_USAGE = "IMPROPER_USAGE",
|
121
|
+
/** Refers to missing payments associated with an IP. */
|
122
|
+
IMPROPER_PAYMENT = "IMPROPER_PAYMENT",
|
123
|
+
/**
|
124
|
+
* Refers to “No-Hate”, “Suitable-for-All-Ages”, “No-Drugs-or-Weapons” and “No-Pornography”.
|
125
|
+
* These items can be found in more detail in the {@link https://docs.story.foundation/concepts/programmable-ip-license/overview | 💊 Programmable IP License (PIL) } legal document.
|
126
|
+
*/
|
127
|
+
CONTENT_STANDARDS_VIOLATION = "CONTENT_STANDARDS_VIOLATION",
|
128
|
+
/**
|
129
|
+
* Different from the other 4, this is a temporary tag that goes away
|
130
|
+
* at the end of a dispute and is replaced by “0x” in case of no infringement or is replaced by one of the other tags.
|
131
|
+
*/
|
132
|
+
IN_DISPUTE = "IN_DISPUTE"
|
133
|
+
}
|
108
134
|
//# sourceMappingURL=dispute.d.ts.map
|
@@ -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;
|
1
|
+
{"version":3,"file":"dispute.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["dispute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAE1C,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,sBAAmB;AAElE,MAAM,MAAM,mBAAmB,GAAG,aAAa,GAAG;IAChD,mDAAmD;IACnD,UAAU,EAAE,OAAO,CAAC;IACpB;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,SAAS,EAAE,gBAAgB,CAAC;IAC5B,yGAAyG;IACzG,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACnC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAChC;;;OAGG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,0BAA0B,CAAC,CAAC;CAC3D,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,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;;;;OAIG;IACH,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACpC;;;;OAIG;IACH,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,gBAAgB,EAAE;QAChB,sBAAsB;QACtB,IAAI,EAAE,OAAO,CAAC;QACd,6DAA6D;QAC7D,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;KACrC,EAAE,CAAC;IACJ,OAAO,CAAC,EAAE;QACR;;;;;WAKG;QACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;KACpC,CAAC;CACH,GAAG,aAAa,CAAC;AAElB,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IACd;;;;OAIG;IACH,WAAW,EAAE,GAAG,CAAC;IACjB;;;;;OAKG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,0BAA0B,CAAC,CAAC;CAC3D,GAAG,aAAa,CAAC;AAElB;;;;GAIG;AACH,oBAAY,gBAAgB;IAC1B,wDAAwD;IACxD,qBAAqB,0BAA0B;IAC/C;;;OAGG;IACH,cAAc,mBAAmB;IACjC,wDAAwD;IACxD,gBAAgB,qBAAqB;IACrC;;;OAGG;IACH,2BAA2B,gCAAgC;IAC3D;;;OAGG;IACH,UAAU,eAAe;CAC1B"}
|
@@ -1,7 +1,7 @@
|
|
1
1
|
import { Address, Hash, TransactionReceipt } from "viem";
|
2
|
+
import { EncodedTxData, GroupingModuleClaimedRewardEvent, GroupingModuleCollectedRoyaltiesToGroupPoolEvent } from "../../abi/generated.js";
|
3
|
+
import { IpMetadataAndTxOptions, LicensingConfig, LicensingConfigInput } from "../common.js";
|
2
4
|
import { TxOptions } from "../options.js";
|
3
|
-
import { EncodedTxData, GroupingModuleCollectedRoyaltiesToGroupPoolEvent } from "../../abi/generated.js";
|
4
|
-
import { IpMetadataAndTxOptions, LicensingConfigInput, LicensingConfig } from "../common.js";
|
5
5
|
export type LicenseDataInput = {
|
6
6
|
licenseTermsId: string | bigint | number;
|
7
7
|
/**
|
@@ -38,7 +38,7 @@ export type MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest = {
|
|
38
38
|
deadline?: string | number | bigint;
|
39
39
|
} & IpMetadataAndTxOptions;
|
40
40
|
export type MintAndRegisterIpAndAttachLicenseAndAddToGroupResponse = {
|
41
|
-
txHash?:
|
41
|
+
txHash?: Hash;
|
42
42
|
encodedTxData?: EncodedTxData;
|
43
43
|
ipId?: Address;
|
44
44
|
tokenId?: bigint;
|
@@ -49,7 +49,7 @@ export type RegisterGroupRequest = {
|
|
49
49
|
txOptions?: TxOptions;
|
50
50
|
};
|
51
51
|
export type RegisterGroupResponse = {
|
52
|
-
txHash?:
|
52
|
+
txHash?: Hash;
|
53
53
|
encodedTxData?: EncodedTxData;
|
54
54
|
groupId?: Address;
|
55
55
|
};
|
@@ -69,7 +69,7 @@ export type RegisterIpAndAttachLicenseAndAddToGroupRequest = {
|
|
69
69
|
maxAllowedRewardShare: number | string;
|
70
70
|
} & IpMetadataAndTxOptions;
|
71
71
|
export type RegisterIpAndAttachLicenseAndAddToGroupResponse = {
|
72
|
-
txHash?:
|
72
|
+
txHash?: Hash;
|
73
73
|
encodedTxData?: EncodedTxData;
|
74
74
|
ipId?: Address;
|
75
75
|
tokenId?: bigint;
|
@@ -82,7 +82,7 @@ export type RegisterGroupAndAttachLicenseRequest = {
|
|
82
82
|
txOptions?: TxOptions;
|
83
83
|
};
|
84
84
|
export type RegisterGroupAndAttachLicenseResponse = {
|
85
|
-
txHash?:
|
85
|
+
txHash?: Hash;
|
86
86
|
encodedTxData?: EncodedTxData;
|
87
87
|
groupId?: Address;
|
88
88
|
};
|
@@ -98,7 +98,7 @@ export type RegisterGroupAndAttachLicenseAndAddIpsRequest = {
|
|
98
98
|
txOptions?: TxOptions;
|
99
99
|
};
|
100
100
|
export type RegisterGroupAndAttachLicenseAndAddIpsResponse = {
|
101
|
-
txHash?:
|
101
|
+
txHash?: Hash;
|
102
102
|
encodedTxData?: EncodedTxData;
|
103
103
|
groupId?: Address;
|
104
104
|
};
|
@@ -139,4 +139,36 @@ export type AddIpRequest = {
|
|
139
139
|
maxAllowedRewardSharePercentage?: number;
|
140
140
|
txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
|
141
141
|
};
|
142
|
+
export type ClaimRewardRequest = {
|
143
|
+
groupIpId: Address;
|
144
|
+
/** The address of the currency (revenue) token to claim. */
|
145
|
+
currencyToken: Address;
|
146
|
+
/** The IDs of the member IPs to distribute the rewards to. */
|
147
|
+
memberIpIds: Address[];
|
148
|
+
txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
|
149
|
+
};
|
150
|
+
export type ClaimRewardResponse = {
|
151
|
+
txHash: Hash;
|
152
|
+
claimedReward?: GroupingModuleClaimedRewardEvent[];
|
153
|
+
};
|
154
|
+
export type GetClaimableRewardRequest = {
|
155
|
+
groupIpId: Address;
|
156
|
+
currencyToken: Address;
|
157
|
+
memberIpIds: Address[];
|
158
|
+
};
|
159
|
+
export type RemoveIpsFromGroupRequest = {
|
160
|
+
groupIpId: Address;
|
161
|
+
ipIds: Address[];
|
162
|
+
txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
|
163
|
+
};
|
164
|
+
export type CollectRoyaltiesRequest = {
|
165
|
+
groupIpId: Address;
|
166
|
+
currencyToken: Address;
|
167
|
+
txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
|
168
|
+
};
|
169
|
+
export type CollectRoyaltiesResponse = {
|
170
|
+
txHash: Hash;
|
171
|
+
/** The amount of royalties collected. */
|
172
|
+
collectedRoyalties?: bigint;
|
173
|
+
};
|
142
174
|
//# sourceMappingURL=group.d.ts.map
|