Skip to content
Open
Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
a83d810
Update docs for Unigraph examples
tk-o May 26, 2026
5ab3e68
Apply AI PR feedback
tk-o May 26, 2026
3d9881c
Apply AI PR feedback
tk-o May 27, 2026
22012e2
Merge remote-tracking branch 'origin/main' into docs/improve-unigraph…
tk-o May 27, 2026
97ccdb4
Create dedicated pages
tk-o May 27, 2026
15fc5b2
Udpate ENSNode Plugins page
tk-o May 27, 2026
d701b2e
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o May 30, 2026
2e61b46
Shift plugins narrative to focus on "ENSNode Plugins"
tk-o May 30, 2026
dc68c9a
Apply AI PR feedback
tk-o May 30, 2026
799444a
Apply AI PR feedback
tk-o May 30, 2026
4ffbc77
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o May 30, 2026
b9ad9ff
Apply AI PR feedback
tk-o May 30, 2026
8e6910f
Fix sidebar link desc
tk-o May 30, 2026
7078001
Apply suggestions from code review
tk-o Jun 1, 2026
6b1904d
Apply suggestions from code review
tk-o Jun 1, 2026
321a5b6
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o Jun 1, 2026
a8ab221
convert crlf to lf
tk-o Jun 1, 2026
0a94011
Apply PR feedback
tk-o Jun 1, 2026
8439521
Apply PR feedback
tk-o Jun 2, 2026
b278eff
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o Jun 2, 2026
9aa00be
Apply PR feedback
tk-o Jun 2, 2026
3e5bb48
Add plugin info links
tk-o Jun 2, 2026
3aa5d30
Apply AI PR feedback
tk-o Jun 2, 2026
ff7597e
Apply AI PR feedback
tk-o Jun 2, 2026
c6aa559
Apply AI PR feedback
tk-o Jun 3, 2026
ec6fabd
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o Jun 3, 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
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,18 @@ export const integrateSidebarTopic = {
label: "ENSDb (SQL)",
link: "/docs/integrate/integration-options/ensdb",
},
{
label: "ENSDb Writers (Indexers)",
link: "/docs/integrate/integration-options/ensdb-writers",
},
{
label: "ENSDb Readers (Custom APIs)",
link: "/docs/integrate/integration-options/ensdb-readers",
},
{
label: "ENSNode Plugins (data models)",
link: "/docs/integrate/integration-options/ensnode-plugins",
},
{
label: "enscli (CLI)",
link: "/docs/integrate/integration-options/enscli",
Expand All @@ -217,7 +229,7 @@ export const integrateSidebarTopic = {
link: "/docs/integrate/integration-options/ensskills",
},
{
label: "ensdb-cli (ENSDb Snapshots)",
label: "ensdb-cli (Snapshots)",
link: "/docs/integrate/integration-options/ensdb-cli",
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,28 +46,11 @@ export const servicesSidebarTopic = {
{ label: "Database Schemas", link: "/docs/services/ensdb/concepts/database-schemas" },
],
},
{ label: "Integrations", link: "/docs/services/ensdb/integrations" },

{
label: "Usage",
collapsed: true,
items: [
{ label: "Overview", link: "/docs/services/ensdb/usage" },
{ label: "ENSDb SDK", link: "/docs/services/ensdb/usage/sdk" },
{ label: "ENSDb SQL", link: "/docs/services/ensdb/usage/sql" },
],
},
{
label: "Integrations",
collapsed: true,
items: [
{
label: "ENSNode Reference Implementation",
link: "/docs/services/ensdb/integrations/ensnode",
},
{
label: "Future Possibilities",
link: "/docs/services/ensdb/integrations/future-possibilities",
},
],
label: "Reference Implementation",
link: "/docs/services/ensdb/reference-implementation",
},
],
Comment thread
tk-o marked this conversation as resolved.
},
Expand All @@ -91,7 +74,7 @@ export const servicesSidebarTopic = {
items: [
{ label: "Overview", link: "/docs/services/ensindexer/contributing" },
{
label: "Creating a Plugin",
label: "Creating an ENSNode Plugin",
link: "/docs/services/ensindexer/contributing/creating-a-plugin",
},
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Full access to ENS data formerly required two separate data-fetching strategies

## How ENSNode solves this

**The Unigraph Data Model**[ENSIndexer](/docs/services/ensindexer)'s `unigraph` plugin builds a single, **unified** indexed data model in [ENSDb](/docs/services/ensdb) that combines all of ENSv1 — mainnet `.eth`, Basenames on Base, Lineanames on Linea, 3DNS on Optimism — together with ENSv2. One data model, every chain, both protocol versions.
**The Unigraph Data Model**The `unigraph` [ENSNode plugin](/docs/integrate/integration-options/ensnode-plugins), implemented in [ENSIndexer](/docs/services/ensindexer), builds a single, **unified** indexed data model in [ENSDb](/docs/services/ensdb) that combines all of ENSv1 — mainnet `.eth`, Basenames on Base, Lineanames on Linea, 3DNS on Optimism — together with ENSv2. One data model, every chain, both protocol versions.

**The Omnigraph API** — The [ENS Omnigraph API](/docs/integrate/omnigraph), delivered by [ENSApi](/docs/services/ensapi), is a fully typed GraphQL API on top of that Unigraph data model. It handles the ENS protocol's many implementation details for you, so you can focus on building your app instead of wiring up the protocol's internals.

Expand Down
3 changes: 3 additions & 0 deletions docs/ensnode.io/src/content/docs/docs/integrate/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,9 @@ The ENS Omnigraph API is a GraphQL API following the Relay specification, so you
Beyond [`enssdk`](/docs/integrate/integration-options/enssdk), [`enskit`](/docs/integrate/integration-options/enskit), and the [Omnigraph GraphQL API](/docs/integrate/integration-options/omnigraph-graphql-api), ENSNode exposes a deeper set of integration surfaces for advanced use cases:

- **[ENSDb (SQL)](/docs/integrate/integration-options/ensdb)** — query the indexed ENSv1 and ENSv2 datasets directly via SQL for custom analytics or your own service layer, from any language with a Postgres driver.
- **[ENSDb Writers (Indexers)](/docs/integrate/integration-options/ensdb-writers)** — build your own ENSDb Writer to index ENS data into your own ENSDb instance.
- **[ENSDb Readers](/docs/integrate/integration-options/ensdb-readers)** — build your own ENSDb Reader to query your own ENSDb instance through any interface of your choice, such as, i.e. MCP, CLI, REST API, GraphQL, gRPC, CLI or any other interface you need.
Comment thread
tk-o marked this conversation as resolved.
Outdated
Comment thread
tk-o marked this conversation as resolved.
Outdated
Comment thread
tk-o marked this conversation as resolved.
Outdated
- **[ENSNode Plugins](/docs/integrate/integration-options/ensnode-plugins)** — extend the core ENSNode indexing and API capabilities with custom plugins that can index additional data, add new API fields, or even integrate with external data sources.
Comment thread
tk-o marked this conversation as resolved.
Outdated
Comment thread
tk-o marked this conversation as resolved.
Outdated
- **[enscli (CLI)](/docs/integrate/integration-options/enscli)** — resolve names, look up records, and run ad-hoc Omnigraph queries from the terminal — built for humans and AI agents alike.
- **[ensskills (AI agents)](/docs/integrate/integration-options/ensskills)** — a curated set of skills that gives AI coding agents a well-defined contract for working with ENS.
- **[ensdb-cli (ENSDb Snapshots)](/docs/integrate/integration-options/ensdb-cli)** — bootstrap a fresh ENSDb in minutes from portable, versioned snapshots instead of waiting days on a full historical backfill.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: ENSDb Readers (Custom APIs)
description: How to build custom APIs and other services on top of ENSDb, using the ENSDb Reader standard.
---

import { LinkCard } from "@astrojs/starlight/components";

Comment thread
tk-o marked this conversation as resolved.
An [ENSDb Reader](/docs/services/ensdb/concepts/glossary#ensdb-reader) is any service that interacts with ENSDb to read ENS data. This can be anything from a custom GraphQL or REST API, to a data analytics pipeline, to a command-line interface, to a dashboard, and more.

:::tip[Build your own ENSDb Reader]
You can build your own ENSDb Reader in any language, using any framework, as long as you follow the [ENSDb Standard](/docs/services/ensdb/concepts/glossary#ensdb-standard). The ENSDb Standard defines rules and constraints for how an ENSDb Reader should read data from an ENSDb instance in a way that maintains the integrity of the data and supports interoperability with any ENSDb Writer.
:::
Comment thread
tk-o marked this conversation as resolved.

## Current ENSDb Readers

### ENSApi

ENSApi is a reference implementation of an [ENSDb Reader](/docs/services/ensdb/concepts/glossary#ensdb-reader) that includes the following APIs:

- The new [ENS Omnigraph GraphQL API](/docs/integrate/integration-options/omnigraph-graphql-api) that's built on top of [ENSNode Plugins](/docs/integrate/integration-options/ensnode-plugins) such as `unigraph` and `protocol-acceleration`.
- A backwards-compatible [ENS Subgraph GraphQL API](/docs/integrate/ens-subgraph) that's built on top of [ENSNode Plugins](/docs/integrate/integration-options/ensnode-plugins) such as `subgraph`, `basenames`, `lineanames`, and `threedns`.
- APIs for various queries related to the metadata stored in ENSDb, such as the indexing status from the [ENSDb Writer](/docs/services/ensdb/concepts/glossary#ensdb-writer) and [metadata](/docs/services/ensdb/concepts/glossary#indexing-metadata-context) about the overall [ENSNode stack of services](/docs/services) active in the ENSNode instance.

<LinkCard
title="Learn more about ENSApi"
description="A reference implementation of ENSDb Reader, built by the NameHash team."
href="/docs/services/ensapi"
/>

### New ENSDb Readers Under Development

Multiple new [ENSDb Reader](/docs/services/ensdb/concepts/glossary#ensdb-reader) services are planned by the NameHash team. Find out more about each of them below.

<LinkCard
Comment thread
tk-o marked this conversation as resolved.
title="Learn more about ensdb-cli"
description="A command-line interface for interacting with ENSDb."
href="/docs/integrate/integration-options/ensdb-cli"
/>

<LinkCard
title="Learn more about ENSEngine"
description="A push-based web service allowing you to track ENS data changes as they occur."
href="/docs/integrate/integration-options/ensengine"
/>

<LinkCard
title="Learn more about ENSAnalytics (coming soon)"
description="A web service that provides analytics and insights on ENS data."
href="/docs/services"
/>
Comment thread
tk-o marked this conversation as resolved.
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Comment thread
tk-o marked this conversation as resolved.
Comment thread
tk-o marked this conversation as resolved.
Comment thread
tk-o marked this conversation as resolved.

:::note[Build your own ENSDb Reader]
Creating your own ENSDb Reader service enables you to build your own completely custom APIs and data pipeline services. See related inspiration on the [ENSDb integration options page](/docs/integrate/integration-options/ensdb). Use any programming language or framework you wish! If you'd like any help or guidance, feel welcome to reach out to the NameHash team on [Telegram](https://t.me/ensnode).
:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: ENSDb Writers (Indexers)
description: How to build your own custom indexer implementation for ENSDb, using the ENSDb Writer specification.
---

import { LinkCard } from "@astrojs/starlight/components";

An [ENSDb Writer](/docs/services/ensdb/concepts/glossary#ensdb-writer) is the implementation of an indexing service that implements one or more standards-compliant [ENSNode plugins](/docs/integrate/integration-options/ensnode-plugins) and implements a standards-compliant [ENSDb Metadata Writer](/docs/services/ensdb/concepts/glossary#ensdb-metadata-writer) that stores [metadata](/docs/services/ensdb/concepts/glossary#indexing-metadata-context) about the [ENSDb Writer](/docs/services/ensdb/concepts/glossary#ensdb-writer).

:::tip[Build your own ENSDb Writer]
You can build your own ENSDb Writer in any language, using any indexing framework, as long as you follow the [ENSDb Standard](/docs/services/ensdb/concepts/glossary#ensdb-standard). The ENSDb Standard defines rules and constraints for how an ENSDb Writer should write data into an ENSDb instance in a way that maintains the integrity of the data and supports interoperability with any ENSDb Reader.

Your ENSDb Writer must include:

- The _implementation_ of 1 or more standards-compliant [ENSNode plugins](/docs/integrate/integration-options/ensnode-plugins).
- The _implementation_ of an [ENSDb Metadata Writer](/docs/services/ensdb/concepts/glossary#ensdb-metadata-writer) that stores [metadata](/docs/services/ensdb/concepts/glossary#indexing-metadata-context) about the [ENSDb Writer](/docs/services/ensdb/concepts/glossary#ensdb-writer) overall, including which [ENSNode Plugins](/docs/integrate/integration-options/ensnode-plugins) it has activated, what the status of indexing is across each indexed chain, etc.
Comment thread
tk-o marked this conversation as resolved.

:::

## Current ENSDb Writers

### ENSIndexer

[ENSIndexer](/docs/services/ensindexer) is a reference implementation of an [ENSDb Writer](/docs/services/ensdb/concepts/glossary#ensdb-writer) built by the NameHash team. It is a multi-chain ENS indexer built on top of [Ponder](https://ponder.sh/) that implements many ENSNode Plugins.

<LinkCard
title="Learn more about ENSIndexer"
description="A reference implementation of ENSDb Writer, built by the NameHash team."
href="/docs/services/ensindexer"
/>

## New ENSDb Writers Under Development or Discussions

### Envio

The [Envio](https://envio.dev/) team is actively collaborating with NameHash Labs to build another standards-compliant [ENSDb Writer](/docs/services/ensdb/concepts/glossary#ensdb-writer) that uses Envio as the indexing engine. Their initial ENSNode plugin under development is `subgraph`, with plans to support `unigraph` after that.

### Amp (Edge & Node)
Comment thread
tk-o marked this conversation as resolved.

[Edge & Node](https://www.edgeandnode.com) has discussions scheduled with the NameHash Labs team to investigate the use of their new [Amp](https://www.edgeandnode.com/articles/stream-live-chain-data-into-your-analytics-stack-with-amp) platform to implement an ENSDb Writer.

### Build Your Own

You can build your own ENSDb Writer in any language, using any indexing framework, as long as you follow the [ENSDb Standard](/docs/services/ensdb/concepts/glossary#ensdb-standard). Join us on [Telegram](https://t.me/ensnode) for any questions and support.
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,17 @@ title: ENSDb (SQL)
description: Direct database access for self-hosters needing custom queries, analytics, or building custom services beyond what existing APIs expose.
---

import { LinkCard } from "@astrojs/starlight/components";
import { LinkCard, Tabs, TabItem } from "@astrojs/starlight/components";
import EnsDbSelfHostingNote from "@components/molecules/EnsDbSelfHostingNote.astro";
import EnsDbUseCases from "@components/molecules/EnsDbUseCases.astro";
import EnsIndexerSchemaIntro from "@components/molecules/EnsIndexerSchemaIntro.astro";
import EnsDbReaderIntro from "@components/molecules/EnsDbReaderIntro.astro";
Comment thread
tk-o marked this conversation as resolved.
Outdated
Comment thread
tk-o marked this conversation as resolved.
Outdated

For special use cases that go beyond what the ENS Omnigraph exposes — you can query the live onchain state of both **ENSv1 and ENSv2** directly via `SQL`.

**ENSDb** is a bi-directional integration standard for any EnsDbWriter and EnsDbReader implementations to coordinate around the live unified onchain state of ENSv1 **and ENSv2** in a carefully-crafted standardized data model within a PostgreSQL database. Because ENSDb builds on Postgres, you can use _any_ language with a Postgres driver — **TypeScript**, **Python**, **Rust**, **Go**, and more.
The bi-directional [ENSDb integration standard](/docs/services/ensdb/concepts/glossary#ensdb-standard) enables any decoupled [ENSDb Writer](/docs/integrate/integration-options/ensdb-writers) and [ENSDb Reader](/docs/integrate/integration-options/ensdb-readers) implementations to coordinate around the live unified onchain state of **ENSv1 and ENSv2** in a carefully-crafted standardized data model within a PostgreSQL database. Because ENSDb builds on Postgres, you can use _any_ language with a Postgres driver — **TypeScript**, **Python**, **Rust**, **Go**, and more.

The ENSDb standard also defines _the abstract specification_ for how ENSDb Writers store their [metadata](/docs/services/ensdb/concepts/glossary#indexing-metadata-context) in an [ENSDb instance](/docs/services/ensdb/concepts/glossary#ensdb-instance).

:::tip[Coming soon: ensdb-cli & ENSDb snapshots]
We're building [**`ensdb-cli` & ENSDb snapshots**](/docs/integrate/integration-options/ensdb-cli) so you can pull down a fresh ENSDb in minutes instead of paying for a full historical RPC backfill among many other benefits.
Expand All @@ -21,68 +25,22 @@ We're building [**`ensdb-cli` & ENSDb snapshots**](/docs/integrate/integration-o

<EnsDbUseCases />

### Example: fetch a Domain by canonical name

Canonical fields (`canonical_name`, `canonical_path`, `canonical_node`, `canonical_depth`) are
populated on every Domain reachable from the canonical root, across both ENSv1 and ENSv2 — query
them uniformly without branching by `type`.

```typescript title="example.ts"
import { EnsDbReader } from "@ensnode/ensdb-sdk";
import { eq } from "drizzle-orm";

const ensDbReader = new EnsDbReader(ensDbConnectionString, ensIndexerSchemaName);
const { ensDb, ensIndexerSchema } = ensDbReader;

const [vitalik] = await ensDb
.select()
.from(ensIndexerSchema.domain)
.where(eq(ensIndexerSchema.domain.canonicalName, "vitalik.eth"));
```

```sql title="example.sql"
SELECT * FROM ensindexer_0.domains
WHERE canonical_name = 'vitalik.eth';
```

### Example: count an address's Domains by type (ENSv1 vs ENSv2)

```typescript title="example.ts"
import { count, eq } from "drizzle-orm";

const counts = await ensDb
.select({ type: ensIndexerSchema.domain.type, count: count() })
.from(ensIndexerSchema.domain)
.where(eq(ensIndexerSchema.domain.ownerId, "0xd8da6bf26964af9d7eed9e03e53415d37aa96045"))
.groupBy(ensIndexerSchema.domain.type);
```
## Examples

```sql title="example.sql"
SELECT type, count(*) FROM ensindexer_0.domains
WHERE owner_id = '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
GROUP BY type;
```
<LinkCard
title="Query ENS Unigraph data from ENSDb"
description="See practical examples of how to query ENSDb using SQL or ensdb-sdk in Typescript using Drizzle."
Comment thread
tk-o marked this conversation as resolved.
Outdated
Comment thread
tk-o marked this conversation as resolved.
Outdated
href="/docs/integrate/unigraph/examples"
/>

### Learn more
## Learn more

<LinkCard
title="ENSDb overview"
description="Architecture, schemas, what you can build, and quick-start guides."
href="/docs/services/ensdb"
/>

<LinkCard
title="ENSDb SDK (TypeScript)"
description="Type-safe database access and utilities for working with ENSDb."
href="/docs/services/ensdb/usage/sdk"
/>

<LinkCard
title="ENSDb SQL interface"
description="Connect with any PostgreSQL client and run queries directly."
href="/docs/services/ensdb/usage/sql"
/>

<LinkCard
title="Self-host ENSNode"
description="Run your own ENSNode instance to get full ENSDb access."
Expand Down
Loading
Loading