feat: Add warp deploy configs reader functions #521

ltyu · 2025-01-24T17:29:27Z

Description

Add Warp Deploy Config reader functions getWarpDeployConfigs() and getWarpDeployConfig() as well DRY out logic that is shared with getWarpRoute()

Backward compatibility

Yes

Testing

Unit tests

Fixes: hyperlane-xyz/hyperlane-monorepo#5261

…e warpRouteConfigPathToId to call parseWarpRouteConfigPath

…nt to include warpDeploys, getWarpRoutesForIds to call readConfigsForIds

…t names

changeset-bot · 2025-01-24T17:29:31Z

🦋 Changeset detected

Latest commit: ef4d7dc

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

This PR includes changesets to release 1 package

Name	Type
@hyperlane-xyz/registry	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

ltyu · 2025-01-24T17:35:46Z

src/registry/SynchronousRegistry.ts

@@ -72,9 +75,21 @@ export abstract class SynchronousRegistry extends BaseRegistry implements IRegis
    return Object.fromEntries(idsWithConfigs);
  }

+  /**
+   * Retrieves a map of all the warp routes deployment configs


Not sure if a filter parameter is needed yet

Maybe not but I suggest including it for consistency. If you don't do it now, it'll probably be 6 months before this is touched again

jmrossy

Seems like you're on the right track

jmrossy · 2025-01-24T17:48:13Z

src/registry/FileSystemRegistry.ts

+      warpDeploys[routeId] = filePath;
+    }
+
+    return (this.listContentCache = { chains, deployments: { warpRoutes, warpDeploys } });


Suggest renaming warpDeploys, it's not clear how it's different from wrapRoutes

jmrossy · 2025-01-24T17:48:58Z

src/registry/FileSystemRegistry.ts

+    return this.readConfigsForIds(ids, warpRoutes);
+  }
+
+  protected getWarpDeploysForIds(ids: WarpRouteId[]): WarpRouteDeployConfig[] {


ditto throughout

jmrossy · 2025-01-24T17:49:25Z

src/registry/IRegistry.ts

    warpRoutes: Record<WarpRouteId, string>;
+
+    // Warp route ID to warp config URI


Suggested change

// Warp route ID to warp config URI

// Warp route ID to warp deploy config URI

jmrossy · 2025-01-24T17:51:26Z

src/registry/PartialRegistry.ts

@@ -58,6 +58,7 @@ export class PartialRegistry extends SynchronousRegistry implements IRegistry {
      chains,
      deployments: {
        warpRoutes,
+        warpDeploys: warpRoutes


intentional? Doesn't look right

jmrossy · 2025-01-24T17:52:15Z

src/registry/PartialRegistry.ts

@@ -87,6 +88,10 @@ export class PartialRegistry extends SynchronousRegistry implements IRegistry {
    }) as WarpCoreConfig[];
  }

+  protected getWarpDeploysForIds(_ids: WarpRouteId[]): WarpRouteDeployConfig[] {
+    throw new Error('Method not implemented.');


I'd expect this to filter and return some member var state like what getWarpRoutesForIds does

This is kind of hard to implement because the warpRouteId includes the symbol name (USDC/base-ethereum), which WarpDeployConfig does not have. We will need to derive from the config.token.

Is it worth implementing now as it seems like we may merge both configs soon

Please leave a comment about this though

jmrossy · 2025-01-24T17:53:42Z

src/registry/SynchronousRegistry.ts

@@ -64,6 +64,9 @@ export abstract class SynchronousRegistry extends BaseRegistry implements IRegis
    return this.getWarpRoutesForIds([routeId])[0] || null;
  }

+  /**
+   * Retrieves a filtered map of the warp routes artifacts


Let's try to be consistent with our nomenclature. I don't think I call these artifacts anywhere in the registry code but I could be wrong. The problem with 'artifact' is that while it is the output of one tool, it's also the input to another.

jmrossy · 2025-01-24T17:54:31Z

src/registry/SynchronousRegistry.ts

@@ -72,9 +75,21 @@ export abstract class SynchronousRegistry extends BaseRegistry implements IRegis
    return Object.fromEntries(idsWithConfigs);
  }

+  /**
+   * Retrieves a map of all the warp routes deployment configs


Maybe not but I suggest including it for consistency. If you don't do it now, it'll probably be 6 months before this is touched again

jmrossy · 2025-01-24T17:55:33Z

test/unit/warp-routes.test.ts

@@ -19,15 +19,15 @@ describe('Warp Route Configs', () => {
  const routes = localRegistry.getWarpRoutes();

  for (const id of Object.keys(routes)) {
-    it(`Route ${id} is valid`, async () => {
+    it(`Core Config ${id} is valid`, async () => {


Replace Core with WarpCore. Core is too ambiguous with hyperlane core config IMO

jmrossy · 2025-01-24T17:56:44Z

test/unit/warp-routes.test.ts

+  const warpDeploys = localRegistry.getWarpDeploys();
+
+  // These Ids do not validate due to owner
+  // Remove after https://github.com/hyperlane-xyz/hyperlane-monorepo/issues/5292
+  const excludeIds = [
+    'ECLIP/arbitrum-neutron', 
+    'INJ/inevm-injective', 
+    'TIA/arbitrum-neutron', 
+    'INJ/inevm-injective', 
+    'TIA/arbitrum-neutron', 
+    'TIA/eclipsemainnet-stride', 
+    'TIA/mantapacific-neutron', 
+    'stTIA/eclipsemainnet-stride'
+  ];
+  const configs = Object.keys(warpDeploys).filter(id =>!excludeIds.includes(id));
+  for (const id of configs) {
+    it(`Deploy config ${id} is valid`, async () => {
+      WarpRouteDeployConfigSchema.parse(warpDeploys[id]);
+    });
+  }


Please put this section in a separate describe block

jmrossy · 2025-01-25T13:31:25Z

src/registry/FileSystemRegistry.ts

+      warpDeployConfigURIs[routeId] = filePath;
+    }
+
+    return (this.listContentCache = { chains, deployments: { warpRoutes, warpDeployConfigURIs } });


Nit: wondering why the warpDeployConfigURIs name feels inconsistent with the other exports here. Would warpDeployConfigs be better?

ltyu added 9 commits January 24, 2025 12:00

Add WARP_ROUTE_DEPLOY_FILE_REGEX

e7b8411

Revert 2 space

aec8be1

Add warpDeploys into deployments object

3f103cf

Add warpDeploys to MergedRegistry

5c777e5

Add warpDeploys to PartialRegistry

6aad188

Add getWarpDeploys, comments into SyncronousRegistry

f434768

Add parseWarpRouteConfigPath and warpRouteDeployConfigPathToId. Updat…

71bfc3c

…e warpRouteConfigPathToId to call parseWarpRouteConfigPath

Add readConfigsForIds, getWarpDeploysForIds. Update listRegistryConte…

15781d4

…nt to include warpDeploys, getWarpRoutesForIds to call readConfigsForIds

Update unit tests to include schema check for warpDeploys. Update tes…

40c974a

…t names

ltyu added 2 commits January 24, 2025 12:31

Revert sortMapEntries

13b3e5e

Rename to configs

714cda3

ltyu commented Jan 24, 2025

View reviewed changes

jmrossy reviewed Jan 24, 2025

View reviewed changes

ltyu added 13 commits January 24, 2025 15:00

Rename warpDeploys -> warpDeployConfigURIs

03f1483

Separate warp deploy tests to its own describe block

f84b8a8

Rename getWarpDeploys() -> getWarpDeployConfigs()

0cc5c5a

Remove unsed var

d168e6d

Add comment regard warpDeployConfigURIs in PartialRegistry

8fdf85f

Revert comment

bac3fef

Add getDeployConfig(s) into base and IRegistry

0f8a94b

Add getWarpDeployConfig(s) into MergedRegistry

066f0f3

Add temp logic for getWarpDeployConfigForIds() into PartialRegistry

28acb0f

Add getWarpDeployConfig(s) into GithubRegistry

b42297e

Add getWarpDeployConfig(s) into SynchronousRegistry

aa7f7aa

Add unit test for Add getWarpDeployConfig(s)

8c5b80b

Add type WarpDeployConfigMap

7daaeff

ltyu changed the title ~~feat: warp speed warp configs reader~~ feat: Add warp deploy configs reader functions Jan 24, 2025

ltyu added 2 commits January 24, 2025 17:20

Add cs

ed7db21

Update CS

a5096d2

Update CS

ef4d7dc

jmrossy approved these changes Jan 25, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add warp deploy configs reader functions #521

feat: Add warp deploy configs reader functions #521

ltyu commented Jan 24, 2025 •

edited

Loading

changeset-bot bot commented Jan 24, 2025 •

edited

Loading

ltyu Jan 24, 2025

jmrossy Jan 24, 2025

ltyu Jan 24, 2025

jmrossy left a comment

jmrossy Jan 24, 2025

jmrossy Jan 24, 2025

jmrossy Jan 24, 2025

jmrossy Jan 24, 2025

jmrossy Jan 24, 2025

ltyu Jan 24, 2025

jmrossy Jan 24, 2025

jmrossy Jan 24, 2025

jmrossy Jan 24, 2025

jmrossy Jan 24, 2025

jmrossy Jan 24, 2025

jmrossy Jan 24, 2025

jmrossy Jan 25, 2025

		warpRoutes: Record<WarpRouteId, string>;

		// Warp route ID to warp config URI

	// Warp route ID to warp config URI
	// Warp route ID to warp deploy config URI

feat: Add warp deploy configs reader functions #521

Are you sure you want to change the base?

feat: Add warp deploy configs reader functions #521

Conversation

ltyu commented Jan 24, 2025 • edited Loading

Description

Backward compatibility

Testing

changeset-bot bot commented Jan 24, 2025 • edited Loading

🦋 Changeset detected

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmrossy 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

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

ltyu commented Jan 24, 2025 •

edited

Loading

changeset-bot bot commented Jan 24, 2025 •

edited

Loading