@story-protocol/core-sdk 0.1.0-rc.7 → 1.0.0-rc.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (109) hide show
  1. package/README.md +94 -55
  2. package/dist/declarations/src/abi/generated.d.ts +14196 -0
  3. package/dist/declarations/src/abi/generated.d.ts.map +1 -0
  4. package/dist/declarations/src/client.d.ts +42 -49
  5. package/dist/declarations/src/client.d.ts.map +1 -1
  6. package/dist/declarations/src/clients/storyAPI.d.ts +9 -0
  7. package/dist/declarations/src/clients/storyAPI.d.ts.map +1 -0
  8. package/dist/declarations/src/constants/common.d.ts +4 -0
  9. package/dist/declarations/src/constants/common.d.ts.map +1 -0
  10. package/dist/declarations/src/index.d.ts +13 -10
  11. package/dist/declarations/src/index.d.ts.map +1 -1
  12. package/dist/declarations/src/resources/dispute.d.ts +49 -0
  13. package/dist/declarations/src/resources/dispute.d.ts.map +1 -0
  14. package/dist/declarations/src/resources/ipAccount.d.ts +28 -0
  15. package/dist/declarations/src/resources/ipAccount.d.ts.map +1 -0
  16. package/dist/declarations/src/resources/ipAsset.d.ts +44 -20
  17. package/dist/declarations/src/resources/ipAsset.d.ts.map +1 -1
  18. package/dist/declarations/src/resources/license.d.ts +83 -18
  19. package/dist/declarations/src/resources/license.d.ts.map +1 -1
  20. package/dist/declarations/src/resources/permission.d.ts +30 -0
  21. package/dist/declarations/src/resources/permission.d.ts.map +1 -0
  22. package/dist/declarations/src/resources/royalty.d.ts +34 -0
  23. package/dist/declarations/src/resources/royalty.d.ts.map +1 -0
  24. package/dist/declarations/src/types/common.d.ts +6 -0
  25. package/dist/declarations/src/types/common.d.ts.map +1 -0
  26. package/dist/declarations/src/types/config.d.ts +27 -12
  27. package/dist/declarations/src/types/config.d.ts.map +1 -1
  28. package/dist/declarations/src/types/options.d.ts +10 -0
  29. package/dist/declarations/src/types/options.d.ts.map +1 -0
  30. package/dist/declarations/src/types/resources/dispute.d.ts +50 -0
  31. package/dist/declarations/src/types/resources/dispute.d.ts.map +1 -0
  32. package/dist/declarations/src/types/resources/ipAccount.d.ts +25 -0
  33. package/dist/declarations/src/types/resources/ipAccount.d.ts.map +1 -0
  34. package/dist/declarations/src/types/resources/ipAsset.d.ts +23 -63
  35. package/dist/declarations/src/types/resources/ipAsset.d.ts.map +1 -1
  36. package/dist/declarations/src/types/resources/license.d.ts +56 -68
  37. package/dist/declarations/src/types/resources/license.d.ts.map +1 -1
  38. package/dist/declarations/src/types/resources/permission.d.ts +14 -0
  39. package/dist/declarations/src/types/resources/permission.d.ts.map +1 -0
  40. package/dist/declarations/src/types/resources/royalty.d.ts +58 -0
  41. package/dist/declarations/src/types/resources/royalty.d.ts.map +1 -0
  42. package/dist/story-protocol-core-sdk.cjs.d.ts +1 -1
  43. package/dist/story-protocol-core-sdk.cjs.dev.js +10649 -1617
  44. package/dist/story-protocol-core-sdk.cjs.prod.js +10649 -1617
  45. package/dist/story-protocol-core-sdk.esm.js +10645 -1616
  46. package/package.json +16 -13
  47. package/dist/declarations/src/abi/generated/CollectModule.d.ts +0 -80
  48. package/dist/declarations/src/abi/generated/CollectModule.d.ts.map +0 -1
  49. package/dist/declarations/src/abi/generated/FranchiseRegistry.d.ts +0 -78
  50. package/dist/declarations/src/abi/generated/FranchiseRegistry.d.ts.map +0 -1
  51. package/dist/declarations/src/abi/generated/IpAssetRegistry.d.ts +0 -94
  52. package/dist/declarations/src/abi/generated/IpAssetRegistry.d.ts.map +0 -1
  53. package/dist/declarations/src/abi/generated/LicensingModule.d.ts +0 -97
  54. package/dist/declarations/src/abi/generated/LicensingModule.d.ts.map +0 -1
  55. package/dist/declarations/src/abi/generated/RelationshipModule.d.ts +0 -116
  56. package/dist/declarations/src/abi/generated/RelationshipModule.d.ts.map +0 -1
  57. package/dist/declarations/src/abi/generated/common.d.ts +0 -22
  58. package/dist/declarations/src/abi/generated/common.d.ts.map +0 -1
  59. package/dist/declarations/src/abi/generated/factories/CollectModule__factory.d.ts +0 -52
  60. package/dist/declarations/src/abi/generated/factories/CollectModule__factory.d.ts.map +0 -1
  61. package/dist/declarations/src/abi/generated/factories/FranchiseRegistry__factory.d.ts +0 -58
  62. package/dist/declarations/src/abi/generated/factories/FranchiseRegistry__factory.d.ts.map +0 -1
  63. package/dist/declarations/src/abi/generated/factories/IpAssetRegistry__factory.d.ts +0 -112
  64. package/dist/declarations/src/abi/generated/factories/IpAssetRegistry__factory.d.ts.map +0 -1
  65. package/dist/declarations/src/abi/generated/factories/LicensingModule__factory.d.ts +0 -88
  66. package/dist/declarations/src/abi/generated/factories/LicensingModule__factory.d.ts.map +0 -1
  67. package/dist/declarations/src/abi/generated/factories/RelationshipModule__factory.d.ts +0 -175
  68. package/dist/declarations/src/abi/generated/factories/RelationshipModule__factory.d.ts.map +0 -1
  69. package/dist/declarations/src/abi/generated/factories/index.d.ts +0 -6
  70. package/dist/declarations/src/abi/generated/factories/index.d.ts.map +0 -1
  71. package/dist/declarations/src/abi/generated/index.d.ts +0 -12
  72. package/dist/declarations/src/abi/generated/index.d.ts.map +0 -1
  73. package/dist/declarations/src/enums/Environment.d.ts +0 -8
  74. package/dist/declarations/src/enums/Environment.d.ts.map +0 -1
  75. package/dist/declarations/src/enums/IPAssetType.d.ts +0 -12
  76. package/dist/declarations/src/enums/IPAssetType.d.ts.map +0 -1
  77. package/dist/declarations/src/enums/ResourceType.d.ts +0 -11
  78. package/dist/declarations/src/enums/ResourceType.d.ts.map +0 -1
  79. package/dist/declarations/src/resources/collect.d.ts +0 -17
  80. package/dist/declarations/src/resources/collect.d.ts.map +0 -1
  81. package/dist/declarations/src/resources/collectReadOnly.d.ts +0 -15
  82. package/dist/declarations/src/resources/collectReadOnly.d.ts.map +0 -1
  83. package/dist/declarations/src/resources/franchise.d.ts +0 -26
  84. package/dist/declarations/src/resources/franchise.d.ts.map +0 -1
  85. package/dist/declarations/src/resources/franchiseReadOnly.d.ts +0 -27
  86. package/dist/declarations/src/resources/franchiseReadOnly.d.ts.map +0 -1
  87. package/dist/declarations/src/resources/ipAssetReadOnly.d.ts +0 -25
  88. package/dist/declarations/src/resources/ipAssetReadOnly.d.ts.map +0 -1
  89. package/dist/declarations/src/resources/licenseReadOnly.d.ts +0 -27
  90. package/dist/declarations/src/resources/licenseReadOnly.d.ts.map +0 -1
  91. package/dist/declarations/src/resources/relationship.d.ts +0 -47
  92. package/dist/declarations/src/resources/relationship.d.ts.map +0 -1
  93. package/dist/declarations/src/resources/relationshipReadOnly.d.ts +0 -16
  94. package/dist/declarations/src/resources/relationshipReadOnly.d.ts.map +0 -1
  95. package/dist/declarations/src/resources/transaction.d.ts +0 -10
  96. package/dist/declarations/src/resources/transaction.d.ts.map +0 -1
  97. package/dist/declarations/src/resources/transactionReadOnly.d.ts +0 -25
  98. package/dist/declarations/src/resources/transactionReadOnly.d.ts.map +0 -1
  99. package/dist/declarations/src/types/client.d.ts +0 -29
  100. package/dist/declarations/src/types/client.d.ts.map +0 -1
  101. package/dist/declarations/src/types/resources/collect.d.ts +0 -45
  102. package/dist/declarations/src/types/resources/collect.d.ts.map +0 -1
  103. package/dist/declarations/src/types/resources/franchise.d.ts +0 -71
  104. package/dist/declarations/src/types/resources/franchise.d.ts.map +0 -1
  105. package/dist/declarations/src/types/resources/relationship.d.ts +0 -83
  106. package/dist/declarations/src/types/resources/relationship.d.ts.map +0 -1
  107. package/dist/declarations/src/types/resources/transaction.d.ts +0 -40
  108. package/dist/declarations/src/types/resources/transaction.d.ts.map +0 -1
  109. package/dist/story-protocol-core-sdk.cjs.d.ts.map +0 -1
