Skip to content

refactor(api): remove deprecated version endpoint and update documentation to reflect changes in public config endpoint #1960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
djstrong merged 2 commits into from
Apr 20, 2026
Merged

refactor(api): remove deprecated version endpoint and update documentation to reflect changes in public config endpoint #1960

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d56f0c
refactor(api): remove deprecated version endpoint and update document…
djstrong Apr 20, 2026
d42ad67
chore(ensrainbow): remove deprecated version method and update docume…
djstrong Apr 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/odd-seahorses-sleep.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@ensnode/ensrainbow-sdk": minor
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps Bot Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Breaking change versioned as minor

Removing the public version() method from @ensnode/ensrainbow-sdk is a breaking API change — any consumer calling client.version() will get a runtime TypeError: client.version is not a function after upgrading. Under semver, this requires a major bump, not minor, regardless of the prior @deprecated annotation.

Suggested change
"@ensnode/ensrainbow-sdk": minor
"@ensnode/ensrainbow-sdk": major

---

Remove deprecated ENSRainbow `version()` client method and `Version*` types (the `/v1/version` endpoint has been removed in favor of `/v1/config`).

17 changes: 0 additions & 17 deletions apps/ensrainbow/src/commands/server-command.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,20 +157,6 @@ describe("Server Command Tests", () => {
});
});

describe("GET /v1/version", () => {
it("should return version information", async () => {
const response = await fetch(`http://localhost:${nonDefaultPort}/v1/version`);
expect(response.status).toBe(200);
const data = await response.json();

expect(data.status).toEqual(StatusCode.Success);
expect(typeof data.versionInfo.version).toBe("string");
expect(typeof data.versionInfo.dbSchemaVersion).toBe("number");
expect(typeof data.versionInfo.labelSet.labelSetId).toBe("string");
expect(typeof data.versionInfo.labelSet.highestLabelSetVersion).toBe("number");
});
});

