@story-protocol/core-sdk 0.0.1-beta-rc.1

package/README.md

@@ -0,0 +1,85 @@
+core-sdk is the base level sdk to interact with story protocol. It provides functions to both read and write data to the protocol.
+
+## Installation
+
+Install the SDK and ethers.js
+
+npm
+
+```shell
+npm i @story-protocol/core-sdk ethers@^5.7.2
+```
+
+pnpm
+
+```shell
+pnpm i @story-protocol/core-sdk ethers@^5.7.2
+```
+
+yarn
+
+```shell
+yarn add @story-protocol/core-sdk ethers@^5.7.2
+```
+
+## Set up `.env` file
+
+(Ask the team to provide the values)
+
+```
+NEXT_PUBLIC_API_BASE_URL =
+NEXT_PUBLIC_FRANCHISE_REGISTRY_CONTRACT =
+NEXT_PUBLIC_RELATIONSHIP_MODULE_CONTRACT =
+NEXT_PUBLIC_COLLECT_MODULE_CONTRACT =
+NEXT_PUBLIC_LICENSING_MODULE_CONTRACT =
+```
+
+## Set up SDK client
+
+Using browser wallet
+
+```typescript
+import { StoryClient } from "@story-protocol/core-sdk";
+import ethers from "ethers";
+
+// Provider/Signer from browser wallet (i.e Metamask)
+const provider = new ethers.providers.Web3Provider(window.ethereum);
+await provider.send("eth_requestAccounts", []);
+const signer = await provider.getSigner();
+
+// Instantiate a read-only Story Client with an optional provider
+const client = StoryClient.newReadOnlyClient({ provider });
+
+// Instatiate a read/write Story Client with a signer
+const client = StoryClient.newClient({ signer });
+```
+
+Using private key
+
+```typescript
+import { StoryClient } from "@story-protocol/core-sdk"
+import ethers from "ethers"
+
+// Signer from private key
+const provider = new ethers.providers.JsonRpcProvider(<YOUR RPC URL>)
+const signer = new ethers.Wallet(<YOUR PRIVATE KEY>, provider)
+
+// Instantiate the Story Client
+const client = StoryClient.newClient({ signer })
+
+```
+
+## Use SDK client
+
+```typescript
+// Create a new franchise
+const response = await client.franchise.create({
+  franchiseName: "Alice in Wonderland",
+  franchiseSymbol: "Wonderland",
+  franchiseDescription:
+    "Fantastical journey, curious girl, whimsical characters, dreamlike adventures.",
+});
+
+// List franchises
+const { data: franchise } = await client.franchise.list();
+```

package/dist/declarations/src/client.d.ts

