@story-protocol/core-sdk 0.1.0-rc.5 → 1.0.0-rc.1

package/README.md

@@ -1,76 +1,124 @@
-core-sdk is the base level sdk to interact with story protocol. It provides functions to both read and write data to the protocol.
+# Story Protocol SDK
 
-## Installation
+Welcome to the documents for Story Protocol SDK. The SDK provides the APIs for developers to build applications with Story Protocol. By using the SDK, developers can create the resources like IP assets and perform actions to interact with the resource.
 
-Install the SDK and ethers.js 
+## How to use Story Protocol SDK in Your Project
+
+### Install Story Protocol core SDK
+
+Suppose you already have a node project or created a new node project. First, you need to install `@story-protocol/core-sdk` in your project. You can use one of the following command to install the package:
+
+Use `npm`:
 
-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
+npm install --save @story-protocol/core-sdk viem@1.21.4
 ```
 
-## Set up `.env` file
+Use `pnpm`:
+
+```
+pnpm install @story-protocol/core-sdk viem@1.21.4
+```
 
-(Ask the team to provide the values)
+Use `yarn`:
 
 ```
-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 =
+yarn add @story-protocol/core-sdk viem@1.21.4
 ```
 
-## Set up SDK client
-Using browser wallet
+Besides the Story Protocol SDK package `@story-protocol/core-sdk`, we also require the package `viem` (https://www.npmjs.com/package/viem) to access the DeFi wallet accounts.
+
+# Initiate SDK Client
+
+Next we can initiate the SDK Client by first setting up our wallet and then the client itself.
 
-```typescript 
-import { StoryClient } from "@story-protocol/core-sdk"
-import ethers from "ethers" 
+## Set up your wallet
 
-// Signer from browser wallet (i.e Metamask)
-const provider = new ethers.providers.Web3Provider(window.ethereum);
-// request wallet permissions
-await provider.send("eth_requestAccounts", []);
-const signer = await provider.getSigner();
+The SDK supports using `viem` for initiating SDK client. Create a typescript file and write the following code to initiate the client with a private key:
 
-// Instantiate the Story Client
-const client = new StoryClient( { signer } )
+> :information-source: Make sure to have WALLET_PRIVATE_KEY set up in your .env file.
 
+```typescript index.ts
+import { privateKeyToAccount } from "viem/accounts";
+
+const WALLET_PRIVATE_KEY = process.env.WALLET_PRIVATE_KEY || "0x";
+const account = privateKeyToAccount(WALLET_PRIVATE_KEY as `0x${string}`);
 ```
-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)
+The preceding code created the `account` object for creating the SDK client.
+
+## Set up SDK client
+
+To set up the SDK client, import `StoryClient` and `StoryConfig` from `@story-protocol/core-sdk`. Write the following code, utilizing the `account` we created previously.
+
+> :information-source: Make sure to have RPC_PROVIDER_URL for your desired chain set up in your .env file. We recommend using the Sepolia network with `RPC_PROVIDER_URL=https://rpc.ankr.com/eth_sepolia`.
 
-// Instantiate the Story Client
-const client = new StoryClient( { signer } )
+```typescript index.ts
+import { StoryClient, StoryConfig } from "@story-protocol/core-sdk";
 
+const config: StoryConfig = {
+  transport: http(process.env.RPC_PROVIDER_URL),
+  account: account,
+};
+const client = StoryClient.newClient(config);
 ```
 