describe("GET /v1/config", () => {
it("should return config snapshot from startup", async () => {
// The config is built once on startup with count = 0 (set in beforeAll)
Expand Down Expand Up @@ -229,9 +215,6 @@ describe("Server Command Tests", () => {
fetch(`http://localhost:${nonDefaultPort}/v1/config`, {
method: "OPTIONS",
}),
fetch(`http://localhost:${nonDefaultPort}/v1/version`, {
method: "OPTIONS",
}),
]);

for (const response of responses) {
Expand Down
18 changes: 0 additions & 18 deletions apps/ensrainbow/src/lib/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
import packageJson from "@/../package.json" with { type: "json" };

import type { Context as HonoContext } from "hono";
import { Hono } from "hono";
import { cors } from "hono/cors";
Expand All @@ -14,7 +12,6 @@ import {
} from "@ensnode/ensnode-sdk";
import { type EnsRainbow, ErrorCode, StatusCode } from "@ensnode/ensrainbow-sdk";

import { DB_SCHEMA_VERSION } from "@/lib/database";
import type { ENSRainbowServer } from "@/lib/server";
import { getErrorMessage } from "@/utils/error-utils";
import { logger } from "@/utils/logger";
Expand Down Expand Up @@ -102,20 +99,5 @@ export function createApi(
return c.json(publicConfig);
});

/**
* @deprecated Use GET /v1/config instead. This endpoint will be removed in a future version.
*/
api.get("/v1/version", (c: HonoContext) => {
const result: EnsRainbow.VersionResponse = {
status: StatusCode.Success,
versionInfo: {
version: packageJson.version,
dbSchemaVersion: DB_SCHEMA_VERSION,
labelSet: server.serverLabelSet,
},
};
return c.json(result);
});

return api;
}
4 changes: 2 additions & 2 deletions docs/ensnode.io/src/content/docs/ensrainbow/concepts/versioning.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ sidebar:
ENSRainbow uses **three distinct version numbers**—each serving a different purpose.

## 1. ENSRainbow Software Version
The semantic version of the Node.js application itself (e.g. `v0.4.2`).
The semantic version of the Node.js application itself (e.g. `0.4.2`).
- Bumped when new features, fixes, or breaking changes are released.
- Shown in `/v1/version` under the `version` field.
- Shown in `/v1/config` under the `version` field.

## 2. Database Schema Version (`DB_SCHEMA_VERSION`)
Specifies the expected on-disk structure of the LevelDB database as well as the expected format of the downloadable pre-built LevelDB databases.
Expand Down
2 changes: 1 addition & 1 deletion docs/ensnode.io/src/content/docs/ensrainbow/contributing/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ For focused guidance on specific topics, check out these dedicated pages:

Follow these steps to start contributing to ENSRainbow:

1. **Follow ENSNode's [contribution guide](/docs/contributing/)** to prepare your workspace environment & install dependencies
1. **Follow ENSNode's [contribution guide](/docs/contributing)** to prepare your workspace environment & install dependencies
2. **Choose your development path** using the focused guides above
3. **Start with [Local Development](/ensrainbow/contributing/local-development/)** for the quickest way to get ENSRainbow running locally

Expand Down
13 changes: 6 additions & 7 deletions docs/ensnode.io/src/content/docs/ensrainbow/usage/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sidebar:
| `GET /health` | Liveness probe for orchestration | `{ status: "ok" }` |
| `GET /v1/heal/{labelhash}` | Heal a single labelhash | `HealSuccess`, `HealError` |
| `GET /v1/labels/count` | Current healable label count | `CountSuccess`, `CountServerError` |
| `GET /v1/version` | Server & database schema info plus label set details | `VersionInfo` |
| `GET /v1/config` | Public service config (version, label set, records count) | `EnsRainbowPublicConfig` |

:::tip[Deterministic Results]
Pin `labelSetVersion` in your client if you need **deterministic results** across time. See the [Label Sets & Versioning guide](/ensrainbow/concepts/label-sets-and-versioning/) for details.
Expand Down Expand Up @@ -148,29 +148,28 @@ Success Response:
}
```

## Get Version Information
## Get Public Config

```bash
curl https://api.ensrainbow.io/v1/version
curl https://api.ensrainbow.io/v1/config
```

Success Response:

```json
{
"status": "success",
"version": "0.1.0",
"dbSchemaVersion": 3,
"labelSet": {
"labelSetId": "subgraph",
"highestLabelSetVersion": 0
}
},
"recordsCount": 133856894
}
```

The response contains:
- `version`: The current version of ENSRainbow
- `dbSchemaVersion`: The current schema version of the database
- `labelSet`: The label set of the loaded database
- `labelSetId`: The label set ID of the loaded database
- `highestLabelSetVersion`: The highest label set version available in the database
- `recordsCount`: The total count of labels that can be healed by the ENSRainbow instance
24 changes: 0 additions & 24 deletions packages/ensrainbow-sdk/src/client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,30 +271,6 @@ describe("EnsRainbowApiClient", () => {
} satisfies EnsRainbow.HealthResponse);
});

it("should return version information", async () => {
mockFetch.mockResolvedValueOnce({
json: () =>
Promise.resolve({
status: StatusCode.Success,
versionInfo: {
version: "1.0.0",
dbSchemaVersion: 1,
labelSet: {
labelSetId: "test-label-set-id",
highestLabelSetVersion: 123,
},
},
} satisfies EnsRainbow.VersionResponse),
});

const response = await client.version();

expect(response satisfies EnsRainbow.VersionResponse).toBeTruthy();
expect(response.status).toEqual(StatusCode.Success);
expect(typeof response.versionInfo.version === "string").toBeTruthy();
expect(typeof response.versionInfo.dbSchemaVersion === "number").toBeTruthy();
});

describe("config", () => {
it("should request /v1/config and return public config on success", async () => {
const configData: EnsRainbow.ENSRainbowPublicConfig = {
Expand Down
72 changes: 0 additions & 72 deletions packages/ensrainbow-sdk/src/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import {
type Cache,
type EnsRainbowClientLabelSet,
type EnsRainbowPublicConfig,
type EnsRainbowServerLabelSet,
LruCache,
} from "@ensnode/ensnode-sdk";

Expand All @@ -33,13 +32,6 @@ export namespace EnsRainbow {

health(): Promise<HealthResponse>;

/**
* Get the version information of the ENSRainbow service
*
* @deprecated Use {@link ApiClient.config} instead. This method will be removed in a future version.
*/
version(): Promise<VersionResponse>;

getOptions(): Readonly<EnsRainbowApiClientOptions>;
}
Comment thread
djstrong marked this conversation as resolved.

Expand Down Expand Up @@ -130,38 +122,6 @@ export namespace EnsRainbow {

export type CountResponse = CountSuccess | CountServerError;

/**
* ENSRainbow version information.
*
* @deprecated Use {@link ENSRainbowPublicConfig} instead. This type will be removed in a future version.
*/
export interface VersionInfo {
/**
* ENSRainbow version.
*/
version: string;

/**
* ENSRainbow database schema version.
*/
dbSchemaVersion: number;

/**
* The EnsRainbowServerLabelSet managed by the ENSRainbow server.
*/
labelSet: EnsRainbowServerLabelSet;
}

/**
* Interface for the version endpoint response
*
* @deprecated Use {@link ENSRainbowPublicConfig} instead. This type will be removed in a future version.
*/
export interface VersionResponse {
status: typeof StatusCode.Success;
versionInfo: VersionInfo;
}

/**
* Complete public configuration object for ENSRainbow.
*
Expand Down Expand Up @@ -405,38 +365,6 @@ export class EnsRainbowApiClient implements EnsRainbow.ApiClient {
return response.json() as Promise<EnsRainbow.ENSRainbowPublicConfig>;
}

/**
* Get the version information of the ENSRainbow service
*
* @deprecated Use {@link EnsRainbowApiClient.config} instead. This method will be removed in a future version.
* @returns the version information of the ENSRainbow service
* @throws if the request fails due to network failures, DNS lookup failures, request
* timeouts, CORS violations, or invalid URLs
* @example
* ```typescript
* const response = await client.version();
*
* console.log(response);
*
* // {
* // "status": "success",
* // "versionInfo": {
* // "version": "0.1.0",
* // "dbSchemaVersion": 2,
* // "labelSet": {
* // "labelSetId": "subgraph",
* // "labelSetVersion": 0
* // }
* // }
* // }
* ```
*/
async version(): Promise<EnsRainbow.VersionResponse> {
const response = await fetch(new URL("/v1/version", this.options.endpointUrl));

return response.json() as Promise<EnsRainbow.VersionResponse>;
}

/**
* Get a copy of the current client options.
*
Expand Down
Loading