@story-protocol/core-sdk 0.1.0-rc.1

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.
Files changed (68) hide show
  1. package/README.md +0 -0
  2. package/dist/declarations/src/abi/generated/CollectModule.d.ts +70 -0
  3. package/dist/declarations/src/abi/generated/CollectModule.d.ts.map +1 -0
  4. package/dist/declarations/src/abi/generated/FranchiseRegistry.d.ts +73 -0
  5. package/dist/declarations/src/abi/generated/FranchiseRegistry.d.ts.map +1 -0
  6. package/dist/declarations/src/abi/generated/IpAssetRegistry.d.ts +94 -0
  7. package/dist/declarations/src/abi/generated/IpAssetRegistry.d.ts.map +1 -0
  8. package/dist/declarations/src/abi/generated/LicensingModule.d.ts +97 -0
  9. package/dist/declarations/src/abi/generated/LicensingModule.d.ts.map +1 -0
  10. package/dist/declarations/src/abi/generated/RelationshipModule.d.ts +116 -0
  11. package/dist/declarations/src/abi/generated/RelationshipModule.d.ts.map +1 -0
  12. package/dist/declarations/src/abi/generated/common.d.ts +22 -0
  13. package/dist/declarations/src/abi/generated/common.d.ts.map +1 -0
  14. package/dist/declarations/src/abi/generated/factories/CollectModule__factory.d.ts +52 -0
  15. package/dist/declarations/src/abi/generated/factories/CollectModule__factory.d.ts.map +1 -0
  16. package/dist/declarations/src/abi/generated/factories/FranchiseRegistry__factory.d.ts +58 -0
  17. package/dist/declarations/src/abi/generated/factories/FranchiseRegistry__factory.d.ts.map +1 -0
  18. package/dist/declarations/src/abi/generated/factories/IpAssetRegistry__factory.d.ts +112 -0
  19. package/dist/declarations/src/abi/generated/factories/IpAssetRegistry__factory.d.ts.map +1 -0
  20. package/dist/declarations/src/abi/generated/factories/LicensingModule__factory.d.ts +88 -0
  21. package/dist/declarations/src/abi/generated/factories/LicensingModule__factory.d.ts.map +1 -0
  22. package/dist/declarations/src/abi/generated/factories/RelationshipModule__factory.d.ts +175 -0
  23. package/dist/declarations/src/abi/generated/factories/RelationshipModule__factory.d.ts.map +1 -0
  24. package/dist/declarations/src/abi/generated/factories/index.d.ts +6 -0
  25. package/dist/declarations/src/abi/generated/factories/index.d.ts.map +1 -0
  26. package/dist/declarations/src/abi/generated/index.d.ts +12 -0
  27. package/dist/declarations/src/abi/generated/index.d.ts.map +1 -0
  28. package/dist/declarations/src/client.d.ts +67 -0
  29. package/dist/declarations/src/client.d.ts.map +1 -0
  30. package/dist/declarations/src/enums/environment.d.ts +8 -0
  31. package/dist/declarations/src/enums/environment.d.ts.map +1 -0
  32. package/dist/declarations/src/enums/ipAssetType.d.ts +13 -0
  33. package/dist/declarations/src/enums/ipAssetType.d.ts.map +1 -0
  34. package/dist/declarations/src/index.d.ts +5 -0
  35. package/dist/declarations/src/index.d.ts.map +1 -0
  36. package/dist/declarations/src/interfaces/config.d.ts +12 -0
  37. package/dist/declarations/src/interfaces/config.d.ts.map +1 -0
  38. package/dist/declarations/src/interfaces/resources/collect.d.ts +45 -0
  39. package/dist/declarations/src/interfaces/resources/collect.d.ts.map +1 -0
  40. package/dist/declarations/src/interfaces/resources/franchise.d.ts +70 -0
  41. package/dist/declarations/src/interfaces/resources/franchise.d.ts.map +1 -0
  42. package/dist/declarations/src/interfaces/resources/ipAsset.d.ts +70 -0
  43. package/dist/declarations/src/interfaces/resources/ipAsset.d.ts.map +1 -0
  44. package/dist/declarations/src/interfaces/resources/license.d.ts +78 -0
  45. package/dist/declarations/src/interfaces/resources/license.d.ts.map +1 -0
  46. package/dist/declarations/src/interfaces/resources/relationship.d.ts +83 -0
  47. package/dist/declarations/src/interfaces/resources/relationship.d.ts.map +1 -0
  48. package/dist/declarations/src/interfaces/resources/transaction.d.ts +46 -0
  49. package/dist/declarations/src/interfaces/resources/transaction.d.ts.map +1 -0
  50. package/dist/declarations/src/resources/collect.d.ts +24 -0
  51. package/dist/declarations/src/resources/collect.d.ts.map +1 -0
  52. package/dist/declarations/src/resources/franchise.d.ts +41 -0
  53. package/dist/declarations/src/resources/franchise.d.ts.map +1 -0
  54. package/dist/declarations/src/resources/ipAsset.d.ts +40 -0
  55. package/dist/declarations/src/resources/ipAsset.d.ts.map +1 -0
  56. package/dist/declarations/src/resources/license.d.ts +36 -0
  57. package/dist/declarations/src/resources/license.d.ts.map +1 -0
  58. package/dist/declarations/src/resources/relationship.d.ts +48 -0
  59. package/dist/declarations/src/resources/relationship.d.ts.map +1 -0
  60. package/dist/declarations/src/resources/transaction.d.ts +25 -0
  61. package/dist/declarations/src/resources/transaction.d.ts.map +1 -0
  62. package/dist/story-protocol-core-sdk.cjs.d.ts +2 -0
  63. package/dist/story-protocol-core-sdk.cjs.d.ts.map +1 -0
  64. package/dist/story-protocol-core-sdk.cjs.dev.js +2101 -0
  65. package/dist/story-protocol-core-sdk.cjs.js +7 -0
  66. package/dist/story-protocol-core-sdk.cjs.prod.js +2101 -0
  67. package/dist/story-protocol-core-sdk.esm.js +2073 -0
  68. package/package.json +88 -0
