feat(ponder-metadata): make package generic again #551

tk-o · 2025-04-10T16:40:34Z

This PR abstracts fetching ENSRainbow version away from the ponder-metadata package and moves it into the ENSIndexer application layer.

Preview

ENSRainbow info included in ENSNode response	ENSRainbow info not included in ENSNode response

Resolves:

changeset-bot · 2025-04-10T16:40:39Z

🦋 Changeset detected

Latest commit: 8277b77

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages

Name	Type
@ensnode/ponder-metadata	Minor
ensindexer	Minor
ensadmin	Minor
ensrainbow	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2025-04-10T16:40:40Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
admin.ensnode.io	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 10, 2025 4:48pm
ensnode.io	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 10, 2025 4:48pm
ensrainbow.io	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 10, 2025 4:48pm

tk-o · 2025-04-10T16:42:11Z

apps/ensadmin/src/components/ensnode/types.ts

+    deps: PonderMetadata.MetadataMiddlewareResponse["deps"] & {
+      ensRainbow: EnsRainbow.VersionInfo;
+    };


We declare application-level type to specify a generic type coming from the ponder-metadata package.

tk-o · 2025-04-10T16:42:45Z

apps/ensadmin/src/components/ensnode/hooks.ts

+  if (typeof response.deps.ensRainbow === "undefined") {
+    throw new Error(`ENSRainbow version not found in the response.`);
+  }


Including response validation to detect if ENSRainbow version info is available. If it's not, ENSAdmin would refuse to connect.

@tk-o This isn't a full validation of the data model. I expected we would completely verify each field and value.

Logged with #571

Abstract ENSRainbow version away from the package into the app layer.

lightwalker-eth

@tk-o Thanks for updates. Reviewed and shared feedback 👍

lightwalker-eth · 2025-04-10T20:41:31Z

.changeset/eleven-parents-sing.md

+"ensadmin": minor
+---
+
+Generalize `ponder-metadata` package and let ENSAdmin to ensure ENSRainbow version info is available.


Suggested change

Generalize `ponder-metadata` package and let ENSAdmin to ensure ENSRainbow version info is available.

Generalize `ponder-metadata` package. Add rules to ENSAdmin to ensure ENSRainbow version info is available.

lightwalker-eth · 2025-04-10T20:42:30Z

apps/ensadmin/src/components/ensnode/hooks.ts

+  if (typeof response.deps.ensRainbow === "undefined") {
+    throw new Error(`ENSRainbow version not found in the response.`);
+  }


@tk-o This isn't a full validation of the data model. I expected we would completely verify each field and value.

lightwalker-eth · 2025-04-10T20:48:51Z

