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

package/README.md

@@ -68,18 +68,3 @@ const signer = new ethers.Wallet(<YOUR PRIVATE KEY>, provider)
 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

@@ -1,63 +1,54 @@
-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 { StoryConfig } from "./types/config.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";
+import { LicenseClient } from "./resources/license.js";
+import { PolicyClient } from "./resources/policy.js";
+import { DisputeClient } from "./resources/dispute.js";
+import { PlatformClient } from "./utils/platform.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 readonly wallet;
+    private readonly httpClient;
     private _ipAccount;
     private _permission;
-    private _transaction;
+    private _license;
+    private _policy;
     private _platform;
-    private _module;
     private _tagging;
+    private _dispute;
     /**
      * @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
+     * @param config - the configuration for a new SDK client
      */
-    static newClient(config: StoryConfig): Client;
-    get ipAsset(): IPAssetClient | IPAssetReadOnlyClient;
-    get permission(): PermissionClient | PermissionReadOnlyClient;
+    static newClient(config: StoryConfig): StoryClient;
+    get ipAsset(): IPAssetClient;
+    get permission(): PermissionClient;
+    get license(): LicenseClient;
+    get policy(): PolicyClient;
     /**
-     * Getter for the transaction client. The client is lazily created when
+     * Getter for the tagging client. The client is lazily created when
      * this method is called.
      *
-     * @returns the TransactionReadOnlyClient or TransactionClient instance
+     * @returns the TaggingClient instance
      */
-    get transaction(): TransactionClient | TransactionReadOnlyClient;
+    get tagging(): TaggingClient;
     /**
-     * Getter for the tagging client. The client is lazily created when
+     * Getter for the dispute client. The client is lazily created when
      * this method is called.
      *
-     * @returns the TaggingReadOnlyClient or TaggingClient instance
+     * @returns the DisputeClient instance
      */
-    get tagging(): TaggingClient | TaggingReadOnlyClient;
+    get dispute(): DisputeClient;
     /**
      * Getter for the platform client. The client is lazily created when
      * this method is called.
@@ -65,12 +56,5 @@ export declare class StoryClient {
      * @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

@@ -1 +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"}
+{"version":3,"file":"client.d.ts","sourceRoot":"../../../src","sources":["client.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,0BAAuB;AAC7C,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,gBAAgB,EAAE,kCAA+B;AAC1D,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,YAAY,EAAE,8BAA2B;AAClD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAEpD,OAAO,EAAE,cAAc,EAAE,4BAAyB;AAKlD;;GAEG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;IACtC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;IAE3C,OAAO,CAAC,UAAU,CAA8B;IAChD,OAAO,CAAC,WAAW,CAAiC;IACpD,OAAO,CAAC,QAAQ,CAA8B;IAC9C,OAAO,CAAC,OAAO,CAA6B;IAC5C,OAAO,CAAC,SAAS,CAA+B;IAChD,OAAO,CAAC,QAAQ,CAA8B;IAC9C,OAAO,CAAC,QAAQ,CAA8B;IAE9C;;OAEG;IACH,OAAO;IAkCP;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW;IAIlD,IAAW,OAAO,IAAI,aAAa,CAMlC;IAED,IAAW,UAAU,IAAI,gBAAgB,CAMxC;IAED,IAAW,OAAO,IAAI,aAAa,CAMlC;IAED,IAAW,MAAM,IAAI,YAAY,CAMhC;IAED;;;;;OAKG;IACH,IAAW,OAAO,IAAI,aAAa,CAMlC;IAED;;;;;OAKG;IACH,IAAW,OAAO,IAAI,aAAa,CAMlC;IAED;;;;;OAKG;IACH,IAAW,QAAQ,IAAI,cAAc,CAMpC;CACF"}

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

@@ -1,19 +1,18 @@
 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 { LicenseClient } from "./resources/license.js";
+export { PolicyClient } from "./resources/policy.js";
+export { TaggingClient } from "./resources/tagging.js";
+export { DisputeClient } from "./resources/dispute.js";
+export type { StoryConfig } from "./types/config.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";
+export type { RegisterRootIpRequest, RegisterRootIpResponse, RegisterDerivativeIpRequest, RegisterDerivativeIpResponse, } from "./types/resources/ipAsset.js";
+export type { MintLicenseRequest, MintLicenseResponse, LinkIpToParentRequest, LinkIpToParentResponse, } from "./types/resources/license.js";
+export type { RegisterPILPolicyRequest, RegisterPILPolicyResponse, AddPolicyToIpRequest, AddPolicyToIpResponse, } from "./types/resources/policy.js";
+export type { setPermissionsRequest, setPermissionsResponse } from "./types/resources/permission.js";
+export type { SetTagRequest, SetTagResponse, RemoveTagRequest, RemoveTagResponse, } from "./types/resources/tagging.js";
+export type { Dispute, RaiseDisputeRequest, RaiseDisputeResponse, SetDisputeJudgementRequest, SetDisputeJudgementResponse, CancelDisputeRequest, CancelDisputeResponse, ResolveDisputeRequest, ResolveDisputeResponse, } from "./types/resources/dispute.js";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"../../../src","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,oBAAiB;AACvC,OAAO,EAAE,cAAc,EAAE,4BAAyB;AAClD,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,8BAA2B;AAE3D,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,gBAAgB,EAAE,kCAA+B;AAC1D,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,YAAY,EAAE,8BAA2B;AAClD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAEpD,YAAY,EAAE,WAAW,EAAE,0BAAuB;AAClD,YAAY,EAAE,GAAG,EAAE,SAAS,EAAE,0BAAuB;AAErD,YAAY,EACV,qBAAqB,EACrB,sBAAsB,EACtB,2BAA2B,EAC3B,4BAA4B,GAC7B,qCAAkC;AAEnC,YAAY,EACV,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,sBAAsB,GACvB,qCAAkC;AAEnC,YAAY,EACV,wBAAwB,EACxB,yBAAyB,EACzB,oBAAoB,EACpB,qBAAqB,GACtB,oCAAiC;AAElC,YAAY,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,wCAAqC;AAElG,YAAY,EACV,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,iBAAiB,GAClB,qCAAkC;AAEnC,YAAY,EACV,OAAO,EACP,mBAAmB,EACnB,oBAAoB,EACpB,0BAA0B,EAC1B,2BAA2B,EAC3B,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,GACvB,qCAAkC"}