@avaprotocol/sdk-js 0.7.1 → 0.7.2

package/README.md

@@ -103,6 +103,7 @@ For more detailed information on using Changesets, refer to the [Changesets docu
 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)
@@ -112,15 +113,19 @@ This repository uses a two-step workflow process for creating new releases:
 
 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
 
-### NPM Publishing
+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.
 
-The NPM publishing should 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
    ```
@@ -131,8 +136,6 @@ The NPM publishing should be handled manually, since the test cases reference th
    npm publish
    ```
 
-> **Note**: Make sure to run these workflows in order. The Version Bump workflow must complete successfully before running the Create Release workflow.
-
 ### Utility Scripts
 
 To generate the key request message for signing, you can run the following command:

package/dist/index.d.mts

@@ -1458,8 +1458,11 @@ 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 {
-    key: string;
+    authKey: string;
 }
 interface ClientOption {
     endpoint: string;
@@ -1493,16 +1496,16 @@ declare class BaseClient {
     readonly rpcClient: AggregatorClient;
     protected metadata: Metadata;
     constructor(opts: ClientOption);
-    setAuthKey(key: string): void;
-    getAuthKey(): string | undefined;
-    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;
@@ -1514,4 +1517,4 @@ declare class Client extends BaseClient {
     deleteTask(id: string): Promise<boolean>;
 }
 
-export { AUTH_KEY_HEADER, 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

@@ -1458,8 +1458,11 @@ 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 {
-    key: string;
+    authKey: string;
 }
 interface ClientOption {
     endpoint: string;
@@ -1493,16 +1496,16 @@ declare class BaseClient {
     readonly rpcClient: AggregatorClient;
     protected metadata: Metadata;
     constructor(opts: ClientOption);
-    setAuthKey(key: string): void;
-    getAuthKey(): string | undefined;
-    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;
@@ -1514,4 +1517,4 @@ declare class Client extends BaseClient {
     deleteTask(id: string): Promise<boolean>;
 }
 
-export { AUTH_KEY_HEADER, 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

@@ -4529,25 +4529,14 @@ var BaseClient = class {
     );
     this.metadata = new import_grpc_js.Metadata();
   }
-  setAuthKey(key) {
-    this.metadata.add(AUTH_KEY_HEADER, key);
-  }
-  getAuthKey() {
-    const authKey = this.metadata.get(AUTH_KEY_HEADER);
-    return authKey?.[0]?.toString();
-  }
-  isAuthenticated() {
-    const authKey = this.getAuthKey();
-    if (!authKey) {
-      return false;
-    }
+  isAuthKeyValid(key) {
     try {
-      const [, payload] = authKey.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;
     }
   }
@@ -4557,8 +4546,7 @@ var BaseClient = class {
     request.setExpiredAt(expiredAtEpoch);
     request.setSignature(apiKey);
     const result = await this._callRPC("getKey", request);
-    this.setAuthKey(result.getKey());
-    return { key: result.getKey() };
+    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) {
@@ -4570,14 +4558,17 @@ var BaseClient = class {
       "getKey",
       request
     );
-    this.setAuthKey(result.getKey());
-    return { key: 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,
-        this.metadata,
+        metadata,
         (error, response) => {
           if (error) reject(error);
           else resolve(response);
@@ -4590,10 +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);
+    const result = await this._callRPC("getSmartAccountAddress", request, { authKey });
     return {
       owner: address,
       smart_account_address: result.getSmartAccountAddress()

package/dist/index.mjs

@@ -4517,25 +4517,14 @@ var BaseClient = class {
     );
     this.metadata = new Metadata();
   }
-  setAuthKey(key) {
-    this.metadata.add(AUTH_KEY_HEADER, key);
-  }
-  getAuthKey() {
-    const authKey = this.metadata.get(AUTH_KEY_HEADER);
-    return authKey?.[0]?.toString();
-  }
-  isAuthenticated() {
-    const authKey = this.getAuthKey();
-    if (!authKey) {
-      return false;
-    }
+  isAuthKeyValid(key) {
     try {
-      const [, payload] = authKey.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;
     }
   }
@@ -4545,8 +4534,7 @@ var BaseClient = class {
     request.setExpiredAt(expiredAtEpoch);
     request.setSignature(apiKey);
     const result = await this._callRPC("getKey", request);
-    this.setAuthKey(result.getKey());
-    return { key: result.getKey() };
+    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) {
@@ -4558,14 +4546,17 @@ var BaseClient = class {
       "getKey",
       request
     );
-    this.setAuthKey(result.getKey());
-    return { key: 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,
-        this.metadata,
+        metadata,
         (error, response) => {
           if (error) reject(error);
           else resolve(response);
@@ -4578,10 +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);
+    const result = await this._callRPC("getSmartAccountAddress", request, { authKey });
     return {
       owner: address,
       smart_account_address: result.getSmartAccountAddress()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avaprotocol/sdk-js",
-  "version": "0.7.1",
+  "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",