-## Use SDK client
+## How To Build and Test Story Protocol SDK for local testing
+
+This section provides the instructions on how to build Story Protocol SDK from source code.
+
+### Prerequisite
+
+- Install PNPM: Execute `npm install -g pnpm`
+- Install TypeScript: Run `pnpm add typescript -D`
+- Install Yalc: Use `npm install -g yalc`
+
+### Steps for Using Yalc for Local Testing of Core-SDK
+
+For manual testing of the core-sdk, set up a separate web project. The guide below uses `yalc` to link the `core-sdk` locally, enabling its installation and import for testing.
+
+Under the `typescript-sdk/packages/core-sdk` directory:
+
+- Navigate to the `core-sdk` directory.
+- Execute `npm run build` to build your latest code.
+- Run `yalc publish`. You should see a message like `@story-protocol/core-sdk@<version> published in store.` (Note: The version number may vary).
+
+To set up your testing environment (e.g., a new Next.js project), use `yalc add @story-protocol/core-sdk@<version>` (ensure the version number is updated accordingly).
+
+- Run `pnpm install`. This installs `@story-protocol/core-sdk@<version>` with your local changes.
+
+### Steps to Refresh the Changes
+
+Under the `typescript-sdk/packages/core-sdk` directory:
+
+- Execute `npm run build` to build your latest code.
+- Run `yalc push`.
+
+In your testing environment:
+
+- Run `yalc update` to pull the latest changes.
+
+## Steps to pull and compile latest smart contract ABIs (Currently pulls from the protocol-contracts `dev` branch)
+
+Must have `solc` installed (https://docs.soliditylang.org/en/v0.8.9/installing-solidity.html)
+
+- run `make compile_contracts`
+
+## Release
+
+| Package                         | Description                                    |
+| :------------------------------ | :--------------------------------------------- |
+| [core-sdk](./packages/core-sdk) | The core sdk for interacting with the protocol |
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first
+to discuss what you would like to change. Details see: [CONTRIBUTING](/CONTRIBUTING.md)
+
+Please make sure to update tests as appropriate.
 
-```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.",
-  })
+## License
 
-// List franchises
-const { data: franchise } = await client.franchise.list()
+[MIT License](/LICENSE.md)
 
-```
+## Contact Us

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

@@ -1,67 +1,75 @@
 import { StoryConfig } from "./types/config.js";
-import { FranchiseClient } from "./resources/franchise.js";
-import { LicenseClient } from "./resources/license.js";
-import { TransactionClient } from "./resources/transaction.js";
-import { RelationshipClient } from "./resources/relationship.js";
 import { IPAssetClient } from "./resources/ipAsset.js";
-import { CollectClient } from "./resources/collect.js";
+import { PermissionClient } from "./resources/permission.js";
+import { LicenseClient } from "./resources/license.js";
+import { DisputeClient } from "./resources/dispute.js";
+import { IPAccountClient } from "./resources/ipAccount.js";
+import { RoyaltyClient } from "./resources/royalty.js";
 /**
  * The StoryClient is the main entry point for the SDK.
  */
 export declare class StoryClient {
     private readonly config;
-    private readonly httpClient;
-    private _franchise;
-    private _relationship;
+    private readonly rpcClient;
+    private readonly wallet;
+    private readonly storyClient;
     private _ipAsset;
+    private _permission;
     private _license;
-    private _transaction;
-    private _collect;
+    private _dispute;
+    private _ipAccount;
+    private _royalty;
     /**
      * @param config - the configuration for the SDK client
      */
-    constructor(config: StoryConfig);
+    private constructor();
     /**
-     * Getter for the franchise client. The client is lazily created when
-     * this method is called.
+     * Factory method for creating a SDK client with a signer.
      *
-     * @returns the FranchiseClient instance
+     * @param config - the configuration for a new SDK client
      */
-    get franchise(): FranchiseClient;
+    static newClient(config: StoryConfig): StoryClient;
     /**
-     * Getter for the relationship client. The client is lazily created when
+     * Getter for the ip asset client. The client is lazily created when
      * this method is called.
      *
-     * @returns the RelationshipClient instance
+     * @returns the IPAssetClient instance
      */
-    get relationship(): RelationshipClient;
+    get ipAsset(): IPAssetClient;
     /**
-     * Getter for the IP Asset client. The client is lazily created when
+     * Getter for the permission client. The client is lazily created when
      * this method is called.
      *
-     * @returns the IpAssetClient instance
+     * @returns the PermissionClient instance
      */
-    get ipAsset(): IPAssetClient;
+    get permission(): PermissionClient;
     /**
      * Getter for the license client. The client is lazily created when
      * this method is called.
      *
-     * @returns the FranchiseClient instance
+     * @returns the LicenseClient instance
      */
     get license(): LicenseClient;
     /**
-     * Getter for the transaction client. The client is lazily created when
+     * Getter for the dispute client. The client is lazily created when
+     * this method is called.
+     *
+     * @returns the DisputeClient instance
+     */
+    get dispute(): DisputeClient;
+    /**
+     * Getter for the ip account client. The client is lazily created when
      * this method is called.
      *
-     * @returns the TransactionClient instance
+     * @returns the IPAccountClient instance
      */
-    get transaction(): TransactionClient;
+    get ipAccount(): IPAccountClient;
     /**
-     * Getter for the collect module client. The client is lazily created when
+     * Getter for the royalty client. The client is lazily created when
      * this method is called.
      *
-     * @returns the CollectClient instance
+     * @returns the RoyaltyClient instance
      */
-    get collect(): CollectClient;
+    get royalty(): RoyaltyClient;
 }
 //# 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":"AAGA,OAAO,EAAE,WAAW,EAAE,0BAAuB;AAE7C,OAAO,EAAE,eAAe,EAAE,iCAA8B;AACxD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,iBAAiB,EAAE,mCAAgC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,oCAAiC;AAC9D,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAEpD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AASpD;;GAEG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;IAC3C,OAAO,CAAC,UAAU,CAAgC;IAClD,OAAO,CAAC,aAAa,CAAmC;IACxD,OAAO,CAAC,QAAQ,CAA8B;IAC9C,OAAO,CAAC,QAAQ,CAA8B;IAC9C,OAAO,CAAC,YAAY,CAAkC;IACtD,OAAO,CAAC,QAAQ,CAA8B;IAE9C;;OAEG;gBACS,MAAM,EAAE,WAAW;IAW/B;;;;;OAKG;IACH,IAAW,SAAS,IAAI,eAAe,CAmBtC;IAED;;;;;OAKG;IACH,IAAW,YAAY,IAAI,kBAAkB,CAqB5C;IAED;;;;;OAKG;IACH,IAAW,OAAO,IAAI,aAAa,CAYlC;IAED;;;;;OAKG;IACH,IAAW,OAAO,IAAI,aAAa,CAYlC;IAED;;;;;OAKG;IACH,IAAW,WAAW,IAAI,iBAAiB,CAK1C;IAED;;;;;OAKG;IACH,IAAW,OAAO,IAAI,aAAa,CAWlC;CACF"}
+{"version":3,"file":"client.d.ts","sourceRoot":"../../../src","sources":["client.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAqB,0BAAuB;AAChE,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,gBAAgB,EAAE,kCAA+B;AAC1D,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,eAAe,EAAE,iCAA8B;AAGxD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAKpD;;GAEG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA+C;IACtE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;IACtC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAiB;IAC7C,OAAO,CAAC,QAAQ,CAA8B;IAC9C,OAAO,CAAC,WAAW,CAAiC;IACpD,OAAO,CAAC,QAAQ,CAA8B;IAC9C,OAAO,CAAC,QAAQ,CAA8B;IAC9C,OAAO,CAAC,UAAU,CAAgC;IAClD,OAAO,CAAC,QAAQ,CAA8B;IAC9C;;OAEG;IACH,OAAO;IAgCP;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW;IAIlD;;;;;OAKG;IACH,IAAW,OAAO,IAAI,aAAa,CAMlC;IAED;;;;;OAKG;IACH,IAAW,UAAU,IAAI,gBAAgB,CAMxC;IAED;;;;;OAKG;IACH,IAAW,OAAO,IAAI,aAAa,CAWlC;IAED;;;;;OAKG;IACH,IAAW,OAAO,IAAI,aAAa,CAMlC;IAED;;;;;OAKG;IACH,IAAW,SAAS,IAAI,eAAe,CAMtC;IACD;;;;;OAKG;IACH,IAAW,OAAO,IAAI,aAAa,CAMlC;CACF"}

package/dist/declarations/src/clients/storyAPI.d.ts

@@ -0,0 +1,9 @@
+import { RoyaltyPolicy } from "../types/resources/royalty.js";
+import { License } from "../types/resources/license.js";
+export declare class StoryAPIClient {
+    private readonly httpClient;
+    constructor();
+    getRoyaltyPolicy(ipId: string): Promise<RoyaltyPolicy>;
+    getLicense(licenseId: string): Promise<License>;
+}
+//# sourceMappingURL=storyAPI.d.ts.map

package/dist/declarations/src/clients/storyAPI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storyAPI.d.ts","sourceRoot":"../../../../src/clients","sources":["storyAPI.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAA4B,sCAAmC;AACrF,OAAO,EAAE,OAAO,EAAsB,sCAAmC;AAEzE,qBAAa,cAAc;IACzB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;;IAY9B,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAKtD,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAI7D"}

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

@@ -0,0 +1,4 @@
+export declare const AddressZero = "0x0000000000000000000000000000000000000000";
+export declare const HashZero = "0x0000000000000000000000000000000000000000000000000000000000000000";
+export declare const SepoliaChainId = "11155111";
+//# 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;AAE7F,eAAO,MAAM,cAAc,aAAa,CAAC"}

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

@@ -1,12 +1,15 @@
 export { StoryClient } from "./client.js";
-export { Environment } from "./enums/Environment.js";
-export { IPAssetType } from "./enums/IPAssetType.js";
-export { ResourceType } from "./enums/ResourceType.js";
+export { AddressZero, HashZero } from "./constants/common.js";
+export { IPAssetClient } from "./resources/ipAsset.js";
+export { PermissionClient } from "./resources/permission.js";
+export { LicenseClient } from "./resources/license.js";
+export { DisputeClient } from "./resources/dispute.js";
 export type { StoryConfig } from "./types/config.js";
-export type { Franchise, GetFranchiseRequest, GetFranchiseResponse, CreateFranchiseRequest, CreateFranchiseResponse, ListFranchiseResponse, ConfigureFranchiseRequest, ConfigureFranchiseResponse, } from "./types/resources/franchise.js";
-export type { IPAsset, GetIpAssetRequest, GetIpAssetResponse, CreateIpAssetRequest, CreateIpAssetResponse, ListIpAssetRequest, ListIpAssetResponse, } from "./types/resources/ipAsset.js";
-export type { License, GetLicenseRequest, GetLicenseResponse, CreateLicenseRequest, CreateLicenseResponse, CreateLicenseRequestOptions, ListLicenseRequest, ListLicenseResponse, } from "./types/resources/license.js";
-export type { IPAssetId, RelationshipRelateRequest, RelationshipRelateResponse, RelationshipUnrelateRequest, RelationshipUnrelateResponse, RelationshipIsRelationshipExpiredRequest, RelationshipIsRelationshipExpiredResponse, RelationshipIsRelatedRequest, RelationshipIsRelatedResponse, } from "./types/resources/relationship.js";
-export type { Collection, CollectIPAssetRequest, CollectIPAssetResponse, ListCollectionsRequest, ListCollectionsResponse, } from "./types/resources/collect.js";
-export type { Transaction, GetTransactionRequest, GetTransactionResponse, ListTransactionResponse, } from "./types/resources/transaction.js";
+export type { Hex, TypedData } from "./types/common.js";
+export type { RegisterIpResponse, RegisterRequest, RegisterDerivativeResponse, RegisterDerivativeRequest, RegisterDerivativeWithLicenseTokensRequest, RegisterDerivativeWithLicenseTokensResponse, } from "./types/resources/ipAsset.js";
+export type { MintLicenseTokensResponse, MintLicenseTokensRequest, RegisterCommercialUsePILRequest, RegisterLicenseTermsResponse, RegisterCommercialRemixPILRequest, AttachLicenseTermsRequest, LicenseTermsIdResponse, } from "./types/resources/license.js";
+export type { CollectRoyaltyTokensRequest, CollectRoyaltyTokensResponse, PayRoyaltyOnBehalfRequest, PayRoyaltyOnBehalfResponse, } from "./types/resources/royalty.js";
+export type { SetPermissionsRequest, SetPermissionsResponse } from "./types/resources/permission.js";
+export type { Dispute, RaiseDisputeRequest, RaiseDisputeResponse, SetDisputeJudgementRequest, SetDisputeJudgementResponse, CancelDisputeRequest, CancelDisputeResponse, ResolveDisputeRequest, ResolveDisputeResponse, } from "./types/resources/dispute.js";
+export type { IPAccountExecuteRequest, IPAccountExecuteResponse, IPAccountExecuteWithSigRequest, IPAccountExecuteWithSigResponse, } from "./types/resources/ipAccount.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,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,YAAY,EAAE,gCAA6B;AAEpD,YAAY,EAAE,WAAW,EAAE,0BAAuB;AAElD,YAAY,EACV,SAAS,EACT,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,yBAAyB,EACzB,0BAA0B,GAC3B,uCAAoC;AAErC,YAAY,EACV,OAAO,EACP,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,mBAAmB,GACpB,qCAAkC;AAEnC,YAAY,EACV,OAAO,EACP,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,2BAA2B,EAC3B,kBAAkB,EAClB,mBAAmB,GACpB,qCAAkC;AAEnC,YAAY,EACV,SAAS,EACT,yBAAyB,EACzB,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,wCAAwC,EACxC,yCAAyC,EACzC,4BAA4B,EAC5B,6BAA6B,GAC9B,0CAAuC;AAExC,YAAY,EACV,UAAU,EACV,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,GACxB,qCAAkC;AAEnC,YAAY,EACV,WAAW,EACX,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,GACxB,yCAAsC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"../../../src","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,oBAAiB;AACvC,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,aAAa,EAAE,+BAA4B;AAEpD,YAAY,EAAE,WAAW,EAAE,0BAAuB;AAClD,YAAY,EAAE,GAAG,EAAE,SAAS,EAAE,0BAAuB;AAErD,YAAY,EACV,kBAAkB,EAClB,eAAe,EACf,0BAA0B,EAC1B,yBAAyB,EACzB,0CAA0C,EAC1C,2CAA2C,GAC5C,qCAAkC;AAEnC,YAAY,EACV,yBAAyB,EACzB,wBAAwB,EACxB,+BAA+B,EAC/B,4BAA4B,EAC5B,iCAAiC,EACjC,yBAAyB,EACzB,sBAAsB,GACvB,qCAAkC;AAEnC,YAAY,EACV,2BAA2B,EAC3B,4BAA4B,EAC5B,yBAAyB,EACzB,0BAA0B,GAC3B,qCAAkC;AAEnC,YAAY,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,wCAAqC;AAElG,YAAY,EACV,OAAO,EACP,mBAAmB,EACnB,oBAAoB,EACpB,0BAA0B,EAC1B,2BAA2B,EAC3B,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,GACvB,qCAAkC;AAEnC,YAAY,EACV,uBAAuB,EACvB,wBAAwB,EACxB,8BAA8B,EAC9B,+BAA+B,GAChC,uCAAoC"}