@story-protocol/core-sdk 1.4.0-rc.2 → 1.4.0
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/resources/group.d.ts.map +1 -1
- package/dist/declarations/src/resources/ipAsset.d.ts +193 -10
- package/dist/declarations/src/resources/ipAsset.d.ts.map +1 -1
- package/dist/declarations/src/resources/license.d.ts +56 -49
- package/dist/declarations/src/resources/license.d.ts.map +1 -1
- package/dist/declarations/src/types/common.d.ts +28 -4
- package/dist/declarations/src/types/common.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/dispute.d.ts +6 -5
- package/dist/declarations/src/types/resources/dispute.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/group.d.ts +19 -10
- package/dist/declarations/src/types/resources/group.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/ipAccount.d.ts +3 -3
- package/dist/declarations/src/types/resources/ipAccount.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/ipAsset.d.ts +328 -75
- package/dist/declarations/src/types/resources/ipAsset.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/license.d.ts +113 -78
- package/dist/declarations/src/types/resources/license.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/nftClient.d.ts +4 -3
- package/dist/declarations/src/types/resources/nftClient.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/permission.d.ts +5 -4
- package/dist/declarations/src/types/resources/permission.d.ts.map +1 -1
- package/dist/declarations/src/types/utils/pilFlavor.d.ts +4 -3
- package/dist/declarations/src/types/utils/pilFlavor.d.ts.map +1 -1
- package/dist/declarations/src/utils/oov3.d.ts +2 -1
- package/dist/declarations/src/utils/oov3.d.ts.map +1 -1
- package/dist/declarations/src/utils/sign.d.ts +2 -1
- package/dist/declarations/src/utils/sign.d.ts.map +1 -1
- package/dist/story-protocol-core-sdk.cjs.dev.js +1420 -872
- package/dist/story-protocol-core-sdk.cjs.prod.js +1420 -872
- package/dist/story-protocol-core-sdk.esm.js +1420 -872
- package/package.json +1 -1
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { Address, Hash, TransactionReceipt } from "viem";
|
|
2
2
|
import { EncodedTxData, GroupingModuleClaimedRewardEvent, GroupingModuleCollectedRoyaltiesToGroupPoolEvent } from "../../abi/generated.js";
|
|
3
|
-
import { IpMetadataAndTxOptions, LicensingConfig, LicensingConfigInput } from "../common.js";
|
|
3
|
+
import { DeadlineInput, IpMetadataAndTxOptions, LicenseTermsIdInput, LicensingConfig, LicensingConfigInput, RevShareInput, TokenIdInput } from "../common.js";
|
|
4
4
|
import { TxOptions } from "../options.js";
|
|
5
5
|
export type LicenseDataInput = {
|
|
6
|
-
licenseTermsId:
|
|
6
|
+
licenseTermsId: LicenseTermsIdInput;
|
|
7
7
|
/**
|
|
8
8
|
* The address of the license template.
|
|
9
9
|
* Defaults to {@link https://docs.story.foundation/docs/programmable-ip-license | PIL} address if not provided.
|
|
@@ -28,8 +28,10 @@ export type MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest = {
|
|
|
28
28
|
/**
|
|
29
29
|
* The maximum reward share percentage that can be allocated to each member IP.
|
|
30
30
|
* Must be between 0 and 100 (where 100% represents 100_000_000).
|
|
31
|
+
*
|
|
32
|
+
* @default 100
|
|
31
33
|
*/
|
|
32
|
-
maxAllowedRewardShare
|
|
34
|
+
maxAllowedRewardShare?: RevShareInput;
|
|
33
35
|
/** The data of the license and its configuration to be attached to the new group IP. */
|
|
34
36
|
licenseData: LicenseDataInput[];
|
|
35
37
|
/** The address of the recipient of the minted NFT. If not provided, the function will use the user's own wallet address. */
|
|
@@ -38,7 +40,7 @@ export type MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest = {
|
|
|
38
40
|
* The deadline for the signature in seconds.
|
|
39
41
|
* @default 1000
|
|
40
42
|
*/
|
|
41
|
-
deadline?:
|
|
43
|
+
deadline?: DeadlineInput;
|
|
42
44
|
} & IpMetadataAndTxOptions;
|
|
43
45
|
export type MintAndRegisterIpAndAttachLicenseAndAddToGroupResponse = {
|
|
44
46
|
txHash?: Hash;
|
|
@@ -58,18 +60,23 @@ export type RegisterGroupResponse = {
|
|
|
58
60
|
};
|
|
59
61
|
export type RegisterIpAndAttachLicenseAndAddToGroupRequest = {
|
|
60
62
|
nftContract: Address;
|
|
61
|
-
tokenId:
|
|
63
|
+
tokenId: TokenIdInput;
|
|
62
64
|
/** The ID of the group IP to add the newly registered IP. */
|
|
63
65
|
groupId: Address;
|
|
64
66
|
/**
|
|
65
67
|
* The deadline for the signature in seconds.
|
|
66
68
|
* @default 1000
|
|
67
69
|
*/
|
|
68
|
-
deadline?:
|
|
70
|
+
deadline?: DeadlineInput;
|
|
69
71
|
/** The data of the license and its configuration to be attached to the new group IP. */
|
|
70
72
|
licenseData: LicenseDataInput[];
|
|
71
|
-
/**
|
|
72
|
-
|
|
73
|
+
/**
|
|
74
|
+
* The maximum reward share percentage that can be allocated to each member IP.
|
|
75
|
+
* Must be between 0 and 100 (where 100% represents 100_000_000).
|
|
76
|
+
*
|
|
77
|
+
* @default 100
|
|
78
|
+
*/
|
|
79
|
+
maxAllowedRewardShare?: RevShareInput;
|
|
73
80
|
} & IpMetadataAndTxOptions;
|
|
74
81
|
export type RegisterIpAndAttachLicenseAndAddToGroupResponse = {
|
|
75
82
|
txHash?: Hash;
|
|
@@ -99,8 +106,10 @@ export type RegisterGroupAndAttachLicenseAndAddIpsRequest = {
|
|
|
99
106
|
/**
|
|
100
107
|
* The maximum reward share percentage that can be allocated to each member IP.
|
|
101
108
|
* Must be between 0 and 100 (where 100% represents 100_000_000).
|
|
109
|
+
*
|
|
110
|
+
* @default 100
|
|
102
111
|
*/
|
|
103
|
-
maxAllowedRewardShare
|
|
112
|
+
maxAllowedRewardShare?: RevShareInput;
|
|
104
113
|
txOptions?: TxOptions;
|
|
105
114
|
};
|
|
106
115
|
export type RegisterGroupAndAttachLicenseAndAddIpsResponse = {
|
|
@@ -142,7 +151,7 @@ export type AddIpRequest = {
|
|
|
142
151
|
* Must be between 0 and 100 (where 100% represents 100_000_000).
|
|
143
152
|
* @default 100
|
|
144
153
|
*/
|
|
145
|
-
maxAllowedRewardSharePercentage?:
|
|
154
|
+
maxAllowedRewardSharePercentage?: RevShareInput;
|
|
146
155
|
txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
|
|
147
156
|
};
|
|
148
157
|
export type ClaimRewardRequest = {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"group.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAEzD,OAAO,EACL,aAAa,EACb,gCAAgC,EAChC,gDAAgD,EACjD,+BAA4B;AAC7B,OAAO,
|
|
1
|
+
{"version":3,"file":"group.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAEzD,OAAO,EACL,aAAa,EACb,gCAAgC,EAChC,gDAAgD,EACjD,+BAA4B;AAC7B,OAAO,EACL,aAAa,EACb,sBAAsB,EACtB,mBAAmB,EACnB,eAAe,EACf,oBAAoB,EACpB,aAAa,EACb,YAAY,EACb,qBAAkB;AACnB,OAAO,EAAE,SAAS,EAAE,sBAAmB;AAEvC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,cAAc,EAAE,mBAAmB,CAAC;IACpC;;;OAGG;IACH,eAAe,CAAC,EAAE,oBAAoB,CAAC;IACvC,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,eAAe,CAAC;IACjC,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC;AACF,MAAM,MAAM,qDAAqD,GAAG;IAClE,cAAc,EAAE,OAAO,CAAC;IACxB,6DAA6D;IAC7D,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,aAAa,CAAC;IACtC,wFAAwF;IACxF,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAChC,4HAA4H;IAC5H,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC;CAC1B,GAAG,sBAAsB,CAAC;AAE3B,MAAM,MAAM,sDAAsD,GAAG;IACnE,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AACF,MAAM,MAAM,oBAAoB,GAAG;IACjC,6FAA6F;IAC7F,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AACF,MAAM,MAAM,8CAA8C,GAAG;IAC3D,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,YAAY,CAAC;IACtB,6DAA6D;IAC7D,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,wFAAwF;IACxF,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAChC;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,aAAa,CAAC;CACvC,GAAG,sBAAsB,CAAC;AAE3B,MAAM,MAAM,+CAA+C,GAAG;IAC5D,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AACF,MAAM,MAAM,oCAAoC,GAAG;IACjD,6FAA6F;IAC7F,SAAS,EAAE,OAAO,CAAC;IACnB,wFAAwF;IACxF,WAAW,EAAE,gBAAgB,CAAC;IAC9B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG;IAClD,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AACF,MAAM,MAAM,6CAA6C,GAAG;IAC1D,6FAA6F;IAC7F,SAAS,EAAE,OAAO,CAAC;IACnB,sDAAsD;IACtD,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,wFAAwF;IACxF,WAAW,EAAE,gBAAgB,CAAC;IAC9B;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,aAAa,CAAC;IACtC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,8CAA8C,GAAG;IAC3D,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,yCAAyC,GAAG;IACtD,SAAS,EAAE,OAAO,CAAC;IACnB,+DAA+D;IAC/D,cAAc,EAAE,OAAO,EAAE,CAAC;IAC1B,8DAA8D;IAC9D,WAAW,EAAE,OAAO,EAAE,CAAC;IACvB,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,0CAA0C,GAAG;IACvD,MAAM,EAAE,IAAI,CAAC;IACb,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAChC,kBAAkB,CAAC,EAAE,IAAI,CAAC,gDAAgD,EAAE,MAAM,CAAC,EAAE,CAAC;IACtF,oBAAoB,CAAC,EAAE;QACrB,IAAI,EAAE,OAAO,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,OAAO,CAAC;QACf;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB,EAAE,CAAC;CACL,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB;;;;OAIG;IACH,+BAA+B,CAAC,EAAE,aAAa,CAAC;IAChD,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,SAAS,EAAE,OAAO,CAAC;IACnB,4DAA4D;IAC5D,aAAa,EAAE,OAAO,CAAC;IACvB,8DAA8D;IAC9D,WAAW,EAAE,OAAO,EAAE,CAAC;IACvB,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,IAAI,CAAC;IACb,aAAa,CAAC,EAAE,gCAAgC,EAAE,CAAC;CACpD,CAAC;AACF,MAAM,MAAM,yBAAyB,GAAG;IACtC,SAAS,EAAE,OAAO,CAAC;IACnB,aAAa,EAAE,OAAO,CAAC;IACvB,WAAW,EAAE,OAAO,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,OAAO,CAAC;IACnB,aAAa,EAAE,OAAO,CAAC;IACvB,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,IAAI,CAAC;IACb,yCAAyC;IACzC,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,CAAC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Address, Hash, Hex } from "viem";
|
|
2
2
|
import { EncodedTxData } from "../../abi/generated.js";
|
|
3
|
-
import { TokenAmountInput } from "../common.js";
|
|
3
|
+
import { DeadlineInput, TokenAmountInput } from "../common.js";
|
|
4
4
|
import { TxOptions } from "../options.js";
|
|
5
5
|
export type IPAccountExecuteRequest = {
|
|
6
6
|
/** The IP ID of the IP Account {@link https://docs.story.foundation/docs/ip-account}. */
|
|
@@ -27,11 +27,11 @@ export type IPAccountExecuteWithSigRequest = {
|
|
|
27
27
|
/** The signer of the transaction. */
|
|
28
28
|
signer: Address;
|
|
29
29
|
/** The deadline of the transaction signature in seconds. */
|
|
30
|
-
deadline:
|
|
30
|
+
deadline: DeadlineInput;
|
|
31
31
|
/** The signature of the transaction, EIP-712 encoded. The helper method `getPermissionSignature` supports generating the signature. */
|
|
32
32
|
signature: Address;
|
|
33
33
|
/** The amount of IP to send. */
|
|
34
|
-
value?: number | bigint
|
|
34
|
+
value?: number | bigint;
|
|
35
35
|
txOptions?: TxOptions;
|
|
36
36
|
};
|
|
37
37
|
export type IPAccountExecuteWithSigResponse = {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ipAccount.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["ipAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAE1C,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,gBAAgB,EAAE,qBAAkB;
|
|
1
|
+
{"version":3,"file":"ipAccount.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["ipAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAE1C,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,qBAAkB;AAC5D,OAAO,EAAE,SAAS,EAAE,sBAAmB;AAEvC,MAAM,MAAM,uBAAuB,GAAG;IACpC,yFAAyF;IACzF,IAAI,EAAE,OAAO,CAAC;IACd,wCAAwC;IACxC,EAAE,EAAE,OAAO,CAAC;IACZ,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,IAAI,EAAE,GAAG,CAAC;IACV,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,wFAAwF;IACxF,IAAI,EAAE,OAAO,CAAC;IACd,wCAAwC;IACxC,EAAE,EAAE,OAAO,CAAC;IACZ,mDAAmD;IACnD,IAAI,EAAE,GAAG,CAAC;IACV,qCAAqC;IACrC,MAAM,EAAE,OAAO,CAAC;IAChB,4DAA4D;IAC5D,QAAQ,EAAE,aAAa,CAAC;IACxB,uIAAuI;IACvI,SAAS,EAAE,OAAO,CAAC;IACnB,gCAAgC;IAChC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAEzC,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,OAAO,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,OAAO,CAAC;IACd,+CAA+C;IAC/C,WAAW,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,YAAY,EAAE,GAAG,CAAC;IAClB,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE;QACN,uEAAuE;QACvE,OAAO,EAAE,OAAO,CAAC;QACjB,MAAM,EAAE,gBAAgB,CAAC;QACzB,oCAAoC;QACpC,MAAM,EAAE,OAAO,CAAC;KACjB,EAAE,CAAC;IACJ,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;CAClD,CAAC"}
|