chore: rename WarpRouteOptions -> AddWarpRouteOptions

hyperlane-xyz · Jan 17, 2025 · 3eb26b5 · 3eb26b5
1 parent fc7807f
commit 3eb26b5
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 12 deletions.
diff --git a/.changeset/little-paws-begin.md b/.changeset/little-paws-begin.md
@@ -2,4 +2,4 @@
 '@hyperlane-xyz/registry': minor
 ---
 
-Add WarpRouteOptions to addWarpRoute function
+Include AddWarpRouteOptions to addWarpRoute function
diff --git a/src/index.ts b/src/index.ts
@@ -6,11 +6,11 @@ export {
 export { BaseRegistry } from './registry/BaseRegistry.js';
 export { GithubRegistry, GithubRegistryOptions } from './registry/GithubRegistry.js';
 export {
+  AddWarpRouteOptions,
   ChainFiles,
   IRegistry,
   RegistryContent,
   RegistryType,
-  WarpRouteOptions,
 } from './registry/IRegistry.js';
 export { MergedRegistry, MergedRegistryOptions } from './registry/MergedRegistry.js';
 export { PartialRegistry, PartialRegistryOptions } from './registry/PartialRegistry.js';

diff --git a/src/registry/BaseRegistry.ts b/src/registry/BaseRegistry.ts
@@ -5,12 +5,12 @@ import type { ChainAddresses, MaybePromise } from '../types.js';
 import { WarpRouteConfigMap } from '../types.js';
 import { stripLeadingSlash } from '../utils.js';
 import type {
+  AddWarpRouteOptions,
   IRegistry,
   RegistryContent,
   RegistryType,
   UpdateChainParams,
   WarpRouteFilterParams,
-  WarpRouteOptions,
 } from './IRegistry.js';
 import { MergedRegistry } from './MergedRegistry.js';
 
@@ -47,7 +47,7 @@ export abstract class BaseRegistry implements IRegistry {
     return 'deployments/warp_routes';
   }
 
-  protected getWarpRoutesArtifactPaths({ tokens }: WarpCoreConfig, options?: WarpRouteOptions) {
+  protected getWarpRoutesArtifactPaths({ tokens }: WarpCoreConfig, options?: AddWarpRouteOptions) {
     if (!tokens.length) throw new Error('No tokens provided in config');
     const symbols = new Set<string>(tokens.map((token) => token.symbol.toUpperCase()));
     if (!options?.symbol && symbols.size !== 1)

diff --git a/src/registry/FileSystemRegistry.ts b/src/registry/FileSystemRegistry.ts
@@ -11,7 +11,7 @@ import { toYamlString } from '../utils.js';
 import {
   RegistryType,
   UpdateChainParams,
-  WarpRouteOptions,
+  type AddWarpRouteOptions,
   type ChainFiles,
   type IRegistry,
   type RegistryContent,
@@ -95,7 +95,7 @@ export class FileSystemRegistry extends SynchronousRegistry implements IRegistry
     this.removeFiles(Object.values(chainFiles));
   }
 
-  addWarpRoute(config: WarpCoreConfig, options?: WarpRouteOptions): void {
+  addWarpRoute(config: WarpCoreConfig, options?: AddWarpRouteOptions): void {
     let { configPath, addressesPath } = this.getWarpRoutesArtifactPaths(config, options);
 
     configPath = path.join(this.uri, configPath);

diff --git a/src/registry/IRegistry.ts b/src/registry/IRegistry.ts
@@ -34,7 +34,7 @@ export enum RegistryType {
   Partial = 'partial',
 }
 
-export interface WarpRouteOptions {
+export interface AddWarpRouteOptions {
   symbol?: string;
 }
 
@@ -62,7 +62,7 @@ export interface IRegistry {
 
   getWarpRoute(routeId: string): MaybePromise<WarpCoreConfig | null>;
   getWarpRoutes(filter?: WarpRouteFilterParams): MaybePromise<WarpRouteConfigMap>;
-  addWarpRoute(config: WarpCoreConfig, options?: WarpRouteOptions): MaybePromise<void>;
+  addWarpRoute(config: WarpCoreConfig, options?: AddWarpRouteOptions): MaybePromise<void>;
 
   // TODO define more deployment artifact related methods
 

diff --git a/src/registry/MergedRegistry.ts b/src/registry/MergedRegistry.ts
@@ -4,12 +4,12 @@ import type { ChainMap, ChainMetadata, ChainName, WarpCoreConfig } from '@hyperl
 import { ChainAddresses, WarpRouteConfigMap, WarpRouteId } from '../types.js';
 import { objMerge } from '../utils.js';
 import {
+  AddWarpRouteOptions,
   IRegistry,
   RegistryContent,
   RegistryType,
   UpdateChainParams,
   WarpRouteFilterParams,
-  WarpRouteOptions,
 } from './IRegistry.js';
 
 export interface MergedRegistryOptions {
@@ -108,7 +108,7 @@ export class MergedRegistry implements IRegistry {
     return results.reduce((acc, content) => objMerge(acc, content), {});
   }
 
-  async addWarpRoute(config: WarpCoreConfig, options?: WarpRouteOptions): Promise<void> {
+  async addWarpRoute(config: WarpCoreConfig, options?: AddWarpRouteOptions): Promise<void> {
     return this.multiRegistryWrite(
       async (registry) => await registry.addWarpRoute(config, options),
       'adding warp route',

diff --git a/src/registry/SynchronousRegistry.ts b/src/registry/SynchronousRegistry.ts
@@ -3,11 +3,11 @@ import type { ChainMap, ChainMetadata, ChainName, WarpCoreConfig } from '@hyperl
 import { ChainAddresses, WarpRouteConfigMap, WarpRouteId } from '../types.js';
 import { BaseRegistry } from './BaseRegistry.js';
 import {
+  AddWarpRouteOptions,
   IRegistry,
   RegistryContent,
   UpdateChainParams,
   WarpRouteFilterParams,
-  WarpRouteOptions,
 } from './IRegistry.js';
 import { filterWarpRoutesIds } from './warp-utils.js';
 
@@ -72,7 +72,7 @@ export abstract class SynchronousRegistry extends BaseRegistry implements IRegis
     return Object.fromEntries(idsWithConfigs);
   }
 
-  abstract addWarpRoute(config: WarpCoreConfig, options?: WarpRouteOptions): void;
+  abstract addWarpRoute(config: WarpCoreConfig, options?: AddWarpRouteOptions): void;
 
   protected abstract createOrUpdateChain(chain: UpdateChainParams): void;