feat(http-client): implement warp route write methods (#1368)

Mo-Hussain · claude · web-flow · commit b0d88c320e3f · 2026-01-30T19:42:06.000Z
Co-authored-by: Claude Opus 4.5 &lt;noreply@anthropic.com&gt;
diff --git a/.changeset/http-registry-writes.md b/.changeset/http-registry-writes.md
@@ -0,0 +1,5 @@
+---
+'@hyperlane-xyz/registry': minor
+---
+
+Added write support for HttpClientRegistry with new methods: addWarpRoute(), addWarpRouteConfig(), and getWarpDeployConfigs(). Exported WarpRouteIdSchema with regex validation and WarpDeployConfigMap type for HTTP server integration.
diff --git a/src/fs/FileSystemRegistry.ts b/src/fs/FileSystemRegistry.ts
@@ -17,11 +17,16 @@ import {
   WARP_ROUTE_CONFIG_FILE_REGEX,
   WARP_ROUTE_DEPLOY_FILE_REGEX,
 } from '../consts.js';
-import { ChainAddresses, ChainAddressesSchema, UpdateChainParams, WarpRouteId } from '../types.js';
+import {
+  AddWarpRouteConfigOptions,
+  ChainAddresses,
+  ChainAddressesSchema,
+  UpdateChainParams,
+  WarpRouteId,
+} from '../types.js';
 import { toYamlString } from '../utils.js';
 
 import {
-  AddWarpRouteConfigOptions,
   RegistryType,
   type ChainFiles,
   type IRegistry,
diff --git a/src/index.ts b/src/index.ts
@@ -5,13 +5,7 @@ export {
 } from './consts.js';
 export { BaseRegistry } from './registry/BaseRegistry.js';
 export { GithubRegistry, GithubRegistryOptions } from './registry/GithubRegistry.js';
-export {
-  AddWarpRouteConfigOptions,
-  ChainFiles,
-  IRegistry,
-  RegistryContent,
-  RegistryType,
-} from './registry/IRegistry.js';
+export { ChainFiles, IRegistry, RegistryContent, RegistryType } from './registry/IRegistry.js';
 export { MergedRegistry, MergedRegistryOptions } from './registry/MergedRegistry.js';
 export { PartialRegistry, PartialRegistryOptions } from './registry/PartialRegistry.js';
 export { HttpClientRegistry } from './registry/HttpClientRegistry.js';
@@ -22,9 +16,13 @@ export {
   createWarpRouteConfigId,
 } from './registry/warp-utils.js';
 export {
+  AddWarpRouteConfigOptions,
+  AddWarpRouteConfigOptionsSchema,
   ChainAddresses,
   ChainAddressesSchema,
+  WarpDeployConfigMap,
   WarpRouteId,
+  WarpRouteIdSchema,
   WarpRouteConfigMap,
   WarpRouteFilterParams,
   WarpRouteFilterSchema,
diff --git a/src/registry/BaseRegistry.ts b/src/registry/BaseRegistry.ts
@@ -11,6 +11,7 @@ import {
 import { assert, objFilter, objLength } from '@hyperlane-xyz/utils';
 import { WARP_ROUTE_ID_REGEX } from '../consts.js';
 import type {
+  AddWarpRouteConfigOptions,
   ChainAddresses,
   MaybePromise,
   UpdateChainParams,
@@ -20,12 +21,7 @@ import type {
 } from '../types.js';
 import { WarpRouteConfigMap } from '../types.js';
 import { stripLeadingSlash } from '../utils.js';
-import type {
-  AddWarpRouteConfigOptions,
-  IRegistry,
-  RegistryContent,
-  RegistryType,
-} from './IRegistry.js';
+import type { IRegistry, RegistryContent, RegistryType } from './IRegistry.js';
 import { MergedRegistry } from './MergedRegistry.js';
 import { createWarpRouteConfigId } from './warp-utils.js';
 
diff --git a/src/registry/GithubRegistry.ts b/src/registry/GithubRegistry.ts
@@ -18,6 +18,7 @@ import {
   WARP_ROUTE_DEPLOY_FILE_REGEX,
 } from '../consts.js';
 import {
+  AddWarpRouteConfigOptions,
   ChainAddresses,
   UpdateChainParams,
   WarpDeployConfigMap,
@@ -28,7 +29,6 @@ import {
 import { concurrentMap, parseGitHubPath, stripLeadingSlash } from '../utils.js';
 import { BaseRegistry } from './BaseRegistry.js';
 import {
-  AddWarpRouteConfigOptions,
   ChainFiles,
   IRegistry,
   IRegistryMethods,
diff --git a/src/registry/HttpClientRegistry.ts b/src/registry/HttpClientRegistry.ts
@@ -6,20 +6,15 @@ import {
   WarpRouteDeployConfig,
 } from '@hyperlane-xyz/sdk';
 import {
+  AddWarpRouteConfigOptions,
   ChainAddresses,
   MaybePromise,
   UpdateChainParams,
   WarpDeployConfigMap,
   WarpRouteConfigMap,
   WarpRouteFilterParams,
 } from '../types.js';
-import {
-  IRegistry,
-  RegistryContent,
-  RegistryType,
-  AddWarpRouteConfigOptions,
-  IRegistryMethods,
-} from './IRegistry.js';
+import { IRegistry, IRegistryMethods, RegistryContent, RegistryType } from './IRegistry.js';
 
 export class HttpError extends Error {
   public status: number;
@@ -43,10 +38,6 @@ export class HttpClientRegistry implements IRegistry {
     'getChainLogoUri',
     'addChain',
     'removeChain',
-    'addWarpRoute',
-    'getWarpDeployConfig',
-    'getWarpDeployConfigs',
-    'addWarpRouteConfig',
     'merge',
   ]);
 
@@ -137,23 +128,36 @@ export class HttpClientRegistry implements IRegistry {
     return this.fetchJson<WarpRouteConfigMap>(`/warp-route/core?${queryParams.toString()}`);
   }
 
-  addWarpRoute(_config: WarpCoreConfig): MaybePromise<void> {
-    throw new Error('Method not implemented.');
+  async addWarpRoute(config: WarpCoreConfig, options?: AddWarpRouteConfigOptions): Promise<void> {
+    await this.fetchJson<void>('/warp-route', {
+      method: 'POST',
+      body: JSON.stringify({ config, options }),
+    });
   }
 
   getWarpDeployConfig(routeId: string): MaybePromise<WarpRouteDeployConfig | null> {
     return this.fetchJson<WarpRouteDeployConfig | null>(`/warp-route/deploy/${routeId}`);
   }
 
-  getWarpDeployConfigs(): MaybePromise<WarpDeployConfigMap> {
-    throw new Error('Method not implemented.');
+  getWarpDeployConfigs(filter?: WarpRouteFilterParams): MaybePromise<WarpDeployConfigMap> {
+    const queryParams = new URLSearchParams();
+    if (filter?.symbol) {
+      queryParams.set('symbol', filter.symbol);
+    }
+    if (filter?.label) {
+      queryParams.set('label', filter.label);
+    }
+    return this.fetchJson<WarpDeployConfigMap>(`/warp-route/deploy?${queryParams.toString()}`);
   }
 
-  addWarpRouteConfig(
-    _config: WarpRouteDeployConfig,
-    _options: AddWarpRouteConfigOptions,
-  ): MaybePromise<void> {
-    throw new Error('Method not implemented.');
+  async addWarpRouteConfig(
+    config: WarpRouteDeployConfig,
+    options: AddWarpRouteConfigOptions,
+  ): Promise<void> {
+    await this.fetchJson<void>('/warp-route/deploy', {
+      method: 'POST',
+      body: JSON.stringify({ config, options }),
+    });
   }
 
   merge(_otherRegistry: IRegistry): IRegistry {
diff --git a/src/registry/IRegistry.ts b/src/registry/IRegistry.ts
@@ -6,6 +6,7 @@ import type {
   WarpRouteDeployConfig,
 } from '@hyperlane-xyz/sdk';
 import {
+  AddWarpRouteConfigOptions,
   ChainAddresses,
   MaybePromise,
   WarpDeployConfigMap,
@@ -52,14 +53,6 @@ export enum RegistryType {
   Http = 'http',
 }
 
-export type AddWarpRouteConfigOptions =
-  | {
-      symbol: string;
-    }
-  | {
-      warpRouteId: WarpRouteId;
-    };
-
 export interface IRegistry {
   type: RegistryType;
   uri: string;
diff --git a/src/registry/MergedRegistry.ts b/src/registry/MergedRegistry.ts
@@ -8,6 +8,7 @@ import type {
   WarpRouteDeployConfig,
 } from '@hyperlane-xyz/sdk';
 import {
+  AddWarpRouteConfigOptions,
   ChainAddresses,
   UpdateChainParams,
   WarpDeployConfigMap,
@@ -16,13 +17,7 @@ import {
   WarpRouteId,
 } from '../types.js';
 import { objMerge } from '../utils.js';
-import {
-  AddWarpRouteConfigOptions,
-  IRegistry,
-  IRegistryMethods,
-  RegistryContent,
-  RegistryType,
-} from './IRegistry.js';
+import { IRegistry, IRegistryMethods, RegistryContent, RegistryType } from './IRegistry.js';
 
 export interface MergedRegistryOptions {
   registries: Array<IRegistry>;
diff --git a/src/registry/PartialRegistry.ts b/src/registry/PartialRegistry.ts
@@ -7,14 +7,8 @@ import type {
   WarpCoreConfig,
   WarpRouteDeployConfig,
 } from '@hyperlane-xyz/sdk';
-import { ChainAddresses, DeepPartial, WarpRouteId } from '../types.js';
-import {
-  AddWarpRouteConfigOptions,
-  ChainFiles,
-  IRegistry,
-  RegistryContent,
-  RegistryType,
-} from './IRegistry.js';
+import { AddWarpRouteConfigOptions, ChainAddresses, DeepPartial, WarpRouteId } from '../types.js';
+import { ChainFiles, IRegistry, RegistryContent, RegistryType } from './IRegistry.js';
 import { SynchronousRegistry } from './SynchronousRegistry.js';
 import { BaseRegistry } from './BaseRegistry.js';
 const PARTIAL_URI_PLACEHOLDER = '__partial_registry__';
diff --git a/src/registry/SynchronousRegistry.ts b/src/registry/SynchronousRegistry.ts
@@ -7,6 +7,7 @@ import type {
 } from '@hyperlane-xyz/sdk';
 
 import {
+  AddWarpRouteConfigOptions,
   ChainAddresses,
   UpdateChainParams,
   WarpDeployConfigMap,
@@ -15,7 +16,7 @@ import {
   WarpRouteId,
 } from '../types.js';
 import { BaseRegistry } from './BaseRegistry.js';
-import { AddWarpRouteConfigOptions, IRegistry, RegistryContent } from './IRegistry.js';
+import { IRegistry, RegistryContent } from './IRegistry.js';
 import { filterWarpRoutesIds } from './warp-utils.js';
 
 /**
diff --git a/src/types.ts b/src/types.ts
@@ -6,6 +6,8 @@ import {
 } from '@hyperlane-xyz/sdk';
 import { z } from 'zod';
 
+import { WARP_ROUTE_ID_REGEX } from './consts.js';
+
 // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html#the-awaited-type-and-promise-improvements
 export type MaybePromise<T> = T | Promise<T> | PromiseLike<T>;
 
@@ -37,10 +39,22 @@ export type UpdateChainParams = z.infer<typeof UpdateChainSchema> & {
   chainName: ChainName;
 };
 
-export type WarpRouteId = string;
+export const WarpRouteIdSchema = z
+  .string()
+  .regex(
+    WARP_ROUTE_ID_REGEX,
+    'Must be in the format SYMBOL/label (e.g., ETH/ethereum-base, USDC.e/arbitrum-polygon)',
+  );
+export type WarpRouteId = z.infer<typeof WarpRouteIdSchema>;
 export type WarpRouteConfigMap = Record<WarpRouteId, WarpCoreConfig>;
 export type WarpDeployConfigMap = Record<WarpRouteId, WarpRouteDeployConfig>;
 
+export const AddWarpRouteConfigOptionsSchema = z.union([
+  z.object({ symbol: z.string() }),
+  z.object({ warpRouteId: WarpRouteIdSchema }),
+]);
+export type AddWarpRouteConfigOptions = z.infer<typeof AddWarpRouteConfigOptionsSchema>;
+
 export type DeepPartial<T> = T extends object
   ? {
       [P in keyof T]?: DeepPartial<T[P]>;

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@hyperlane-xyz/registry': minor
 +---
++
 +Added write support for HttpClientRegistry with new methods: addWarpRoute(), addWarpRouteConfig(), and getWarpDeployConfigs(). Exported WarpRouteIdSchema with regex validation and WarpDeployConfigMap type for HTTP server integration.