-
Notifications
You must be signed in to change notification settings - Fork 17
Docs: improve docs narrative around "ENSNode Plugins", "ENSDb Writers", and "ENSDb Readers". #2227
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.
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
Merged
Changes from 24 commits
Commits
Show all changes
33 commits
Select commit
Hold shift + click to select a range
a83d810
Update docs for Unigraph examples
tk-o 5ab3e68
Apply AI PR feedback
tk-o 3d9881c
Apply AI PR feedback
tk-o 22012e2
Merge remote-tracking branch 'origin/main' into docs/improve-unigraph…
tk-o 97ccdb4
Create dedicated pages
tk-o 15fc5b2
Udpate ENSNode Plugins page
tk-o d701b2e
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o 2e61b46
Shift plugins narrative to focus on "ENSNode Plugins"
tk-o dc68c9a
Apply AI PR feedback
tk-o 799444a
Apply AI PR feedback
tk-o 4ffbc77
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o b9ad9ff
Apply AI PR feedback
tk-o 8e6910f
Fix sidebar link desc
tk-o 7078001
Apply suggestions from code review
tk-o 6b1904d
Apply suggestions from code review
tk-o 321a5b6
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o a8ab221
convert crlf to lf
tk-o 0a94011
Apply PR feedback
tk-o 8439521
Apply PR feedback
tk-o b278eff
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o 9aa00be
Apply PR feedback
tk-o 3e5bb48
Add plugin info links
tk-o 3aa5d30
Apply AI PR feedback
tk-o ff7597e
Apply AI PR feedback
tk-o c6aa559
Apply AI PR feedback
tk-o ec6fabd
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o 08cde59
Update references relator to "ENSDb Writer" and "ENSDb Reader"
tk-o 840e79e
Drop a temp design file
tk-o 2eecf14
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o fce23a4
Apply AI PR feedback
tk-o a28a838
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o 77ee770
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o d5d982f
Fix typo
tk-o File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,6 +10,8 @@ import HostedEnsNodeInstance from "@components/molecules/HostedEnsNodeInstance.a | |
| import HostedInstanceSdkVersionWarning from "@components/molecules/HostedInstanceSdkVersionWarning.astro"; | ||
| import EnsSubgraphCorrectnessPostEnsV2Launch from "@components/molecules/EnsSubgraphCorrectnessPostEnsV2Launch.astro"; | ||
|
|
||
| export const pluginLink = (pluginName) => `<a href="/docs/integrate/integration-options/ensnode-plugins#existing-plugins" class="underline">${pluginName}</a>`; | ||
|
tk-o marked this conversation as resolved.
tk-o marked this conversation as resolved.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
|
||
| export const subgraphCompatibilityApiLevel = `<em>API-level Subgraph Compatibility.</em> This ENSNode instance has a fully backwards compatible ENS Subgraph GraphQL API. However, additional plugins have been activated which index a superset of data into the subgraph data model in ENSDb. This superset of indexed data means that the data returned for some ENS Subgraph API queries may be different.`; | ||
| export const subgraphCompatibilityFull = `<em>Full Subgraph Compatibility.</em> This ENSNode instance has a fully backwards compatible ENS Subgraph GraphQL API at both the API-level and the data-level. We have exhaustively tested and verified that every data record returned by this ENSNode instance's ENS Subgraph API is byte-for-byte identical with The Graph's ENS Subgraph API.`; | ||
| export const omnigraphForEnsV1 = `<em>Activated.</em> Demonstrates the ENS Omnigraph's ability to support ENSv1 only before ENSv2 launches and both ENSv1 and ENSv2 are concurrently active. Until ENSv2 launches on this namespace, only ENSv1 domains will be available. As soon as ENSv2 launches on this namespace both ENSv1 and ENSv2 domains will be available.`; | ||
|
|
@@ -50,7 +52,7 @@ More details about ENS namespaces can be found inside [ENSNode's datasources pac | |
|
|
||
| ### ENSNode Plugins | ||
|
|
||
| Each ENSNode instance is also configured for a specific set of activated **ENSNode plugins**. | ||
| Each ENSNode instance is also configured for a specific set of activated [ENSNode plugins](/docs/integrate/integration-options/ensnode-plugins). | ||
|
|
||
| The activated plugins determine the specific indexed data model and data records ENSIndexer will produce in ENSDb and therefore which APIs and data records ENSApi will make available to query. | ||
|
|
||
|
|
@@ -69,7 +71,7 @@ The `sepolia-v2` namespace is undergoing active development by the ENS Labs team | |
| connectWithENSAdminURL="https://admin.ensnode.io/connection?connection=https%3A%2F%2Fapi.v2-sepolia.ensnode.io" | ||
| namespace="sepolia-v2" | ||
| ensVersions="ENSv1 + ENSv2 (concurrently activated together)" | ||
| plugins="<em>unigraph</em>, <em>protocol-acceleration</em>, <em>subgraph</em>" | ||
| plugins={`${pluginLink("unigraph")}, ${pluginLink("protocol-acceleration")}, ${pluginLink("subgraph")}`} | ||
| > | ||
| <Fragment slot="ens-omnigraph-api-icon" set:text={"✅"} /> | ||
| <Fragment slot="ens-omnigraph-api" set:html={omnigraphForEnsV1AndEnsV2} /> | ||
|
|
@@ -99,7 +101,7 @@ These ENSNode instances do not constrain themselves to exclusively activating th | |
| connectWithENSAdminURL="https://admin.ensnode.io/connection?connection=https%3A%2F%2Fapi.alpha.ensnode.io" | ||
| namespace="mainnet" | ||
| ensVersions="ENSv1 only (not also ENSv2 yet)" | ||
| plugins="<em>unigraph</em>, <em>protocol-acceleration</em>, <em>subgraph</em>, basenames, lineanames, threedns, registrars, tokenscope" | ||
| plugins={`${pluginLink("unigraph")}, ${pluginLink("protocol-acceleration")}, ${pluginLink("subgraph")}, ${pluginLink("basenames")}, ${pluginLink("lineanames")}, ${pluginLink("threedns")}, ${pluginLink("registrars")}, ${pluginLink("tokenscope")}`} | ||
| > | ||
| <Fragment slot="ens-omnigraph-api-icon" set:text={"✅"} /> | ||
| <Fragment slot="ens-omnigraph-api" set:html={omnigraphForEnsV1} /> | ||
|
|
@@ -121,7 +123,7 @@ These ENSNode instances do not constrain themselves to exclusively activating th | |
| connectWithENSAdminURL="https://admin.ensnode.io/connection?connection=https%3A%2F%2Fapi.alpha-sepolia.ensnode.io" | ||
| namespace="sepolia" | ||
| ensVersions="ENSv1 only (not also ENSv2 yet)" | ||
| plugins="<em>unigraph</em>, <em>protocol-acceleration</em>, <em>subgraph</em>, basenames, lineanames, registrars" | ||
| plugins={`${pluginLink("unigraph")}, ${pluginLink("protocol-acceleration")}, ${pluginLink("subgraph")}, ${pluginLink("basenames")}, ${pluginLink("lineanames")}, ${pluginLink("registrars")}`} | ||
| > | ||
| <Fragment slot="ens-omnigraph-api-icon" set:text={"✅"} /> | ||
| <Fragment slot="ens-omnigraph-api" set:html={omnigraphForEnsV1} /> | ||
|
|
@@ -147,7 +149,7 @@ These ENSNode instances focus on maximizing backwards compatibility with the ENS | |
| connectWithENSAdminURL="https://admin.ensnode.io/connection?connection=https%3A%2F%2Fapi.mainnet.ensnode.io" | ||
| namespace="mainnet" | ||
| ensVersions="ENSv1 only (not also ENSv2 yet)" | ||
| plugins="<em>subgraph</em>" | ||
| plugins={`${pluginLink("subgraph")}`} | ||
| > | ||
| <Fragment slot="ens-omnigraph-api-icon" set:text={"❌"} /> | ||
| <Fragment slot="ens-omnigraph-api" set:html={omnigraphUnactivated} /> | ||
|
|
@@ -169,7 +171,7 @@ These ENSNode instances focus on maximizing backwards compatibility with the ENS | |
| connectWithENSAdminURL="https://admin.ensnode.io/connection?connection=https%3A%2F%2Fapi.sepolia.ensnode.io" | ||
| namespace="sepolia" | ||
| ensVersions="ENSv1 only (not also ENSv2 yet)" | ||
| plugins="<em>subgraph</em>" | ||
| plugins={`${pluginLink("subgraph")}`} | ||
| > | ||
| <Fragment slot="ens-omnigraph-api-icon" set:text={"❌"} /> | ||
| <Fragment slot="ens-omnigraph-api" set:html={omnigraphUnactivated} /> | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
54 changes: 54 additions & 0 deletions
54
...nsnode.io/src/content/docs/docs/integrate/integration-options/ensdb-readers.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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"; | ||
|
|
||
|
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. | ||
| ::: | ||
|
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 | ||
|
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" | ||
| /> | ||
|
tk-o marked this conversation as resolved.
coderabbitai[bot] marked this conversation as resolved.
tk-o marked this conversation as resolved.
tk-o marked this conversation as resolved.
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). | ||
| ::: | ||
44 changes: 44 additions & 0 deletions
44
...nsnode.io/src/content/docs/docs/integrate/integration-options/ensdb-writers.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. | ||
|
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) | ||
|
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. | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.

Uh oh!
There was an error while loading. Please reload this page.