@story-protocol/core-sdk 1.0.0-rc.6 → 1.2.0-rc.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (55) hide show
  1. package/README.md +8 -9
  2. package/dist/declarations/src/abi/generated.d.ts +30706 -11072
  3. package/dist/declarations/src/abi/generated.d.ts.map +1 -1
  4. package/dist/declarations/src/client.d.ts +18 -0
  5. package/dist/declarations/src/client.d.ts.map +1 -1
  6. package/dist/declarations/src/constants/common.d.ts +2 -1
  7. package/dist/declarations/src/constants/common.d.ts.map +1 -1
  8. package/dist/declarations/src/index.d.ts +18 -8
  9. package/dist/declarations/src/index.d.ts.map +1 -1
  10. package/dist/declarations/src/resources/dispute.d.ts +8 -7
  11. package/dist/declarations/src/resources/dispute.d.ts.map +1 -1
  12. package/dist/declarations/src/resources/group.d.ts +85 -0
  13. package/dist/declarations/src/resources/group.d.ts.map +1 -0
  14. package/dist/declarations/src/resources/ipAccount.d.ts +17 -2
  15. package/dist/declarations/src/resources/ipAccount.d.ts.map +1 -1
  16. package/dist/declarations/src/resources/ipAsset.d.ts +232 -8
  17. package/dist/declarations/src/resources/ipAsset.d.ts.map +1 -1
  18. package/dist/declarations/src/resources/license.d.ts +45 -17
  19. package/dist/declarations/src/resources/license.d.ts.map +1 -1
  20. package/dist/declarations/src/resources/nftClient.d.ts +29 -0
  21. package/dist/declarations/src/resources/nftClient.d.ts.map +1 -0
  22. package/dist/declarations/src/resources/permission.d.ts +69 -8
  23. package/dist/declarations/src/resources/permission.d.ts.map +1 -1
  24. package/dist/declarations/src/resources/royalty.d.ts +76 -20
  25. package/dist/declarations/src/resources/royalty.d.ts.map +1 -1
  26. package/dist/declarations/src/types/common.d.ts +11 -1
  27. package/dist/declarations/src/types/common.d.ts.map +1 -1
  28. package/dist/declarations/src/types/config.d.ts +2 -2
  29. package/dist/declarations/src/types/config.d.ts.map +1 -1
  30. package/dist/declarations/src/types/options.d.ts +4 -5
  31. package/dist/declarations/src/types/options.d.ts.map +1 -1
  32. package/dist/declarations/src/types/resources/dispute.d.ts +13 -31
  33. package/dist/declarations/src/types/resources/dispute.d.ts.map +1 -1
  34. package/dist/declarations/src/types/resources/group.d.ts +65 -0
  35. package/dist/declarations/src/types/resources/group.d.ts.map +1 -0
  36. package/dist/declarations/src/types/resources/ipAccount.d.ts +21 -11
  37. package/dist/declarations/src/types/resources/ipAccount.d.ts.map +1 -1
  38. package/dist/declarations/src/types/resources/ipAsset.d.ts +178 -14
  39. package/dist/declarations/src/types/resources/ipAsset.d.ts.map +1 -1
  40. package/dist/declarations/src/types/resources/license.d.ts +50 -25
  41. package/dist/declarations/src/types/resources/license.d.ts.map +1 -1
  42. package/dist/declarations/src/types/resources/nftClient.d.ts +23 -0
  43. package/dist/declarations/src/types/resources/nftClient.d.ts.map +1 -0
  44. package/dist/declarations/src/types/resources/permission.d.ts +44 -5
  45. package/dist/declarations/src/types/resources/permission.d.ts.map +1 -1
  46. package/dist/declarations/src/types/resources/royalty.d.ts +86 -35
  47. package/dist/declarations/src/types/resources/royalty.d.ts.map +1 -1
  48. package/dist/declarations/src/utils/chain.d.ts +34 -0
  49. package/dist/declarations/src/utils/chain.d.ts.map +1 -0
  50. package/dist/declarations/src/utils/sign.d.ts +16 -0
  51. package/dist/declarations/src/utils/sign.d.ts.map +1 -0
  52. package/dist/story-protocol-core-sdk.cjs.dev.js +6528 -13466
  53. package/dist/story-protocol-core-sdk.cjs.prod.js +6528 -13466
  54. package/dist/story-protocol-core-sdk.esm.js +6522 -13468
  55. package/package.json +2 -2
@@ -1,31 +1,195 @@
1
- import { Hex } from "viem";
1
+ import { Address } from "viem";
2
2
  import { TxOptions } from "../options.js";
3
+ import { PIL_TYPE, RegisterPILTermsRequest } from "./license.js";
4
+ import { EncodedTxData } from "../../abi/generated.js";
5
+ import { IpMetadataAndTxOption } from "../common.js";
3
6
  export type RegisterIpResponse = {
4
7
  txHash?: string;
5
- ipId?: Hex;
8
+ encodedTxData?: EncodedTxData;
9
+ ipId?: Address;
10
+ tokenId?: bigint;
6
11
  };
