Skip to content

Commit 347b045

Browse files
docs: address post-merge review of #217 (3.0.0 release) (#218)
Co-authored-by: Wei Lin <wei@avaprotocol.org>
1 parent 38f4289 commit 347b045

4 files changed

Lines changed: 20 additions & 8 deletions

File tree

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,13 @@
44

55
> **3.0.0 is a REST-only rewrite.** The 2.x line spoke gRPC; the 3.x line speaks the aggregator gateway's `/api/v1/...` REST API. The `4.0.0-dev.X` versions on npm are pre-release iterations of this rewrite that we ultimately stabilized as `3.0.0` to keep semver continuity from 2.x — see [packages/sdk-js/CHANGELOG.md](./packages/sdk-js/CHANGELOG.md) for the full rationale. The sections below still describe the 2.x gRPC client; an updated quick-start for the 3.x REST client is tracked in a follow-up doc PR.
66
7-
`ava-sdk-js` is a simple, type-safe wrapper around gRPC designed to simplify integration with Ava Protocol's AVS. It enables developers to interact with Ava Protocol efficiently, whether on the client-side or server-side, and provides full TypeScript support for a seamless development experience.
7+
> **[2.x — archived]** `ava-sdk-js` was a simple, type-safe wrapper around gRPC designed to simplify integration with Ava Protocol's AVS. It enabled developers to interact with Ava Protocol efficiently, whether on the client-side or server-side, and provided full TypeScript support for a seamless development experience.
8+
9+
---
10+
11+
## Archived 2.x documentation
12+
13+
The sections below describe the 2.x gRPC client and are kept for users still on that line. The 3.x REST client documentation is tracked in a follow-up doc PR; in the meantime see the [packages/sdk-js/CHANGELOG.md](./packages/sdk-js/CHANGELOG.md) for what changed between 2.x and 3.x.
814

915
## Features
1016

packages/sdk-js/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,13 @@
44

55
> **3.0.0 is a REST-only rewrite.** The 2.x line spoke gRPC; the 3.x line speaks the aggregator gateway's `/api/v1/...` REST API. The `4.0.0-dev.X` versions on npm are pre-release iterations of this rewrite that we ultimately stabilized as `3.0.0` to keep semver continuity from 2.x — see [CHANGELOG.md](./CHANGELOG.md) for the full rationale. The README sections below still describe the 2.x gRPC client; an updated quick-start for the 3.x REST client is tracked in a follow-up doc PR.
66
7-
`@avaprotocol/sdk-js` is a simple, type-safe wrapper around gRPC designed to simplify integration with Ava Protocol's AVS. It enables developers to interact with Ava Protocol efficiently, whether on the client-side or server-side, and provides full TypeScript support for a seamless development experience.
7+
> **[2.x — archived]** `@avaprotocol/sdk-js` was a simple, type-safe wrapper around gRPC designed to simplify integration with Ava Protocol's AVS. It enabled developers to interact with Ava Protocol efficiently, whether on the client-side or server-side, and provided full TypeScript support for a seamless development experience.
8+
9+
---
10+
11+
## Archived 2.x documentation
12+
13+
The sections below describe the 2.x gRPC client and are kept for users still on that line. The 3.x REST client documentation is tracked in a follow-up doc PR; in the meantime see the [CHANGELOG](./CHANGELOG.md) for what changed between 2.x and 3.x.
814

915
## Features
1016

packages/sdk-js/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@avaprotocol/sdk-js",
33
"version": "3.0.0",
4-
"description": "TypeScript SDK for Ava Protocol's AVS REST API (v4). Resource-grouped sub-clients, fetch transport, EIP-191 auth.",
4+
"description": "TypeScript SDK for Ava Protocol's AVS REST API. Resource-grouped sub-clients, fetch transport, EIP-191 auth.",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",
77
"files": [

packages/sdk-js/src/v4/protocols/index.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
// Protocol catalog re-export.
22
//
3-
// As of 3.0.0 the actual address/ABI/topic data lives in the
4-
// standalone `@avaprotocol/protocols` package — the SDK ships a thin
5-
// re-export so consumers don't have to install a second package and
6-
// the existing `import { Protocols } from "@avaprotocol/sdk-js"`
7-
// surface keeps working.
3+
// Address/ABI/topic data lives in the standalone
4+
// `@avaprotocol/protocols` package — the SDK ships a thin re-export
5+
// so consumers don't have to install a second package and the
6+
// existing `import { Protocols } from "@avaprotocol/sdk-js"` surface
7+
// keeps working.
88
//
99
// Update `@avaprotocol/protocols` (https://github.com/AvaProtocol/protocols)
1010
// when a new protocol address lands or a new chain comes online;

0 commit comments

Comments
 (0)