@@ -1 +0,0 @@
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,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAC3B,wCAAqC;AAEtC,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,kCAAyB;AACtE,OAAO,EAAE,uBAAuB,EAAE,+BAA4B;AAE9D;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,uBAAuB;gBAExD,UAAU,EAAE,aAAa,EACzB,iBAAiB,EAAE,iBAAiB,EACpC,aAAa,EAAE,eAAe;IAKhC;;;;;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"}
@@ -1,27 +0,0 @@
1
- import { AxiosInstance } from "axios";
2
- import { GetFranchiseRequest, GetFranchiseResponse, ListFranchiseResponse } from "../types/resources/franchise.js";
3
- import { FranchiseRegistry, LicensingModule } from "../abi/generated/index.js";
4
- /**
5
- * FranchiseReadOnlyClient allows you to view, search franchises on
6
- * Story Protocol.
7
- */
8
- export declare class FranchiseReadOnlyClient {
9
- protected readonly httpClient: AxiosInstance;
10
- protected readonly franchiseRegistry: FranchiseRegistry;
11
- protected readonly licenseModule: LicensingModule;
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
- //# sourceMappingURL=franchiseReadOnly.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"franchiseReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["franchiseReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAEtC,OAAO,EACL,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACtB,wCAAqC;AAGtC,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,kCAAyB;AAEtE;;;GAGG;AACH,qBAAa,uBAAuB;IAClC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IACxD,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,eAAe,CAAC;gBAGhD,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;CAQpD"}
@@ -1,25 +0,0 @@
1
- import { AxiosInstance } from "axios";
2
- import { GetIpAssetRequest, GetIpAssetResponse, ListIpAssetRequest, ListIpAssetResponse } from "../types/resources/ipAsset.js";
3
- import { FranchiseRegistry } from "../abi/generated/index.js";
4
- /**
5
- * IpAssetClient allows you to create, view, and list IP Assets on Story Protocol.
6
- */
7
- export declare class IPAssetReadOnlyClient {
8
- protected readonly httpClient: AxiosInstance;
9
- protected readonly franchiseRegistry: FranchiseRegistry;
10
- constructor(httpClient: AxiosInstance, franchiseRegistry: FranchiseRegistry);
11
- /**
12
- * Get an IP Asset based on the specified IP asset ID.
13
- *
14
- * @param request - the request object for getting an IP Asset.
15
- * @returns the response object the contains the fetched IP Asset.
16
- */
17
- get(request: GetIpAssetRequest): Promise<GetIpAssetResponse>;
18
- /**
19
- * List all IP assets.
20
- *
21
- * @returns the response object that contains results from listing query.
22
- */
23
- list(request: ListIpAssetRequest): Promise<ListIpAssetResponse>;
24
- }
25
- //# sourceMappingURL=ipAssetReadOnly.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"ipAssetReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAssetReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAEtC,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACpB,sCAAmC;AAGpC,OAAO,EAAE,iBAAiB,EAAE,kCAAyB;AAErD;;GAEG;AACH,qBAAa,qBAAqB;IAChC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;gBAE5C,UAAU,EAAE,aAAa,EAAE,iBAAiB,EAAE,iBAAiB;IAK3E;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAezE;;;;OAIG;IACU,IAAI,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAQ7E"}
@@ -1,27 +0,0 @@
1
- import { AxiosInstance } from "axios";
2
- import { GetLicenseRequest, GetLicenseResponse, ListLicenseResponse, ListLicenseRequest } from "../types/resources/license.js";
3
- import { FranchiseRegistry } from "../abi/generated/index.js";
4
- /**
5
- * A class representing License operations.
6
- *
7
- * @public
8
- */
9
- export declare class LicenseReadOnlyClient {
10
- protected readonly httpClient: AxiosInstance;
11
- protected readonly franchiseRegistry: FranchiseRegistry;
12
- constructor(httpClient: AxiosInstance, franchiseRegistry: FranchiseRegistry);
13
- /**
14
- * Get a license by its ID.
15
- *
16
- * @param licenseId - The ID of the license to retrieve.
17
- * @returns A Promise that resolves to the GetLicenseResponse.
18
- */
19
- get(request: GetLicenseRequest): Promise<GetLicenseResponse>;
20
- /**
21
- * List all licenses.
22
- *
23
- * @returns A Promise that resolves to the ListLicenseResponse.
24
- */
25
- list(request: ListLicenseRequest): Promise<ListLicenseResponse>;
26
- }
27
- //# sourceMappingURL=licenseReadOnly.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"licenseReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["licenseReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AAErD,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EACnB,sCAAmC;AACpC,OAAO,EAAE,iBAAiB,EAAE,kCAAyB;AAIrD;;;;GAIG;AACH,qBAAa,qBAAqB;IAChC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;gBAE5C,UAAU,EAAE,aAAa,EAAE,iBAAiB,EAAE,iBAAiB;IAK3E;;;;;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;CAW7E"}
@@ -1,47 +0,0 @@
1
- import { RelationshipModule } from "../abi/generated/RelationshipModule.js";
2
- import { RelationshipIsRelatedRequest, RelationshipIsRelatedResponse, RelationshipIsRelationshipExpiredRequest, RelationshipIsRelationshipExpiredResponse, RelationshipRelateRequest, RelationshipRelateResponse, RelationshipUnrelateRequest, RelationshipUnrelateResponse } from "../types/resources/relationship.js";
3
- import { FranchiseRegistry } from "../abi/generated/index.js";
4
- import { RelationshipReadOnlyClient } from "./relationshipReadOnly.js";
5
- /**
6
- * Client for managing relationships.
7
- */
8
- export declare class RelationshipClient extends RelationshipReadOnlyClient {
9
- /**
10
- * Creates a new RelationshipClient instance.
11
- * @param relationshipModule - The relationship module to interact with.
12
- * @param franchiseRegistry - The franchise registry to interact with.
13
- */
14
- constructor(relationshipModule: RelationshipModule, franchiseRegistry: FranchiseRegistry);
15
- /**
16
- * Retrieves the registry addresses for source and destination franchises.
17
- * @param sourceFranchiseId - The ID of the source franchise.
18
- * @param destFranchiseId - The ID of the destination franchise.
19
- * @returns An object containing the source and destination IP registry addresses.
20
- */
21
- private getRegistryAddresses;
22
- /**
23
- * Establishes a relationship between two IP assets.
24
- * @param request - The request for establishing the relationship.
25
- * @returns A promise that resolves to the response with the transaction hash.
26
- */
27
- relate(request: RelationshipRelateRequest): Promise<RelationshipRelateResponse>;
28
- /**
29
- * Removes a relationship between two IP assets.
30
- * @param request - The request for removing the relationship.
31
- * @returns A promise that resolves to the response with the transaction hash.
32
- */
33
- unrelate(request: RelationshipUnrelateRequest): Promise<RelationshipUnrelateResponse>;
34
- /**
35
- * Checks if a relationship has expired.
36
- * @param request - The request for checking the relationship's expiration status.
37
- * @returns A promise that resolves to the response indicating whether the relationship has expired.
38
- */
39
- isRelationshipExpired(request: RelationshipIsRelationshipExpiredRequest): Promise<RelationshipIsRelationshipExpiredResponse>;
40
- /**
41
- * Checks if two IP assets are related.
42
- * @param request - The request for checking the relationship between two IP assets.
43
- * @returns A promise that resolves to the response indicating whether the IP assets are related.
44
- */
45
- isRelated(request: RelationshipIsRelatedRequest): Promise<RelationshipIsRelatedResponse>;
46
- }
47
- //# sourceMappingURL=relationship.d.ts.map
@@ -1 +0,0 @@
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,2CAAwC;AAEzC,OAAO,EAAE,iBAAiB,EAAE,kCAAyB;AACrD,OAAO,EAAE,0BAA0B,EAAE,kCAA+B;AAEpE;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,0BAA0B;IAChE;;;;OAIG;gBACS,kBAAkB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,iBAAiB;IAIxF;;;;;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"}
@@ -1,16 +0,0 @@
1
- import { RelationshipModule } from "../abi/generated/RelationshipModule.js";
2
- import { FranchiseRegistry } from "../abi/generated/index.js";
3
- /**
4
- * Client for managing relationships.
5
- */
6
- export declare class RelationshipReadOnlyClient {
7
- protected readonly relationshipModule: RelationshipModule;
8
- protected readonly franchiseRegistry: FranchiseRegistry;
9
- /**
10
- * Creates a new RelationshipClient instance.
11
- * @param relationshipModule - The relationship module to interact with.
12
- * @param franchiseRegistry - The franchise registry to interact with.
13
- */
14
- constructor(relationshipModule: RelationshipModule, franchiseRegistry: FranchiseRegistry);
15
- }
16
- //# sourceMappingURL=relationshipReadOnly.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"relationshipReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["relationshipReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,+CAA4C;AACzE,OAAO,EAAE,iBAAiB,EAAE,kCAAyB;AAErD;;GAEG;AACH,qBAAa,0BAA0B;IACrC,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAC1D,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IAExD;;;;OAIG;gBACS,kBAAkB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,iBAAiB;CAIzF"}
@@ -1,10 +0,0 @@
1
- import { AxiosInstance } from "axios";
2
- import { TransactionReadOnlyClient } from "./transactionReadOnly.js";
3
- /**
4
- * TransactionClient allows you to view and monitor transactions on
5
- * Story Protocol.
6
- */
7
- export declare class TransactionClient extends TransactionReadOnlyClient {
8
- constructor(httpClient: AxiosInstance);
9
- }
10
- //# sourceMappingURL=transaction.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"transaction.d.ts","sourceRoot":"../../../../src/resources","sources":["transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAEtC,OAAO,EAAE,yBAAyB,EAAE,iCAA8B;AAElE;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,yBAAyB;gBAClD,UAAU,EAAE,aAAa;CAGtC"}
@@ -1,25 +0,0 @@
1
- import { AxiosInstance } from "axios";
2
- import { GetTransactionRequest, GetTransactionResponse, ListTransactionResponse } from "../types/resources/transaction.js";
3
- /**
4
- * TransactionClient allows you to view and monitor transactions on
5
- * Story Protocol.
6
- */
7
- export declare class TransactionReadOnlyClient {
8
- protected readonly httpClient: AxiosInstance;
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=transactionReadOnly.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"transactionReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["transactionReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AAGrD,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACxB,0CAAuC;AAExC;;;GAGG;AACH,qBAAa,yBAAyB;IACpC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;gBAEjC,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"}
@@ -1,29 +0,0 @@
1
- import { CollectClient } from "../resources/collect.js";
2
- import { CollectReadOnlyClient } from "../resources/collectReadOnly.js";
3
- import { FranchiseClient } from "../resources/franchise.js";
4
- import { FranchiseReadOnlyClient } from "../resources/franchiseReadOnly.js";
5
- import { LicenseClient } from "../resources/license.js";
6
- import { LicenseReadOnlyClient } from "../resources/licenseReadOnly.js";
7
- import { TransactionClient } from "../resources/transaction.js";
8
- import { TransactionReadOnlyClient } from "../resources/transactionReadOnly.js";
9
- import { IPAssetClient } from "../resources/ipAsset.js";
10
- import { IPAssetReadOnlyClient } from "../resources/ipAssetReadOnly.js";
11
- import { RelationshipClient } from "../resources/relationship.js";
12
- import { RelationshipReadOnlyClient } from "../resources/relationshipReadOnly.js";
13
- export interface ReadOnlyClient {
14
- franchise: FranchiseReadOnlyClient;
15
- license: LicenseReadOnlyClient;
16
- collect: CollectReadOnlyClient;
17
- transaction: TransactionReadOnlyClient;
18
- ipAsset: IPAssetReadOnlyClient;
19
- relationship: RelationshipReadOnlyClient;
20
- }
21
- export interface Client {
22
- franchise: FranchiseClient;
23
- license: LicenseClient;
24
- collect: CollectClient;
25
- transaction: TransactionClient;
26
- ipAsset: IPAssetClient;
27
- relationship: RelationshipClient;
28
- }
29
- //# sourceMappingURL=client.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"client.d.ts","sourceRoot":"../../../../src/types","sources":["client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,gCAA6B;AACrD,OAAO,EAAE,qBAAqB,EAAE,wCAAqC;AACrE,OAAO,EAAE,eAAe,EAAE,kCAA+B;AACzD,OAAO,EAAE,uBAAuB,EAAE,0CAAuC;AACzE,OAAO,EAAE,aAAa,EAAE,gCAA6B;AACrD,OAAO,EAAE,qBAAqB,EAAE,wCAAqC;AACrE,OAAO,EAAE,iBAAiB,EAAE,oCAAiC;AAC7D,OAAO,EAAE,yBAAyB,EAAE,4CAAyC;AAC7E,OAAO,EAAE,aAAa,EAAE,gCAA6B;AACrD,OAAO,EAAE,qBAAqB,EAAE,wCAAqC;AACrE,OAAO,EAAE,kBAAkB,EAAE,qCAAkC;AAC/D,OAAO,EAAE,0BAA0B,EAAE,6CAA0C;AAE/E,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,uBAAuB,CAAC;IACnC,OAAO,EAAE,qBAAqB,CAAC;IAC/B,OAAO,EAAE,qBAAqB,CAAC;IAC/B,WAAW,EAAE,yBAAyB,CAAC;IACvC,OAAO,EAAE,qBAAqB,CAAC;IAC/B,YAAY,EAAE,0BAA0B,CAAC;CAC1C;AAED,MAAM,WAAW,MAAM;IACrB,SAAS,EAAE,eAAe,CAAC;IAC3B,OAAO,EAAE,aAAa,CAAC;IACvB,OAAO,EAAE,aAAa,CAAC;IACvB,WAAW,EAAE,iBAAiB,CAAC;IAC/B,OAAO,EAAE,aAAa,CAAC;IACvB,YAAY,EAAE,kBAAkB,CAAC;CAClC"}
@@ -1,45 +0,0 @@
1
- /**
2
- * Core data model for Collect.
3
- *
4
- * @public
5
- */
6
- export type Collection = {
7
- franchiseId: string;
8
- ipAssetId: string;
9
- totalCollected: number;
10
- };
11
- /**
12
- * Request type for collect.collect method.
13
- *
14
- * @public
15
- */
16
- export type CollectIPAssetRequest = {
17
- franchiseId: string;
18
- ipAssetId: string;
19
- collector: string;
20
- };
21
- /**
22
- * Response type for collect.collect method.
23
- *
24
- * @public
25
- */
26
- export type CollectIPAssetResponse = {
27
- txHash: string;
28
- };
29
- /**
30
- * Request type for collect.list method.
31
- *
32
- * @public
33
- */
34
- export type ListCollectionsRequest = {
35
- franchiseId: string;
36
- };
37
- /**
38
- * Response type for collect.list method.
39
- *
40
- * @public
41
- */
42
- export type ListCollectionsResponse = {
43
- data: Collection[];
44
- };
45
- //# sourceMappingURL=collect.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"collect.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["collect.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,UAAU,EAAE,CAAC;CACpB,CAAC"}
@@ -1,71 +0,0 @@
1
- /**
2
- * Core data model for franchise.
3
- *
4
- * @public
5
- */
6
- export type Franchise = {
7
- franchiseId: string;
8
- franchiseName: string;
9
- ownerAddress: string;
10
- tokenUri: string;
11
- txHash: string;
12
- };
13
- /**
14
- * Request type for franchise.get method.
15
- *
16
- * @public
17
- */
18
- export type GetFranchiseRequest = {
19
- franchiseId: string;
20
- };
21
- /**
22
- * Response type for franchise.get method.
23
- *
24
- * @public
25
- */
26
- export type GetFranchiseResponse = {
27
- data: Franchise;
28
- };
29
- /**
30
- * Request type for franchise.create method.
31
- *
32
- * @public
33
- */
34
- export type CreateFranchiseRequest = {
35
- franchiseName: string;
36
- franchiseSymbol: string;
37
- franchiseDescription: string;
38
- };
39
- /**
40
- * Response type for franchise.create method.
41
- *
42
- * @public
43
- */
44
- export type CreateFranchiseResponse = {
45
- txHash: string;
46
- };
47
- /**
48
- * Response type for franchise.list method.
49
- *
50
- * @public
51
- */
52
- export type ListFranchiseResponse = {
53
- data: Franchise[];
54
- };
55
- /**
56
- * Request type for franchise.configure method.
57
- *
58
- * @public
59
- */
60
- export type ConfigureFranchiseRequest = {
61
- franchiseId: string;
62
- };
63
- /**
64
- * Response type for franchise.configure method.
65
- *
66
- * @public
67
- */
68
- export type ConfigureFranchiseResponse = {
69
- txHash: string;
70
- };
71
- //# sourceMappingURL=franchise.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"franchise.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["franchise.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AACF;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,SAAS,CAAC;CACjB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,oBAAoB,EAAE,MAAM,CAAC;CAC9B,CAAC;AACF;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,SAAS,EAAE,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AACF;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
@@ -1,83 +0,0 @@
1
- import { BigNumberish } from "ethers";
2
- /**
3
- * Core type for relationship IPAsset.
4
- *
5
- * @public
6
- */
7
- export type IPAssetId = {
8
- franchiseId: string;
9
- ipAssetId: string;
10
- };
11
- /**
12
- * Request type for relationship.relate method.
13
- *
14
- * @public
15
- */
16
- export type RelationshipRelateRequest = {
17
- sourceIPAsset: IPAssetId;
18
- destIPAsset: IPAssetId;
19
- ttl?: BigNumberish;
20
- };
21
- /**
22
- * Response type for relationship.relate method.
23
- *
24
- * @public
25
- */
26
- export type RelationshipRelateResponse = {
27
- txHash: string;
28
- };
29
- /**
30
- * Request type for relationship.unrelate method.
31
- *
32
- * @public
33
- */
34
- export type RelationshipUnrelateRequest = {
35
- sourceIPAsset: IPAssetId;
36
- destIPAsset: IPAssetId;
37
- ttl?: BigNumberish;
38
- };
39
- /**
40
- * Response type for relationship.unrelate method.
41
- *
42
- * @public
43
- */
44
- export type RelationshipUnrelateResponse = {
45
- txHash: string;
46
- };
47
- /**
48
- * Request type for relationship.isRelationshipExpired method.
49
- *
50
- * @public
51
- */
52
- export type RelationshipIsRelationshipExpiredRequest = {
53
- sourceIPAsset: IPAssetId;
54
- destIPAsset: IPAssetId;
55
- ttl?: BigNumberish;
56
- };
57
- /**
58
- * Response type for relationship.isRelationshipExpired method.
59
- *
60
- * @public
61
- */
62
- export type RelationshipIsRelationshipExpiredResponse = {
63
- result: boolean;
64
- };
65
- /**
66
- * Request type for relationship.isRelated method.
67
- *
68
- * @public
69
- */
70
- export type RelationshipIsRelatedRequest = {
71
- sourceIPAsset: IPAssetId;
72
- destIPAsset: IPAssetId;
73
- ttl?: BigNumberish;
74
- };
75
- /**
76
- * Response type for relationship.isRelated method.
77
- *
78
- * @public
79
- */
80
- export type RelationshipIsRelatedResponse = {
81
- result: boolean;
82
- };
83
- //# sourceMappingURL=relationship.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"relationship.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["relationship.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AACF;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,aAAa,EAAE,SAAS,CAAC;IACzB,WAAW,EAAE,SAAS,CAAC;IACvB,GAAG,CAAC,EAAE,YAAY,CAAC;CACpB,CAAC;AACF;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,aAAa,EAAE,SAAS,CAAC;IACzB,WAAW,EAAE,SAAS,CAAC;IACvB,GAAG,CAAC,EAAE,YAAY,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AACF;;;;GAIG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,aAAa,EAAE,SAAS,CAAC;IACzB,WAAW,EAAE,SAAS,CAAC;IACvB,GAAG,CAAC,EAAE,YAAY,CAAC;CACpB,CAAC;AACF;;;;GAIG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AACF;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,aAAa,EAAE,SAAS,CAAC;IACzB,WAAW,EAAE,SAAS,CAAC;IACvB,GAAG,CAAC,EAAE,YAAY,CAAC;CACpB,CAAC;AACF;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC"}
@@ -1,40 +0,0 @@
1
- import { ResourceType } from "../../enums/ResourceType.js";
2
- /**
3
- * Core data model for transactions.
4
- *
5
- * @public
6
- */
7
- export type Transaction = {
8
- txId: string;
9
- txHash: string;
10
- createdAt: string;
11
- creatorAddress: string;
12
- type: ResourceType;
13
- resourceId: string;
14
- franchiseId: string;
15
- };
16
- /**
17
- * Request type for transaction.get method.
18
- *
19
- * @public
20
- */
21
- export type GetTransactionRequest = {
22
- txId: string;
23
- };
24
- /**
25
- * Response type for transaction.get method.
26
- *
27
- * @public
28
- */
29
- export type GetTransactionResponse = {
30
- data: Transaction;
31
- };
32
- /**
33
- * Response type for transaction.list method.
34
- *
35
- * @public
36
- */
37
- export type ListTransactionResponse = {
38
- data: Transaction[];
39
- };
40
- //# sourceMappingURL=transaction.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"transaction.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,oCAAiC;AAExD;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,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,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,WAAW,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,WAAW,EAAE,CAAC;CACrB,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"story-protocol-core-sdk.cjs.d.ts","sourceRoot":"","sources":["./declarations/src/index.d.ts"],"names":[],"mappings":"AAAA"}