SDK V1.3.0.beta.2 release

.github/CODEOWNERS

@@ -1 +1 @@
-* @LeoHChen @DonFungible @edisonz0718 @jacob-tucker @AndyBoWu @allenchuang
+* @LeoHChen @DonFungible @edisonz0718 @jacob-tucker @AndyBoWu @allenchuang @bpolania

packages/core-sdk/.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Run Test File",
+      "outputCapture": "std",
+      "program": "${workspaceRoot}/node_modules/mocha/bin/mocha.js",
+      "args": ["-r", "ts-node/register", "${relativeFile}"],
+      "console": "integratedTerminal",
+      "env": {
+        "TS_NODE_PROJECT": "./tsconfig.test.json"
+      }
+    }
+  ]
+}

packages/core-sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@story-protocol/core-sdk",
-  "version": "1.3.0-beta.1",
+  "version": "1.3.0-beta.2",
   "description": "Story Protocol Core SDK",
   "main": "dist/story-protocol-core-sdk.cjs.js",
   "module": "dist/story-protocol-core-sdk.esm.js",
@@ -19,7 +19,7 @@
     "build": "pnpm run fix && preconstruct build",
     "test": "pnpm run test:unit",
     "test:unit": "TS_NODE_PROJECT='./tsconfig.test.json' c8 --all --src ./src mocha -r ts-node/register './test/unit/**/*.test.ts'",
-    "test:integration": "TS_NODE_PROJECT='./tsconfig.test.json' mocha -r ts-node/register './test/integration/**/*.test.ts' --timeout 240000",
+    "test:integration": "TS_NODE_PROJECT='./tsconfig.test.json' mocha -r ts-node/register './test/integration/**/*.test.ts' --timeout 300000",
     "fix": "pnpm run format:fix && pnpm run lint:fix",
     "format": "prettier --check .",
     "format:fix": "prettier --write .",

packages/core-sdk/src/abi/generated.ts

@@ -344,7 +344,7 @@ export const accessControllerAbi = [
         ],
       },
     ],
-    name: "setBatchPermissions",
+    name: "setBatchTransientPermissions",
     outputs: [],
     stateMutability: "nonpayable",
   },
@@ -357,7 +357,7 @@ export const accessControllerAbi = [
       { name: "func", internalType: "bytes4", type: "bytes4" },
       { name: "permission", internalType: "uint8", type: "uint8" },
     ],
-    name: "setPermission",
+    name: "setTransientPermission",
     outputs: [],
     stateMutability: "nonpayable",
   },
@@ -15270,7 +15270,7 @@ export class AccessControllerClient extends AccessControllerEventClient {
     const { request: call } = await this.rpcClient.simulateContract({
       abi: accessControllerAbi,
       address: this.address,
-      functionName: "setBatchPermissions",
+      functionName: "setBatchTransientPermissions",
       account: this.wallet.account,
       args: [request.permissions],
     });
@@ -15290,7 +15290,7 @@ export class AccessControllerClient extends AccessControllerEventClient {
       to: this.address,
       data: encodeFunctionData({
         abi: accessControllerAbi,
-        functionName: "setBatchPermissions",
+        functionName: "setBatchTransientPermissions",
         args: [request.permissions],
       }),
     };
@@ -15308,7 +15308,7 @@ export class AccessControllerClient extends AccessControllerEventClient {
     const { request: call } = await this.rpcClient.simulateContract({
       abi: accessControllerAbi,
       address: this.address,
-      functionName: "setPermission",
+      functionName: "setTransientPermission",
       account: this.wallet.account,
       args: [request.ipAccount, request.signer, request.to, request.func, request.permission],
     });
@@ -15326,7 +15326,7 @@ export class AccessControllerClient extends AccessControllerEventClient {
       to: this.address,
       data: encodeFunctionData({
         abi: accessControllerAbi,
-        functionName: "setPermission",
+        functionName: "setTransientPermission",
         args: [request.ipAccount, request.signer, request.to, request.func, request.permission],
       }),
     };
@@ -20672,6 +20672,14 @@ export class IpAccountImplReadOnlyClient {
       functionName: "token",
     });
   }
+
+  public async owner(): Promise<Address> {
+    return await this.rpcClient.readContract({
+      abi: ipAccountImplAbi,
+      address: this.address,
+      functionName: "owner",
+    });
+  }
 }
 
 /**

packages/core-sdk/src/client.ts

@@ -12,11 +12,12 @@ import { PermissionClient } from "./resources/permission";
 import { LicenseClient } from "./resources/license";
 import { DisputeClient } from "./resources/dispute";
 import { IPAccountClient } from "./resources/ipAccount";
-import { chain, chainStringToViemChain } from "./utils/utils";
+import { chain, chainStringToViemChain, validateAddress } from "./utils/utils";
 import { RoyaltyClient } from "./resources/royalty";
 import { NftClient } from "./resources/nftClient";
 import { GroupClient } from "./resources/group";
 import { SimpleWalletClient } from "./abi/generated";
+import { WipClient } from "./resources/wip";
 
 if (typeof process !== "undefined") {
   dotenv.config();
@@ -36,14 +37,15 @@ export class StoryClient {
   private _royalty: RoyaltyClient | null = null;
   private _nftClient: NftClient | null = null;
   private _group: GroupClient | null = null;
+  private _wip: WipClient | null = null;
 
   /**
    * @param config - the configuration for the SDK client
    */
   private constructor(config: StoryConfig) {
     this.config = {
       ...config,
-      chainId: chain[config.chainId || "homer"],
+      chainId: chain[config.chainId || "aeneid"],
     };
     if (!this.config.transport) {
       throw new Error(
@@ -218,4 +220,25 @@ export class StoryClient {
 
     return this._group;
   }
+
+  public get wipClient(): WipClient {
+    if (this._wip === null) {
+      this._wip = new WipClient(this.rpcClient, this.wallet);
+    }
+    return this._wip;
+  }
+
+  public async getWalletBalance(): Promise<bigint> {
+    if (!this.wallet.account) {
+      throw new Error("No account found in wallet");
+    }
+    return await this.getBalance(this.wallet.account.address);
+  }
+
+  public async getBalance(address: string): Promise<bigint> {
+    const validAddress = validateAddress(address);
+    return await this.rpcClient.getBalance({
+      address: validAddress,
+    });
+  }
 }

packages/core-sdk/src/constants/common.ts

@@ -3,5 +3,8 @@ import { Hex } from "viem";
 export const AddressZero = "0x0000000000000000000000000000000000000000";
 export const HashZero = "0x0000000000000000000000000000000000000000000000000000000000000000";
 export const defaultFunctionSelector: Hex = "0x00000000";
-export const royaltySharesTotalSupply: number = 100000000;
-export const MAX_ROYALTY_TOKEN = 100000000;
+export const royaltySharesTotalSupply: number = 100_000_000;
+export const MAX_ROYALTY_TOKEN = 100_000_000;
+
+/** Address for the WIP contract. This address is fixed */
+export const WIP_TOKEN_ADDRESS = "0x1514000000000000000000000000000000000000";

packages/core-sdk/src/index.ts

@@ -1,6 +1,6 @@
 export { StoryClient } from "./client";
 export { AddressZero, HashZero } from "./constants/common";
-export { homer } from "./utils/chain";
+export { aeneid } from "./utils/chain";
 export { IPAssetClient } from "./resources/ipAsset";
 export { PermissionClient } from "./resources/permission";
 export { LicenseClient } from "./resources/license";