@avaprotocol/sdk-js 0.6.11 → 0.7.1

package/README.md

@@ -38,46 +38,100 @@ import { AvaSDK } from "ava-sdk-js";
 In the case of `.proto` files at https://github.com/AvaProtocol/EigenLayer-AVS/blob/main/protobuf/avs.proto changes, the gRPC types needs to be regenerated.Before regenerating the types from the protocol buffers, ensure that `grpc_tools_node_protoc` is installed globally on your system. You can install it using npm:
 
 ```bash
-npm install -g grpc-tools
+npm install # install grpc-tools, etc. as dev dependencies
 ```
 
 Then, run the following command to regenerate the types:
 
 ```bash
+# download the latest .proto file from https://github.com/AvaProtocol/EigenLayer-AVS
+npm run proto-download
+
+# Generate the TypeScript types and gRPC code based on the downloaded .proto file
 npm run gen-protoc
 ```
 
-This will automatically download the latest `.proto` file from https://github.com/AvaProtocol/EigenLayer-AVS and generate the updated TypeScript types and gRPC code, ensuring that all changes are reflected in the SDK.
+> Important: the last line of the `grpc_codegen/avs_pb.js` needs to be manually added after the `gen-protoc` command. These type definitions must be exported; otherwise they will be undefined in the SDK. For example: `export const { Task, CreateTaskReq, CreateTaskResp, GetKeyReq, KeyResp, UpdateChecksReq, UpdateChecksResp, AddressResp, AddressRequest } = proto.aggregator;`
 
 ### Running Tests
 
 To ensure the SDK is functioning correctly, we have a comprehensive test suite. Follow these steps to run the tests:
 
-1. Make sure all dependencies are installed:
+1. Make sure all dependencies are installed, and build the project. Tests are run against the files in the `/dist` folder
    ```bash
    npm install
+   npm run build
    ```
+2. Before running the e2e tests, make sure to configure the required environment variables in your `.env.test` file, based on the `.env.example` file.
+
+3. Run the test command. This will test the SDK against test server, configured in `.env.test`.
 
-2. Run the test command. This will test the SDK against mockup responses.
    ```bash
+   # Run all tests
    npm test
+
+   # or, run a specific test
+   npm run test:select -- <authWithSignature>
    ```
-   
-3. To test the SDK against the live AVS on Ethereum Mainnet, you can run the following command:
+
+4. In order to individually test `cancelTask` or `deleteTask`, `createTask` test needs to run first.
    ```bash
-   npm run test:e2e
+   npm run test:select -- "createTask|cancelTask"
    ```
 
-   Before running the e2e tests, make sure to configure the required TEST values in your `.env` file:
+This will execute all unit and integration tests. Make sure all tests pass before submitting a pull request or deploying changes.
+
+## Version Management
 
-   ```
-   TEST_JWT_TOKEN=your_TEST_JWT_TOKEN_here
-   TEST_OWNER=your_test_owner_here
+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`.
+
+### NPM Publishing
+
+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
    ```
 
-   Replace `your_TEST_JWT_TOKEN_here` with a valid JWT API key and `your_test_owner_here` with the appropriate owner address for testing.
+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
+   ```
 
-This will execute all unit and integration tests. Make sure all tests pass before submitting a pull request or deploying changes.
+> **Note**: Make sure to run these workflows in order. The Version Bump workflow must complete successfully before running the Create Release workflow.
 
 ### Utility Scripts
 

package/dist/index.d.mts

@@ -1,4 +1,5 @@
 import * as grpc from '@grpc/grpc-js';
+import { Metadata } from '@grpc/grpc-js';
 import * as jspb from 'google-protobuf';
 import * as google_protobuf_timestamp_pb from 'google-protobuf/google/protobuf/timestamp_pb';
 import * as google_protobuf_wrappers_pb from 'google-protobuf/google/protobuf/wrappers_pb';
@@ -565,53 +566,53 @@ declare namespace Execution {
     }
 }
 