7
12
  export type RegisterRequest = {
8
- tokenContract: Hex;
9
- tokenId: string;
10
- txOptions?: TxOptions;
11
- };
13
+ nftContract: Address;
14
+ tokenId: string | number | bigint;
15
+ deadline?: string | number | bigint;
16
+ } & IpMetadataAndTxOption;
12
17
  export type RegisterDerivativeWithLicenseTokensRequest = {
13
- childIpId: Hex;
14
- licenseTokenIds: string[];
18
+ childIpId: Address;
19
+ licenseTokenIds: string[] | bigint[] | number[];
15
20
  txOptions?: TxOptions;
16
21
  };
17
22
  export type RegisterDerivativeWithLicenseTokensResponse = {
18
- txHash: string;
23
+ txHash?: string;
24
+ encodedTxData?: EncodedTxData;
19
25
  };
20
26
  export type RegisterDerivativeRequest = {
21
- childIpId: Hex;
22
- parentIpIds: Hex[];
23
- licenseTermsIds: string[];
24
- licenseTemplate?: Hex;
27
+ childIpId: Address;
28
+ parentIpIds: Address[];
29
+ licenseTermsIds: string[] | bigint[] | number[];
30
+ licenseTemplate?: Address;
25
31
  txOptions?: TxOptions;
26
32
  };
27
33
  export type RegisterDerivativeResponse = {
28
34
  txHash?: string;
29
- childIpId?: Hex;
35
+ encodedTxData?: EncodedTxData;
36
+ childIpId?: Address;
37
+ };
38
+ export type CreateIpAssetWithPilTermsRequest = {
39
+ spgNftContract: Address;
40
+ pilType: PIL_TYPE;
41
+ currency?: Address;
42
+ mintingFee?: string | number | bigint;
43
+ recipient?: Address;
44
+ commercialRevShare?: number;
45
+ } & IpMetadataAndTxOption;
46
+ export type CreateIpAssetWithPilTermsResponse = {
47
+ txHash?: string;
48
+ encodedTxData?: EncodedTxData;
49
+ ipId?: Address;
50
+ tokenId?: bigint;
51
+ licenseTermsId?: bigint;
52
+ };
53
+ export type RegisterIpAndMakeDerivativeRequest = {
54
+ nftContract: Address;
55
+ tokenId: string | number | bigint;
56
+ deadline?: string | number | bigint;
57
+ derivData: {
58
+ parentIpIds: Address[];
59
+ licenseTermsIds: string[] | bigint[] | number[];
60
+ licenseTemplate?: Address;
61
+ };
62
+ } & IpMetadataAndTxOption;
63
+ export type RegisterIpAndMakeDerivativeResponse = {
64
+ txHash?: string;
65
+ encodedTxData?: EncodedTxData;
66
+ ipId?: Address;
67
+ };
68
+ export type RegisterIpAndAttachPilTermsRequest = {
69
+ nftContract: Address;
70
+ tokenId: bigint | string | number;
71
+ pilType: PIL_TYPE;
72
+ mintingFee: string | number | bigint;
73
+ currency: Address;
74
+ deadline?: bigint | number | string;
75
+ commercialRevShare?: number;
76
+ } & IpMetadataAndTxOption;
77
+ export type RegisterIpAndAttachPilTermsResponse = {
78
+ txHash?: string;
79
+ encodedTxData?: EncodedTxData;
80
+ ipId?: Address;
81
+ licenseTermsId?: bigint;
82
+ };
83
+ export type MintAndRegisterIpAndMakeDerivativeRequest = {
84
+ spgNftContract: Address;
85
+ derivData: {
86
+ parentIpIds: Address[];
87
+ licenseTermsIds: string[] | bigint[] | number[];
88
+ licenseTemplate?: Address;
89
+ };
90
+ recipient?: Address;
91
+ } & IpMetadataAndTxOption;
92
+ export type IpRelationship = {
93
+ parentIpId: Address;
94
+ type: string;
95
+ };
96
+ export type IpCreator = {
97
+ name: string;
98
+ address: Address;
99
+ description?: string;
100
+ image?: string;
101
+ socialMedia?: IpCreatorSocial[];
102
+ role?: string;
103
+ contributionPercent: number;
104
+ };
105
+ export type IpCreatorSocial = {
106
+ platform: string;
107
+ url: string;
108
+ };
109
+ export type IpMedia = {
110
+ name: string;
111
+ url: string;
112
+ mimeType: string;
113
+ };
114
+ export type IpAttribute = {
115
+ key: string;
116
+ value: string | number;
117
+ };
118
+ export type StoryProtocolApp = {
119
+ id: string;
120
+ name: string;
121
+ website: string;
122
+ action?: string;
123
+ };
124
+ export type GenerateCreatorMetadataParam = {
125
+ name: string;
126
+ address: Address;
127
+ contributionPercent: number;
128
+ description?: string;
129
+ image?: string;
130
+ socialMedia?: IpCreatorSocial[];
131
+ role?: string;
132
+ };
133
+ export type IPRobotTerms = {
134
+ userAgent: string;
135
+ allow: string;
136
+ };
137
+ export type GenerateIpMetadataParam = {
138
+ title?: string;
139
+ description?: string;
140
+ ipType?: string;
141
+ relationships?: IpRelationship[];
142
+ createdAt?: string;
143
+ watermarkImg?: string;
144
+ creators?: IpCreator[];
145
+ media?: IpMedia[];
146
+ attributes?: IpAttribute[];
147
+ app?: StoryProtocolApp;
148
+ tags?: string[];
149
+ robotTerms?: IPRobotTerms;
150
+ additionalProperties?: {
151
+ [key: string]: unknown;
152
+ };
153
+ };
154
+ export type IpMetadata = {
155
+ title?: string;
156
+ description?: string;
157
+ ipType?: string;
158
+ relationships?: IpRelationship[];
159
+ createdAt?: string;
160
+ watermarkImg?: string;
161
+ creators?: IpCreator[];
162
+ media?: IpMedia[];
163
+ attributes?: IpAttribute[];
164
+ appInfo?: StoryProtocolApp[];
165
+ tags?: string[];
166
+ robotTerms?: IPRobotTerms;
167
+ [key: string]: unknown;
168
+ };
169
+ export type MintAndRegisterIpRequest = {
170
+ spgNftContract: Address;
171
+ recipient?: Address;
172
+ } & IpMetadataAndTxOption;
173
+ export type RegisterPilTermsAndAttachRequest = {
174
+ ipId: Address;
175
+ terms: RegisterPILTermsRequest;
176
+ deadline?: string | number | bigint;
177
+ txOptions?: TxOptions;
178
+ };
179
+ export type RegisterPilTermsAndAttachResponse = {
180
+ txHash?: string;
181
+ encodedTxData?: EncodedTxData;
182
+ licenseTermsId?: bigint;
30
183
  };
