@story-protocol/core-sdk 0.1.0-rc.4 → 0.1.0-rc.7
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +85 -0
- package/dist/declarations/src/abi/generated/CollectModule.d.ts +12 -2
- package/dist/declarations/src/abi/generated/CollectModule.d.ts.map +1 -1
- package/dist/declarations/src/abi/generated/FranchiseRegistry.d.ts +6 -1
- package/dist/declarations/src/abi/generated/FranchiseRegistry.d.ts.map +1 -1
- package/dist/declarations/src/abi/generated/IpAssetRegistry.d.ts.map +1 -1
- package/dist/declarations/src/abi/generated/common.d.ts.map +1 -1
- package/dist/declarations/src/abi/generated/factories/CollectModule__factory.d.ts.map +1 -1
- package/dist/declarations/src/abi/generated/factories/FranchiseRegistry__factory.d.ts.map +1 -1
- package/dist/declarations/src/abi/generated/factories/IpAssetRegistry__factory.d.ts.map +1 -1
- package/dist/declarations/src/abi/generated/factories/index.d.ts +1 -1
- package/dist/declarations/src/abi/generated/factories/index.d.ts.map +1 -1
- package/dist/declarations/src/client.d.ts +40 -13
- package/dist/declarations/src/client.d.ts.map +1 -1
- package/dist/declarations/src/index.d.ts +1 -1
- package/dist/declarations/src/index.d.ts.map +1 -1
- package/dist/declarations/src/resources/collect.d.ts +3 -10
- package/dist/declarations/src/resources/collect.d.ts.map +1 -1
- package/dist/declarations/src/resources/collectReadOnly.d.ts +15 -0
- package/dist/declarations/src/resources/collectReadOnly.d.ts.map +1 -0
- package/dist/declarations/src/resources/franchise.d.ts +3 -18
- package/dist/declarations/src/resources/franchise.d.ts.map +1 -1
- package/dist/declarations/src/resources/franchiseReadOnly.d.ts +27 -0
- package/dist/declarations/src/resources/franchiseReadOnly.d.ts.map +1 -0
- package/dist/declarations/src/resources/ipAsset.d.ts +3 -17
- package/dist/declarations/src/resources/ipAsset.d.ts.map +1 -1
- package/dist/declarations/src/resources/ipAssetReadOnly.d.ts +25 -0
- package/dist/declarations/src/resources/ipAssetReadOnly.d.ts.map +1 -0
- package/dist/declarations/src/resources/license.d.ts +3 -17
- package/dist/declarations/src/resources/license.d.ts.map +1 -1
- package/dist/declarations/src/resources/licenseReadOnly.d.ts +27 -0
- package/dist/declarations/src/resources/licenseReadOnly.d.ts.map +1 -0
- package/dist/declarations/src/resources/relationship.d.ts +2 -3
- package/dist/declarations/src/resources/relationship.d.ts.map +1 -1
- package/dist/declarations/src/resources/relationshipReadOnly.d.ts +16 -0
- package/dist/declarations/src/resources/relationshipReadOnly.d.ts.map +1 -0
- package/dist/declarations/src/resources/transaction.d.ts +2 -17
- package/dist/declarations/src/resources/transaction.d.ts.map +1 -1
- package/dist/declarations/src/resources/transactionReadOnly.d.ts +25 -0
- package/dist/declarations/src/resources/transactionReadOnly.d.ts.map +1 -0
- package/dist/declarations/src/types/client.d.ts +29 -0
- package/dist/declarations/src/types/client.d.ts.map +1 -0
- package/dist/declarations/src/types/config.d.ts +8 -2
- package/dist/declarations/src/types/config.d.ts.map +1 -1
- package/dist/story-protocol-core-sdk.cjs.dev.js +1020 -769
- package/dist/story-protocol-core-sdk.cjs.prod.js +1020 -769
- package/dist/story-protocol-core-sdk.esm.js +1021 -770
- package/package.json +1 -1
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"license.d.ts","sourceRoot":"../../../../src/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,
|
1
|
+
{"version":3,"file":"license.d.ts","sourceRoot":"../../../../src/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,MAAM,EAAkC,MAAM,QAAQ,CAAC;AAEhE,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,sCAAmC;AACzF,OAAO,EAAE,iBAAiB,EAA4B,kCAAyB;AAE/E,OAAO,EAAE,qBAAqB,EAAE,6BAA0B;AAE1D;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,qBAAqB;IACtD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;gBAEpB,UAAU,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,iBAAiB;IAK3F;;;;;OAKG;IACU,MAAM,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAyDnF"}
|
@@ -0,0 +1,27 @@
|
|
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
|
@@ -0,0 +1 @@
|
|
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,12 +1,11 @@
|
|
1
1
|
import { RelationshipModule } from "../abi/generated/RelationshipModule.js";
|
2
2
|
import { RelationshipIsRelatedRequest, RelationshipIsRelatedResponse, RelationshipIsRelationshipExpiredRequest, RelationshipIsRelationshipExpiredResponse, RelationshipRelateRequest, RelationshipRelateResponse, RelationshipUnrelateRequest, RelationshipUnrelateResponse } from "../types/resources/relationship.js";
|
3
3
|
import { FranchiseRegistry } from "../abi/generated/index.js";
|
4
|
+
import { RelationshipReadOnlyClient } from "./relationshipReadOnly.js";
|
4
5
|
/**
|
5
6
|
* Client for managing relationships.
|
6
7
|
*/
|
7
|
-
export declare class RelationshipClient {
|
8
|
-
private readonly relationshipModule;
|
9
|
-
private readonly franchiseRegistry;
|
8
|
+
export declare class RelationshipClient extends RelationshipReadOnlyClient {
|
10
9
|
/**
|
11
10
|
* Creates a new RelationshipClient instance.
|
12
11
|
* @param relationshipModule - The relationship module to interact with.
|
@@ -1 +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,2CAAwC;AAEzC,OAAO,EAAE,iBAAiB,EAAE,kCAAyB;
|
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"}
|
@@ -0,0 +1,16 @@
|
|
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
|
@@ -0,0 +1 @@
|
|
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,25 +1,10 @@
|
|
1
1
|
import { AxiosInstance } from "axios";
|
2
|
-
import {
|
2
|
+
import { TransactionReadOnlyClient } from "./transactionReadOnly.js";
|
3
3
|
/**
|
4
4
|
* TransactionClient allows you to view and monitor transactions on
|
5
5
|
* Story Protocol.
|
6
6
|
*/
|
7
|
-
export declare class TransactionClient {
|
8
|
-
private readonly httpClient;
|
7
|
+
export declare class TransactionClient extends TransactionReadOnlyClient {
|
9
8
|
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
9
|
}
|
25
10
|
//# sourceMappingURL=transaction.d.ts.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"transaction.d.ts","sourceRoot":"../../../../src/resources","sources":["transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,
|
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"}
|
@@ -0,0 +1,25 @@
|
|
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
|
@@ -0,0 +1 @@
|
|
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"}
|
@@ -0,0 +1,29 @@
|
|
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
|
@@ -0,0 +1 @@
|
|
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,3 +1,4 @@
|
|
1
|
+
import { Provider } from "@ethersproject/providers";
|
1
2
|
import { Signer } from "ethers";
|
2
3
|
import { Environment } from "../enums/Environment.js";
|
3
4
|
/**
|
@@ -5,8 +6,13 @@ import { Environment } from "../enums/Environment.js";
|
|
5
6
|
*
|
6
7
|
* @public
|
7
8
|
*/
|
8
|
-
export
|
9
|
+
export interface StoryCommonConfig {
|
9
10
|
readonly environment: Environment;
|
11
|
+
}
|
12
|
+
export interface StoryConfig extends StoryCommonConfig {
|
10
13
|
readonly signer: Signer;
|
11
|
-
}
|
14
|
+
}
|
15
|
+
export interface StoryReadOnlyConfig extends StoryCommonConfig {
|
16
|
+
readonly provider?: Provider;
|
17
|
+
}
|
12
18
|
//# sourceMappingURL=config.d.ts.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"config.d.ts","sourceRoot":"../../../../src/types","sources":["config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,WAAW,EAAE,gCAA6B;AAEnD;;;;GAIG;AACH,MAAM,
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"../../../../src/types","sources":["config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,WAAW,EAAE,gCAA6B;AAEnD;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;CACnC;AAED,MAAM,WAAW,WAAY,SAAQ,iBAAiB;IACpD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;IAC5D,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;CAC9B"}
|