-declare class Task extends jspb.Message { 
+declare class Task$1 extends jspb.Message { 
 
     hasId(): boolean;
     clearId(): void;
     getId(): UUID | undefined;
-    setId(value?: UUID): Task;
+    setId(value?: UUID): Task$1;
     getOwner(): string;
-    setOwner(value: string): Task;
+    setOwner(value: string): Task$1;
     getSmartAccountAddress(): string;
-    setSmartAccountAddress(value: string): Task;
+    setSmartAccountAddress(value: string): Task$1;
 
     hasTrigger(): boolean;
     clearTrigger(): void;
     getTrigger(): TaskTrigger | undefined;
-    setTrigger(value?: TaskTrigger): Task;
+    setTrigger(value?: TaskTrigger): Task$1;
     clearNodesList(): void;
     getNodesList(): Array<TaskAction>;
-    setNodesList(value: Array<TaskAction>): Task;
+    setNodesList(value: Array<TaskAction>): Task$1;
     addNodes(value?: TaskAction, index?: number): TaskAction;
     getStartAt(): number;
-    setStartAt(value: number): Task;
+    setStartAt(value: number): Task$1;
     getExpiredAt(): number;
-    setExpiredAt(value: number): Task;
+    setExpiredAt(value: number): Task$1;
     getMemo(): string;
-    setMemo(value: string): Task;
+    setMemo(value: string): Task$1;
     getCompletedAt(): number;
-    setCompletedAt(value: number): Task;
+    setCompletedAt(value: number): Task$1;
     getStatus(): TaskStatus;
-    setStatus(value: TaskStatus): Task;
+    setStatus(value: TaskStatus): Task$1;
     getRepeatable(): boolean;
-    setRepeatable(value: boolean): Task;
+    setRepeatable(value: boolean): Task$1;
     clearExecutionsList(): void;
     getExecutionsList(): Array<Execution>;
-    setExecutionsList(value: Array<Execution>): Task;
+    setExecutionsList(value: Array<Execution>): Task$1;
     addExecutions(value?: Execution, index?: number): Execution;
 
     serializeBinary(): Uint8Array;
-    toObject(includeInstance?: boolean): Task.AsObject;
-    static toObject(includeInstance: boolean, msg: Task): Task.AsObject;
+    toObject(includeInstance?: boolean): Task$1.AsObject;
+    static toObject(includeInstance: boolean, msg: Task$1): Task$1.AsObject;
     static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
     static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
-    static serializeBinaryToWriter(message: Task, writer: jspb.BinaryWriter): void;
-    static deserializeBinary(bytes: Uint8Array): Task;
-    static deserializeBinaryFromReader(message: Task, reader: jspb.BinaryReader): Task;
+    static serializeBinaryToWriter(message: Task$1, writer: jspb.BinaryWriter): void;
+    static deserializeBinary(bytes: Uint8Array): Task$1;
+    static deserializeBinaryFromReader(message: Task$1, reader: jspb.BinaryReader): Task$1;
 }
 
-declare namespace Task {
+declare namespace Task$1 {
     export type AsObject = {
         id?: UUID.AsObject,
         owner: string,
@@ -1087,18 +1088,18 @@ interface IAggregatorClient {
   ): grpc.ClientUnaryCall;
   getTask(
     request: UUID,
-    callback: (error: grpc.ServiceError | null, response: Task) => void
+    callback: (error: grpc.ServiceError | null, response: Task$1) => void
   ): grpc.ClientUnaryCall;
   getTask(
     request: UUID,
     metadata: grpc.Metadata,
-    callback: (error: grpc.ServiceError | null, response: Task) => void
+    callback: (error: grpc.ServiceError | null, response: Task$1) => void
   ): grpc.ClientUnaryCall;
   getTask(
     request: UUID,
     metadata: grpc.Metadata,
     options: Partial<grpc.CallOptions>,
-    callback: (error: grpc.ServiceError | null, response: Task) => void
+    callback: (error: grpc.ServiceError | null, response: Task$1) => void
   ): grpc.ClientUnaryCall;
   cancelTask(
     request: UUID,
@@ -1335,18 +1336,18 @@ declare class AggregatorClient extends grpc.Client implements IAggregatorClient
   ): grpc.ClientUnaryCall;
   public getTask(
     request: UUID,
-    callback: (error: grpc.ServiceError | null, response: Task) => void
+    callback: (error: grpc.ServiceError | null, response: Task$1) => void
   ): grpc.ClientUnaryCall;
   public getTask(
     request: UUID,
     metadata: grpc.Metadata,
-    callback: (error: grpc.ServiceError | null, response: Task) => void
+    callback: (error: grpc.ServiceError | null, response: Task$1) => void
   ): grpc.ClientUnaryCall;
   public getTask(
     request: UUID,
     metadata: grpc.Metadata,
     options: Partial<grpc.CallOptions>,
-    callback: (error: grpc.ServiceError | null, response: Task) => void
+    callback: (error: grpc.ServiceError | null, response: Task$1) => void
   ): grpc.ClientUnaryCall;
   public cancelTask(
     request: UUID,
@@ -1456,24 +1457,28 @@ declare class AggregatorClient extends grpc.Client implements IAggregatorClient
 }
 
 type Environment = "production" | "development" | "staging";
-interface KeyExchangeResp {
+declare const AUTH_KEY_HEADER = "authKey";
+interface GetKeyResponse {
     key: string;
 }
 interface ClientOption {
     endpoint: string;
     jwtApiKey?: string;
 }
-interface TaskResp {
+interface Task {
     id: string;
     status: string;
     result?: any;
     error?: string;
 }
-interface TaskListResp {
-    tasks: TaskResp[];
+interface CreateTaskResponse {
+    id: string;
+}
+interface ListTasksResponse {
+    tasks: Task[];
 }
-interface SmartWalletResp {
-    address: string;
+interface GetAddressesResponse {
+    owner: string;
     smart_account_address: string;
 }
 interface TransactionResp {
@@ -1486,14 +1491,27 @@ interface BalanceResp {
 declare class BaseClient {
     readonly endpoint: string;
     readonly rpcClient: AggregatorClient;
-    protected authkey?: string;
+    protected metadata: Metadata;
     constructor(opts: ClientOption);
-    authWithSignature(address: string, signature: string, expiredAtEpoch: number): Promise<KeyExchangeResp>;
+    setAuthKey(key: string): void;
+    getAuthKey(): string | undefined;
     isAuthenticated(): 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>;
 }
 declare class Client extends BaseClient {
     constructor(config: ClientOption);
-}
-
-export { type BalanceResp, type ClientOption, type Environment, type KeyExchangeResp, type SmartWalletResp, type TaskListResp, type TaskResp, type TransactionResp, Client as default, getKeyRequestMessage };
+    getAddresses(address: string): Promise<GetAddressesResponse>;
+    createTask({ address, oracleContract, tokenContract, }: {
+        address: string;
+        tokenContract: string;
+        oracleContract: string;
+    }): Promise<CreateTaskResponse>;
+    listTasks(address: string): Promise<ListTasksResponse>;
+    getTask(id: string): Promise<object>;
+    cancelTask(id: string): Promise<boolean>;
+    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 };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import * as grpc from '@grpc/grpc-js';
+import { Metadata } from '@grpc/grpc-js';
 import * as jspb from 'google-protobuf';
 import * as google_protobuf_timestamp_pb from 'google-protobuf/google/protobuf/timestamp_pb';
 import * as google_protobuf_wrappers_pb from 'google-protobuf/google/protobuf/wrappers_pb';
@@ -565,53 +566,53 @@ declare namespace Execution {
     }
 }
 
-declare class Task extends jspb.Message { 
+declare class Task$1 extends jspb.Message { 
 
     hasId(): boolean;
     clearId(): void;
     getId(): UUID | undefined;
-    setId(value?: UUID): Task;
+    setId(value?: UUID): Task$1;
     getOwner(): string;
-    setOwner(value: string): Task;
+    setOwner(value: string): Task$1;
     getSmartAccountAddress(): string;
-    setSmartAccountAddress(value: string): Task;
+    setSmartAccountAddress(value: string): Task$1;
 
     hasTrigger(): boolean;
     clearTrigger(): void;
     getTrigger(): TaskTrigger | undefined;
-    setTrigger(value?: TaskTrigger): Task;
+    setTrigger(value?: TaskTrigger): Task$1;
     clearNodesList(): void;
     getNodesList(): Array<TaskAction>;
-    setNodesList(value: Array<TaskAction>): Task;
+    setNodesList(value: Array<TaskAction>): Task$1;
     addNodes(value?: TaskAction, index?: number): TaskAction;
     getStartAt(): number;
-    setStartAt(value: number): Task;
+    setStartAt(value: number): Task$1;
     getExpiredAt(): number;
-    setExpiredAt(value: number): Task;
+    setExpiredAt(value: number): Task$1;
     getMemo(): string;
-    setMemo(value: string): Task;
+    setMemo(value: string): Task$1;
     getCompletedAt(): number;
-    setCompletedAt(value: number): Task;
+    setCompletedAt(value: number): Task$1;
     getStatus(): TaskStatus;
-    setStatus(value: TaskStatus): Task;
+    setStatus(value: TaskStatus): Task$1;
     getRepeatable(): boolean;
-    setRepeatable(value: boolean): Task;
+    setRepeatable(value: boolean): Task$1;
     clearExecutionsList(): void;
     getExecutionsList(): Array<Execution>;
-    setExecutionsList(value: Array<Execution>): Task;
+    setExecutionsList(value: Array<Execution>): Task$1;
     addExecutions(value?: Execution, index?: number): Execution;
 
     serializeBinary(): Uint8Array;
-    toObject(includeInstance?: boolean): Task.AsObject;
-    static toObject(includeInstance: boolean, msg: Task): Task.AsObject;
+    toObject(includeInstance?: boolean): Task$1.AsObject;
+    static toObject(includeInstance: boolean, msg: Task$1): Task$1.AsObject;
     static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
     static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
-    static serializeBinaryToWriter(message: Task, writer: jspb.BinaryWriter): void;
-    static deserializeBinary(bytes: Uint8Array): Task;
-    static deserializeBinaryFromReader(message: Task, reader: jspb.BinaryReader): Task;
+    static serializeBinaryToWriter(message: Task$1, writer: jspb.BinaryWriter): void;
+    static deserializeBinary(bytes: Uint8Array): Task$1;
+    static deserializeBinaryFromReader(message: Task$1, reader: jspb.BinaryReader): Task$1;
 }
 
-declare namespace Task {
+declare namespace Task$1 {
     export type AsObject = {
         id?: UUID.AsObject,
         owner: string,
@@ -1087,18 +1088,18 @@ interface IAggregatorClient {
   ): grpc.ClientUnaryCall;
   getTask(
     request: UUID,
-    callback: (error: grpc.ServiceError | null, response: Task) => void
+    callback: (error: grpc.ServiceError | null, response: Task$1) => void
   ): grpc.ClientUnaryCall;
   getTask(
     request: UUID,
     metadata: grpc.Metadata,
-    callback: (error: grpc.ServiceError | null, response: Task) => void
+    callback: (error: grpc.ServiceError | null, response: Task$1) => void
   ): grpc.ClientUnaryCall;
   getTask(
     request: UUID,
     metadata: grpc.Metadata,
     options: Partial<grpc.CallOptions>,
-    callback: (error: grpc.ServiceError | null, response: Task) => void
+    callback: (error: grpc.ServiceError | null, response: Task$1) => void
   ): grpc.ClientUnaryCall;
   cancelTask(
     request: UUID,
@@ -1335,18 +1336,18 @@ declare class AggregatorClient extends grpc.Client implements IAggregatorClient
   ): grpc.ClientUnaryCall;
   public getTask(
     request: UUID,
-    callback: (error: grpc.ServiceError | null, response: Task) => void
+    callback: (error: grpc.ServiceError | null, response: Task$1) => void
   ): grpc.ClientUnaryCall;
   public getTask(
     request: UUID,
     metadata: grpc.Metadata,
-    callback: (error: grpc.ServiceError | null, response: Task) => void
+    callback: (error: grpc.ServiceError | null, response: Task$1) => void
   ): grpc.ClientUnaryCall;
   public getTask(
     request: UUID,
     metadata: grpc.Metadata,
     options: Partial<grpc.CallOptions>,
-    callback: (error: grpc.ServiceError | null, response: Task) => void
+    callback: (error: grpc.ServiceError | null, response: Task$1) => void
   ): grpc.ClientUnaryCall;
   public cancelTask(
     request: UUID,
@@ -1456,24 +1457,28 @@ declare class AggregatorClient extends grpc.Client implements IAggregatorClient
 }
 
 type Environment = "production" | "development" | "staging";
-interface KeyExchangeResp {
+declare const AUTH_KEY_HEADER = "authKey";
+interface GetKeyResponse {
     key: string;
 }
 interface ClientOption {
     endpoint: string;
     jwtApiKey?: string;
 }
-interface TaskResp {
+interface Task {
     id: string;
     status: string;
     result?: any;
     error?: string;
 }
-interface TaskListResp {
-    tasks: TaskResp[];
+interface CreateTaskResponse {
+    id: string;
+}
+interface ListTasksResponse {
+    tasks: Task[];
 }
-interface SmartWalletResp {
-    address: string;
+interface GetAddressesResponse {
+    owner: string;
     smart_account_address: string;
 }
 interface TransactionResp {
@@ -1486,14 +1491,27 @@ interface BalanceResp {
 declare class BaseClient {
     readonly endpoint: string;
     readonly rpcClient: AggregatorClient;
-    protected authkey?: string;
+    protected metadata: Metadata;
     constructor(opts: ClientOption);
-    authWithSignature(address: string, signature: string, expiredAtEpoch: number): Promise<KeyExchangeResp>;
+    setAuthKey(key: string): void;
+    getAuthKey(): string | undefined;
     isAuthenticated(): 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>;
 }
 declare class Client extends BaseClient {
     constructor(config: ClientOption);
-}
-
-export { type BalanceResp, type ClientOption, type Environment, type KeyExchangeResp, type SmartWalletResp, type TaskListResp, type TaskResp, type TransactionResp, Client as default, getKeyRequestMessage };
+    getAddresses(address: string): Promise<GetAddressesResponse>;
+    createTask({ address, oracleContract, tokenContract, }: {
+        address: string;
+        tokenContract: string;
+        oracleContract: string;
+    }): Promise<CreateTaskResponse>;
+    listTasks(address: string): Promise<ListTasksResponse>;
+    getTask(id: string): Promise<object>;
+    cancelTask(id: string): Promise<boolean>;
+    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 };