@story-protocol/core-sdk 0.0.1-beta-rc.4 → 0.0.1-beta-rc.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (34) hide show
  1. package/README.md +97 -43
  2. package/dist/declarations/src/client.d.ts +31 -7
  3. package/dist/declarations/src/client.d.ts.map +1 -1
  4. package/dist/declarations/src/constants/common.d.ts +1 -0
  5. package/dist/declarations/src/constants/common.d.ts.map +1 -1
  6. package/dist/declarations/src/index.d.ts +2 -3
  7. package/dist/declarations/src/index.d.ts.map +1 -1
  8. package/dist/declarations/src/resources/dispute.d.ts +0 -20
  9. package/dist/declarations/src/resources/dispute.d.ts.map +1 -1
  10. package/dist/declarations/src/resources/ipAccount.d.ts +732 -0
  11. package/dist/declarations/src/resources/{tagging.d.ts.map → ipAccount.d.ts.map} +1 -1
  12. package/dist/declarations/src/resources/ipAsset.d.ts +53 -36
  13. package/dist/declarations/src/resources/ipAsset.d.ts.map +1 -1
  14. package/dist/declarations/src/resources/license.d.ts +44 -41
  15. package/dist/declarations/src/resources/license.d.ts.map +1 -1
  16. package/dist/declarations/src/resources/permission.d.ts +3 -43
  17. package/dist/declarations/src/resources/permission.d.ts.map +1 -1
  18. package/dist/declarations/src/resources/policy.d.ts +99 -82
  19. package/dist/declarations/src/resources/policy.d.ts.map +1 -1
  20. package/dist/declarations/src/types/resources/ipAccount.d.ts +25 -0
  21. package/dist/declarations/src/types/resources/ipAccount.d.ts.map +1 -0
  22. package/dist/declarations/src/types/resources/ipAsset.d.ts +5 -5
  23. package/dist/declarations/src/types/resources/ipAsset.d.ts.map +1 -1
  24. package/dist/declarations/src/types/resources/permission.d.ts +3 -3
  25. package/dist/declarations/src/types/resources/permission.d.ts.map +1 -1
  26. package/dist/declarations/src/types/resources/policy.d.ts +39 -1
  27. package/dist/declarations/src/types/resources/policy.d.ts.map +1 -1
  28. package/dist/story-protocol-core-sdk.cjs.dev.js +734 -285
  29. package/dist/story-protocol-core-sdk.cjs.prod.js +734 -285
  30. package/dist/story-protocol-core-sdk.esm.js +736 -286
  31. package/package.json +1 -1
  32. package/dist/declarations/src/resources/tagging.d.ts +0 -718
  33. package/dist/declarations/src/types/resources/tagging.d.ts +0 -23
  34. package/dist/declarations/src/types/resources/tagging.d.ts.map +0 -1
@@ -0,0 +1,25 @@
1
+ import { TxOptions } from "../options.js";
2
+ export type IPAccountExecuteRequest = {
3
+ accountAddress: `0x${string}`;
4
+ to: `0x${string}`;
5
+ value: number;
6
+ data: `0x${string}`;
7
+ txOptions?: TxOptions;
8
+ };
9
+ export type IPAccountExecuteResponse = {
10
+ txHash: string;
11
+ };
12
+ export type IPAccountExecuteWithSigRequest = {
13
+ accountAddress: `0x${string}`;
14
+ to: `0x${string}`;
15
+ value: number;
16
+ data: `0x${string}`;
17
+ signer: `0x${string}`;
18
+ deadline: number;
19
+ signature: `0x${string}`;
20
+ txOptions?: TxOptions;
21
+ };
22
+ export type IPAccountExecuteWithSigResponse = {
23
+ txHash: string;
24
+ };
25
+ //# sourceMappingURL=ipAccount.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ipAccount.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["ipAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,sBAAmB;AAEvC,MAAM,MAAM,uBAAuB,GAAG;IACpC,cAAc,EAAE,KAAK,MAAM,EAAE,CAAC;IAC9B,EAAE,EAAE,KAAK,MAAM,EAAE,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;IACpB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,cAAc,EAAE,KAAK,MAAM,EAAE,CAAC;IAC9B,EAAE,EAAE,KAAK,MAAM,EAAE,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;IACpB,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,KAAK,MAAM,EAAE,CAAC;IACzB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
@@ -1,20 +1,20 @@
1
1
  import { TxOptions } from "../options.js";
2
2
  export type RegisterRootIpRequest = {
3
- policyId: string;
4
- tokenContractAddress: string;
3
+ tokenContractAddress: `0x${string}`;
5
4
  tokenId: string;
5
+ policyId?: string;
6
6
  ipName?: string;
7
7
  contentHash?: `0x${string}`;
8
8
  uri?: string;
9
9
  txOptions?: TxOptions;
10
10
  };
11
11
  export type RegisterRootIpResponse = {
12
- txHash: string;
12
+ txHash?: string;
13
13
  ipId?: string;
14
14
  };