184
+ export type MintAndRegisterIpAndMakeDerivativeWithLicenseTokensRequest = {
185
+ spgNftContract: Address;
186
+ licenseTokenIds: string[] | bigint[] | number[];
187
+ recipient?: Address;
188
+ } & IpMetadataAndTxOption;
189
+ export type RegisterIpAndMakeDerivativeWithLicenseTokensRequest = {
190
+ nftContract: Address;
191
+ tokenId: string | number | bigint;
192
+ licenseTokenIds: string[] | bigint[] | number[];
193
+ deadline?: string | number | bigint;
194
+ } & IpMetadataAndTxOption;
31
195
  //# sourceMappingURL=ipAsset.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAE3B,OAAO,EAAE,SAAS,EAAE,sBAAmB;AAEvC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,aAAa,EAAE,GAAG,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0CAA0C,GAAG;IACvD,SAAS,EAAE,GAAG,CAAC;IACf,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,2CAA2C,GAAG;IACxD,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,SAAS,EAAE,GAAG,CAAC;IACf,WAAW,EAAE,GAAG,EAAE,CAAC;IACnB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,GAAG,CAAC;CACjB,CAAC"}
1
+ {"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,QAAQ,EAAE,uBAAuB,EAAE,qBAAkB;AAC9D,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,qBAAqB,EAAE,qBAAkB;AAElD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAClC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACrC,GAAG,qBAAqB,CAAC;AAE1B,MAAM,MAAM,0CAA0C,GAAG;IACvD,SAAS,EAAE,OAAO,CAAC;IACnB,eAAe,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IAChD,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,2CAA2C,GAAG;IACxD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,OAAO,EAAE,CAAC;IACvB,eAAe,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IAChD,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,cAAc,EAAE,OAAO,CAAC;IACxB,OAAO,EAAE,QAAQ,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACtC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,GAAG,qBAAqB,CAAC;AAE1B,MAAM,MAAM,iCAAiC,GAAG;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAClC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACpC,SAAS,EAAE;QACT,WAAW,EAAE,OAAO,EAAE,CAAC;QACvB,eAAe,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;QAChD,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH,GAAG,qBAAqB,CAAC;AAE1B,MAAM,MAAM,mCAAmC,GAAG;IAChD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAClC,OAAO,EAAE,QAAQ,CAAC;IAClB,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACrC,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACpC,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,GAAG,qBAAqB,CAAC;AAE1B,MAAM,MAAM,mCAAmC,GAAG;IAChD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,yCAAyC,GAAG;IACtD,cAAc,EAAE,OAAO,CAAC;IACxB,SAAS,EAAE;QACT,WAAW,EAAE,OAAO,EAAE,CAAC;QACvB,eAAe,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;QAChD,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B,CAAC;IACF,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,GAAG,qBAAqB,CAAC;AAE1B,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,EAAE,OAAO,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,eAAe,EAAE,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mBAAmB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,eAAe,EAAE,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AACF,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,cAAc,EAAE,CAAC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAC;IACvB,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;IAClB,UAAU,CAAC,EAAE,WAAW,EAAE,CAAC;IAC3B,GAAG,CAAC,EAAE,gBAAgB,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,YAAY,CAAC;IAC1B,oBAAoB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACnD,CAAC;AACF,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,cAAc,EAAE,CAAC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAC;IACvB,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;IAClB,UAAU,CAAC,EAAE,WAAW,EAAE,CAAC;IAC3B,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,YAAY,CAAC;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,cAAc,EAAE,OAAO,CAAC;IACxB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,GAAG,qBAAqB,CAAC;AAE1B,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,uBAAuB,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACpC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,0DAA0D,GAAG;IACvE,cAAc,EAAE,OAAO,CAAC;IACxB,eAAe,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IAChD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,GAAG,qBAAqB,CAAC;AAE1B,MAAM,MAAM,mDAAmD,GAAG;IAChE,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAClC,eAAe,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IAChD,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACrC,GAAG,qBAAqB,CAAC"}
@@ -1,67 +1,92 @@
1
- import { Hex } from "viem";
1
+ import { Address } from "viem";
2
2
  import { TxOptions } from "../options.js";
