diff --git a/docs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.ts b/docs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.ts index dcc5856c2..22651accb 100644 --- a/docs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.ts +++ b/docs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.ts @@ -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", diff --git a/docs/ensnode.io/config/integrations/starlight/sidebar-topics/services.ts b/docs/ensnode.io/config/integrations/starlight/sidebar-topics/services.ts index 36e0861be..dfbc62a15 100644 --- a/docs/ensnode.io/config/integrations/starlight/sidebar-topics/services.ts +++ b/docs/ensnode.io/config/integrations/starlight/sidebar-topics/services.ts @@ -91,7 +91,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", }, ], diff --git a/docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx b/docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx index 82f38dd0d..a4e58f882 100644 --- a/docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx +++ b/docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx @@ -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. diff --git a/docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb-readers.mdx b/docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb-readers.mdx new file mode 100644 index 000000000..ca855163d --- /dev/null +++ b/docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb-readers.mdx @@ -0,0 +1,48 @@ +--- +title: ENSDb Readers (Custom APIs) +description: How to build custom APIs on top of ENSDb, using the ENSDb Reader specification. +--- + +import { LinkCard } from "@astrojs/starlight/components"; + +## Standards-compliant ENSDb Readers + +There are multiple [ENSDb Reader](/docs/services/ensdb/concepts/glossary#ensdb-reader) apps created (and planned) by the NameHash team. Find out more about each of them below. + +:::note[Build your own ENSDb Reader] +Continuing on the ideas shared in [ENSDb integration options page](/docs/integrate/integration-options/ensdb), you can build your own ENSDb Reader app and define a custom data model and capabilities that are required for your use cases. Feel free to reach out to the NameHash team on [Telegram](https://t.me/ensnode) if you want to build your own ENSDb Reader and want any help or guidance! +::: + +### ENSApi + +ENSApi is a reference implementation of an [ENSDb Reader](/docs/services/ensdb/concepts/glossary#ensdb-reader) that includes standards-compliant web services: + +- A standards-compliant [ENS Omnigraph GraphQL API](/docs/integrate/integration-options/omnigraph-graphql-api) on top of [ENSNode Plugins](/docs/integrate/integration-options/ensnode-plugins) such as `unigraph` and `protocol-acceleration`. +- A standards-compliant [ENS Subgraph GraphQL API](/docs/integrate/ens-subgraph) on top of [ENSNode Plugins](/docs/integrate/integration-options/ensnode-plugins) such as `subgraph`, `basenames`, `lineanames`, and `threedns`. +- An API for accessing the metadata stored in ENSDb, including [metadata](/docs/services/ensdb/concepts/glossary#indexing-metadata-context) about 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. + + + +### Other ENSDb Readers + + + + + + diff --git a/docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb-writers.mdx b/docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb-writers.mdx new file mode 100644 index 000000000..700142a0d --- /dev/null +++ b/docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb-writers.mdx @@ -0,0 +1,49 @@ +--- +title: ENSDb Writers (Indexers) +description: How to build indexers for ENSDb, using the ENSDb Writer specification. +--- + +import { LinkCard } from "@astrojs/starlight/components"; + +An [ENSDb Writer](/docs/services/ensdb/concepts/glossary#ensdb-writer) defines how an indexing process for ENS looks like, including: + +- How to source onchain data about ENS (events, blocks, etc.) +- How to process onchain data into an indexed data model (including transforming raw onchain data into a desired internal data model). +- How to store that processed data in the [ENSDb instance](/docs/services/ensdb/concepts/glossary#ensdb-instance). +- How to store metadata about the [ENSDb Writer](/docs/services/ensdb/concepts/glossary#ensdb-writer) in the [ENSDb instance](/docs/services/ensdb/concepts/glossary#ensdb-instance). + +:::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. + +::: + +## Standards-compliant 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/), a modular blockchain indexing framework. ENSIndexer processes events from each relevant chain and transforms the data, storing it in your ENSDb instance. + + + +### 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 plugin is `subgraph`, with plans to support `unigraph` and `protocol-acceleration` after that. + +## Other Potential ENSDb Writers + +### Amp (Edge & Node) + +[Amp](https://www.edgeandnode.com/articles/stream-live-chain-data-into-your-analytics-stack-with-amp) by [Edge & Node](https://www.edgeandnode.com) is a next-generation blockchain data platform that transforms onchain activity into structured, verifiable datasets — preserving full cryptographic provenance for compliance and auditability. Amp can stream live onchain data, including live ENS state, making it a perfect foundation for a new production-grade ENSDb Writer implementation. + +### 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. diff --git a/docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb.mdx b/docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb.mdx index 163a6adfb..115304ad7 100644 --- a/docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb.mdx +++ b/docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb.mdx @@ -9,7 +9,9 @@ import EnsDbUseCases from "@components/molecules/EnsDbUseCases.astro"; 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. +**ENSDb** is a bi-directional integration standard for any ENSDb Writer and ENSDb Reader 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](/docs/services/ensdb/concepts/glossary#ensdb-standard) also defines _the abstract specification_ for how [ENSDb Writers](/docs/integrate/integration-options/ensdb-writers) store their [metadata](/docs/services/ensdb/concepts/glossary#indexing-metadata-context) in an [ENSDb instance](/docs/services/ensdb/concepts/glossary#ensdb-instance) in a manner that supports decoupling and interop with any of [ENSDb Readers](/docs/integrate/integration-options/ensdb-readers). :::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. diff --git a/docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensnode-plugins.mdx b/docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensnode-plugins.mdx new file mode 100644 index 000000000..a56e93dd8 --- /dev/null +++ b/docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensnode-plugins.mdx @@ -0,0 +1,73 @@ +--- +title: ENSNode Plugins +description: How to customize data models for ENSNode, using the ENSNode Plugin specification. +--- + +import { LinkCard } from "@astrojs/starlight/components"; + +## What is an ENSNode Plugin? + +An **ENSNode Plugin** is an abstract specification that defines how a specific aspect of the ENS namespace is indexed into [ENSDb](/docs/services/ensdb). It is **not** an implementation — it is a standard that any [ENSDb Writer](/docs/services/ensdb/concepts/glossary#ensdb-writer) can implement. + +Each ENSNode Plugin defines: + +- **Name** — e.g. `unigraph`, `protocol-acceleration`, `subgraph`. +- **Datasources** — which onchain contracts should be indexed, as a function of the ENS namespace. +- **Dependency relationships** — other plugins that must (or must not) be activated concurrently. +- **Indexed data model** — the tables, columns, and indexes that the plugin produces in ENSDb. +- **Standards and invariants** — rules for how onchain events are translated into the indexed data model during indexing. +- **Versioning** — a version number that can be stored in ENSNode Metadata, to track which version of the plugin implementation is being used by ENSDb Writers and ENSDb Readers. + +## Why ENSNode Plugins Matter + +ENSNode Plugins are the key architectural piece that enables a decoupling between [ENSDb Writers](/docs/services/ensdb/concepts/glossary#ensdb-writer) and [ENSDb Readers](/docs/services/ensdb/concepts/glossary#ensdb-reader), so that anyone can create their own implementations of these. For example, any team working on indexing infrastructure can implement an ENSDb Writer and have it produce a standards-compliant ENSDb. On the other hand, any team working on products for ENS ecosystem can build their own standards-compliant ENSDb Reader and have it query ENSDb. + +:::note[Interoperability between ENSDb Writers and Readers] +When new ENSNode plugins are created, it becomes possible for the [ENS Omnigraph API](/docs/integrate/omnigraph) (or other APIs built by any ENSDb Reader) to unify the ability to query across ENSNode plugins in a single query. For example, you could query both ENS state from the `unigraph` and EFP state about followers from the `efp` plugin in a single GraphQL query. +::: + +## Core Plugins + +[ENSIndexer](/docs/services/ensindexer) is a reference implementation of an [ENSDb Writer](/docs/services/ensdb/concepts/glossary#ensdb-writer) that implements multiple core plugins following the ENSNode Plugins specification. The code for each plugin inside ENSIndexer is a reference implementation of that plugin's abstract specification. [The core plugins implemented in ENSIndexer today](https://github.com/namehash/ensnode/tree/main/apps/ensindexer/src/plugins) are: + +:::note[Built by the NameHash team] +All core ENSNode Plugins are built by the NameHash team. [We welcome contributions and collaborations to expand the ecosystem of plugins](#build-your-own). +::: + +| Plugin | Description | +| ----------------------- | ---------------------------------------------------------- | +| `unigraph` | Unified ENSv1 + ENSv2 data model with polymorphic entities | +| `protocol-acceleration` | Accelerated lookups for ENS resolution | +| `subgraph` | Legacy ENS Subgraph-compatible data model | +| `basenames` | Basenames (`.base.eth`) subname indexing | +| `lineanames` | Lineanames (`.linea.eth`) subname indexing | +| `threedns` | 3DNS (`.box`) name indexing | +| `registrars` | Registration and renewal lifecycle tracking | +| `tokenscope` | NFT tokenization and marketplace activity | + +## Community Plugins + +### Under Development + +The `efp` plugin is [a new plugin currently under development](https://github.com/Quantumlyy/efpnode/tree/main/packages/ensnode-plugin-efp) by the [EthId team](https://ethid.org/): + +- [EFP (Ethereum Follow Protocol)](https://efp.app/) — onchain social graph protocol +- [Grails](https://grails.app/) — by the EthId Foundation + +### Build Your Own + +If you are interested in defining a new ENSNode plugin or implementing an existing one, reach out to the NameHash Labs team — we are happy to provide support and additional info. Join us on [Telegram](https://t.me/ensnode) for any questions. + +## Related + + + + diff --git a/docs/ensnode.io/src/content/docs/docs/integrate/integration-options/index.mdx b/docs/ensnode.io/src/content/docs/docs/integrate/integration-options/index.mdx index 3b3aaeb69..15424723a 100644 --- a/docs/ensnode.io/src/content/docs/docs/integrate/integration-options/index.mdx +++ b/docs/ensnode.io/src/content/docs/docs/integrate/integration-options/index.mdx @@ -45,7 +45,34 @@ For special use cases that go beyond what the ENS Omnigraph exposes, query the l href="/docs/integrate/integration-options/ensdb" /> -## 5. enscli +## 5. ENSDb Writers + +Build your own indexer for ENSDb by implementing the [ENSNode Plugin](/docs/integrate/integration-options/ensnode-plugins) specification. ENSDb Writers index onchain ENS data and write it into an ENSDb instance. + + + +## 6. ENSDb Readers + +Build custom APIs on top of ENSDb. ENSDb Readers query indexed ENS data from an ENSDb instance and serve it through any API surface (GraphQL, REST, gRPC, etc.). + + + +## 7. ENSNode Plugins + +ENSNode Plugins are abstract specifications that define indexed data models for ENS. They are the key architectural piece that enables decoupling between ENSDb Writers and ENSDb Readers. + + + +## 8. enscli `enscli` is a CLI that wraps `enssdk` to bring the ENS Omnigraph to the terminal. Designed for developers exploring or validating integrations, operators wiring ENS lookups into shell pipelines, and AI coding agents driving `ensskills`. @@ -54,7 +81,7 @@ For special use cases that go beyond what the ENS Omnigraph exposes, query the l href="/docs/integrate/integration-options/enscli" /> -## 6. ensskills +## 9. ensskills `ensskills` is a collection of curated skill bundles that give AI coding agents a well-defined contract for working with ENS — powering conversational ENS lookups and streamlining integration code written with `enskit`, `enssdk`, or the raw Omnigraph API. @@ -63,7 +90,7 @@ For special use cases that go beyond what the ENS Omnigraph exposes, query the l href="/docs/integrate/integration-options/ensskills" /> -## 7. ensdb-cli & ENSDb snapshots +## 10. ensdb-cli & ENSDb snapshots `ensdb-cli` is the operator-facing tool for ENSDb snapshots — portable, versioned packages of an ENSDb instance. Pull one down, restore it into Postgres, and start querying ENS in minutes instead of waiting days to complete a full historical indexing backfill from scratch. @@ -72,7 +99,7 @@ For special use cases that go beyond what the ENS Omnigraph exposes, query the l href="/docs/integrate/integration-options/ensdb-cli" /> -## 8. ENSEngine +## 11. ENSEngine ENSEngine watches your ENSDb for changes in real time and delivers ENS-aware events — including webhooks — to any sink you configure. Stop polling and start reacting to ENS state changes. diff --git a/docs/ensnode.io/src/content/docs/docs/integrate/omnigraph/concepts.mdx b/docs/ensnode.io/src/content/docs/docs/integrate/omnigraph/concepts.mdx index 9aca48328..0527ef500 100644 --- a/docs/ensnode.io/src/content/docs/docs/integrate/omnigraph/concepts.mdx +++ b/docs/ensnode.io/src/content/docs/docs/integrate/omnigraph/concepts.mdx @@ -82,7 +82,7 @@ query Namegraph { The **Unigraph** is the entire collection of these disjoint ENSv2 Namegraphs and multiple ENSv1 Nametables, combined together into a single unified data model using ENS Resolution semantics. Navigating the Unigraph from `"eth"` down to `"vitalik.eth"` and beyond looks identical regardless of whether the underlying entities are ENSv1 or ENSv2. -The [`unigraph` plugin](/docs/services/ensindexer) in ENSIndexer is what builds this unified model. The Unigraph constructs two Namegraphs, one rooted at the ENSv1 Root Registry and another rooted at the ENSv2 Root Registry. It's also where multichain coverage lives: Basenames (`.base.eth`), Lineanames (`.linea.eth`), and 3DNS names (`.box`) are all stitched into the ENSv1 Namegraph. +The `unigraph` [ENSNode plugin](/docs/integrate/integration-options/ensnode-plugins), implemented in [ENSIndexer](/docs/services/ensindexer), is what builds this unified model. The Unigraph constructs two Namegraphs, one rooted at the ENSv1 Root Registry and another rooted at the ENSv2 Root Registry. It's also where multichain coverage lives: Basenames (`.base.eth`), Lineanames (`.linea.eth`), and 3DNS names (`.box`) are all stitched into the ENSv1 Namegraph. ```mermaid flowchart TD diff --git a/docs/ensnode.io/src/content/docs/docs/integrate/unigraph/schema-reference.mdx b/docs/ensnode.io/src/content/docs/docs/integrate/unigraph/schema-reference.mdx index c709f900f..8c77e67c1 100644 --- a/docs/ensnode.io/src/content/docs/docs/integrate/unigraph/schema-reference.mdx +++ b/docs/ensnode.io/src/content/docs/docs/integrate/unigraph/schema-reference.mdx @@ -7,14 +7,14 @@ sidebar: import { Aside } from "@astrojs/starlight/components"; -This is the canonical reference for the **Unigraph schema** — the unified, polymorphic data model that the [`unigraph` plugin](/docs/services/ensindexer) materializes into [ENSDb](/docs/services/ensdb). It models ENSv1 and ENSv2 with shared, polymorphic entities (Domains, Registries, Registrations, Renewals, Resolvers), so the same query shape works across both protocol versions. +This is the canonical reference for the **Unigraph schema** — the unified, polymorphic data model that the `unigraph` [ENSNode plugin](/docs/integrate/integration-options/ensnode-plugins) (implemented in [ENSIndexer](/docs/services/ensindexer)) materializes into [ENSDb](/docs/services/ensdb). It models ENSv1 and ENSv2 with shared, polymorphic entities (Domains, Registries, Registrations, Renewals, Resolvers), so the same query shape works across both protocol versions. Each ENSIndexer instance owns a dedicated database schema (e.g. `ensindexer_0`) holding all of its indexed Unigraph data, fully isolated from other instances. diff --git a/docs/ensnode.io/src/content/docs/docs/services/ensdb/concepts/glossary.mdx b/docs/ensnode.io/src/content/docs/docs/services/ensdb/concepts/glossary.mdx index ab5beb754..6d46bc6ea 100644 --- a/docs/ensnode.io/src/content/docs/docs/services/ensdb/concepts/glossary.mdx +++ b/docs/ensnode.io/src/content/docs/docs/services/ensdb/concepts/glossary.mdx @@ -46,18 +46,26 @@ Objects contained within a [database schema](#database-schema), including: An open standard for bi-directional ENS integration. The ENSDb Standard defines: - Schema designs for storing ENS data in a [PostgreSQL database](#postgresql-database) -- Rules and constraints for [ENSDb Writers](#ensdb-writer) and [ENSDb Readers](#ensdb-reader) +- Rules and constraints for [ENSDb Writers](#ensdb-writer), [ENSDb Metadata Writers](#ensdb-metadata-writer), and [ENSDb Readers](#ensdb-reader) - A modular architecture enabling interoperability Any [PostgreSQL database](#postgresql-database) following the ENSDb Standard is an [ENSDb instance](#ensdb-instance). +### ENSNode Plugin + +An abstract specification that defines how a specific aspect of the ENS namespace is indexed into [ENSDb](/docs/services/ensdb). A plugin defines: a name, datasources (which onchain contracts to index as a function of the ENS namespace), dependency relationships with other plugins, an indexed data model with indexes, and standards and invariants for how onchain events are translated into that indexed data model during indexing. Any [ENSDb Writer](#ensdb-writer) can implement an ENSNode Plugin. + ### ENSDb Writer -Any application that writes ENS data into an [ENSDb instance](#ensdb-instance) following the [ENSDb Standard](#ensdb-standard). For example, [ENSIndexer](#ensindexer) is a reference implementation of an ENSDb Writer. Other implementations of ENSDb Writers can be built in any language, and can use different indexing frameworks (i.e. [Ponder](https://ponder.sh/), [rindexer](https://rindexer.xyz/)), as long as they follow the ENSDb Standard. +Any application that implements one or more standard-compliant [ENSNode Plugins](#ensnode-plugin) and includes an [ENSDb Metadata Writer](#ensdb-metadata-writer), writing ENS data into an [ENSDb instance](#ensdb-instance) following the [ENSDb Standard](#ensdb-standard). For example, [ENSIndexer](#ensindexer) is a reference implementation of an ENSDb Writer. Other implementations of ENSDb Writers can be built in any language, and can use different indexing frameworks (i.e. [Ponder](https://ponder.sh/), [Envio](https://envio.dev/), [rindexer](https://rindexer.xyz/)), as long as they follow the ENSDb Standard. + +### ENSDb Metadata Writer + +Any application that writes metadata about an [ENSDb Writer](#ensdb-writer) into an [ENSDb instance](#ensdb-instance) following the [ENSDb Standard](#ensdb-standard). For example, [ENSIndexer](#ensindexer) is a reference implementation of an ENSDb Metadata Writer, which writes [Indexing Metadata Context](/docs/services/ensdb/concepts/glossary#indexing-metadata-context) records into the [ENSNode Metadata Table](/docs/services/ensdb/concepts/glossary#ensnode-metadata-table) for each ENSIndexer instance that has ever connected to the ENSDb instance. Other implementations of ENSDb Metadata Writers can be built in any language, as long as they follow the ENSDb Standard. ### ENSDb Reader -Any application that reads ENS data from an [ENSDb instance](#ensdb-instance) following the [ENSDb Standard](#ensdb-standard). For example, [ENSApi](#ensapi) is a reference implementation of an ENSDb Reader. Other implementations of ENSDb Readers can be built in any language, and can serve different types of APIs (GraphQL, REST, gRPC, etc.), as long as they follow the ENSDb Standard. +Any application that reads ENS data from an [ENSDb instance](#ensdb-instance) following the [ENSDb Standard](#ensdb-standard). It knows how to read state from ENSDb, including overall metadata from the sole [ENSDb Writer](#ensdb-writer) and (where relevant) data associated with the [ENSNode Plugins](#ensnode-plugin) relevant to the specific ENSDb Reader implementation. For example, [ENSApi](#ensapi) is a reference implementation of an ENSDb Reader. Other implementations of ENSDb Readers can be built in any language, and can serve different types of APIs (GraphQL, REST, gRPC, etc.), as long as they follow the ENSDb Standard. ## ENSDb Concepts @@ -147,17 +155,17 @@ The `value` column stores a JSON object which structure may evolve over time. To The `key` column identifies the type of metadata: -| Key | Description | -| --------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `indexing_metadata_context` | [Indexing metadata context](#indexing-metadata-context) of the [ENSIndexer instance](#ensindexer-instance) | +| Key | Description | +| --------------------------- | ------------------------------------------------------------------------------------------------------ | +| `indexing_metadata_context` | [Indexing metadata context](#indexing-metadata-context) for the [ENSDb Writer](#ensdb-writer) instance | #### Indexing Metadata Context -A JSON object that provides indexing metadata context. The actual context data, whose structure may evolve over time as the needs of the ENSNode stack evolve. The object may include fields such as: +A data model that describes indexing metadata context. The actual context data, whose structure may evolve over time as the needs of the ENSNode stack evolve. The data model may include fields such as: - `version`: The version of the Indexing Metadata Context structure -- `indexingStatus`: the current Indexing Status of the [ENSIndexer instance](#ensindexer-instance). -- `stackInfo`: a group of public config objects that describe the ENSIndexer instance and its dependencies. +- `indexingStatus`: the current Indexing Status of the [ENSDb Writer](#ensdb-writer) instance (i.e. the [Indexing Status](#indexing-status) of the [ENSIndexer instance](#ensindexer-instance)). +- `stackInfo`: describes the [ENSDb Writer](#ensdb-writer) instance and its config, dependencies, etc. ### ENSApi @@ -172,7 +180,7 @@ A running [ENSApi](#ensapi) process that serves GraphQL and REST APIs from an [E ### ENSIndexer -A reference implementation of an [ENSDb Writer](#ensdb-writer) that indexes onchain ENS data and writes to an [ENSDb instance](#ensdb-instance). It is built on top of [Ponder](https://ponder.sh/), a modular blockchain indexing framework. +A reference implementation of an [ENSDb Writer](#ensdb-writer) that indexes onchain ENS data and writes to an [ENSDb instance](#ensdb-instance). It is built on top of [Ponder](https://ponder.sh/), a modular blockchain indexing framework. ENSIndexer implements the [ENSDb Metadata Writer](#ensdb-metadata-writer) spec by writing metadata about itself into the [ENSNode Metadata Table](#ensnode-metadata-table) in the ENSDb instance. ### ENSIndexer Instance @@ -209,8 +217,8 @@ A TypeScript package published as [`@ensnode/ensdb-sdk`](https://www.npmjs.com/p The ENSDb SDK includes: -- [EnsDbReader Client](#ensdb-reader-client) — An ENSDb client implementation for querying ENSDb Metadata, and building custom queries against the [ENSDb instance](#ensdb-instance). -- [EnsDbWriter Client](#ensdb-writer-client) — An ENSDb client implementation for writing ENSNode Metadata and executing ENSNode migrations. +- [ENSDb Reader Client](#ensdb-reader-client) — An ENSDb client implementation for querying ENSDb Metadata, and building custom queries against the [ENSDb instance](#ensdb-instance). +- [ENSDb Writer Client](#ensdb-writer-client) — An ENSDb client implementation for writing ENSNode Metadata and executing ENSNode migrations. - [Schema Definitions](#schema-definition) — Drizzle schemas for [ENSIndexer Schema](#ensindexer-schema) and [ENSNode Schema](#ensnode-schema). ### ENSDb Reader Client diff --git a/docs/ensnode.io/src/content/docs/docs/services/ensdb/index.mdx b/docs/ensnode.io/src/content/docs/docs/services/ensdb/index.mdx index 8859fec04..946da6d76 100644 --- a/docs/ensnode.io/src/content/docs/docs/services/ensdb/index.mdx +++ b/docs/ensnode.io/src/content/docs/docs/services/ensdb/index.mdx @@ -7,7 +7,6 @@ sidebar: --- import { LinkCard, Aside } from "@astrojs/starlight/components"; -import EnsDbUseCases from "@components/molecules/EnsDbUseCases.astro"; ## Vision @@ -26,7 +25,6 @@ The [ENSDb standard](/docs/services/ensdb/concepts/glossary#ensdb-standard) is i _any programming language_ that has a PostgreSQL driver. Zig, Rust, Go, Python, JavaScript, Ruby, Java, C# — the choice is yours. - ## What You Get ### Complete ENS State @@ -52,9 +50,11 @@ By building on a PostgreSQL database, ENSDb inherits world-class capabilities: ## What You Can Build -ENSDb unlocks a new universe of ENS applications: - - + ## Quick Start diff --git a/docs/ensnode.io/src/content/docs/docs/services/ensindexer/contributing/creating-a-plugin.mdx b/docs/ensnode.io/src/content/docs/docs/services/ensindexer/contributing/creating-a-plugin.mdx index 77f5928ef..37dbb66c1 100644 --- a/docs/ensnode.io/src/content/docs/docs/services/ensindexer/contributing/creating-a-plugin.mdx +++ b/docs/ensnode.io/src/content/docs/docs/services/ensindexer/contributing/creating-a-plugin.mdx @@ -1,22 +1,32 @@ --- -title: Creating a Plugin -description: Learn how to create a plugin for ENSIndexer +title: ENSNode Plugins in ENSIndexer +description: How ENSIndexer implements ENSNode plugins sidebar: - label: Creating a Plugin + label: ENSNode Plugins order: 2 --- import { LinkCard } from "@astrojs/starlight/components"; -## ENSIndexer Plugins +ENSIndexer is a reference implementation of an [ENSDb Writer](/docs/services/ensdb/concepts/glossary#ensdb-writer) that implements [ENSNode plugins](/docs/integrate/integration-options/ensnode-plugins). The code for each plugin inside ENSIndexer is a reference implementation of that plugin's abstract specification. -ENSNode is extensible through ENSIndexer plugins that implement custom indexing logic and produce custom indexed data models inside ENSDb. This allows you to tailor ENSNode to your specific use case and data needs. +For the full specification of ENSNode plugins and how they enable decoupling between [ENSDb Writers](/docs/integrate/integration-options/ensdb-writers) and [ENSDb Readers](/docs/integrate/integration-options/ensdb-readers), see the [ENSNode Plugins](/docs/integrate/integration-options/ensnode-plugins) integration guide. -ENSIndexer will only activate the plugins you specify in the `PLUGINS` env variable, so you can choose to only activate the plugins that are relevant to your use case. The `PLUGINS` env variable accepts a comma-separated list of plugin names to be activated. For example, if you want to activate the `ensv2` and `protocol-acceleration` plugins, you can set `PLUGINS=ensv2,protocol-acceleration`. + -## Plugin Architecture +## How ENSIndexer implements ENSNode plugins -Each ENSIndexer plugin is a standalone TypeScript module that can be developed, tested, and deployed independently. The ENSIndexer Plugin can define its own indexed data models and indexing logic. It must include two main files: +ENSNode is extensible through ENSNode Plugins. You can have your ENSIndexer implement custom indexing logic and produce custom indexed data models inside ENSDb. This allows you to tailor ENSNode to your specific use case and data needs. + +ENSIndexer will only activate the ENSNode Plugins which you specify in the `PLUGINS` env variable, so you can choose to only activate the plugins that are relevant to your use case. The `PLUGINS` env variable accepts a comma-separated list of plugin names to be activated. For example, if you want to activate the `unigraph` and `protocol-acceleration` plugins, you can set `PLUGINS=unigraph,protocol-acceleration`. + +## Plugin implementation structure + +Each ENSNode Plugin implemented in ENSIndexer is a standalone TypeScript module that can be developed, tested, and deployed independently. The ENSNode Plugin can define its own indexed data models and indexing logic. It must include two main files: - `event-handlers.ts`: This file defines the event handlers for the plugin, which are functions that will be called when specific onchain events are indexed. The event handlers contain the logic for how to process the indexed data and store it in the relevant indexed data model inside the ENSIndexer Schema. - `plugin.ts`: This file defines the plugin itself, including its name, description, and any configuration options, like datasources to be used for specifying onchain contracts that will be indexed. @@ -32,11 +42,3 @@ You need to import the `event-handlers.ts` file from each plugin into [`register The `plugin.ts` file has a default export with the plugin definition object returned from `createPlugin` function. The plugin definition object includes the plugin name, datasources required for the plugin to operate, and the config for contracts to be indexed by ENSIndexer when the plugin is active. You need to import the plugin definition object into [`apps/ensindexer/src/plugins/index.ts`](https://github.com/namehash/ensnode/tree/main/apps/ensindexer/src/plugins/index.ts) file and have it included in the `ALL_PLUGINS` array. This way, you let the ENSIndexer runtime know that the plugin is available for activation, which in turn allows you to activate the plugin by including its name in the `PLUGINS` env variable. - -## Existing Plugins - -You can find the current list of existing ENSIndexer plugins in [the ENSIndexer repository](https://github.com/namehash/ensnode/tree/main/apps/ensindexer/src/plugins). - -## Creating Your Own Plugin - -If you’re interested in building a plugin, reach out to the NameHash Labs team who is happy to provide support and additional info. diff --git a/docs/ensnode.io/src/content/docs/docs/services/ensindexer/index.mdx b/docs/ensnode.io/src/content/docs/docs/services/ensindexer/index.mdx index 7e3bee2be..f89ae2242 100644 --- a/docs/ensnode.io/src/content/docs/docs/services/ensindexer/index.mdx +++ b/docs/ensnode.io/src/content/docs/docs/services/ensindexer/index.mdx @@ -8,7 +8,7 @@ sidebar: import { LinkCard } from "@astrojs/starlight/components"; -ENSIndexer is a [Ponder](https://ponder.sh) app that indexes ENS contracts across multiple chains. It processes events from each relevant chain and transforms the data, storing it in your Postgres database. +ENSIndexer is a reference implementation of an [ENSDb Writer](/docs/services/ensdb/concepts/glossary#ensdb-writer). It uses [Ponder](https://ponder.sh) for indexing ENS state from contracts across multiple chains. It processes events from each relevant chain and transforms the data, storing it in your ENSDb instance. :::note While ENSIndexer can be run independently in certain scenarios, it is designed to work as part of the complete ENSNode system, and we recommend following the [ENSNode Contribution Guide](/docs/reference/contributing) if you'd like to run ENSIndexer locally, or the [ENSNode Deployment Guide](/docs/self-host) if you'd like to run ENSIndexer in the cloud.