@avaprotocol/sdk-js 0.6.12 → 0.7.2

package/README.md

@@ -81,6 +81,61 @@ To ensure the SDK is functioning correctly, we have a comprehensive test suite.
 
 This will execute all unit and integration tests. Make sure all tests pass before submitting a pull request or deploying changes.
 
+## Version Management
+
+This project uses [Changesets](https://github.com/changesets/changesets) to manage versions and changelogs. To contribute changes:
+
+1. Make your changes to the codebase.
+2. Run `npm run changeset` to create a new changeset.
+3. Follow the prompts to describe your changes.
+4. Commit the generated changeset file along with your changes.
+
+To release a new version:
+
+1. Run `npm run version` to update package versions and changelogs.
+2. Review and commit the changes.
+3. Run `npm run release` to publish the new version to npm.
+
+For more detailed information on using Changesets, refer to the [Changesets documentation](https://github.com/changesets/changesets/blob/main/docs/intro-to-using-changesets.md).
+
+## Release Process
+
+This repository uses a two-step workflow process for creating new releases:
+
+1. **Record changeset workflow**
+
+   - Go to the "Actions" tab in GitHub, and run the "Record Changeset" workflow
+   - Select the version bump type:
+     - `patch` for backwards-compatible bug fixes (0.0.x)
+     - `minor` for backwards-compatible features (0.x.0)
+     - `major` for breaking changes (x.0.0)
+   - Examine the Pull Request created by the workflow, and merge it if everything looks correct. This will record any commits before it as a major, minor, or patch.
+
+2. **Create release workflow**
+   - Go to the "Actions" tab in GitHub and run the "Create Release" workflow. This will run `npx changeset version` to bump up version in `package.json` based on the recorded changeset files. It will also create a new GitHub Release if the new version is higher than the current version in `package.json`.
+3. **Publish to NPM**
+   - After the last step, the version number in `package.json` is updated and a git tag with the new version number is created. Now you can publish the production version to NPM using `npm publish`.
+
+### NPM Publishing Dev Versions
+
+The NPM publishing of dev versions can be handled manually, since the test cases reference the dist folder and don’t require a new version on NPM. NPM publish on dev tag is only required for testing the new version in a web app.
+
+1. Publish a dev version and test it in your local environment:
+
+   ```bash
+   # Update version with dev tag in package.json
+   npm version prerelease --preid=dev
+
+   # Publish to npm with dev tag
+   npm publish --tag dev
+   ```
+
+2. Once tested, and a release is created using GitHub Actions, publish the production version to NPM:
+   ```bash
+   # Publish to npm with latest tag
+   npm publish
+   ```
+
 ### Utility Scripts
 
 To generate the key request message for signing, you can run the following command:

package/dist/index.d.mts

@@ -1457,8 +1457,12 @@ declare class AggregatorClient extends grpc.Client implements IAggregatorClient
 }
 
 type Environment = "production" | "development" | "staging";
+declare const AUTH_KEY_HEADER = "authKey";
+interface RequestOptions {
+    authKey: string;
+}
 interface GetKeyResponse {
-    jwtToken: string;
+    authKey: string;
 }
 interface ClientOption {
     endpoint: string;
@@ -1492,14 +1496,16 @@ declare class BaseClient {
     readonly rpcClient: AggregatorClient;
     protected metadata: Metadata;
     constructor(opts: ClientOption);
-    private setAuthKey;
-    isAuthenticated(): boolean;
+    isAuthKeyValid(key: string): boolean;
+    authWithAPIKey(apiKey: string, expiredAtEpoch: number): Promise<GetKeyResponse>;
     authWithSignature(address: string, signature: string, expiredAtEpoch: number): Promise<GetKeyResponse>;
-    protected _callRPC<TResponse, TRequest>(method: string, request: TRequest | any): Promise<TResponse>;
+    protected _callRPC<TResponse, TRequest>(method: string, request: TRequest | any, options?: RequestOptions): Promise<TResponse>;
 }
 declare class Client extends BaseClient {
     constructor(config: ClientOption);
-    getAddresses(address: string): Promise<GetAddressesResponse>;
+    getAddresses(address: string, { authKey }: {
+        authKey: string;
+    }): Promise<GetAddressesResponse>;
     createTask({ address, oracleContract, tokenContract, }: {
         address: string;
         tokenContract: string;
@@ -1511,4 +1517,4 @@ declare class Client extends BaseClient {
     deleteTask(id: string): Promise<boolean>;
 }
 
-export { type BalanceResp, type ClientOption, type CreateTaskResponse, type Environment, type GetAddressesResponse, type GetKeyResponse, type ListTasksResponse, type Task, type TransactionResp, Client as default, getKeyRequestMessage };
+export { AUTH_KEY_HEADER, type BalanceResp, type ClientOption, type CreateTaskResponse, type Environment, type GetAddressesResponse, type GetKeyResponse, type ListTasksResponse, type RequestOptions, type Task, type TransactionResp, Client as default, getKeyRequestMessage };

package/dist/index.d.ts

@@ -1457,8 +1457,12 @@ declare class AggregatorClient extends grpc.Client implements IAggregatorClient
 }
 
 type Environment = "production" | "development" | "staging";
+declare const AUTH_KEY_HEADER = "authKey";
+interface RequestOptions {
+    authKey: string;
+}
 interface GetKeyResponse {
-    jwtToken: string;
+    authKey: string;
 }
 interface ClientOption {
     endpoint: string;
@@ -1492,14 +1496,16 @@ declare class BaseClient {
     readonly rpcClient: AggregatorClient;
     protected metadata: Metadata;
     constructor(opts: ClientOption);
-    private setAuthKey;
-    isAuthenticated(): boolean;
+    isAuthKeyValid(key: string): boolean;
+    authWithAPIKey(apiKey: string, expiredAtEpoch: number): Promise<GetKeyResponse>;
     authWithSignature(address: string, signature: string, expiredAtEpoch: number): Promise<GetKeyResponse>;
-    protected _callRPC<TResponse, TRequest>(method: string, request: TRequest | any): Promise<TResponse>;
+    protected _callRPC<TResponse, TRequest>(method: string, request: TRequest | any, options?: RequestOptions): Promise<TResponse>;
 }
 declare class Client extends BaseClient {
     constructor(config: ClientOption);
-    getAddresses(address: string): Promise<GetAddressesResponse>;
+    getAddresses(address: string, { authKey }: {
+        authKey: string;
+    }): Promise<GetAddressesResponse>;
     createTask({ address, oracleContract, tokenContract, }: {
         address: string;
         tokenContract: string;
@@ -1511,4 +1517,4 @@ declare class Client extends BaseClient {
     deleteTask(id: string): Promise<boolean>;
 }
 
-export { type BalanceResp, type ClientOption, type CreateTaskResponse, type Environment, type GetAddressesResponse, type GetKeyResponse, type ListTasksResponse, type Task, type TransactionResp, Client as default, getKeyRequestMessage };
+export { AUTH_KEY_HEADER, type BalanceResp, type ClientOption, type CreateTaskResponse, type Environment, type GetAddressesResponse, type GetKeyResponse, type ListTasksResponse, type RequestOptions, type Task, type TransactionResp, Client as default, getKeyRequestMessage };

package/dist/index.js

@@ -4182,6 +4182,7 @@ var init_avs_pb = __esm({
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  AUTH_KEY_HEADER: () => AUTH_KEY_HEADER,
   default: () => Client,
   getKeyRequestMessage: () => getKeyRequestMessage
 });
@@ -4511,13 +4512,14 @@ var Task2 = class {
   constructor(task) {
     this.id = task.getId();
     this.status = task.getStatus().toString();
-    console.log("task.constructor:", task.toObject());
   }
 };
 var task_default = Task2;
 
+// src/types.ts
+var AUTH_KEY_HEADER = "authKey";
+
 // src/index.ts
-var metadata = new grpc2.Metadata();
 var BaseClient = class {
   constructor(opts) {
     this.endpoint = opts.endpoint;
@@ -4527,51 +4529,27 @@ var BaseClient = class {
     );
     this.metadata = new import_grpc_js.Metadata();
   }
-  setAuthKey(jwtToken) {
-    metadata.add("authkey", jwtToken);
-  }
-  isAuthenticated() {
-    if (!metadata.get("authkey")) {
-      return false;
-    }
+  isAuthKeyValid(key) {
     try {
-      const [, payload] = metadata.get("authkey")[0].toString().split(".");
+      const [, payload] = key.split(".");
       const decodedPayload = JSON.parse(atob(payload));
       const currentTimestamp = Math.floor(Date.now() / 1e3);
       return decodedPayload.exp > currentTimestamp;
     } catch (error) {
-      console.error("Error validating JWT token:", error);
+      console.error("Error validating auth key:", error);
       return false;
     }
   }
-  // async authWithJwtToken(
-  //   address: string,
-  //   jwtToken: string,
-  //   expiredAt?: number
-  // ): Promise<KeyExchangeResp> {
-  //   console.log("Authenticating with JWT token: ", jwtToken);
-  //   // Use the provided expiredAt or set it to 24 hours from now if not provided
-  //   const expirationTime =
-  //     expiredAt || Math.floor(Date.now() / 1000) + DEFAULT_JWT_EXPIRATION;
-  //   const result: avsPb.KeyResp = await this._callRPC<
-  //     avsPb.KeyResp,
-  //     avsPb.GetKeyReq
-  //   >("getKey", {
-  //     owner: address,
-  //     expired_at: expirationTime,
-  //     signature: jwtToken,
-  //   });
-  //   this.jwtToken = result.getKey();
-  //   return { key: result.getKey() };
-  // }
+  async authWithAPIKey(apiKey, expiredAtEpoch) {
+    const request = new GetKeyReq();
+    request.setOwner("");
+    request.setExpiredAt(expiredAtEpoch);
+    request.setSignature(apiKey);
+    const result = await this._callRPC("getKey", request);
+    return { authKey: result.getKey() };
+  }
   // This flow can be used where the signature is generate from outside, such as in front-end and pass in
   async authWithSignature(address, signature, expiredAtEpoch) {
-    console.log(
-      "Authenticating with signature:",
-      signature,
-      "Expired at epoch:",
-      expiredAtEpoch
-    );
     const request = new GetKeyReq();
     request.setOwner(address);
     request.setExpiredAt(expiredAtEpoch);
@@ -4580,10 +4558,13 @@ var BaseClient = class {
       "getKey",
       request
     );
-    this.setAuthKey(result.getKey());
-    return { jwtToken: result.getKey() };
+    return { authKey: result.getKey() };
   }
-  _callRPC(method, request) {
+  _callRPC(method, request, options) {
+    const metadata = import_lodash.default.cloneDeep(this.metadata);
+    if (options?.authKey) {
+      metadata.set(AUTH_KEY_HEADER, options.authKey);
+    }
     return new Promise((resolve, reject) => {
       this.rpcClient[method].bind(this.rpcClient)(
         request,
@@ -4600,11 +4581,10 @@ var Client = class extends BaseClient {
   constructor(config) {
     super(config);
   }
-  async getAddresses(address) {
+  async getAddresses(address, { authKey }) {
     const request = new AddressRequest();
     request.setOwner(address);
-    const result = await this._callRPC("getSmartAccountAddress", request);
-    console.log("getAddresses.result:", result);
+    const result = await this._callRPC("getSmartAccountAddress", request, { authKey });
     return {
       owner: address,
       smart_account_address: result.getSmartAccountAddress()
@@ -4637,11 +4617,9 @@ var Client = class extends BaseClient {
       import_ethers.ethers.parseUnits("12", 18)
     ]);
     execution.setCallData(callData);
-    console.log("execution:", execution.toObject());
     action.setContractExecution(execution);
     const request = new CreateTaskReq().setTrigger(trigger).setActionsList([action]).setExpiredAt(Math.floor(Date.now() / 1e3) + 1e6);
     const result = await this._callRPC("createTask", request);
-    console.log("createTask.result:", result.toObject());
     return {
       id: result.getId()
     };
@@ -4649,12 +4627,10 @@ var Client = class extends BaseClient {
   async listTasks(address) {
     const request = new ListTasksReq();
     const result = await this._callRPC("listTasks", request);
-    console.log("listTasks.result:", result.toObject());
     const tasks = import_lodash.default.map(
       result.getTasksList(),
       (obj) => new task_default(obj)
     );
-    console.log("listTasks.tasks:", tasks);
     return {
       tasks
     };
@@ -4668,7 +4644,6 @@ var Client = class extends BaseClient {
       "getTask",
       request
     );
-    console.log("getTask.result:", result.toObject());
     return result.toObject();
   }
   async cancelTask(id) {
@@ -4692,5 +4667,6 @@ var Client = class extends BaseClient {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  AUTH_KEY_HEADER,
   getKeyRequestMessage
 });

package/dist/index.mjs

@@ -4178,7 +4178,7 @@ var init_avs_pb = __esm({
 import _ from "lodash";
 import { ethers } from "ethers";
 import * as grpc2 from "@grpc/grpc-js";
-import { Metadata as Metadata2 } from "@grpc/grpc-js";
+import { Metadata } from "@grpc/grpc-js";
 
 // src/auth.ts
 var getKeyRequestMessage = (address, expiredAt) => {
@@ -4500,13 +4500,14 @@ var Task2 = class {
   constructor(task) {
     this.id = task.getId();
     this.status = task.getStatus().toString();
-    console.log("task.constructor:", task.toObject());
   }
 };
 var task_default = Task2;
 
+// src/types.ts
+var AUTH_KEY_HEADER = "authKey";
+
 // src/index.ts
-var metadata = new grpc2.Metadata();
 var BaseClient = class {
   constructor(opts) {
     this.endpoint = opts.endpoint;
@@ -4514,53 +4515,29 @@ var BaseClient = class {
       this.endpoint,
       grpc2.credentials.createInsecure()
     );
-    this.metadata = new Metadata2();
-  }
-  setAuthKey(jwtToken) {
-    metadata.add("authkey", jwtToken);
+    this.metadata = new Metadata();
   }
-  isAuthenticated() {
-    if (!metadata.get("authkey")) {
-      return false;
-    }
+  isAuthKeyValid(key) {
     try {
-      const [, payload] = metadata.get("authkey")[0].toString().split(".");
+      const [, payload] = key.split(".");
       const decodedPayload = JSON.parse(atob(payload));
       const currentTimestamp = Math.floor(Date.now() / 1e3);
       return decodedPayload.exp > currentTimestamp;
     } catch (error) {
-      console.error("Error validating JWT token:", error);
+      console.error("Error validating auth key:", error);
       return false;
     }
   }
-  // async authWithJwtToken(
-  //   address: string,
-  //   jwtToken: string,
-  //   expiredAt?: number
-  // ): Promise<KeyExchangeResp> {
-  //   console.log("Authenticating with JWT token: ", jwtToken);
-  //   // Use the provided expiredAt or set it to 24 hours from now if not provided
-  //   const expirationTime =
-  //     expiredAt || Math.floor(Date.now() / 1000) + DEFAULT_JWT_EXPIRATION;
-  //   const result: avsPb.KeyResp = await this._callRPC<
-  //     avsPb.KeyResp,
-  //     avsPb.GetKeyReq
-  //   >("getKey", {
-  //     owner: address,
-  //     expired_at: expirationTime,
-  //     signature: jwtToken,
-  //   });
-  //   this.jwtToken = result.getKey();
-  //   return { key: result.getKey() };
-  // }
+  async authWithAPIKey(apiKey, expiredAtEpoch) {
+    const request = new GetKeyReq();
+    request.setOwner("");
+    request.setExpiredAt(expiredAtEpoch);
+    request.setSignature(apiKey);
+    const result = await this._callRPC("getKey", request);
+    return { authKey: result.getKey() };
+  }
   // This flow can be used where the signature is generate from outside, such as in front-end and pass in
   async authWithSignature(address, signature, expiredAtEpoch) {
-    console.log(
-      "Authenticating with signature:",
-      signature,
-      "Expired at epoch:",
-      expiredAtEpoch
-    );
     const request = new GetKeyReq();
     request.setOwner(address);
     request.setExpiredAt(expiredAtEpoch);
@@ -4569,10 +4546,13 @@ var BaseClient = class {
       "getKey",
       request
     );
-    this.setAuthKey(result.getKey());
-    return { jwtToken: result.getKey() };
+    return { authKey: result.getKey() };
   }
-  _callRPC(method, request) {
+  _callRPC(method, request, options) {
+    const metadata = _.cloneDeep(this.metadata);
+    if (options?.authKey) {
+      metadata.set(AUTH_KEY_HEADER, options.authKey);
+    }
     return new Promise((resolve, reject) => {
       this.rpcClient[method].bind(this.rpcClient)(
         request,
@@ -4589,11 +4569,10 @@ var Client = class extends BaseClient {
   constructor(config) {
     super(config);
   }
-  async getAddresses(address) {
+  async getAddresses(address, { authKey }) {
     const request = new AddressRequest();
     request.setOwner(address);
-    const result = await this._callRPC("getSmartAccountAddress", request);
-    console.log("getAddresses.result:", result);
+    const result = await this._callRPC("getSmartAccountAddress", request, { authKey });
     return {
       owner: address,
       smart_account_address: result.getSmartAccountAddress()
@@ -4626,11 +4605,9 @@ var Client = class extends BaseClient {
       ethers.parseUnits("12", 18)
     ]);
     execution.setCallData(callData);
-    console.log("execution:", execution.toObject());
     action.setContractExecution(execution);
     const request = new CreateTaskReq().setTrigger(trigger).setActionsList([action]).setExpiredAt(Math.floor(Date.now() / 1e3) + 1e6);
     const result = await this._callRPC("createTask", request);
-    console.log("createTask.result:", result.toObject());
     return {
       id: result.getId()
     };
@@ -4638,12 +4615,10 @@ var Client = class extends BaseClient {
   async listTasks(address) {
     const request = new ListTasksReq();
     const result = await this._callRPC("listTasks", request);
-    console.log("listTasks.result:", result.toObject());
     const tasks = _.map(
       result.getTasksList(),
       (obj) => new task_default(obj)
     );
-    console.log("listTasks.tasks:", tasks);
     return {
       tasks
     };
@@ -4657,7 +4632,6 @@ var Client = class extends BaseClient {
       "getTask",
       request
     );
-    console.log("getTask.result:", result.toObject());
     return result.toObject();
   }
   async cancelTask(id) {
@@ -4680,6 +4654,7 @@ var Client = class extends BaseClient {
   }
 };
 export {
+  AUTH_KEY_HEADER,
   Client as default,
   getKeyRequestMessage
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avaprotocol/sdk-js",
-  "version": "0.6.12",
+  "version": "0.7.2",
   "description": "A JavaScript/TypeScript SDK designed to simplify integration with Ava Protocol's AVS",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -26,7 +26,9 @@
     "gen-protoc": "grpc_tools_node_protoc --js_out=import_style=commonjs,binary:./grpc_codegen/ --grpc_out=grpc_js:./grpc_codegen/ --plugin=protoc-gen-ts=./node_modules/.bin/protoc-gen-ts --ts_out=grpc_js:./grpc_codegen --proto_path=./grpc_codegen grpc_codegen/avs.proto",
     "build": "tsup src/index.ts --format cjs,esm --dts",
     "test": "jest --config jest.config.cjs",
-    "test:select": "npm run test -- --testNamePattern"
+    "test:select": "npm run test -- --testNamePattern",
+    "changeset": "changeset",
+    "version": "changeset version"
   },
   "dependencies": {
     "@grpc/grpc-js": "^1.11.3",
@@ -40,6 +42,7 @@
     "@babel/core": "^7.26.0",
     "@babel/preset-env": "^7.26.0",
     "@babel/preset-typescript": "^7.26.0",
+    "@changesets/cli": "^2.27.9",
     "@jest/globals": "^29.7.0",
     "@types/google-protobuf": "^3.15.12",
     "@types/jest": "^29.5.13",