3
+ import { EncodedTxData } from "../../abi/generated.js";
3
4
  export type LicenseApiResponse = {
4
5
  data: License;
5
6
  };
6
7
  export type License = {
7
8
  id: string;
8
9
  policyId: string;
9
- licensorIpId: Hex;
10
+ licensorIpId: Address;
10
11
  };
11
12
  export type RegisterNonComSocialRemixingPILRequest = {
12
13
  txOptions?: TxOptions;
13
14
  };
15
+ /**
16
+ * This structure defines the terms for a Programmable IP License (PIL). These terms can be attached to IP Assets. The legal document of the PIL can be found in this repository.
17
+ * @type LicenseTerms
18
+ **/
14
19
  export type LicenseTerms = {
15
- mintingFee: bigint;
16
- expiration: bigint;
17
- commercialRevCelling: bigint;
18
- derivativeRevCelling: bigint;
19
- commercializerCheckerData: Hex;
20
20
  transferable: boolean;
21
- royaltyPolicy: Hex;
21
+ royaltyPolicy: Address;
22
+ defaultMintingFee: bigint;
23
+ expiration: bigint;
22
24
  commercialUse: boolean;
23
25
  commercialAttribution: boolean;
24
- commercializerChecker: Hex;
26
+ commercializerChecker: Address;
27
+ commercializerCheckerData: Address;
25
28
  commercialRevShare: number;
29
+ commercialRevCeiling: bigint;
26
30
  derivativesAllowed: boolean;
27
31
  derivativesAttribution: boolean;
28
32
  derivativesApproval: boolean;
29
33
  derivativesReciprocal: boolean;
30
- currency: Hex;
34
+ derivativeRevCeiling: bigint;
35
+ currency: Address;
31
36
  uri: string;
32
37
  };
33
- export type LicenseTermsIdResponse = number;
38
+ export type RegisterPILTermsRequest = Omit<LicenseTerms, "defaultMintingFee" | "expiration" | "commercialRevCeiling" | "derivativeRevCeiling"> & {
39
+ defaultMintingFee: bigint | string | number;
40
+ expiration: bigint | string | number;
41
+ commercialRevCeiling: bigint | string | number;
42
+ derivativeRevCeiling: bigint | string | number;
43
+ txOptions?: TxOptions;
44
+ };
45
+ export type LicenseTermsIdResponse = bigint;
34
46
  export type RegisterPILResponse = {
35
- licenseTermsId?: string;
47
+ licenseTermsId?: bigint;
36
48
  txHash?: string;
49
+ encodedTxData?: EncodedTxData;
37
50
  };
38
51
  export type RegisterCommercialUsePILRequest = {
39
- mintingFee: string;
40
- currency: Hex;
52
+ defaultMintingFee: string | number | bigint;
53
+ currency: Address;
41
54
  txOptions?: TxOptions;
42
55
  };
43
56
  export type RegisterCommercialRemixPILRequest = {
44
- mintingFee: string;
57
+ defaultMintingFee: string | number | bigint;
45
58
  commercialRevShare: number;
46
- currency: Hex;
59
+ currency: Address;
47
60
  txOptions?: TxOptions;
48
61
  };
49
62
  export type AttachLicenseTermsRequest = {
50
- ipId: Hex;
51
- licenseTermsId: string;
52
- licenseTemplate?: Hex;
63
+ ipId: Address;
64
+ licenseTermsId: string | number | bigint;
65
+ licenseTemplate?: Address;
53
66
  txOptions?: TxOptions;
54
67
  };
68
+ export type AttachLicenseTermsResponse = {
69
+ txHash?: string;
70
+ encodedTxData?: EncodedTxData;
71
+ success?: boolean;
72
+ };
55
73
  export type MintLicenseTokensRequest = {
56
- licensorIpId: Hex;
57
- licenseTermsId: string;
58
- licenseTemplate?: Hex;
59
- amount?: number;
60
- receiver?: Hex;
74
+ licensorIpId: Address;
75
+ licenseTermsId: string | number | bigint;
76
+ licenseTemplate?: Address;
77
+ amount?: number | string | bigint;
78
+ receiver?: Address;
61
79
  txOptions?: TxOptions;
62
80
  };
