Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/cool-hotels-dress.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@ensnode/ensnode-sdk": minor
Comment thread
Y3drk marked this conversation as resolved.
Comment thread
Y3drk marked this conversation as resolved.
Comment thread
Y3drk marked this conversation as resolved.
---

Fully removed the deprecated `ENSNodeClient` (use `EnsApiClient` instead).
5 changes: 5 additions & 0 deletions .changeset/stale-wombats-help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@ensnode/ensnode-react": minor
Comment thread
Y3drk marked this conversation as resolved.
---

Applied `ASSUME_IMMUTABLE_QUERY` options to `useResolvedIdentity` to prevent redundant refetches.
Comment thread
Y3drk marked this conversation as resolved.
5 changes: 5 additions & 0 deletions .changeset/two-rice-flash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@ensnode/ensnode-react": minor
Comment thread
Y3drk marked this conversation as resolved.
---

Replaced references to the deprecated and removed `ENSNodeClient` with `EnsApiClient`.
6 changes: 6 additions & 0 deletions packages/ensnode-react/src/hooks/useResolvedIdentity.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import {
} from "@ensnode/ensnode-sdk";

import type { UseResolvedIdentityParameters } from "../types";
import { ASSUME_IMMUTABLE_QUERY } from "../utils/query";
import { useENSNodeConfig } from "./useENSNodeConfig";
import { usePrimaryName } from "./usePrimaryName";

Expand Down Expand Up @@ -56,7 +57,12 @@ export function useResolvedIdentity(parameters: UseResolvedIdentityParameters) {
namespace ?? ENSNamespaceIds.Mainnet,
),
accelerate,
// NOTE: Overriding `gcTime` to prevent unbounded memory growth
// in long-running sessions with many identities.
query: {
...ASSUME_IMMUTABLE_QUERY, // identity changes very rarely
gcTime: 60 * 60 * 1000, // 1 hour
refetchInterval: false, // not covered by ASSUME_IMMUTABLE_QUERY
..._query,
enabled: (_query.enabled ?? true) && namespace !== undefined,
Comment thread
Y3drk marked this conversation as resolved.
},
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Expand Down
6 changes: 3 additions & 3 deletions packages/ensnode-react/src/provider.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import { QueryClient, QueryClientProvider, useQueryClient } from "@tanstack/react-query";
import { createElement, useMemo } from "react";

import { ENSNodeClient } from "@ensnode/ensnode-sdk";
import { EnsApiClient } from "@ensnode/ensnode-sdk";