@@ -0,0 +1,76 @@
+import { StoryConfig, StoryReadOnlyConfig } from "./types/config.js";
+import { TransactionClient } from "./resources/transaction.js";
+import { TransactionReadOnlyClient } from "./resources/transactionReadOnly.js";
+import { Client, ReadOnlyClient } from "./types/client.js";
+import { PlatformClient } from "./utils/platform.js";
+import { ModuleReadOnlyClient } from "./resources/moduleReadOnly.js";
+import { TaggingClient } from "./resources/tagging.js";
+import { TaggingReadOnlyClient } from "./resources/taggingReadOnly.js";
+import { IPAssetClient } from "./resources/ipAsset.js";
+import { IPAssetReadOnlyClient } from "./resources/ipAssetReadOnly.js";
+import { PermissionClient } from "./resources/permission.js";
+import { PermissionReadOnlyClient } from "./resources/permissionReadOnly.js";
+/**
+ * The StoryClient is the main entry point for the SDK.
+ */
+export declare class StoryClient {
+    private readonly config;
+    private readonly httpClient;
+    private readonly isReadOnly;
+    private readonly rpcClient;
+    private readonly wallet?;
+    private _ipAccount;
+    private _permission;
+    private _transaction;
+    private _platform;
+    private _module;
+    private _tagging;
+    /**
+     * @param config - the configuration for the SDK client
+     * @param isReadOnly
+     */
+    private constructor();
+    /**
+     * Factory method for creating a read only SDK client.
+     *
+     * @param config - the configuration for a read only SDK client
+     */
+    static newReadOnlyClient(config: StoryReadOnlyConfig): ReadOnlyClient;
+    /**
+     * Factory method for creating a SDK client with a signer.
+     *
+     * @param config - the configuration for a new read/write SDK client
+     */
+    static newClient(config: StoryConfig): Client;
+    get ipAsset(): IPAssetClient | IPAssetReadOnlyClient;
+    get permission(): PermissionClient | PermissionReadOnlyClient;
+    /**
+     * Getter for the transaction client. The client is lazily created when
+     * this method is called.
+     *
+     * @returns the TransactionReadOnlyClient or TransactionClient instance
+     */
+    get transaction(): TransactionClient | TransactionReadOnlyClient;
+    /**
+     * Getter for the tagging client. The client is lazily created when
+     * this method is called.
+     *
+     * @returns the TaggingReadOnlyClient or TaggingClient instance
+     */
+    get tagging(): TaggingClient | TaggingReadOnlyClient;
+    /**
+     * Getter for the platform client. The client is lazily created when
+     * this method is called.
+     *
+     * @returns the PlatformClient instance
+     */
+    get platform(): PlatformClient;
+    /**
+     * Getter for the module client. The client is lazily created when
+     * this method is called.
+     *
+     * @returns the Module instance
+     */
+    get module(): ModuleReadOnlyClient;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/declarations/src/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"../../../src","sources":["client.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,0BAAuB;AAClE,OAAO,EAAE,iBAAiB,EAAE,mCAAgC;AAC5D,OAAO,EAAE,yBAAyB,EAAE,2CAAwC;AAE5E,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,0BAAuB;AACxD,OAAO,EAAE,cAAc,EAAE,4BAAyB;AAClD,OAAO,EAAE,oBAAoB,EAAE,sCAAmC;AAClE,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,qBAAqB,EAAE,uCAAoC;AACpE,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,qBAAqB,EAAE,uCAAoC;AACpE,OAAO,EAAE,gBAAgB,EAAE,kCAA+B;AAC1D,OAAO,EAAE,wBAAwB,EAAE,0CAAuC;AAK1E;;GAEG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAoC;IAC3D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;IAC3C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAkB;IAC7C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAe;IAEvC,OAAO,CAAC,UAAU,CAAsD;IACxE,OAAO,CAAC,WAAW,CAA4D;IAC/E,OAAO,CAAC,YAAY,CAA8D;IAClF,OAAO,CAAC,SAAS,CAA+B;IAChD,OAAO,CAAC,OAAO,CAAqC;IACpD,OAAO,CAAC,QAAQ,CAAsD;IAEtE;;;OAGG;IACH,OAAO;IAgCP;;;;OAIG;IACH,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,mBAAmB,GAAG,cAAc;IAIrE;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM;IAI7C,IAAW,OAAO,IAAI,aAAa,GAAG,qBAAqB,CAQ1D;IAED,IAAW,UAAU,IAAI,gBAAgB,GAAG,wBAAwB,CAQnE;IAED;;;;;OAKG;IACH,IAAW,WAAW,IAAI,iBAAiB,GAAG,yBAAyB,CAQtE;IAED;;;;;OAKG;IACH,IAAW,OAAO,IAAI,aAAa,GAAG,qBAAqB,CAQ1D;IAED;;;;;OAKG;IACH,IAAW,QAAQ,IAAI,cAAc,CAMpC;IAED;;;;;OAKG;IACH,IAAW,MAAM,IAAI,oBAAoB,CAMxC;CACF"}

package/dist/declarations/src/constants/common.d.ts

@@ -0,0 +1,3 @@
+export declare const AddressZero = "0x0000000000000000000000000000000000000000";
+export declare const HashZero = "0x0000000000000000000000000000000000000000000000000000000000000000";
+//# sourceMappingURL=common.d.ts.map

package/dist/declarations/src/constants/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"../../../../src/constants","sources":["common.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,+CAA+C,CAAC;AAExE,eAAO,MAAM,QAAQ,uEAAuE,CAAC"}

package/dist/declarations/src/enums/ActionType.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @public
+ */
+export declare enum ActionType {
+    Unspecified = "Unspecified",
+    Register = "Register",
+    Unregister = "Unregister",
+    Configure = "Configure",
+    Create = "Create"
+}
+//# sourceMappingURL=ActionType.d.ts.map

package/dist/declarations/src/enums/ActionType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActionType.d.ts","sourceRoot":"../../../../src/enums","sources":["ActionType.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,UAAU;IACpB,WAAW,gBAAgB;IAC3B,QAAQ,aAAa;IACrB,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,MAAM,WAAW;CAClB"}

package/dist/declarations/src/enums/ResourceType.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @public
+ */
+export declare enum ResourceType {
+    Unspecified = "Unspecified",
+    IPOrg = "IPOrg",
+    IPAsset = "IPAsset",
+    License = "License",
+    Relationship = "Relationship",
+    RelationshipType = "RelationshipType",
+    Module = "Module",
+    Hook = "Hook",
+    Dispute = "Dispute"
+}
+//# sourceMappingURL=ResourceType.d.ts.map

package/dist/declarations/src/enums/ResourceType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResourceType.d.ts","sourceRoot":"../../../../src/enums","sources":["ResourceType.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,YAAY;IACtB,WAAW,gBAAgB;IAC3B,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,YAAY,iBAAiB;IAC7B,gBAAgB,qBAAqB;IACrC,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,OAAO,YAAY;CACpB"}

package/dist/declarations/src/index.d.ts

@@ -0,0 +1,19 @@
+export { StoryClient } from "./client.js";
+export { ResourceType } from "./enums/ResourceType.js";
+export { ActionType } from "./enums/ActionType.js";
+export { TransactionClient } from "./resources/transaction.js";
+export { PlatformClient } from "./utils/platform.js";
+export { AddressZero, HashZero } from "./constants/common.js";
+export { TaggingReadOnlyClient } from "./resources/taggingReadOnly.js";
+export { ModuleReadOnlyClient } from "./resources/moduleReadOnly.js";
+export { IPAssetClient } from "./resources/ipAsset.js";
+export { IPAssetReadOnlyClient } from "./resources/ipAssetReadOnly.js";
+export { PermissionClient } from "./resources/permission.js";
+export { PermissionReadOnlyClient } from "./resources/permissionReadOnly.js";
+export type { StoryConfig, StoryReadOnlyConfig } from "./types/config.js";
+export type { Client, ReadOnlyClient } from "./types/client.js";
+export type { Hex, TypedData } from "./types/common.js";
+export type { Transaction, GetTransactionRequest, GetTransactionResponse, ListTransactionRequest, ListTransactionResponse, } from "./types/resources/transaction.js";
+export type { Tag, ListTagRequest, ListTagResponse } from "./types/resources/tagging.js";
+export type { Module, GetModuleRequest, GetModuleResponse, ListModuleRequest, ListModuleResponse, } from "./types/resources/module.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/declarations/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"../../../src","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,oBAAiB;AACvC,OAAO,EAAE,YAAY,EAAE,gCAA6B;AACpD,OAAO,EAAE,UAAU,EAAE,8BAA2B;AAChD,OAAO,EAAE,iBAAiB,EAAE,mCAAgC;AAC5D,OAAO,EAAE,cAAc,EAAE,4BAAyB;AAClD,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,8BAA2B;AAE3D,OAAO,EAAE,qBAAqB,EAAE,uCAAoC;AACpE,OAAO,EAAE,oBAAoB,EAAE,sCAAmC;AAClE,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,qBAAqB,EAAE,uCAAoC;AACpE,OAAO,EAAE,gBAAgB,EAAE,kCAA+B;AAC1D,OAAO,EAAE,wBAAwB,EAAE,0CAAuC;AAE1E,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,0BAAuB;AACvE,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,0BAAuB;AAC7D,YAAY,EAAE,GAAG,EAAE,SAAS,EAAE,0BAAuB;AAErD,YAAY,EACV,WAAW,EACX,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,GACxB,yCAAsC;AAEvC,YAAY,EAAE,GAAG,EAAE,cAAc,EAAE,eAAe,EAAE,qCAAkC;AACtF,YAAY,EACV,MAAM,EACN,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,GACnB,oCAAiC"}

package/dist/declarations/src/resources/ipAsset.d.ts

@@ -0,0 +1,23 @@
+import { AxiosInstance } from "axios";
+import { PublicClient, WalletClient } from "viem";
+import { IPAssetReadOnlyClient } from "./ipAssetReadOnly.js";
+import { RegisterDerivativeIpRequest, RegisterDerivativeIpResponse, RegisterRootIpRequest, RegisterRootIpResponse } from "../types/resources/ipAsset.js";
+export declare class IPAssetClient extends IPAssetReadOnlyClient {
+    private readonly wallet;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient, wallet: WalletClient);
+    /**
+     * Register a root IP on Story Protocol based on the specified input asset data.
+     *
+     * @param request - the request object that contains all data needed to register a root IP.
+     * @returns the response object that contains results from the IP creation.
+     */
+    registerRootIp(request: RegisterRootIpRequest): Promise<RegisterRootIpResponse>;
+    /**
+     * Register a derivative IP on Story Protocol based on the specified input asset data.
+     *
+     * @param request - the request object that contains all data needed to register a derivative IP.
+     * @returns the response object that contains results from the IP creation.
+     */
+    registerDerivativeIp(request: RegisterDerivativeIpRequest): Promise<RegisterDerivativeIpResponse>;
+}
+//# sourceMappingURL=ipAsset.d.ts.map