63
81
  export type MintLicenseTokensResponse = {
64
- licenseTokenId?: string;
82
+ licenseTokenIds?: bigint[];
65
83
  txHash?: string;
84
+ encodedTxData?: EncodedTxData;
66
85
  };
86
+ export declare enum PIL_TYPE {
87
+ NON_COMMERCIAL_REMIX = 0,
88
+ COMMERCIAL_USE = 1,
89
+ COMMERCIAL_REMIX = 2
90
+ }
91
+ export type LicenseTermsId = string | number | bigint;
67
92
  //# sourceMappingURL=license.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"license.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAE3B,OAAO,EAAE,SAAS,EAAE,sBAAmB;AAEvC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,GAAG,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,sCAAsC,GAAG;IACnD,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,yBAAyB,EAAE,GAAG,CAAC;IAC/B,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,GAAG,CAAC;IACnB,aAAa,EAAE,OAAO,CAAC;IACvB,qBAAqB,EAAE,OAAO,CAAC;IAC/B,qBAAqB,EAAE,GAAG,CAAC;IAC3B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,sBAAsB,EAAE,OAAO,CAAC;IAChC,mBAAmB,EAAE,OAAO,CAAC;IAC7B,qBAAqB,EAAE,OAAO,CAAC;IAC/B,QAAQ,EAAE,GAAG,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAE5C,MAAM,MAAM,mBAAmB,GAAG;IAChC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,GAAG,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,QAAQ,EAAE,GAAG,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,GAAG,CAAC;IACV,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,YAAY,EAAE,GAAG,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
1
+ {"version":3,"file":"license.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAEpD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sCAAsC,GAAG;IACnD,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF;;;IAGI;AACJ,MAAM,MAAM,YAAY,GAAG;IAEzB,YAAY,EAAE,OAAO,CAAC;IAEtB,aAAa,EAAE,OAAO,CAAC;IAEvB,iBAAiB,EAAE,MAAM,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB,aAAa,EAAE,OAAO,CAAC;IAEvB,qBAAqB,EAAE,OAAO,CAAC;IAE/B,qBAAqB,EAAE,OAAO,CAAC;IAE/B,yBAAyB,EAAE,OAAO,CAAC;IAEnC,kBAAkB,EAAE,MAAM,CAAC;IAE3B,oBAAoB,EAAE,MAAM,CAAC;IAE7B,kBAAkB,EAAE,OAAO,CAAC;IAE5B,sBAAsB,EAAE,OAAO,CAAC;IAEhC,mBAAmB,EAAE,OAAO,CAAC;IAE7B,qBAAqB,EAAE,OAAO,CAAC;IAE/B,oBAAoB,EAAE,MAAM,CAAC;IAE7B,QAAQ,EAAE,OAAO,CAAC;IAElB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AACF,MAAM,MAAM,uBAAuB,GAAG,IAAI,CACxC,YAAY,EACZ,mBAAmB,GAAG,YAAY,GAAG,sBAAsB,GAAG,sBAAsB,CACrF,GAAG;IACF,iBAAiB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC5C,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACrC,oBAAoB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC/C,oBAAoB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC/C,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAE5C,MAAM,MAAM,mBAAmB,GAAG;IAChC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,iBAAiB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC5C,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,iBAAiB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC5C,kBAAkB,EAAE,MAAM,CAAC;IAC3B,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,OAAO,CAAC;IACd,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACzC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACzC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAClC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,oBAAY,QAAQ;IAClB,oBAAoB,IAAA;IACpB,cAAc,IAAA;IACd,gBAAgB,IAAA;CACjB;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC"}
@@ -0,0 +1,23 @@
1
+ import { Address, Hex } from "viem";
2
+ import { TxOptions } from "../options.js";
3
+ import { EncodedTxData } from "../../abi/generated.js";
4
+ export type CreateNFTCollectionRequest = {
5
+ name: string;
6
+ symbol: string;
7
+ isPublicMinting: boolean;
8
+ mintOpen: boolean;
9
+ mintFeeRecipient: Address;
10
+ contractURI: string;
11
+ baseURI?: string;
12
+ maxSupply?: number;
13
+ mintFee?: bigint;
14
+ mintFeeToken?: Hex;
15
+ owner?: Hex;
16
+ txOptions?: TxOptions;
17
+ };
18
+ export type CreateNFTCollectionResponse = {
19
+ txHash?: string;
20
+ encodedTxData?: EncodedTxData;
21
+ spgNftContract?: Address;
22
+ };
23
+ //# sourceMappingURL=nftClient.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"nftClient.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["nftClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAEpD,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,OAAO,CAAC;IACzB,QAAQ,EAAE,OAAO,CAAC;IAClB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC"}
@@ -1,14 +1,53 @@
1
+ import { Address, Hex, WalletClient } from "viem";
1
2
  import { TxOptions } from "../options.js";
