@avaprotocol/sdk-js 0.7.2 → 0.8.0

package/README.md

@@ -33,9 +33,7 @@ import { AvaSDK } from "ava-sdk-js";
 
 ## Development
 
-### Regenerating gRPC Types
-
-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:
+### Install Dependencies and Download Proto Files
 
 ```bash
 npm install # install grpc-tools, etc. as dev dependencies
@@ -49,9 +47,10 @@ npm run proto-download
 
 # Generate the TypeScript types and gRPC code based on the downloaded .proto file
 npm run gen-protoc
-```
 
-> 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;`
+# Build the source files in to ./dist folder
+npm run build
+```
 
 ### Running Tests
 
@@ -64,39 +63,42 @@ To ensure the SDK is functioning correctly, we have a comprehensive test suite.
    ```
 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`.
+3. Bring up a locally environment for aggregator
 
    ```bash
-   # Run all tests
-   npm test
-
-   # or, run a specific test
-   npm run test:select -- <authWithSignature>
+   docker compose up -d --pull always
    ```
 
-4. In order to individually test `cancelTask` or `deleteTask`, `createTask` test needs to run first.
+   > By default the above command will pull the docker image of the latest commit on the `main` branch of https://github.com/AvaProtocol/EigenLayer-AVS. Alternatively, we could also run tests against a specific commit with the below command.
+   >
+   > ```
+   > export AVS_BUILD_VERSION=git-commit-hash-123
+   > docker compose up -d --pull always
+   > ```
+
+4. Generate a test API key for the local tests with the following command. It will automatically save the output to the `TEST_API_KEY` variable in `.env.test`.
+
    ```bash
-   npm run test:select -- "createTask|cancelTask"
+   npm run gen-apikey
    ```
 
-This will execute all unit and integration tests. Make sure all tests pass before submitting a pull request or deploying changes.
-
-## Version Management
+5. Run the test command with env variables set in `.env.test`.
 
-This project uses [Changesets](https://github.com/changesets/changesets) to manage versions and changelogs. To contribute changes:
+   ```bash
+   # Run all tests
+   npm test
 
-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.
+   # or, run a specific test
+   npm run test:select -- <authWithSignature>
+   ```
 
-To release a new version:
+   > Note: In order to individually test `cancelTask` or `deleteTask`, `createTask` test needs to run first.
 
-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.
+   > ```bash
+   > npm run test:select -- "createTask|cancelTask"
+   > ```
 
-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).
+   This will execute all unit and integration tests. Make sure all tests pass in local dev environment before submitting a pull request or deploying changes.
 
 ## Release Process
 
@@ -120,10 +122,10 @@ This repository uses a two-step workflow process for creating new releases:
 
 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:
+1. Publish a dev version and test it in your local environment. The `npm publish` will use the version number in `package.json`, so run `npm version prerelease --preid=dev` first if you need a new version number.
 
    ```bash
-   # Update version with dev tag in package.json
+   # Optionally, update version with dev tag in package.json
    npm version prerelease --preid=dev
 
    # Publish to npm with dev tag