package/dist/declarations/src/resources/ipAsset.d.ts.map

@@ -0,0 +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,YAAY,EAAE,YAAY,EAAc,MAAM,MAAM,CAAC;AAE9D,OAAO,EAAE,qBAAqB,EAAE,6BAA0B;AAG1D,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,qBAAqB,EACrB,sBAAsB,EACvB,sCAAmC;AAIpC,qBAAa,aAAc,SAAQ,qBAAqB;IACtD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;IAKpF;;;;;OAKG;IACU,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IA4B5F;;;;;OAKG;IACU,oBAAoB,CAC/B,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,4BAA4B,CAAC;CAmEzC"}

package/dist/declarations/src/resources/ipAssetReadOnly.d.ts

@@ -0,0 +1,26 @@
+import { AxiosInstance } from "axios";
+import { PublicClient } from "viem";
+import { GetIpAssetRequest, GetIpAssetResponse, ListIpAssetRequest, ListIpAssetResponse } from "../types/resources/ipAsset.js";
+/**
+ * IPAssetReadOnlyClient allows you to view and search IP Assets on Story Protocol.
+ */
+export declare class IPAssetReadOnlyClient {
+    protected readonly httpClient: AxiosInstance;
+    protected readonly rpcClient: PublicClient;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient);
+    /**
+     * Get an IP Asset based on the specified IP asset ID.
+     *
+     * @param request - the request object for getting an IP Asset.
+     * @returns the response object the contains the fetched IP Asset.
+     */
+    get(request: GetIpAssetRequest): Promise<GetIpAssetResponse>;
+    /**
+     * List IP accounts.
+     *
+     * @returns the response object that contains results from listing query.
+     */
+    list(request?: ListIpAssetRequest): Promise<ListIpAssetResponse>;
+    getIpId(): Promise<void>;
+}
+//# sourceMappingURL=ipAssetReadOnly.d.ts.map