3
+ import { EncodedTxData } from "../../abi/generated.js";
2
4
  export type SetPermissionsRequest = {
3
- ipId: `0x${string}`;
4
- signer: `0x${string}`;
5
- to: `0x${string}`;
5
+ ipId: Address;
6
+ signer: Address;
7
+ to: Address;
8
+ permission: AccessPermission;
6
9
  func?: string;
7
- permission: number;
8
10
  txOptions?: TxOptions;
9
11
  };
10
12
  export type SetPermissionsResponse = {
11
- txHash: string;
13
+ txHash?: string;
14
+ encodedTxData?: EncodedTxData;
12
15
  success?: boolean;
13
16
  };
17
+ export type SetAllPermissionsRequest = {
18
+ ipId: Address;
19
+ signer: Address;
20
+ permission: AccessPermission;
21
+ txOptions?: TxOptions;
22
+ };
23
+ /**
24
+ * Permission level
25
+ * @enum {number}
26
+ **/
27
+ export declare enum AccessPermission {
28
+ ABSTAIN = 0,
29
+ ALLOW = 1,
30
+ DENY = 2
31
+ }
32
+ export type CreateSetPermissionSignatureRequest = {
33
+ deadline?: bigint | number | string;
34
+ } & SetPermissionsRequest;
35
+ export type SetBatchPermissionsRequest = {
36
+ permissions: Omit<SetPermissionsRequest, "txOptions">[];
37
+ txOptions?: TxOptions;
38
+ };
39
+ export type CreateBatchPermissionSignatureRequest = {
40
+ ipId: Address;
41
+ deadline?: bigint | number | string;
42
+ } & SetBatchPermissionsRequest;
43
+ export type PermissionSignatureRequest = {
44
+ ipId: Address;
45
+ state: Hex;
46
+ deadline: string | number | bigint;
47
+ wallet: WalletClient;
48
+ chainId: string | number | bigint;
49
+ permissions: Omit<SetPermissionsRequest, "txOptions">[];
50
+ permissionFunc?: "setPermission" | "setBatchPermissions";
51
+ };
52
+ export type PermissionSignatureResponse = Hex;
14
53
  //# sourceMappingURL=permission.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"permission.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["permission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,sBAAmB;AAEvC,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;IACpB,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;IACtB,EAAE,EAAE,KAAK,MAAM,EAAE,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"permission.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["permission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAElD,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAEpD,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,EAAE,EAAE,OAAO,CAAC;IACZ,UAAU,EAAE,gBAAgB,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,UAAU,EAAE,gBAAgB,CAAC;IAC7B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AACF;;;IAGI;AACJ,oBAAY,gBAAgB;IAE1B,OAAO,IAAA;IAEP,KAAK,IAAA;IAEL,IAAI,IAAA;CACL;AAED,MAAM,MAAM,mCAAmC,GAAG;IAChD,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACrC,GAAG,qBAAqB,CAAC;AAE1B,MAAM,MAAM,0BAA0B,GAAG;IACvC,WAAW,EAAE,IAAI,CAAC,qBAAqB,EAAE,WAAW,CAAC,EAAE,CAAC;IACxD,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACrC,GAAG,0BAA0B,CAAC;AAE/B,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,GAAG,CAAC;IACX,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACnC,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAClC,WAAW,EAAE,IAAI,CAAC,qBAAqB,EAAE,WAAW,CAAC,EAAE,CAAC;IACxD,cAAc,CAAC,EAAE,eAAe,GAAG,qBAAqB,CAAC;CAC1D,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,GAAG,CAAC"}
@@ -1,10 +1,11 @@
1
- import { Hex } from "viem";
1
+ import { Address } from "viem";
2
2
  import { TxOptions } from "../options.js";
3
+ import { EncodedTxData } from "../../abi/generated.js";
3
4
  export type RoyaltyPolicyApiResponse = {
4
5
  data: RoyaltyPolicy;
5
6
  };
6
7
  export type RoyaltyPolicy = {
7
- id: `0x${string}`;
8
+ id: Address;
8
9
  targetAncestors: string[];
9
10
  targetRoyaltyAmount: string[];
10
11
  };
@@ -16,57 +17,107 @@ export type RoyaltyContext = {
16
17
  parentAncestorsRoyalties1: number[];
17
18
  parentAncestorsRoyalties2: number[];
18
19
  };
19
- export type CollectRoyaltyTokensRequest = {
20
- parentIpId: Hex;
21
- royaltyVaultIpId: Hex;
22
- txOptions?: TxOptions;
23
- };
24
- export type CollectRoyaltyTokensResponse = {
25
- txHash: string;
26
- royaltyTokensCollected?: string;
27
- };
28
20
  export type RoyaltyData = [
29
21
  isUnlinkableToParents: boolean,
30
- ipRoyaltyVault: Hex,
22
+ ipRoyaltyVault: Address,
31
23
  royaltyStack: bigint,
32
- ancestorsAddresses: Hex,
24
+ ancestorsAddresses: Address,
33
25
  ancestorsRoyalties: bigint[]
34
26
  ];