apps/ensindexer/src/lib/ponder-helpers.ts

    try {
      const versionResponse = await client.version();
+
      return {


Flagging how several lines below this we can potentially return junk values if an error is thrown. This doesn't seem right. If we can't query the ENSRainbow version for some reason then it seems we should handle that in a smarter way that helps to build up our state invariants.

State invariants are CRITICAL for us. We need to focus on them much more.

I've started working on list of invariants. More details here:

Full response validation when trying to connect to ENSNode #571 (comment)

lightwalker-eth · 2025-04-10T20:51:29Z

packages/ponder-metadata/src/middleware.ts

@@ -23,6 +22,9 @@ interface PonderMetadataModule {
    version: string;
  };

+  /** Application dependencies info */
+  DepsInfo: Record<string, unknown>;


Really don't like type definitions like this that use unknown.

I assume a type definition like this is very temporary until we split our /metadata endpoint into separate APIs for /indexing-status and /config?

/config should not be generalized for any Ponder app. It should be 100% specific to ENSIndexer.

Likewise, the ponder-metadata package maybe should be renamed such that it is only for supporting the /indexing-status API.

If we assume ponder-metadata only deals with indexing status, then we can delegate the config type definition to ENSIndexer app, so ponder-metadata knows nothing about it and only passes-through the data (& its application-defined type).

tk-o

Thanks for feedback, @lightwalker-eth 🤝 I'll park this PR until #571 is done.

tk-o · 2025-04-13T14:58:08Z

apps/ensadmin/src/components/ensnode/hooks.ts

+  if (typeof response.deps.ensRainbow === "undefined") {
+    throw new Error(`ENSRainbow version not found in the response.`);
+  }


Logged with #571

tk-o · 2025-04-13T15:00:41Z

apps/ensindexer/src/lib/ponder-helpers.ts

    try {
      const versionResponse = await client.version();
+
      return {


I've started working on list of invariants. More details here:

Full response validation when trying to connect to ENSNode #571 (comment)

tk-o · 2025-04-13T15:03:05Z

packages/ponder-metadata/src/middleware.ts

@@ -23,6 +22,9 @@ interface PonderMetadataModule {
    version: string;
  };

+  /** Application dependencies info */
+  DepsInfo: Record<string, unknown>;


If we assume ponder-metadata only deals with indexing status, then we can delegate the config type definition to ENSIndexer app, so ponder-metadata knows nothing about it and only passes-through the data (& its application-defined type).

tk-o force-pushed the feat/513-521-generic-ponder-metadata-pkg branch from 8ddee99 to 033b2a1 Compare April 10, 2025 16:41

vercel bot deployed to Preview – ensnode.io April 10, 2025 16:41 View deployment

tk-o commented Apr 10, 2025

View reviewed changes

vercel bot deployed to Preview – ensrainbow.io April 10, 2025 16:42 View deployment

tk-o commented Apr 10, 2025

View reviewed changes

tk-o force-pushed the feat/513-521-generic-ponder-metadata-pkg branch from 033b2a1 to b4b426d Compare April 10, 2025 16:43

vercel bot deployed to Preview – ensnode.io April 10, 2025 16:44 View deployment

vercel bot deployed to Preview – admin.ensnode.io April 10, 2025 16:45 View deployment

vercel bot deployed to Preview – ensrainbow.io April 10, 2025 16:46 View deployment

feat(ponder-metadata): make package generic again

8277b77

Abstract ENSRainbow version away from the package into the app layer.

tk-o force-pushed the feat/513-521-generic-ponder-metadata-pkg branch from b4b426d to 8277b77 Compare April 10, 2025 16:46

vercel bot deployed to Preview – admin.ensnode.io April 10, 2025 16:47 View deployment

vercel bot deployed to Preview – ensrainbow.io April 10, 2025 16:47 View deployment

vercel bot deployed to Preview – ensnode.io April 10, 2025 16:48 View deployment

tk-o marked this pull request as ready for review April 10, 2025 16:49

tk-o requested a review from a team as a code owner April 10, 2025 16:49

lightwalker-eth requested changes Apr 10, 2025

View reviewed changes

tk-o commented Apr 13, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(ponder-metadata): make package generic again #551

feat(ponder-metadata): make package generic again #551

tk-o commented Apr 10, 2025 •

edited

Loading

changeset-bot bot commented Apr 10, 2025 •

edited

Loading

vercel bot commented Apr 10, 2025 •

edited

Loading

tk-o Apr 10, 2025

tk-o Apr 10, 2025

lightwalker-eth Apr 10, 2025

tk-o Apr 13, 2025

lightwalker-eth left a comment

lightwalker-eth Apr 10, 2025

lightwalker-eth Apr 10, 2025

lightwalker-eth Apr 10, 2025

tk-o Apr 13, 2025

lightwalker-eth Apr 10, 2025

tk-o Apr 13, 2025

tk-o left a comment

tk-o Apr 13, 2025

tk-o Apr 13, 2025

tk-o Apr 13, 2025

	Generalize `ponder-metadata` package and let ENSAdmin to ensure ENSRainbow version info is available.
	Generalize `ponder-metadata` package. Add rules to ENSAdmin to ensure ENSRainbow version info is available.

feat(ponder-metadata): make package generic again #551

Are you sure you want to change the base?

feat(ponder-metadata): make package generic again #551

Conversation

tk-o commented Apr 10, 2025 • edited Loading

Preview

changeset-bot bot commented Apr 10, 2025 • edited Loading

🦋 Changeset detected

vercel bot commented Apr 10, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lightwalker-eth left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tk-o left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tk-o commented Apr 10, 2025 •

edited

Loading

changeset-bot bot commented Apr 10, 2025 •

edited

Loading

vercel bot commented Apr 10, 2025 •

edited

Loading