package/dist/declarations/src/resources/ipAssetReadOnly.d.ts.map

@@ -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;AACtC,OAAO,EAAE,YAAY,EAAa,MAAM,MAAM,CAAC;AAE/C,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACpB,sCAAmC;AAGpC;;GAEG;AACH,qBAAa,qBAAqB;IAChC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;gBAE/B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY;IAK9D;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAYzE;;;;OAIG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAShE,OAAO;CACrB"}

package/dist/declarations/src/resources/moduleReadOnly.d.ts

@@ -0,0 +1,25 @@
+import { AxiosInstance } from "axios";
+import { PublicClient } from "viem";
+import { GetModuleRequest, GetModuleResponse, ListModuleRequest, ListModuleResponse } from "../types/resources/module.js";
+/**
+ * ModuleReadOnlyClient allows you to view and search modules on Story Protocol.
+ */
+export declare class ModuleReadOnlyClient {
+    protected readonly httpClient: AxiosInstance;
+    protected readonly rpcClient: PublicClient;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient);
+    /**
+     * Get an module based on the module name.
+     *
+     * @param request - the request object for getting a module.
+     * @returns the response object the contains the fetched module.
+     */
+    get(request: GetModuleRequest): Promise<GetModuleResponse>;
+    /**
+     * List modules.
+     *
+     * @returns the response object that contains results from listing query.
+     */
+    list(request?: ListModuleRequest): Promise<ListModuleResponse>;
+}
+//# sourceMappingURL=moduleReadOnly.d.ts.map