@@ -0,0 +1,70 @@
1
+ /**
2
+ * Core data model for franchise.
3
+ *
4
+ * @public
5
+ */
6
+ export interface Franchise {
7
+ franchiseId: string;
8
+ franchiseName: string;
9
+ ownerAddress: string;
10
+ tokenUri: string;
11
+ }
12
+ /**
13
+ * Request interface for franchise.get method.
14
+ *
15
+ * @public
16
+ */
17
+ export interface GetFranchiseRequest {
18
+ franchiseId: string;
19
+ }
20
+ /**
21
+ * Response interface for franchise.get method.
22
+ *
23
+ * @public
24
+ */
25
+ export interface GetFranchiseResponse {
26
+ data: Franchise;
27
+ }
28
+ /**
29
+ * Request interface for franchise.create method.
30
+ *
31
+ * @public
32
+ */
33
+ export interface CreateFranchiseRequest {
34
+ franchiseName: string;
35
+ franchiseSymbol: string;
36
+ franchiseDescription: string;
37
+ }
38
+ /**
39
+ * Response interface for franchise.create method.
40
+ *
41
+ * @public
42
+ */
43
+ export interface CreateFranchiseResponse {
44
+ txHash: string;
45
+ }
46
+ /**
47
+ * Response interface for franchise.list method.
48
+ *
49
+ * @public
50
+ */
51
+ export interface ListFranchiseResponse {
52
+ data: Franchise[];
53
+ }
54
+ /**
55
+ * Request interface for franchise.configure method.
56
+ *
57
+ * @public
58
+ */
59
+ export interface ConfigureFranchiseRequest {
60
+ franchiseId: string;
61
+ }
62
+ /**
63
+ * Response interface for franchise.configure method.
64
+ *
65
+ * @public
66
+ */
67
+ export interface ConfigureFranchiseResponse {
68
+ txHash: string;
69
+ }
70
+ //# sourceMappingURL=franchise.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"franchise.d.ts","sourceRoot":"../../../../../src/interfaces/resources","sources":["franchise.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAC;CACrB;AACD;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,SAAS,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AACD;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,SAAS,EAAE,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,MAAM,CAAC;CACrB;AACD;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,MAAM,CAAC;CAChB"}
@@ -0,0 +1,70 @@
1
+ import { ipAssetType } from "../../enums/ipAssetType.js";
2
+ /**
3
+ * Core data model for IP Asset.
4
+ *
5
+ * @public
6
+ */
7
+ export interface ipAsset {
8
+ ipAssetId: string;
9
+ franchiseId: string;
10
+ ipAssetName: string;
11
+ ipAssetType: ipAssetType;
12
+ ownerAddress: string;
13
+ tokenUri: string;
14
+ }
15
+ /**
16
+ * Request interface for ipAsset.get method.
17
+ *
18
+ * @public
19
+ */
20
+ export interface GetIpAssetRequest {
21
+ ipAssetId: string;
22
+ franchiseId: string;
23
+ }
24
+ /**
25
+ * Response interface for ipAsset.get method.
26
+ *
27
+ * @public
28
+ */
29
+ export interface GetIpAssetResponse {
30
+ data: ipAsset;
31
+ }
32
+ /**
33
+ * Request interface for ipAsset.create method.
34
+ *
35
+ * @public
36
+ */
37
+ export interface CreateIpAssetRequest {
38
+ franchiseId: string;
39
+ ipAssetType: ipAssetType;
40
+ ipAssetName: string;
41
+ description: string;
42
+ mediaUrl: string;
43
+ to: string;
44
+ parentIpAssetId: string;
45
+ }
46
+ /**
47
+ * Response interface for ipAsset.create method.
48
+ *
49
+ * @public
50
+ */
51
+ export interface CreateIpAssetResponse {
52
+ txHash: string;
53
+ }
54
+ /**
55
+ * Request interface for ipAsset.list method.
56
+ *
57
+ * @public
58
+ */
59
+ export interface ListIpAssetRequest {
60
+ franchiseId: string;
61
+ }
62
+ /**
63
+ * Response interface for ipAsset.list method.
64
+ *
65
+ * @public
66
+ */
67
+ export interface ListIpAssetResponse {
68
+ data: ipAsset[];
69
+ }
70
+ //# sourceMappingURL=ipAsset.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../../src/interfaces/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,mCAAgC;AAEtD;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,OAAO,EAAE,CAAC;CACjB"}
@@ -0,0 +1,78 @@
1
+ import { BytesLike } from "ethers";
2
+ /**
3
+ * Represents the core data model for a License, containing essential information.
4
+ *
5
+ * @public
6
+ */
7
+ export interface License {
8
+ licenseId: string;
9
+ ipAssetId: string;
10
+ franchiseId: string;
11
+ ownerAddress: string;
12
+ uri: string;
13
+ txHash: string;
14
+ }
15
+ /**
16
+ * Represents the request structure for retrieving license details using the `franchise.get` method.
17
+ *
18
+ * @public
19
+ */
20
+ export interface GetLicenseRequest {
21
+ licenseId: string;
22
+ }
23
+ /**
24
+ * Represents the response structure for retrieving license details using the `license.get` method.
25
+ *
26
+ * @public
27
+ */
28
+ export interface GetLicenseResponse {
29
+ data: License;
30
+ }
31
+ export interface ListLicenseRequest {
32
+ ipAssetId: string;
33
+ franchiseId: string;
34
+ }
35
+ /**
36
+ * Represents the request structure for listing multiple licenses using the `license.list` method.
37
+ *
38
+ * @public
39
+ */
40
+ export interface ListLicenseResponse {
41
+ data: License[];
42
+ }
43
+ /**
44
+ * Represents the optional parameters for creating a new license using the `license.create` method.
45
+ *
46
+ * @public
47
+ */
48
+ export interface CreateLicenseRequestOptions {
49
+ parentLicenseId?: string;
50
+ ownerAddress?: string;
51
+ revoker?: string;
52
+ isCommercial?: boolean;
53
+ isSublicensable?: boolean;
54
+ terms?: {
55
+ processor: string;
56
+ data: BytesLike | string;
57
+ };
58
+ }
59
+ /**
60
+ * Represents the request structure for creating a new license using the `license.create` method.
61
+ *
62
+ * @public
63
+ */
64
+ export interface CreateLicenseRequest {
65
+ franchiseId: string;
66
+ ipAssetId: string;
67
+ licenseURI: string;
68
+ options?: CreateLicenseRequestOptions;
69
+ }
70
+ /**
71
+ * Represents the response structure for creating a new license using the `license.create` method.
72
+ *
73
+ * @public
74
+ */
75
+ export interface CreateLicenseResponse {
76
+ txHash: string;
77
+ }
78
+ //# sourceMappingURL=license.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"license.d.ts","sourceRoot":"../../../../../src/interfaces/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAEnC;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,OAAO,EAAE,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,KAAK,CAAC,EAAE;QACN,SAAS,EAAE,MAAM,CAAC;QAClB,IAAI,EAAE,SAAS,GAAG,MAAM,CAAC;KAC1B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,2BAA2B,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;CAChB"}
@@ -0,0 +1,83 @@
1
+ import { BigNumberish } from "ethers";
2
+ /**
3
+ * Core interface for relationship IPAsset.
4
+ *
5
+ * @public
6
+ */
7
+ export interface IPAsset {
8
+ franchiseId: string;
9
+ ipAssetId: string;
10
+ }
11
+ /**
12
+ * Request interface for relationship.relate method.
13
+ *
14
+ * @public
15
+ */
16
+ export interface RelationshipRelateRequest {
17
+ sourceIPAsset: IPAsset;
18
+ destIPAsset: IPAsset;
19
+ ttl?: BigNumberish;
20
+ }
21
+ /**
22
+ * Response interface for relationship.relate method.
23
+ *
24
+ * @public
25
+ */
26
+ export interface RelationshipRelateResponse {
27
+ txHash: string;
28
+ }
29
+ /**
30
+ * Request interface for relationship.unrelate method.
31
+ *
32
+ * @public
33
+ */
34
+ export interface RelationshipUnrelateRequest {
35
+ sourceIPAsset: IPAsset;
36
+ destIPAsset: IPAsset;
37
+ ttl?: BigNumberish;
38
+ }
39
+ /**
40
+ * Response interface for relationship.unrelate method.
41
+ *
42
+ * @public
43
+ */
44
+ export interface RelationshipUnrelateResponse {
45
+ txHash: string;
46
+ }
47
+ /**
48
+ * Request interface for relationship.isRelationshipExpired method.
49
+ *
50
+ * @public
51
+ */
52
+ export interface RelationshipIsRelationshipExpiredRequest {
53
+ sourceIPAsset: IPAsset;
54
+ destIPAsset: IPAsset;
55
+ ttl?: BigNumberish;
56
+ }
57
+ /**
58
+ * Response interface for relationship.isRelationshipExpired method.
59
+ *
60
+ * @public
61
+ */
62
+ export interface RelationshipIsRelationshipExpiredResponse {
63
+ result: boolean;
64
+ }
65
+ /**
66
+ * Request interface for relationship.isRelated method.
67
+ *
68
+ * @public
69
+ */
70
+ export interface RelationshipIsRelatedRequest {
71
+ sourceIPAsset: IPAsset;
72
+ destIPAsset: IPAsset;
73
+ ttl?: BigNumberish;
74
+ }
75
+ /**
76
+ * Response interface for relationship.isRelated method.
77
+ *
78
+ * @public
79
+ */
80
+ export interface RelationshipIsRelatedResponse {
81
+ result: boolean;
82
+ }
83
+ //# sourceMappingURL=relationship.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"relationship.d.ts","sourceRoot":"../../../../../src/interfaces/resources","sources":["relationship.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;CACnB;AACD;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,OAAO,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,GAAG,CAAC,EAAE,YAAY,CAAC;CACpB;AACD;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,aAAa,EAAE,OAAO,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,GAAG,CAAC,EAAE,YAAY,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,MAAM,CAAC;CAChB;AACD;;;;GAIG;AACH,MAAM,WAAW,wCAAwC;IACvD,aAAa,EAAE,OAAO,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,GAAG,CAAC,EAAE,YAAY,CAAC;CACpB;AACD;;;;GAIG;AACH,MAAM,WAAW,yCAAyC;IACxD,MAAM,EAAE,OAAO,CAAC;CACjB;AACD;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,aAAa,EAAE,OAAO,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,GAAG,CAAC,EAAE,YAAY,CAAC;CACpB;AACD;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EAAE,OAAO,CAAC;CACjB"}
@@ -0,0 +1,46 @@
1
+ /**
2
+ * Core data model for transactions.
3
+ *
4
+ * @public
5
+ */
6
+ export interface Transaction {
7
+ txId: string;
8
+ txHash: string;
9
+ createdAt: string;
10
+ creatorAddress: string;
11
+ type: ResourceType;
12
+ resourceId: string;
13
+ franchiseId: string;
14
+ }
15
+ export declare enum ResourceType {
16
+ FRANCHISE = 0,
17
+ IP_ASSET = 1,
18
+ LICENSE = 2,
19
+ RELATIONSHIP = 3,
20
+ COLLECT = 4
21
+ }
22
+ /**
23
+ * Request interface for transaction.get method.
24
+ *
25
+ * @public
26
+ */
27
+ export interface GetTransactionRequest {
28
+ txId: string;
29
+ }
30
+ /**
31
+ * Response interface for transaction.get method.
32
+ *
33
+ * @public
34
+ */
35
+ export interface GetTransactionResponse {
36
+ data: Transaction;
37
+ }
38
+ /**
39
+ * Response interface for transaction.list method.
40
+ *
41
+ * @public
42
+ */
43
+ export interface ListTransactionResponse {
44
+ data: Transaction[];
45
+ }
46
+ //# sourceMappingURL=transaction.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"transaction.d.ts","sourceRoot":"../../../../../src/interfaces/resources","sources":["transaction.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,YAAY,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,oBAAY,YAAY;IACtB,SAAS,IAAA;IACT,QAAQ,IAAA;IACR,OAAO,IAAA;IACP,YAAY,IAAA;IACZ,OAAO,IAAA;CACR;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,WAAW,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,WAAW,EAAE,CAAC;CACrB"}
@@ -0,0 +1,24 @@
1
+ import { AxiosInstance } from "axios";
2
+ import { Signer } from "ethers";
3
+ import { CollectIPAssetRequest, CollectIPAssetResponse, ListCollectionsRequest, ListCollectionsResponse } from "../interfaces/resources/collect.js";
4
+ import { CollectModule } from "../abi/generated/index.js";
5
+ export declare class CollectClient {
6
+ private readonly httpClient;
7
+ private readonly signer;
8
+ private readonly collectModuleContract;
9
+ constructor(httpClient: AxiosInstance, signer: Signer, collectModule: CollectModule);
10
+ /**
11
+ * List all collected IP Assets.
12
+ *
13
+ * @returns A Promise that resolves to the ListLicenseResponse.
14
+ */
15
+ list(request: ListCollectionsRequest): Promise<ListCollectionsResponse>;
16
+ /**
17
+ * Collect an IP Asset on Story Protocol based on the specified input collect data.
18
+ *
19
+ * @param request - the request object that contains all data needed to collect an IP Asset
20
+ * @returns the response object that contains results from the create franchise action
21
+ */
22
+ collect(request: CollectIPAssetRequest): Promise<CollectIPAssetResponse>;
23
+ }
24
+ //# sourceMappingURL=collect.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"collect.d.ts","sourceRoot":"../../../../src/resources","sources":["collect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AACrD,OAAO,EAAuB,MAAM,EAAE,MAAM,QAAQ,CAAC;AAErD,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACxB,2CAAwC;AACzC,OAAO,EAAE,aAAa,EAAE,kCAAyB;AAGjD,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;IAC3C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAgB;gBAE1C,UAAU,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa;IAMnF;;;;OAIG;IACU,IAAI,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAWpF;;;;;OAKG;IACU,OAAO,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;CAkBtF"}
@@ -0,0 +1,41 @@
1
+ import { AxiosInstance } from "axios";
2
+ import { GetFranchiseRequest, GetFranchiseResponse, CreateFranchiseRequest, CreateFranchiseResponse, ListFranchiseResponse, ConfigureFranchiseRequest, ConfigureFranchiseResponse } from "../interfaces/resources/franchise.js";
3
+ import { FranchiseRegistry, LicensingModule } from "../abi/generated/index.js";
4
+ /**
5
+ * FranchiseClient allows you to create, update, view, search franchises on
6
+ * Story Protocol.
7
+ */
8
+ export declare class FranchiseClient {
9
+ private readonly httpClient;
10
+ private readonly franchiseRegistry;
11
+ private readonly licenseModule;
12
+ constructor(httpClient: AxiosInstance, franchiseRegistry: FranchiseRegistry, licenseModule: LicensingModule);
13
+ /**
14
+ * Get a franchise data based on the specified franchise id.
15
+ *
16
+ * @param request - the request object for getting the franchise
17
+ * @returns the response object that contains the fetched franchise object
18
+ */
19
+ get(request: GetFranchiseRequest): Promise<GetFranchiseResponse>;
20
+ /**
21
+ * List all franchises.
22
+ *
23
+ * @returns the response object that contains a list of franchises
24
+ */
25
+ list(): Promise<ListFranchiseResponse>;
26
+ /**
27
+ * Create a franchise on Story Protocol based on the specified input franchise data.
28
+ *
29
+ * @param request - the request object that contains all data needed to create a franchise
30
+ * @returns the response object that contains results from the create franchise action
31
+ */
32
+ create(request: CreateFranchiseRequest): Promise<CreateFranchiseResponse>;
33
+ /**
34
+ * Configure a franchise on Story Protocol.
35
+ *
36
+ * @param request - the request object that contains all data needed to configure a franchise
37
+ * @returns the response object that contains results from the configure franchise action
38
+ */
39
+ configure(request: ConfigureFranchiseRequest): Promise<ConfigureFranchiseResponse>;
40
+ }
41
+ //# sourceMappingURL=franchise.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"franchise.d.ts","sourceRoot":"../../../../src/resources","sources":["franchise.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAGtC,OAAO,EACL,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,yBAAyB,EACzB,0BAA0B,EAC3B,6CAA0C;AAG3C,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,kCAAyB;AAEtE;;;GAGG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;IAC3C,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAoB;IACtD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAkB;gBAG9C,UAAU,EAAE,aAAa,EACzB,iBAAiB,EAAE,iBAAiB,EACpC,aAAa,EAAE,eAAe;IAOhC;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAc7E;;;;OAIG;IACU,IAAI,IAAI,OAAO,CAAC,qBAAqB,CAAC;IASnD;;;;;OAKG;IACU,MAAM,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAoBtF;;;;;OAKG;IACU,SAAS,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,0BAA0B,CAAC;CA+BhG"}
@@ -0,0 +1,40 @@
1
+ import { AxiosInstance } from "axios";
2
+ import { Signer } from "ethers";
3
+ import { GetIpAssetRequest, GetIpAssetResponse, CreateIpAssetRequest, CreateIpAssetResponse, ListIpAssetRequest, ListIpAssetResponse } from "../interfaces/resources/ipAsset.js";
4
+ import { FranchiseRegistry } from "../abi/generated/index.js";
5
+ /**
6
+ * IpAssetClient allows you to create, view, and list IP Assets on Story Protocol.
7
+ */
8
+ export declare class IpAssetClient {
9
+ private readonly httpClient;
10
+ private readonly franchiseRegistry;
11
+ private readonly signer;
12
+ constructor(httpClient: AxiosInstance, franchiseRegistry: FranchiseRegistry, signer: Signer);
13
+ /**
14
+ * Get the ipAssetRegistry associated with a franchiseId.
15
+ *
16
+ * @returns the response object that contains the requested ipAssetRegistry.
17
+ */
18
+ private getRegistry;
19
+ /**
20
+ * Get an IP Asset based on the specified IP asset ID.
21
+ *
22
+ * @param request - the request object for getting an IP Asset.
23
+ * @returns the response object the contains the fetched IP Asset.
24
+ */
25
+ get(request: GetIpAssetRequest): Promise<GetIpAssetResponse>;
26
+ /**
27
+ * Create an IP Asset on Story Protocol based on the specified input asset data.
28
+ *
29
+ * @param request - the request object that contains all data needed to create an IP Asset.
30
+ * @returns the response object that contains results from the asset creation.
31
+ */
32
+ create(request: CreateIpAssetRequest): Promise<CreateIpAssetResponse>;
33
+ /**
34
+ * List all IP assets.
35
+ *
36
+ * @returns the response object that contains results from listing query.
37
+ */
38
+ list(request: ListIpAssetRequest): Promise<ListIpAssetResponse>;
39
+ }
40
+ //# sourceMappingURL=ipAsset.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,mBAAmB,EACpB,2CAAwC;AAGzC,OAAO,EAAE,iBAAiB,EAA4B,kCAAyB;AAG/E;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;IAC3C,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAoB;IACtD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;gBAEpB,UAAU,EAAE,aAAa,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM;IAM3F;;;;OAIG;YACW,WAAW;IAUzB;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAezE;;;;;OAKG;IACU,MAAM,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA0BlF;;;;OAIG;IACU,IAAI,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAQ7E"}
@@ -0,0 +1,36 @@
1
+ import { AxiosInstance } from "axios";
2
+ import { Signer } from "ethers";
3
+ import { GetLicenseRequest, GetLicenseResponse, ListLicenseResponse, CreateLicenseRequest, CreateLicenseResponse, ListLicenseRequest } from "../interfaces/resources/license.js";
4
+ import { FranchiseRegistry } from "../abi/generated/index.js";
5
+ /**
6
+ * A class representing License operations.
7
+ *
8
+ * @public
9
+ */
10
+ export declare class LicenseClient {
11
+ private readonly httpClient;
12
+ private readonly signer;
13
+ private readonly franchiseRegistry;
14
+ constructor(httpClient: AxiosInstance, signer: Signer, franchiseRegistry: FranchiseRegistry);
15
+ /**
16
+ * Get a license by its ID.
17
+ *
18
+ * @param licenseId - The ID of the license to retrieve.
19
+ * @returns A Promise that resolves to the GetLicenseResponse.
20
+ */
21
+ get(request: GetLicenseRequest): Promise<GetLicenseResponse>;
22
+ /**
23
+ * List all licenses.
24
+ *
25
+ * @returns A Promise that resolves to the ListLicenseResponse.
26
+ */
27
+ list(request: ListLicenseRequest): Promise<ListLicenseResponse>;
28
+ /**
29
+ * Create a license within the Story Protocol based on the specified input data.
30
+ *
31
+ * @param request - An object containing the necessary data to create a license.
32
+ * @returns A response object containing the result of the create license action, including the transaction hash.
33
+ */
34
+ create(request: CreateLicenseRequest): Promise<CreateLicenseResponse>;
35
+ }
36
+ //# sourceMappingURL=license.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"license.d.ts","sourceRoot":"../../../../src/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AACrD,OAAO,EAAE,MAAM,EAAkC,MAAM,QAAQ,CAAC;AAEhE,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EACnB,2CAAwC;AACzC,OAAO,EAAE,iBAAiB,EAA4B,kCAAyB;AAI/E;;;;GAIG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;IAC3C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAoB;gBAE1C,UAAU,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,iBAAiB;IAM3F;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAczE;;;;OAIG;IACU,IAAI,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAY5E;;;;;OAKG;IACU,MAAM,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAyDnF"}
@@ -0,0 +1,48 @@
1
+ import { RelationshipModule } from "../abi/generated/RelationshipModule.js";
2
+ import { RelationshipIsRelatedRequest, RelationshipIsRelatedResponse, RelationshipIsRelationshipExpiredRequest, RelationshipIsRelationshipExpiredResponse, RelationshipRelateRequest, RelationshipRelateResponse, RelationshipUnrelateRequest, RelationshipUnrelateResponse } from "../interfaces/resources/relationship.js";
3
+ import { FranchiseRegistry } from "../abi/generated/index.js";
4
+ /**
5
+ * Client for managing relationships.
6
+ */
7
+ export declare class RelationshipClient {
8
+ private readonly relationshipModule;
9
+ private readonly franchiseRegistry;
10
+ /**
11
+ * Creates a new RelationshipClient instance.
12
+ * @param relationshipModule - The relationship module to interact with.
13
+ * @param franchiseRegistry - The franchise registry to interact with.
14
+ */
15
+ constructor(relationshipModule: RelationshipModule, franchiseRegistry: FranchiseRegistry);
16
+ /**
17
+ * Retrieves the registry addresses for source and destination franchises.
18
+ * @param sourceFranchiseId - The ID of the source franchise.
19
+ * @param destFranchiseId - The ID of the destination franchise.
20
+ * @returns An object containing the source and destination IP registry addresses.
21
+ */
22
+ private getRegistryAddresses;
23
+ /**
24
+ * Establishes a relationship between two IP assets.
25
+ * @param request - The request for establishing the relationship.
26
+ * @returns A promise that resolves to the response with the transaction hash.
27
+ */
28
+ relate(request: RelationshipRelateRequest): Promise<RelationshipRelateResponse>;
29
+ /**
30
+ * Removes a relationship between two IP assets.
31
+ * @param request - The request for removing the relationship.
32
+ * @returns A promise that resolves to the response with the transaction hash.
33
+ */
34
+ unrelate(request: RelationshipUnrelateRequest): Promise<RelationshipUnrelateResponse>;
35
+ /**
36
+ * Checks if a relationship has expired.
37
+ * @param request - The request for checking the relationship's expiration status.
38
+ * @returns A promise that resolves to the response indicating whether the relationship has expired.
39
+ */
40
+ isRelationshipExpired(request: RelationshipIsRelationshipExpiredRequest): Promise<RelationshipIsRelationshipExpiredResponse>;
41
+ /**
42
+ * Checks if two IP assets are related.
43
+ * @param request - The request for checking the relationship between two IP assets.
44
+ * @returns A promise that resolves to the response indicating whether the IP assets are related.
45
+ */
46
+ isRelated(request: RelationshipIsRelatedRequest): Promise<RelationshipIsRelatedResponse>;
47
+ }
48
+ //# sourceMappingURL=relationship.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"relationship.d.ts","sourceRoot":"../../../../src/resources","sources":["relationship.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,+CAA4C;AACzE,OAAO,EACL,4BAA4B,EAC5B,6BAA6B,EAC7B,wCAAwC,EACxC,yCAAyC,EACzC,yBAAyB,EACzB,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC7B,gDAA6C;AAE9C,OAAO,EAAE,iBAAiB,EAAE,kCAAyB;AAErD;;GAEG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAqB;IACxD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAoB;IAEtD;;;;OAIG;gBACS,kBAAkB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,iBAAiB;IAKxF;;;;;OAKG;YACW,oBAAoB;IAwBlC;;;;OAIG;IACU,MAAM,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAiC5F;;;;OAIG;IACU,QAAQ,CACnB,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,4BAA4B,CAAC;IA+BxC;;;;OAIG;IACU,qBAAqB,CAChC,OAAO,EAAE,wCAAwC,GAChD,OAAO,CAAC,yCAAyC,CAAC;IA+BrD;;;;OAIG;IACU,SAAS,CACpB,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,6BAA6B,CAAC;CA8B1C"}
@@ -0,0 +1,25 @@
1
+ import { AxiosInstance } from "axios";
2
+ import { GetTransactionRequest, GetTransactionResponse, ListTransactionResponse } from "../interfaces/resources/transaction.js";
3
+ /**
4
+ * TransactionClient allows you to view and monitor transactions on
5
+ * Story Protocol.
6
+ */
7
+ export declare class TransactionClient {
8
+ private readonly httpClient;
9
+ constructor(httpClient: AxiosInstance);
10
+ /**
11
+ * Get transaction data based on the specified transaction id.
12
+ *
13
+ * @param request - the request object for getting the transaction
14
+ * @returns the response object that contains the fetched transaction object
15
+ */
16
+ get(request: GetTransactionRequest): Promise<GetTransactionResponse>;
17
+ /**
18
+ * Get transaction data based on the specified transaction id.
19
+ *
20
+ * @param request - the request object for getting the transactions
21
+ * @returns the response object that contains the fetched transaction object
22
+ */
23
+ list(): Promise<ListTransactionResponse>;
24
+ }
25
+ //# sourceMappingURL=transaction.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"transaction.d.ts","sourceRoot":"../../../../src/resources","sources":["transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AAGrD,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACxB,+CAA4C;AAE7C;;;GAGG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;gBAE/B,UAAU,EAAE,aAAa;IAIrC;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IASjF;;;;;OAKG;IACU,IAAI,IAAI,OAAO,CAAC,uBAAuB,CAAC;CAQtD"}
@@ -0,0 +1,2 @@
1
+ export * from "./declarations/src/index";
2
+ //# sourceMappingURL=story-protocol-core-sdk.cjs.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"story-protocol-core-sdk.cjs.d.ts","sourceRoot":"","sources":["./declarations/src/index.d.ts"],"names":[],"mappings":"AAAA"}