ox 0.14.32 → 0.14.34

package/tempo/ZoneId.ts

@@ -1,58 +1,94 @@
-import type * as Errors from '../core/Errors.js'
+import * as Errors from '../core/Errors.js'
+
+const chainIdConfig = {
+  4217: {
+    base: 421_700_000,
+    range: 1_002_610_000,
+  },
+  42431: {
+    base: 1_424_310_000,
+    range: 723_173_648,
+  },
+} as const
+
+const defaultSourceId = 4_217
 
 /**
- * Base offset for deriving zone chain IDs.
- *
- * Zone chain IDs are computed as `chainIdBase + zoneId`.
+ * Base offset for deriving Presto zone chain IDs.
  */
-export const chainIdBase = 4_217_000_000 as const
+export const chainIdBase = chainIdConfig[defaultSourceId].base
+
+/** Tempo source chain ID. */
+export type SourceId = keyof typeof chainIdConfig
 
 /**
  * Derives a zone ID from a zone chain ID.
  *
- * Zone chain IDs follow the formula `4_217_000_000 + zoneId`, so a chain ID
- * of `4217000006` corresponds to zone ID `6`.
+ * Zone chain IDs use the base assigned to their Tempo source chain.
  *
  * @example
  * ```ts twoslash
  * import { ZoneId } from 'ox/tempo'
  *
- * const zoneId = ZoneId.fromChainId(4_217_000_006)
- * // @log: 6
+ * const zoneId = ZoneId.fromChainId(421_700_001)
+ * // @log: 1
  * ```
  *
  * @param chainId - The zone chain ID.
+ * @param sourceId - The Tempo source chain ID. Defaults to `4217` (Presto).
  * @returns The zone ID.
  */
-export function fromChainId(chainId: number): number {
-  return chainId - chainIdBase
+export function fromChainId(
+  chainId: number,
+  sourceId: SourceId = defaultSourceId,
+): number {
+  return chainId - getChainIdConfig(sourceId).base
 }
 
 export declare namespace fromChainId {
-  type ErrorType = Errors.GlobalErrorType
+  type ErrorType = typeof UnsupportedSourceIdError | Errors.GlobalErrorType
 }
 
 /**
  * Derives a zone chain ID from a zone ID.
  *
- * Zone chain IDs follow the formula `4_217_000_000 + zoneId`, so zone ID
- * `6` corresponds to chain ID `4217000006`.
+ * Zone chain IDs use the base and range assigned to their Tempo source chain.
  *
  * @example
  * ```ts twoslash
  * import { ZoneId } from 'ox/tempo'
  *
- * const chainId = ZoneId.toChainId(6)
- * // @log: 4217000006
+ * const chainId = ZoneId.toChainId(1)
+ * // @log: 421700001
  * ```
  *
  * @param zoneId - The zone ID.
+ * @param sourceId - The Tempo source chain ID. Defaults to `4217` (Presto).
  * @returns The zone chain ID.
  */
-export function toChainId(zoneId: number): number {
-  return chainIdBase + zoneId
+export function toChainId(
+  zoneId: number,
+  sourceId: SourceId = defaultSourceId,
+): number {
+  const { base, range } = getChainIdConfig(sourceId)
+  return base + (zoneId % range)
 }
 
 export declare namespace toChainId {
-  type ErrorType = Errors.GlobalErrorType
+  type ErrorType = typeof UnsupportedSourceIdError | Errors.GlobalErrorType
+}
+
+/** Thrown when a Tempo source chain ID is unsupported. */
+export class UnsupportedSourceIdError extends Errors.BaseError {
+  override readonly name = 'ZoneId.UnsupportedSourceIdError'
+  constructor({ sourceId }: { sourceId: number }) {
+    super(`Source chain ID "${sourceId}" is not supported.`, {
+      metaMessages: ['Supported source chain IDs: 4217, 42431.'],
+    })
+  }
+}
+
+function getChainIdConfig(sourceId: number) {
+  if (sourceId === 4_217 || sourceId === 42_431) return chainIdConfig[sourceId]
+  throw new UnsupportedSourceIdError({ sourceId })
 }

package/tempo/index.ts

@@ -136,7 +136,7 @@ export * as KeyAuthorization from './KeyAuthorization.js'
  * ```ts twoslash
  * import { MultisigConfig } from 'ox/tempo'
  *
- * const genesisConfig = MultisigConfig.from({
+ * const initialConfig = MultisigConfig.from({
  *   threshold: 2,
  *   owners: [
  *     { owner: '0x1111111111111111111111111111111111111111', weight: 1 },
@@ -144,7 +144,7 @@ export * as KeyAuthorization from './KeyAuthorization.js'
  *   ],
  * })
  *
- * const account = MultisigConfig.getAddress(genesisConfig)
+ * const account = MultisigConfig.getAddress(initialConfig)
  * ```
  *
  * @category Reference
@@ -524,18 +524,17 @@ export * as VirtualMaster from './VirtualMaster.js'
 /**
  * Zone ID utilities for converting between zone IDs and zone chain IDs.
  *
- * Zone chain IDs are deterministically derived from zone IDs using the formula
- * `421_700_000 + zoneId`. This module provides helpers to convert between them.
+ * Zone chain IDs use the base and range assigned to their Tempo source chain.
  *
  * @example
  * ```ts twoslash
  * import { ZoneId } from 'ox/tempo'
  *
- * const zoneId = ZoneId.fromChainId(421_700_026)
- * // @log: 26
+ * const zoneId = ZoneId.fromChainId(421_700_001)
+ * // @log: 1
  *
- * const chainId = ZoneId.toChainId(26)
- * // @log: 421700026
+ * const chainId = ZoneId.toChainId(1)
+ * // @log: 421700001
  * ```
  *
  * @category Reference