package/dist/declarations/src/resources/moduleReadOnly.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"moduleReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["moduleReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAGpC,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EACnB,qCAAkC;AAEnC;;GAEG;AACH,qBAAa,oBAAoB;IAC/B,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;gBAE/B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY;IAK9D;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IASvE;;;;OAIG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAQ5E"}

package/dist/declarations/src/resources/permission.d.ts

@@ -0,0 +1,16 @@
+import { AxiosInstance } from "axios";
+import { PublicClient, WalletClient } from "viem";
+import { setPermissionsRequest, setPermissionsResponse } from "../types/resources/permission.js";
+import { PermissionReadOnlyClient } from "./permissionReadOnly.js";
+export declare class PermissionClient extends PermissionReadOnlyClient {
+    private readonly wallet;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient, wallet: WalletClient);
+    /**
+     * Set Permission based on the specified input
+     *
+     * @param request - the request object that contains all data needed to set permission.
+     * @returns the response object that contains results from the set permission.
+     */
+    setPermission(request: setPermissionsRequest): Promise<setPermissionsResponse>;
+}
+//# sourceMappingURL=permission.d.ts.map

package/dist/declarations/src/resources/permission.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"permission.d.ts","sourceRoot":"../../../../src/resources","sources":["permission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAuC,MAAM,MAAM,CAAC;AAGvF,OAAO,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,yCAAsC;AAC9F,OAAO,EAAE,wBAAwB,EAAE,gCAA6B;AAMhE,qBAAa,gBAAiB,SAAQ,wBAAwB;IAC5D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;IAKpF;;;;;OAKG;IACU,aAAa,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;CA6C5F"}

package/dist/declarations/src/resources/permissionReadOnly.d.ts

@@ -0,0 +1,25 @@
+import { AxiosInstance } from "axios";
+import { PublicClient } from "viem";
+import { GetPermissionRequest, GetPermissionResponse, ListPermissionsRequest, ListPermissionsResponse } from "../types/resources/permission.js";
+/**
+ * IPAssetReadOnlyClient allows you to view and search IP Assets on Story Protocol.
+ */
+export declare class PermissionReadOnlyClient {
+    protected readonly httpClient: AxiosInstance;
+    protected readonly rpcClient: PublicClient;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient);
+    /**
+     * Get permission based on based on the specified IP id.
+     *
+     * @param request - the request object for getting an IP Asset.
+     * @returns the response object the contains the fetched IP Asset.
+     */
+    get(request: GetPermissionRequest): Promise<GetPermissionResponse>;
+    /**
+     * List IP accounts.
+     *
+     * @returns the response object that contains results from listing query.
+     */
+    list(request?: ListPermissionsRequest): Promise<ListPermissionsResponse>;
+}
+//# sourceMappingURL=permissionReadOnly.d.ts.map

package/dist/declarations/src/resources/permissionReadOnly.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissionReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["permissionReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EACL,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACxB,yCAAsC;AAIvC;;GAEG;AACH,qBAAa,wBAAwB;IACnC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;gBAE/B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY;IAK9D;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAc/E;;;;OAIG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAQtF"}

package/dist/declarations/src/resources/tagging.d.ts

@@ -0,0 +1,11 @@
+import { AxiosInstance } from "axios";
+import { PublicClient, WalletClient } from "viem";
+import { TaggingReadOnlyClient } from "./taggingReadOnly.js";
+import { RemoveTagRequest, RemoveTagResponse, SetTagRequest, SetTagResponse } from "../types/resources/tagging.js";
+export declare class TaggingClient extends TaggingReadOnlyClient {
+    private readonly wallet;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient, wallet: WalletClient);
+    setTag(request: SetTagRequest): Promise<SetTagResponse>;
+    removeTag(request: RemoveTagRequest): Promise<RemoveTagResponse>;
+}
+//# sourceMappingURL=tagging.d.ts.map