import { ENSNodeContext } from "./context";
import type { ENSNodeSDKConfig } from "./types";
Expand Down Expand Up @@ -95,11 +95,11 @@ export function ENSNodeProvider(parameters: React.PropsWithChildren<ENSNodeProvi
* Helper function to create ENSNode configuration
*/
export function createConfig(options?: { url?: string | URL }): ENSNodeSDKConfig {
const url = options?.url ? new URL(options.url) : ENSNodeClient.defaultOptions().url;
const url = options?.url ? new URL(options.url) : EnsApiClient.defaultOptions().url;

return {
client: {
...ENSNodeClient.defaultOptions(),
...EnsApiClient.defaultOptions(),
url,
},
};
Expand Down
16 changes: 8 additions & 8 deletions packages/ensnode-react/src/utils/query.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import type { UndefinedInitialDataOptions } from "@tanstack/react-query";

import {
ENSNodeClient,
EnsApiClient,
type NameTokensRequest,
type RegistrarActionsRequest,
type ResolvePrimaryNameRequest,
Expand Down Expand Up @@ -76,7 +76,7 @@ export function createRecordsQueryOptions<SELECTION extends ResolverRecordsSelec
enabled: true,
queryKey: queryKeys.records(config.client.url.href, args),
queryFn: async () => {
const client = new ENSNodeClient(config.client);
const client = new EnsApiClient(config.client);
return client.resolveRecords(args.name, args.selection, args);
},
};
Expand All @@ -93,7 +93,7 @@ export function createPrimaryNameQueryOptions(
enabled: true,
queryKey: queryKeys.primaryName(config.client.url.href, args),
queryFn: async () => {
const client = new ENSNodeClient(config.client);
const client = new EnsApiClient(config.client);
return client.resolvePrimaryName(args.address, args.chainId, args);
},
};
Expand All @@ -110,7 +110,7 @@ export function createPrimaryNamesQueryOptions(
enabled: true,
queryKey: queryKeys.primaryNames(config.client.url.href, args),
queryFn: async () => {
const client = new ENSNodeClient(config.client);
const client = new EnsApiClient(config.client);
return client.resolvePrimaryNames(args.address, args);
},
};
Expand All @@ -124,7 +124,7 @@ export function createConfigQueryOptions(config: ENSNodeSDKConfig) {
enabled: true,
queryKey: queryKeys.config(config.client.url.href),
queryFn: async () => {
const client = new ENSNodeClient(config.client);
const client = new EnsApiClient(config.client);
return client.config();
},
};
Expand All @@ -138,7 +138,7 @@ export function createIndexingStatusQueryOptions(config: ENSNodeSDKConfig) {
enabled: true,
queryKey: queryKeys.indexingStatus(config.client.url.href),
queryFn: async () => {
const client = new ENSNodeClient(config.client);
const client = new EnsApiClient(config.client);
return client.indexingStatus();
},
};
Expand All @@ -155,7 +155,7 @@ export function createRegistrarActionsQueryOptions(
enabled: true,
queryKey: queryKeys.registrarActions(config.client.url.href, args),
queryFn: async () => {
const client = new ENSNodeClient(config.client);
const client = new EnsApiClient(config.client);

return client.registrarActions(args);
},
Expand All @@ -170,7 +170,7 @@ export function createNameTokensQueryOptions(config: ENSNodeSDKConfig, args: Nam
enabled: true,
queryKey: queryKeys.nameTokens(config.client.url.href, args),
queryFn: async () => {
const client = new ENSNodeClient(config.client);
const client = new EnsApiClient(config.client);

return client.nameTokens(args);
},
Expand Down
12 changes: 6 additions & 6 deletions packages/ensnode-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,20 @@ Learn more about [ENSNode](https://ensnode.io/) from [the ENSNode docs](https://
npm install @ensnode/ensnode-sdk
```

## ENSNode Client
## EnsApiClient

The `ENSNodeClient` provides a unified interface for the supported ENSNode APIs:
The `EnsApiClient` provides a unified interface for the ENSApi REST APIs:
- Resolution API (Protocol Accelerated Forward/Reverse Resolution)
- Indexing Status API
- Configuration API

### Basic Usage

```typescript
import { ENSNodeClient, evmChainIdToCoinType } from "@ensnode/ensnode-sdk";
import { mainnet } from 'viem/chains';
import { EnsApiClient, evmChainIdToCoinType } from "@ensnode/ensnode-sdk";
import { mainnet } from "viem/chains";

const client = new ENSNodeClient();
const client = new EnsApiClient();

// Resolution API: Records Resolution
const { records } = await client.resolveRecords("jesse.base.eth", {
Expand Down Expand Up @@ -186,7 +186,7 @@ console.log(status);
### Configuration

```typescript
const client = new ENSNodeClient({
const client = new EnsApiClient({
url: new URL("https://my-ensnode-instance.com"),
});
```
7 changes: 0 additions & 7 deletions packages/ensnode-sdk/src/ensapi/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -678,10 +678,3 @@ export class EnsApiClient {
return deserializedNameTokensResponse(responseData as SerializedNameTokensResponse);
}
}

/**
* ENSNode Client
*
* @deprecated use {@link EnsApiClient} instead
*/
export class ENSNodeClient extends EnsApiClient {}
1 change: 0 additions & 1 deletion packages/ensnode-sdk/src/ensapi/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
export * from "./api";
export {
type ClientOptions,
ENSNodeClient,
EnsApiClient,
type EnsApiClientOptions,
} from "./client";
Expand Down
Loading