15
15
  export type RegisterDerivativeIpRequest = {
16
16
  licenseIds: string[];
17
- tokenContractAddress: string;
17
+ tokenContractAddress: `0x${string}`;
18
18
  tokenId: string;
19
19
  ipName?: string;
20
20
  contentHash?: `0x${string}`;
@@ -23,7 +23,7 @@ export type RegisterDerivativeIpRequest = {
23
23
  txOptions?: TxOptions;
24
24
  };
25
25
  export type RegisterDerivativeIpResponse = {
26
- txHash: string;
26
+ txHash?: string;
27
27
  ipId?: string;
28
28
  };
29
29
  //# 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,SAAS,EAAE,sBAAmB;AAEvC,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IAC5B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IAC5B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC"}
1
+ {"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,sBAAmB;AAEvC,MAAM,MAAM,qBAAqB,GAAG;IAClC,oBAAoB,EAAE,KAAK,MAAM,EAAE,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IAC5B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,oBAAoB,EAAE,KAAK,MAAM,EAAE,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IAC5B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC"}
@@ -1,13 +1,13 @@
1
1
  import { TxOptions } from "../options.js";
2
- export type setPermissionsRequest = {
2
+ export type SetPermissionsRequest = {
3
3
  ipId: `0x${string}`;
4
4
  signer: `0x${string}`;
5
5
  to: `0x${string}`;
6
- func: string;
6
+ func?: string;
7
7
  permission: number;
8
8
  txOptions?: TxOptions;
9
9
  };
10
- export type setPermissionsResponse = {
10
+ export type SetPermissionsResponse = {
11
11
  txHash: string;
12
12
  success?: boolean;
13
13
  };
@@ -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,EAAE,MAAM,CAAC;IACb,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,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"}
@@ -20,7 +20,30 @@ export type RegisterPILPolicyRequest = {
20
20
  txOptions?: TxOptions;
21
21
  };
22
22
  export type RegisterPILPolicyResponse = {
23
- txHash: string;
23
+ txHash?: string;
24
+ policyId?: string;
25
+ };
26
+ export type RegisterPILSocialRemixPolicyRequest = {
27
+ territories?: string[];
28
+ distributionChannels?: string[];
29
+ contentRestrictions?: string[];
30
+ txOptions?: TxOptions;
31
+ };
32
+ export type RegisterPILSocialRemixPolicyResponse = {
33
+ txHash?: string;
34
+ policyId?: string;
35
+ };
36
+ export type RegisterPILCommercialUsePolicyRequest = {
37
+ commercialRevShare: number;
38
+ mintingFee?: string;
39
+ mintingFeeToken?: `0x${string}`;
40
+ territories?: string[];
41
+ distributionChannels?: string[];
42
+ contentRestrictions?: string[];
43
+ txOptions?: TxOptions;
44
+ };
45
+ export type RegisterPILCommercialUsePolicyResponse = {
46
+ txHash?: string;
24
47
  policyId?: string;
25
48
  };
26
49
  export type AddPolicyToIpRequest = {
@@ -42,4 +65,19 @@ export type Policy = {
42
65
  export type PILData = {
43
66
  commercialRevShare: string;
44
67
  };
68
+ export type FrameworkData = {
69
+ attribution: boolean;
70
+ commercialUse: boolean;
71
+ commercialAttribution: boolean;
72
+ commercialRevShare: number;
73
+ derivativesAllowed: boolean;
74
+ derivativesAttribution: boolean;
75
+ derivativesApproval: boolean;
76
+ derivativesReciprocal: boolean;
77
+ territories: string[];
78
+ distributionChannels: string[];
79
+ contentRestrictions: string[];
80
+ commercializerChecker: `0x${string}`;
81
+ commercializerCheckerData: `0x${string}`;
82
+ };
45
83
  //# sourceMappingURL=policy.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"policy.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["policy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,sBAAmB;AAEvC,MAAM,MAAM,wBAAwB,GAAG;IACrC,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IAChC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,qBAAqB,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IACtC,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,OAAO,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC"}
1
+ {"version":3,"file":"policy.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["policy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,sBAAmB;AAEvC,MAAM,MAAM,wBAAwB,GAAG;IACrC,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IAChC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,qBAAqB,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IACtC,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG;IAChD,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG;IAClD,kBAAkB,EAAE,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sCAAsC,GAAG;IACnD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,OAAO,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,WAAW,EAAE,OAAO,CAAC;IACrB,aAAa,EAAE,OAAO,CAAC;IACvB,qBAAqB,EAAE,OAAO,CAAC;IAC/B,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,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,oBAAoB,EAAE,MAAM,EAAE,CAAC;IAC/B,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,qBAAqB,EAAE,KAAK,MAAM,EAAE,CAAC;IACrC,yBAAyB,EAAE,KAAK,MAAM,EAAE,CAAC;CAC1C,CAAC"}