package/dist/declarations/src/resources/tagging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tagging.d.ts","sourceRoot":"../../../../src/resources","sources":["tagging.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAIlD,OAAO,EAAE,qBAAqB,EAAE,6BAA0B;AAC1D,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EACb,cAAc,EACf,sCAAmC;AAEpC,qBAAa,aAAc,SAAQ,qBAAqB;IACtD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;IAKvE,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAgBvD,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAe9E"}

package/dist/declarations/src/resources/taggingReadOnly.d.ts

@@ -0,0 +1,24 @@
+import { AxiosInstance } from "axios";
+import { PublicClient } from "viem";
+import { GetTagRequest, GetTagResponse, ListTagRequest, ListTagResponse } from "../types/resources/tagging.js";
+/**
+ * TaggingReadOnlyClient allows you to view and search IP Assets on Story Protocol.
+ */
+export declare class TaggingReadOnlyClient {
+    protected readonly httpClient: AxiosInstance;
+    protected readonly rpcClient: PublicClient;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient);
+    /**
+     * Get tags.
+     *
+     * @returns the response object that contains results from get tag query.
+     */
+    get(request: GetTagRequest): Promise<GetTagResponse>;
+    /**
+     * List tags.
+     *
+     * @returns the response object that contains results from list tags query.
+     */
+    list(request?: ListTagRequest): Promise<ListTagResponse>;
+}
+//# sourceMappingURL=taggingReadOnly.d.ts.map

package/dist/declarations/src/resources/taggingReadOnly.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"taggingReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["taggingReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAGpC,OAAO,EACL,aAAa,EACb,cAAc,EACd,cAAc,EACd,eAAe,EAChB,sCAAmC;AAEpC;;GAEG;AACH,qBAAa,qBAAqB;IAChC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;gBAE/B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY;IAK9D;;;;OAIG;IACU,GAAG,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAQjE;;;;OAIG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;CAQtE"}

package/dist/declarations/src/resources/transaction.d.ts

@@ -0,0 +1,11 @@
+import { AxiosInstance } from "axios";
+import { PublicClient, WalletClient } from "viem";
+import { TransactionReadOnlyClient } from "./transactionReadOnly.js";
+/**
+ * TransactionClient allows you to view and monitor transactions on Story Protocol.
+ */
+export declare class TransactionClient extends TransactionReadOnlyClient {
+    private readonly wallet;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient, wallet: WalletClient);
+}
+//# sourceMappingURL=transaction.d.ts.map

package/dist/declarations/src/resources/transaction.d.ts.map

@@ -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;AACtC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAElD,OAAO,EAAE,yBAAyB,EAAE,iCAA8B;AAElE;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,yBAAyB;IAC9D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;CAIrF"}

package/dist/declarations/src/resources/transactionReadOnly.d.ts

@@ -0,0 +1,25 @@
+import { AxiosInstance } from "axios";
+import { PublicClient } from "viem";
+import { GetTransactionRequest, GetTransactionResponse, ListTransactionRequest, ListTransactionResponse } from "../types/resources/transaction.js";
+/**
+ * TransactionClient allows you to view and monitor transactions on Story Protocol.
+ */
+export declare class TransactionReadOnlyClient {
+    protected readonly httpClient: AxiosInstance;
+    protected readonly rpcClient: PublicClient;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient);
+    /**
+     * Get transaction data based on the specified transaction id.
+     *
+     * @param request - the request object for getting the transaction
+     * @returns the response object that contains the fetched transaction object
+     */
+    get(request: GetTransactionRequest): Promise<GetTransactionResponse>;
+    /**
+     * List Transactions.
+     *
+     * @returns the response object that contains a list of transactions
+     */
+    list(request?: ListTransactionRequest): Promise<ListTransactionResponse>;
+}
+//# sourceMappingURL=transactionReadOnly.d.ts.map

package/dist/declarations/src/resources/transactionReadOnly.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactionReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["transactionReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAGpC,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACxB,0CAAuC;AAExC;;GAEG;AACH,qBAAa,yBAAyB;IACpC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;gBAE/B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY;IAK9D;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IASjF;;;;OAIG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAQtF"}

package/dist/declarations/src/types/client.d.ts