35
27
  export type ClaimableRevenueRequest = {
36
- royaltyVaultIpId: Hex;
37
- account: Hex;
38
- snapshotId: string;
39
- token: Hex;
28
+ royaltyVaultIpId: Address;
29
+ account: Address;
30
+ snapshotId: string | number | bigint;
31
+ token: Address;
40
32
  };
41
- export type ClaimableRevenueResponse = string;
33
+ export type ClaimableRevenueResponse = bigint;
42
34
  export type PayRoyaltyOnBehalfRequest = {
43
- receiverIpId: Hex;
44
- payerIpId: Hex;
45
- token: Hex;
46
- amount: string;
35
+ receiverIpId: Address;
36
+ payerIpId: Address;
37
+ token: Address;
38
+ amount: string | number | bigint;
47
39
  txOptions?: TxOptions;
48
40
  };
49
41
  export type PayRoyaltyOnBehalfResponse = {
50
- txHash: string;
42
+ txHash?: string;
43
+ encodedTxData?: EncodedTxData;
51
44
  };
52
45
  export type SnapshotRequest = {
53
- royaltyVaultIpId: Hex;
46
+ royaltyVaultIpId: Address;
54
47
  txOptions?: TxOptions;
55
48
  };
56
- export type claimRevenueRequest = {
57
- snapshotIds: string[];
58
- token: Hex;
59
- account: Hex;
60
- royaltyVaultIpId: Hex;
49
+ export type ClaimRevenueRequest = {
50
+ snapshotIds: string[] | number[] | bigint[];
51
+ token: Address;
52
+ royaltyVaultIpId: Address;
53
+ account?: Address;
61
54
  txOptions?: TxOptions;
62
55
  };
63
- export type claimRevenueResponse = {
64
- txHash: string;
65
- claimableToken?: string;
56
+ export type ClaimRevenueResponse = {
57
+ txHash?: string;
58
+ encodedTxData?: EncodedTxData;
59
+ claimableToken?: bigint;
66
60
  };
67
61
  export type SnapshotResponse = {
68
- txHash: string;
69
- snapshotId?: string;
62
+ txHash?: string;
63
+ encodedTxData?: EncodedTxData;
64
+ snapshotId?: bigint;
65
+ };
66
+ type RoyaltyClaimDetail = {
67
+ childIpId: Address;
68
+ royaltyPolicy: Address;
69
+ currencyToken: Address;
70
+ amount: bigint | string | number;
71
+ };
72
+ export type TransferToVaultAndSnapshotAndClaimByTokenBatchRequest = {
73
+ ancestorIpId: Address;
74
+ royaltyClaimDetails: RoyaltyClaimDetail[];
75
+ claimer?: Address;
76
+ txOptions?: TxOptions;
77
+ };
78
+ export type TransferToVaultAndSnapshotAndClaimByTokenBatchResponse = {
79
+ txHash?: string;
80
+ encodedTxData?: EncodedTxData;
81
+ snapshotId?: bigint;
82
+ amountsClaimed?: bigint;
83
+ };
84
+ export type TransferToVaultAndSnapshotAndClaimBySnapshotBatchRequest = {
85
+ ancestorIpId: Address;
86
+ unclaimedSnapshotIds: bigint[] | number[] | string[];
87
+ claimer?: Address;
88
+ royaltyClaimDetails: RoyaltyClaimDetail[];
89
+ txOptions?: TxOptions;
90
+ };
91
+ export type TransferToVaultAndSnapshotAndClaimBySnapshotBatchResponse = {
92
+ txHash?: string;
93
+ encodedTxData?: EncodedTxData;
94
+ snapshotId?: bigint;
95
+ amountsClaimed?: bigint;
96
+ };
97
+ export type SnapshotAndClaimByTokenBatchRequest = {
98
+ royaltyVaultIpId: Address;
99
+ currencyTokens: Address[];
100
+ claimer?: Address;
101
+ txOptions?: TxOptions;
102
+ };
103
+ export type SnapshotAndClaimByTokenBatchResponse = {
104
+ txHash?: string;
105
+ encodedTxData?: EncodedTxData;
106
+ snapshotId?: bigint;
107
+ amountsClaimed?: bigint;
108
+ };
109
+ export type SnapshotAndClaimBySnapshotBatchRequest = {
110
+ royaltyVaultIpId: Address;
111
+ unclaimedSnapshotIds: bigint[] | number[] | string[];
112
+ currencyTokens: Address[];
113
+ claimer?: Address;
114
+ txOptions?: TxOptions;
115
+ };
116
+ export type SnapshotAndClaimBySnapshotBatchResponse = {
117
+ txHash?: string;
118
+ encodedTxData?: EncodedTxData;
119
+ snapshotId?: bigint;
120
+ amountsClaimed?: bigint;
70
121
  };
71
- export type RoyaltyVaultAddress = Hex;
122
+ export {};
72
123
  //# sourceMappingURL=royalty.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"royalty.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["royalty.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAE3B,OAAO,EAAE,SAAS,EAAE,sBAAmB;AAEvC,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,EAAE,KAAK,MAAM,EAAE,CAAC;IAClB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,mBAAmB,EAAE,MAAM,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,yBAAyB,EAAE,MAAM,EAAE,CAAC;IACpC,yBAAyB,EAAE,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,UAAU,EAAE,GAAG,CAAC;IAChB,gBAAgB,EAAE,GAAG,CAAC;IACtB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,qBAAqB,EAAE,OAAO;IAC9B,cAAc,EAAE,GAAG;IACnB,YAAY,EAAE,MAAM;IACpB,kBAAkB,EAAE,GAAG;IACvB,kBAAkB,EAAE,MAAM,EAAE;CAC7B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,gBAAgB,EAAE,GAAG,CAAC;IACtB,OAAO,EAAE,GAAG,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,GAAG,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAE9C,MAAM,MAAM,yBAAyB,GAAG;IACtC,YAAY,EAAE,GAAG,CAAC;IAClB,SAAS,EAAE,GAAG,CAAC;IACf,KAAK,EAAE,GAAG,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,gBAAgB,EAAE,GAAG,CAAC;IACtB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,KAAK,EAAE,GAAG,CAAC;IACX,OAAO,EAAE,GAAG,CAAC;IACb,gBAAgB,EAAE,GAAG,CAAC;IACtB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,GAAG,CAAC"}
1
+ {"version":3,"file":"royalty.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["royalty.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAEpD,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,EAAE,OAAO,CAAC;IACZ,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,mBAAmB,EAAE,MAAM,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,yBAAyB,EAAE,MAAM,EAAE,CAAC;IACpC,yBAAyB,EAAE,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,qBAAqB,EAAE,OAAO;IAC9B,cAAc,EAAE,OAAO;IACvB,YAAY,EAAE,MAAM;IACpB,kBAAkB,EAAE,OAAO;IAC3B,kBAAkB,EAAE,MAAM,EAAE;CAC7B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACrC,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAE9C,MAAM,MAAM,yBAAyB,GAAG;IACtC,YAAY,EAAE,OAAO,CAAC;IACtB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACjC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IAC5C,KAAK,EAAE,OAAO,CAAC;IACf,gBAAgB,EAAE,OAAO,CAAC;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AACF,KAAK,kBAAkB,GAAG;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,aAAa,EAAE,OAAO,CAAC;IACvB,aAAa,EAAE,OAAO,CAAC;IACvB,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CAClC,CAAC;AACF,MAAM,MAAM,qDAAqD,GAAG;IAClE,YAAY,EAAE,OAAO,CAAC;IACtB,mBAAmB,EAAE,kBAAkB,EAAE,CAAC;IAC1C,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,sDAAsD,GAAG;IACnE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,wDAAwD,GAAG;IACrE,YAAY,EAAE,OAAO,CAAC;IACtB,oBAAoB,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IACrD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,mBAAmB,EAAE,kBAAkB,EAAE,CAAC;IAC1C,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,yDAAyD,GAAG;IACtE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,mCAAmC,GAAG;IAChD,gBAAgB,EAAE,OAAO,CAAC;IAC1B,cAAc,EAAE,OAAO,EAAE,CAAC;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,oCAAoC,GAAG;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,sCAAsC,GAAG;IACnD,gBAAgB,EAAE,OAAO,CAAC;IAC1B,oBAAoB,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IACrD,cAAc,EAAE,OAAO,EAAE,CAAC;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,uCAAuC,GAAG;IACpD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC"}
@@ -0,0 +1,34 @@
1
+ export declare const iliad: {
2
+ blockExplorers: {
3
+ readonly default: {
4
+ readonly name: "Explorer";
5
+ readonly url: "https://testnet.storyscan.xyz";
6
+ };
7
+ };
8
+ contracts: {
9
+ readonly multicall3: {
10
+ readonly address: "0xcA11bde05977b3631167028862bE2a173976CA11";
11
+ readonly blockCreated: 5882;
12
+ };
13
+ };
14
+ id: 1513;
15
+ name: "iliad";
16
+ nativeCurrency: {
17
+ readonly name: "IP";
18
+ readonly symbol: "IP";
19
+ readonly decimals: 18;
20
+ };
21
+ rpcUrls: {
22
+ readonly default: {
23
+ readonly http: readonly ["https://testnet.storyrpc.io"];
24
+ readonly webSocket: readonly ["wss://story-network.rpc.caldera.xyz/ws"];
25
+ };
26
+ };
27
+ sourceId?: number | undefined;
28
+ testnet: true;
29
+ custom?: Record<string, unknown> | undefined;
30
+ formatters?: undefined;
31
+ serializers?: import("viem").ChainSerializers<undefined> | undefined;
32
+ fees?: import("viem").ChainFees<undefined> | undefined;
33
+ };
34
+ //# sourceMappingURL=chain.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"chain.d.ts","sourceRoot":"../../../../src/utils","sources":["chain.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuBhB,CAAC"}