Skip to content

Commit 2df3b45

Browse files
Initial docs for ENSDb (#1942)
Co-authored-by: lightwalker.eth <126201998+lightwalker-eth@users.noreply.github.com>
1 parent e40ce8f commit 2df3b45

14 files changed

Lines changed: 1559 additions & 12 deletions

File tree

.changeset/fifty-chairs-heal.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@docs/ensnode": minor
3+
---
4+
5+
Created docs for ENSDb.

docs/ensnode.io/config/integrations/starlight.ts

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,11 +123,26 @@ export function starlight(): AstroIntegration {
123123
label: "Overview",
124124
items: [
125125
{
126-
label: "Coming soon",
126+
label: "Getting started",
127127
link: "/ensdb",
128128
},
129129
],
130130
},
131+
{
132+
label: "Concepts",
133+
collapsed: false,
134+
autogenerate: { directory: "ensdb/concepts" },
135+
},
136+
{
137+
label: "Using ENSDb",
138+
collapsed: false,
139+
autogenerate: { directory: "ensdb/usage" },
140+
},
141+
{
142+
label: "Integrations",
143+
collapsed: false,
144+
autogenerate: { directory: "ensdb/integrations" },
145+
},
131146
],
132147
},
133148
{

docs/ensnode.io/mindmap.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
```mermaid
2+
mindmap
3+
root((ENSDb))
4+
Vision
5+
Bi-directional ENS integration
6+
Writers provide data about ENS
7+
ENSIndexer indexes onchain data for ENS
8+
Readers query data about ENS
9+
ENSAwards queries ENS referrals to build dashboards
10+
ENSApi queries data about resolver records to enable Protocol Acceleration
11+
12+
Foundations
13+
ENSDb instance
14+
Database Schema
15+
Ponder Schema
16+
Exactly one per ENSDb instance
17+
Schema Lifecycle managed by Ponder runtime
18+
Shared
19+
Among apps writing to the ENSDb instances
20+
ENSIndexer instances
21+
Among apps reading from the ENSDb instance
22+
ENSApi instances
23+
ENSNode Schema
24+
Exactly one per ENSDb instance
25+
Schema Lifecycle managed by ENSIndexer runtime
26+
Shared
27+
Among apps writing to the ENSDb instances
28+
ENSIndexer instances
29+
Among apps reading from the ENSDb instance
30+
ENSApi instances
31+
ENSIndexer Schema
32+
At least one per ENSDb instance
33+
Schema Lifecycle managed by Ponder runtime
34+
Isolated writer
35+
A single ENSIndexer can write data
36+
Shared readers
37+
Any number of readers can read data
38+
39+
Operations
40+
Infrastructure
41+
Database Server
42+
Serves at least one ENSDb instance
43+
Writers
44+
ENSIndexer instance
45+
Writes into the ENSDb instance
46+
Cached RPC requests
47+
Ponder Schema
48+
Indexed ENS onchain data
49+
ENSIndexer Schema
50+
ENSNode Metadata
51+
ENSNode Schema
52+
Readers
53+
ENSApi instance
54+
Reads from the ENSDb instance
55+
Indexed ENS onchain data
56+
ENSNode Metadata
57+
Provides powerful APIs for querying data about ENS
58+
Possible future ENS primitives
59+
Event notifications
60+
Cache invalidations
61+
Advanced Dashboards
62+
63+
Tools
64+
Snapshot tool
65+
Capabilities
66+
Takes a snapshot of a selected ENSDb instance
67+
Restores the ENSDb instance from the snapshot
68+
Goals
69+
Cut the cost of RPC requests
70+
Cut the time needed to complete indexing from scratch
71+
72+
Integrations
73+
TypeScript
74+
ENSDb SDK
75+
ENSDb Reader
76+
Drizzle client
77+
ENSDb Writer
78+
Any tech-stack
79+
PostgreSQL client
80+
```

docs/ensnode.io/public/ensdb-schemas.svg

Lines changed: 20 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)