@@ -0,0 +1,23 @@
+import { TaggingClient } from "../resources/tagging.js";
+import { ModuleReadOnlyClient } from "../resources/moduleReadOnly.js";
+import { IPAssetClient } from "../resources/ipAsset.js";
+import { IPAssetReadOnlyClient } from "../resources/ipAssetReadOnly.js";
+import { PermissionClient } from "../resources/permission.js";
+import { PermissionReadOnlyClient } from "../resources/permissionReadOnly.js";
+import { TransactionClient } from "../resources/transaction.js";
+import { TransactionReadOnlyClient } from "../resources/transactionReadOnly.js";
+import { PlatformClient } from "../utils/platform.js";
+export interface ReadOnlyClient {
+    ipAsset: IPAssetReadOnlyClient;
+    permission: PermissionReadOnlyClient;
+    transaction: TransactionReadOnlyClient;
+    module: ModuleReadOnlyClient;
+}
+export interface Client {
+    ipAsset: IPAssetClient;
+    permission: PermissionClient;
+    transaction: TransactionClient;
+    platform: PlatformClient;
+    tagging: TaggingClient;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/declarations/src/types/client.d.ts.map

@@ -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,oBAAoB,EAAE,uCAAoC;AACnE,OAAO,EAAE,aAAa,EAAE,gCAA6B;AACrD,OAAO,EAAE,qBAAqB,EAAE,wCAAqC;AACrE,OAAO,EAAE,gBAAgB,EAAE,mCAAgC;AAC3D,OAAO,EAAE,wBAAwB,EAAE,2CAAwC;AAC3E,OAAO,EAAE,iBAAiB,EAAE,oCAAiC;AAC7D,OAAO,EAAE,yBAAyB,EAAE,4CAAyC;AAC7E,OAAO,EAAE,cAAc,EAAE,6BAA0B;AAEnD,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,qBAAqB,CAAC;IAC/B,UAAU,EAAE,wBAAwB,CAAC;IACrC,WAAW,EAAE,yBAAyB,CAAC;IACvC,MAAM,EAAE,oBAAoB,CAAC;CAC9B;AAED,MAAM,WAAW,MAAM;IACrB,OAAO,EAAE,aAAa,CAAC;IACvB,UAAU,EAAE,gBAAgB,CAAC;IAC7B,WAAW,EAAE,iBAAiB,CAAC;IAC/B,QAAQ,EAAE,cAAc,CAAC;IACzB,OAAO,EAAE,aAAa,CAAC;CACxB"}

package/dist/declarations/src/types/common.d.ts

@@ -0,0 +1,6 @@
+export type Hex = `0x${string}`;
+export type TypedData = {
+    interface: string;
+    data: unknown[];
+};
+//# sourceMappingURL=common.d.ts.map

package/dist/declarations/src/types/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"../../../../src/types","sources":["common.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,GAAG,GAAG,KAAK,MAAM,EAAE,CAAC;AAEhC,MAAM,MAAM,SAAS,GAAG;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,OAAO,EAAE,CAAC;CACjB,CAAC"}

package/dist/declarations/src/types/config.d.ts

@@ -0,0 +1,19 @@
+import { Account, Chain, Transport } from "viem";
+/**
+ * Configuration for the SDK Client.
+ *
+ * @public
+ */
+export interface StoryConfig extends StoryReadOnlyConfig {
+    readonly account: Account;
+}
+/**
+ * Configuration for the read-only SDK Client.
+ *
+ * @public
+ */
+export interface StoryReadOnlyConfig {
+    readonly chain?: Chain;
+    readonly transport?: Transport;
+}
+//# sourceMappingURL=config.d.ts.map

package/dist/declarations/src/types/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"../../../../src/types","sources":["config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAEjD;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,mBAAmB;IACtD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IACvB,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;CAChC"}

package/dist/declarations/src/types/options.d.ts

@@ -0,0 +1,12 @@
+export type TxOptions = {
+    waitForTransaction?: boolean;
+    gasPrice?: bigint;
+    numBlockConfirmations?: number;
+};
+export type QueryOptions = {
+    pagination?: {
+        offset?: number;
+        limit?: number;
+    };
+};
+//# sourceMappingURL=options.d.ts.map

package/dist/declarations/src/types/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"../../../../src/types","sources":["options.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG;IACtB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,UAAU,CAAC,EAAE;QACX,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH,CAAC"}