sushi 6.7.1 → 7.0.1

package/evm/api/swap.ts

@@ -2,13 +2,12 @@ import type { Address } from 'viem'
 import * as z from 'zod'
 import { sz } from '../../generic/validate/zod.js'
 import { version } from '../../version.js'
-import type { SwapApiSupportedChainId } from '../config/index.js'
-import { szevm } from '../validate/zod.js'
 import {
-  type RouterLiquiditySource,
-  RouteStatus,
-  type TransferValue,
-} from './types.js'
+  isSwapApiSupportedChainId,
+  type SwapApiSupportedChainId,
+} from '../config/index.js'
+import { szevm } from '../validate/zod.js'
+import { RouterLiquiditySource, RouteStatus, TransferValue } from './types.js'
 
 export type SwapRequest<Simulate extends boolean = true> = {
   chainId: SwapApiSupportedChainId
@@ -19,7 +18,7 @@ export type SwapRequest<Simulate extends boolean = true> = {
   maxSlippage: number
   maxPriceImpact?: number
   source?: RouterLiquiditySource
-  fee?: bigint
+  fee?: number
   feeReceiver?: Address
   feeBy?: TransferValue
   referrer?: string
@@ -30,6 +29,43 @@ export type SwapRequest<Simulate extends boolean = true> = {
   apiKey?: string
 }
 
+const swapRequestSchema = z
+  .object({
+    chainId: z.number().int().refine(isSwapApiSupportedChainId),
+    tokenIn: szevm.address(),
+    tokenOut: szevm.address(),
+    amount: z.bigint().positive(),
+    sender: szevm.address(),
+    maxSlippage: z.number().gte(0).lt(1),
+    maxPriceImpact: z.number().positive().lte(1).optional(),
+    source: z.enum(RouterLiquiditySource).optional(),
+    fee: z.number().gte(0).lte(0.5).optional(),
+    feeReceiver: szevm.address().optional(),
+    feeBy: z.enum(TransferValue).optional(),
+    referrer: z.string().min(1).optional(),
+    baseUrl: z.url().optional(),
+    recipient: szevm.address().optional(),
+    simulate: z.boolean().optional(),
+    validate: z.boolean().optional(),
+    apiKey: z.string().min(1).optional(),
+  })
+  .superRefine((params, ctx) => {
+    if (params.fee && !params.feeReceiver) {
+      ctx.addIssue({
+        code: 'custom',
+        message: 'Fee receiver is required when fee is set',
+        path: ['feeReceiver'],
+      })
+    }
+    if (params.feeReceiver && !params.fee) {
+      ctx.addIssue({
+        code: 'custom',
+        message: 'Fee is required when fee receiver is set',
+        path: ['fee'],
+      })
+    }
+  })
+
 function swapResponseSchema<Simulate extends boolean>(simulate?: Simulate) {
   const tokenSchema = z.object({
     address: szevm.address(),
@@ -93,7 +129,7 @@ export async function getSwap<Simulate extends boolean = true>(
   params: SwapRequest<Simulate>,
   options?: RequestInit,
 ): Promise<SwapResponse<Simulate>> {
-  // TODO: VALIDATE PARAMS
+  params = swapRequestSchema.parse(params) as SwapRequest<Simulate>
   const url = new URL(
     `swap/v7/${params.chainId}`,
     params.baseUrl ?? 'https://api.sushi.com',
@@ -118,8 +154,8 @@ export async function getSwap<Simulate extends boolean = true>(
   }
 
   if (
-    typeof params.fee === 'bigint' &&
-    params.fee > 0n &&
+    typeof params.fee === 'number' &&
+    params.fee > 0 &&
     params.feeReceiver !== undefined
   ) {
     url.searchParams.append('fee', params.fee.toString())

package/evm/chain/chains.ts

@@ -31,6 +31,7 @@ import {
   optimism as optimismViem,
   polygon as polygonViem,
   polygonZkEvm as polygonZkevmViem,
+  robinhood as robinhoodViem,
   rootstock as rootstockViem,
   scroll as scrollViem,
   sepolia as sepoliaViem,
@@ -493,6 +494,11 @@ const xLayer = /* @__PURE__ */ defineEvmChain(xLayerViem, {
   parentChainId: ethereum.chainId,
 })
 
+const robinhood = /* @__PURE__ */ defineEvmChain(robinhoodViem, {
+  key: 'robinhood',
+  shortName: 'robinhood',
+})
+
 // Testnets
 const sepolia = /* @__PURE__ */ defineEvmChain(sepoliaViem, {
   key: 'sepolia',
@@ -624,7 +630,7 @@ export const evmChains = [
   monad,
   megaeth,
   xLayer,
-
+  robinhood,
   sepolia,
   arbitrumSepolia,
   tatara,

package/evm/chain/define-chain.ts

@@ -1,7 +1,7 @@
 import type { Address, Hex, Chain as ViemChain } from 'viem'
 import type {
   BlockExplorers,
-  Chain,
+  ChainDefinition,
   NetType,
 } from '../../generic/chain/interface.js'
 import type { EvmChainId, EvmChainKey } from '../chain/chains.js'
@@ -9,9 +9,11 @@ import type { EvmAddress } from '../currency/token.js'
 
 export type EvmChainType = 'evm'
 
-type EvmChainBase<TChainId extends number, TChainKey extends string> = Chain<
+type EvmChainBase<
+  TChainId extends number,
+  TChainKey extends string,
+> = ChainDefinition<
   EvmChainType,
-  // @ts-expect-error infinite loop
   TChainId,
   TChainKey,
   Readonly<string>,

package/evm/config/features/api.ts

@@ -47,6 +47,7 @@ export const SWAP_API_SUPPORTED_CHAIN_IDS = [
   EvmChainId.MONAD,
   EvmChainId.MEGAETH,
   EvmChainId.XLAYER,
+  EvmChainId.ROBINHOOD,
 ] as const
 
 export type SwapApiSupportedChainId =

package/evm/config/features/fee-collector.ts

@@ -48,6 +48,7 @@ export const FEE_COLLECTOR_CHAIN_IDS = [
   EvmChainId.MONAD,
   EvmChainId.MEGAETH,
   EvmChainId.XLAYER,
+  EvmChainId.ROBINHOOD,
 ] as const
 
 type FeeCollectorChainId = (typeof FEE_COLLECTOR_CHAIN_IDS)[number]
@@ -108,6 +109,7 @@ export const UI_FEE_COLLECTOR_ADDRESS: Record<
   [EvmChainId.MONAD]: '0xde7259893af7cdbc9fd806c6ba61d22d581d5667',
   [EvmChainId.MEGAETH]: '0xde7259893af7cdbc9fd806c6ba61d22d581d5667',
   [EvmChainId.XLAYER]: '0xd1b5e7dfc65126e261e8f254c36ab8eee57c43c9',
+  [EvmChainId.ROBINHOOD]: '0x9cb751ce2799bc90457b75a3975c1d5bd902697f',
 } as const
 export const isUIFeeCollectorChainId = isFeeCollectorChainId
 
@@ -162,6 +164,7 @@ export const SURPLUS_FEE_COLLECTOR_ADDRESS: Record<
   [EvmChainId.MONAD]: '0x5c2e112783a6854653b4bc7dc22248d3e592559c',
   [EvmChainId.MEGAETH]: '0x5c2e112783a6854653b4bc7dc22248d3e592559c',
   [EvmChainId.XLAYER]: '0x8bd735438369d318cbf39b0d5c57819a3336bde6',
+  [EvmChainId.ROBINHOOD]: '0x7282249282902e1f99c2cb0a04230091bd30fe3a',
 } as const
 export const isSurplusFeeCollectorChainId = isFeeCollectorChainId
 
@@ -216,5 +219,6 @@ export const PROTOCOL_FEE_COLLECTOR_ADDRESS: Record<
   [EvmChainId.MONAD]: '0xdbeca8fb948c42634256609bce5a3768c9b3e9eb',
   [EvmChainId.MEGAETH]: '0xdbeca8fb948c42634256609bce5a3768c9b3e9eb',
   [EvmChainId.XLAYER]: '0xdb6d24bc373d52598911c75cef401d5d2519e497',
+  [EvmChainId.ROBINHOOD]: '0x2ec2560cba6aeb2fe13bdb381700b505f5e9e4e8',
 } as const
 export const isProtocolFeeCollectorChainId = isFeeCollectorChainId

package/evm/config/features/init-code-hash.test.ts

@@ -0,0 +1,15 @@
+import { describe, expect, it } from 'vitest'
+import * as features from './index.js'
+
+describe('DEX init code hashes', () => {
+  it('are 32-byte hex values', () => {
+    for (const [name, value] of Object.entries(features)) {
+      if (!name.endsWith('_INIT_CODE_HASH')) continue
+
+      const hashes = typeof value === 'string' ? [value] : Object.values(value)
+      for (const hash of hashes) {
+        expect(hash, name).toMatch(/^0x[0-9a-f]{64}$/i)
+      }
+    }
+  })
+})

package/evm/config/features/master-chef.ts

@@ -2,10 +2,6 @@ import { EvmChainId } from '../../chain/index.js'
 
 export const MASTERCHEF_ADDRESS = {
   [EvmChainId.ETHEREUM]: '0xc2edad668740f1aa35e4d8f227fb8e17dca888cd',
-  // [EvmChainId.ROPSTEN]: '0x80c7dd17b01855a6d2347444a0fcc36136a314de',
-  // [EvmChainId.RINKEBY]: '0x80c7dd17b01855a6d2347444a0fcc36136a314de',
-  // [EvmChainId.GÖRLI]: '0x80c7dd17b01855a6d2347444a0fcc36136a314de',
-  // [EvmChainId.KOVAN]: '0x80c7dd17b01855a6d2347444a0fcc36136a314de',
 } as const
 
 export const MASTERCHEF_V2_ADDRESS = {

package/evm/config/features/operations-multisig.ts

@@ -45,6 +45,7 @@ export const MULTISIG_CHAIN_IDS = [
   EvmChainId.MONAD,
   EvmChainId.MEGAETH,
   EvmChainId.XLAYER,
+  EvmChainId.ROBINHOOD,
 ] as const
 
 export type MultisigChainId = (typeof MULTISIG_CHAIN_IDS)[number]
@@ -94,6 +95,7 @@ export const MULTISIG_ADDRESS: Record<MultisigChainId, `0x${string}`> = {
   [EvmChainId.MONAD]: '0xc4c2fc252f51b3fad6120963acf0d560526abb00',
   [EvmChainId.MEGAETH]: '0xa5b3262d0c239a82d99ecd785e07459f258160b2',
   [EvmChainId.XLAYER]: '0x67056d0429932053d8c78a248d9965f36961fe04',
+  [EvmChainId.ROBINHOOD]: '0x6fa4080b70eed82cf48570dde705026905a64657',
 } as const
 
 export const isMultisigChainId = (

package/evm/config/features/pancakeswap-v2.ts

@@ -33,7 +33,6 @@ export const PANCAKESWAP_V2_FACTORY_ADDRESS: Record<
   [EvmChainId.LINEA]: '0x02a84c1b3bbd7401a5f7fa98a384ebc70bb5749e',
   [EvmChainId.BASE]: '0x02a84c1b3bbd7401a5f7fa98a384ebc70bb5749e',
   [EvmChainId.MONAD]: '0x02a84c1b3bbd7401a5f7fa98a384ebc70bb5749e',
-  // [EvmChainId.OP_BNB]: '0x02a84c1b3bbd7401a5f7fa98a384ebc70bb5749e',
 } as const
 
 export const PANCAKESWAP_V2_INIT_CODE_HASH: Record<
@@ -53,9 +52,7 @@ export const PANCAKESWAP_V2_INIT_CODE_HASH: Record<
   [EvmChainId.LINEA]:
     '0x57224589c67f3f30a6b0d7a1b54cf3153ab84563bc609ef41dfb34f8b2974d2d',
   [EvmChainId.BASE]:
-    '0x57224589c67f3f30a6b0d7a1b54cf3153ab84563bc609ef41dfb34f8b2974d2d ',
+    '0x57224589c67f3f30a6b0d7a1b54cf3153ab84563bc609ef41dfb34f8b2974d2d',
   [EvmChainId.MONAD]:
-    '0x57224589c67f3f30a6b0d7a1b54cf3153ab84563bc609ef41dfb34f8b2974d2d ',
-  // [EvmChainId.OP_BNB]:
-  //   '0x57224589c67f3f30a6b0d7a1b54cf3153ab84563bc609ef41dfb34f8b2974d2d ',
+    '0x57224589c67f3f30a6b0d7a1b54cf3153ab84563bc609ef41dfb34f8b2974d2d',
 } as const

package/evm/config/features/red-snwapper.ts

@@ -48,6 +48,7 @@ export const RED_SNWAPPER_SUPPORTED_CHAIN_IDS = [
   EvmChainId.MONAD,
   EvmChainId.MEGAETH,
   EvmChainId.XLAYER,
+  EvmChainId.ROBINHOOD,
   // testnets
   EvmChainId.SEPOLIA,
   EvmChainId.TATARA,
@@ -104,6 +105,7 @@ export const RED_SNWAPPER_ADDRESS: Record<RedSnwapperChainId, Address> = {
   [EvmChainId.MONAD]: '0xac4c6e212a361c968f1725b4d055b47e63f80b75',
   [EvmChainId.MEGAETH]: '0xac4c6e212a361c968f1725b4d055b47e63f80b75',
   [EvmChainId.XLAYER]: '0xac4c6e212a361c968f1725b4d055b47e63f80b75',
+  [EvmChainId.ROBINHOOD]: '0x8e6fd69a77e88ee20ba4b4fbd59dfcda3ec0e98a',
   // testnets
   [EvmChainId.SEPOLIA]: '0xac4c6e212a361c968f1725b4d055b47e63f80b75',
   [EvmChainId.TATARA]: '0xac4c6e212a361c968f1725b4d055b47e63f80b75',

package/evm/config/features/uniswap-v2.ts

@@ -16,6 +16,7 @@ export const UNISWAP_V2_FACTORY_ADDRESS: Record<
   [EvmChainId.SEPOLIA]: '0xf62c03e08ada871a0beb309762e260a7a6a880e6',
   [EvmChainId.MONAD]: '0x182a927119d56008d921126764bf884221b10f59',
   [EvmChainId.XLAYER]: '0xdf38f24fe153761634be942f9d859f3dba857e95',
+  [EvmChainId.ROBINHOOD]: '0x8bceaa40b9acdfaedf85adf4ff01f5ad6517937f',
   [EvmChainId.MEGAETH]: '0xbf56488c857a881ae7e3bed27cf99c10a7ab7e50',
 }
 
@@ -35,9 +36,15 @@ export const UNISWAP_V2_SUPPORTED_CHAIN_IDS = [
   EvmChainId.SEPOLIA,
   EvmChainId.MONAD,
   EvmChainId.XLAYER,
+  EvmChainId.ROBINHOOD,
   EvmChainId.MEGAETH,
 ] as const
 
 export const UniswapV2ChainIds = UNISWAP_V2_SUPPORTED_CHAIN_IDS
 
 export type UniswapV2ChainId = (typeof UNISWAP_V2_SUPPORTED_CHAIN_IDS)[number]
+
+export const isUniswapV2ChainId = (
+  chainId: number,
+): chainId is UniswapV2ChainId =>
+  UNISWAP_V2_SUPPORTED_CHAIN_IDS.includes(chainId as UniswapV2ChainId)

package/evm/config/features/uniswap-v3.ts

@@ -57,6 +57,7 @@ export const UNISWAP_V3_SUPPORTED_CHAIN_IDS = [
   EvmChainId.PLASMA,
   EvmChainId.MONAD,
   EvmChainId.XLAYER,
+  EvmChainId.ROBINHOOD,
   EvmChainId.MEGAETH,
 ] as const
 
@@ -101,6 +102,7 @@ export const UNISWAP_V3_INIT_CODE_HASH: Record<
   [EvmChainId.PLASMA]: POOL_INIT_CODE_HASH,
   [EvmChainId.MONAD]: POOL_INIT_CODE_HASH,
   [EvmChainId.XLAYER]: POOL_INIT_CODE_HASH,
+  [EvmChainId.ROBINHOOD]: POOL_INIT_CODE_HASH,
   [EvmChainId.MEGAETH]: POOL_INIT_CODE_HASH,
 } as const
 
@@ -135,5 +137,6 @@ export const UNISWAP_V3_FACTORY_ADDRESS: Record<
   [EvmChainId.PLASMA]: '0xcb2436774c3e191c85056d248ef4260ce5f27a9d',
   [EvmChainId.MONAD]: '0x204faca1764b154221e35c0d20abb3c525710498',
   [EvmChainId.XLAYER]: '0x4b2ab38dbf28d31d467aa8993f6c2585981d6804',
+  [EvmChainId.ROBINHOOD]: '0x1f7d7550b1b028f7571e69a784071f0205fd2efa',
   [EvmChainId.MEGAETH]: '0x3a5f0cd7d62452b7f899b2a5758bfa57be0de478',
 } as const

package/evm/config/tokens/token-maps/default-bases.ts

@@ -32,6 +32,7 @@ import { EvmToken } from '../../../currency/token.js'
 import { BERACHAIN_HONEY } from '../tokens/berachain/HONEY.js'
 import { HEMI_HEMI } from '../tokens/hemi/HEMI.js'
 import { MEGAETH_USDm } from '../tokens/megaeth/USDm.js'
+import { ROBINHOOD_USDG } from '../tokens/robinhood/USDG.js'
 import { WNATIVE } from '../wrapped-native.js'
 
 /*
@@ -463,4 +464,9 @@ export const EVM_DEFAULT_BASES = {
     USDT0[EvmChainId.XLAYER],
     USDC[EvmChainId.XLAYER],
   ],
+  [EvmChainId.ROBINHOOD]: [
+    EvmNative.fromChainId(EvmChainId.ROBINHOOD),
+    WNATIVE[EvmChainId.ROBINHOOD],
+    ROBINHOOD_USDG[EvmChainId.ROBINHOOD],
+  ],
 } as const satisfies Record<EvmChainId, Readonly<EvmCurrency[]>>

package/evm/config/tokens/token-maps/default-quote.ts

@@ -17,6 +17,7 @@ import {
 import type { EvmCurrency } from '../../../currency/currency.js'
 import { EvmNative } from '../../../currency/native.js'
 import { EvmToken } from '../../../currency/token.js'
+import { ROBINHOOD_USDG } from '../tokens/robinhood/USDG.js'
 import { WNATIVE } from '../wrapped-native.js'
 
 export const defaultCurrency = {
@@ -84,4 +85,5 @@ export const defaultQuoteCurrency = {
   [EvmChainId.MONAD]: USDC[EvmChainId.MONAD],
   [EvmChainId.MEGAETH]: USDT0[EvmChainId.MEGAETH],
   [EvmChainId.XLAYER]: USDT0[EvmChainId.XLAYER],
+  [EvmChainId.ROBINHOOD]: ROBINHOOD_USDG[EvmChainId.ROBINHOOD],
 } as const satisfies Record<EvmChainId, EvmCurrency>

package/evm/config/tokens/token-maps/lsds.ts

@@ -369,6 +369,7 @@ export const LSDS = {
   [EvmChainId.MONAD]: [],
   [EvmChainId.MEGAETH]: [],
   [EvmChainId.XLAYER]: [],
+  [EvmChainId.ROBINHOOD]: [],
 
   // TESTNETS
   [EvmChainId.ARBITRUM_SEPOLIA]: [],

package/evm/config/tokens/token-maps/stables.ts

@@ -41,6 +41,7 @@ import { AUSD } from '../tokens/AUSD.js'
 import { BERACHAIN_HONEY } from '../tokens/berachain/HONEY.js'
 import { HEMI_VUSD } from '../tokens/hemi/VUSD.js'
 import { MEGAETH_USDm } from '../tokens/megaeth/USDm.js'
+import { ROBINHOOD_USDG } from '../tokens/robinhood/USDG.js'
 import { USDT0 } from '../tokens/USDT0.js'
 
 export const STABLES = {
@@ -265,6 +266,7 @@ export const STABLES = {
     USDT0[EvmChainId.XLAYER],
     USDC[EvmChainId.XLAYER],
   ],
+  [EvmChainId.ROBINHOOD]: [ROBINHOOD_USDG[EvmChainId.ROBINHOOD]],
   // TESTNETS
   [EvmChainId.ARBITRUM_SEPOLIA]: [],
   [EvmChainId.SEPOLIA]: [USDC[EvmChainId.SEPOLIA]],

package/evm/config/tokens/tokens/WETH9.ts

@@ -50,6 +50,7 @@ export const WETH9_ADDRESS = {
   [EvmChainId.MONAD]: '0xee8c0e9f1bffb4eb878d8f15f368a02a35481242',
   [EvmChainId.MEGAETH]: '0x4200000000000000000000000000000000000006',
   [EvmChainId.XLAYER]: '0x5a77f1443d16ee5761d310e38b62f77f726bc71c',
+  [EvmChainId.ROBINHOOD]: '0x0bd7d308f8e1639fab988df18a8011f41eacad73', // https://docs.robinhood.com/chain/contracts/
 } as const
 
 export const WETH9 = {

package/evm/config/tokens/tokens/index.ts

@@ -1,3 +1,4 @@
+export * from '../tokens/robinhood/index.js'
 export * from './AAVE.js'
 export * from './AERO.js'
 export * from './AGEUR.js'

package/evm/config/tokens/tokens/robinhood/USDG.ts

@@ -0,0 +1,11 @@
+import { EvmChainId } from '../../../../chain/chains.js'
+import { addressMapToTokenMap } from '../../address-map-to-token-map.js'
+
+export const ROBINHOOD_USDG_ADDRESS = {
+  [EvmChainId.ROBINHOOD]: '0x5fc5360d0400a0fd4f2af552add042d716f1d168',
+} as const
+
+export const ROBINHOOD_USDG = addressMapToTokenMap(
+  { decimals: 6, symbol: 'USDG', name: 'Global Dollar' },
+  ROBINHOOD_USDG_ADDRESS,
+)

package/evm/config/tokens/tokens/robinhood/index.ts

@@ -0,0 +1 @@
+export * from './USDG.js'

package/evm/config/tokens/wrapped-native.ts

@@ -57,6 +57,7 @@ export const WNATIVE_ADDRESS = {
   [EvmChainId.MONAD]: '0x3bd359c1119da7da1d913d1c4d2b7c461115433a',
   [EvmChainId.MEGAETH]: WETH9_ADDRESS[EvmChainId.MEGAETH],
   [EvmChainId.XLAYER]: '0xe538905cf8410324e03a5a23c1c177a474d59b2b',
+  [EvmChainId.ROBINHOOD]: '0x0bd7d308f8e1639fab988df18a8011f41eacad73', // https://docs.robinhood.com/chain/contracts/
 } as const satisfies Record<EvmChainId, Address>
 
 export const WNATIVE = {
@@ -277,6 +278,13 @@ export const WNATIVE = {
     symbol: 'WOKB',
     name: 'Wrapped OKB',
   }),
+  [EvmChainId.ROBINHOOD]: new EvmToken({
+    chainId: EvmChainId.ROBINHOOD,
+    address: WNATIVE_ADDRESS[EvmChainId.ROBINHOOD],
+    decimals: 18,
+    symbol: 'WETH',
+    name: 'WETH',
+  }),
 } as const satisfies Record<EvmChainId, EvmToken>
 
 export const isEvmWNativeSupported = (chainId: EvmChainId) =>

package/evm/currency/deserialize-currency.ts

@@ -1,3 +1,4 @@
+import { createCurrencyDeserializer } from '../../generic/currency/deserialize-currency.js'
 import { EvmNative, type SerializedEvmNative } from './native.js'
 import { EvmToken, type SerializedEvmToken } from './token.js'
 
@@ -7,11 +8,12 @@ function deserializeEvmCurrency(data: SerializedEvmNative): EvmNative
 function deserializeEvmCurrency(
   data: SerializedEvmNative | SerializedEvmToken,
 ) {
-  if (data.type === 'native') {
-    return new EvmNative(data)
-  } else {
-    return new EvmToken(data)
-  }
+  return deserialize({ ...data, type: data.type })
 }
 
+const deserialize = createCurrencyDeserializer({
+  native: EvmNative,
+  token: EvmToken,
+})
+
 export { deserializeEvmCurrency }

package/evm/currency/token.ts

@@ -1,7 +1,8 @@
 import invariant from 'tiny-invariant'
 import { type Address, type Hex, isAddress } from 'viem'
-import * as z from 'zod'
+import type * as z from 'zod'
 import type { CurrencyMetadata } from '../../generic/currency/currency.js'
+import { createSerializedTokenSchema } from '../../generic/currency/serialized-token.js'
 import { Token } from '../../generic/currency/token.js'
 import { type EvmChainId, isEvmChainId } from '../chain/chains.js'
 import { normalizeEvmAddress } from '../utils/normalize-address.js'
@@ -64,7 +65,7 @@ export class EvmToken<
       type: this.type,
 
       metadata: this.metadata,
-    } as const
+    }
   }
 
   static fromJSON<TMetadata extends CurrencyMetadata>(
@@ -83,26 +84,10 @@ export const serializedEvmTokenSchema = <
 }: {
   metadata?: z.ZodType<TMetadata>
 } = {}) =>
-  z.object({
-    chainId: z
-      .number()
-      .int()
-      .refine(isEvmChainId)
-      .transform((chainId) => chainId as EvmChainId),
-    address: z
-      .string()
-      .refine(isEvmAddress)
-      .transform((address) => address as EvmAddress),
-    symbol: z.string(),
-    name: z.string(),
-    decimals: z.number().int().nonnegative(),
-    type: z.literal('token'),
-
-    metadata: (metadata ||
-      z
-        .record(z.string(), z.unknown())
-        .optional()
-        .default({})) as z.ZodType<TMetadata>,
+  createSerializedTokenSchema({
+    isChainId: isEvmChainId,
+    isAddress: isEvmAddress,
+    metadata,
   })
 
 export type SerializedEvmToken<

package/evm/pool/sushiswap-v3/utils/tickList.ts

@@ -67,7 +67,6 @@ export abstract class TickList {
     let l = 0
     let r = ticks.length - 1
     let i
-    // eslint-disable-next-line no-constant-condition
     while (true) {
       i = Math.floor((l + r) / 2)
 

package/evm/token-list/index.ts

@@ -1,2 +1 @@
-export * from '@uniswap/token-lists'
 export * from './constants.js'

package/evm/types/sushi-pool/steer-vault-id.ts

@@ -1,5 +1,5 @@
-import type { SushiSwapV3ChainId } from '~/evm/config/features/sushiswap-v3.js'
-import type { EvmAddress } from '~/evm/currency/token.js'
+import type { SushiSwapV3ChainId } from '../../config/features/sushiswap-v3.js'
+import type { EvmAddress } from '../../currency/token.js'
 import type { EvmID } from '../id.js'
 
 export type SteerVaultId = {

package/evm/validate/zod.ts

@@ -1,14 +1,9 @@
-import * as z from 'zod'
-import { type EvmAddress, isEvmAddress } from '../currency/token.js'
+import { createAddressSchema } from '../../generic/validate/create-address-schema.js'
+import { isEvmAddress } from '../currency/token.js'
 import { normalizeEvmAddress } from '../utils/normalize-address.js'
 
 export const evmAddress = () =>
-  z
-    .string()
-    .refine((value) => isEvmAddress(value), {
-      message: 'Invalid address',
-    })
-    .transform((value) => normalizeEvmAddress(value as EvmAddress))
+  createAddressSchema(isEvmAddress, normalizeEvmAddress)
 
 export const szevm = {
   address: evmAddress,

package/generic/chain/chains.test-d.ts

@@ -0,0 +1,35 @@
+import { expectTypeOf, test } from 'vitest'
+import type { EvmChainId } from '../../evm/chain/chains.js'
+import type { SvmChainId } from '../../svm/chain/chains.js'
+import type { AddressFor, TxHashFor } from '../types/for-chain.js'
+import { type ChainId, getChainById } from './chains.js'
+import type { Chain, ChainDefinition } from './interface.js'
+
+test('public Chain only accepts registered chain IDs and keys', () => {
+  // @ts-expect-error 999999 and unknown are not registered
+  expectTypeOf<Chain<'evm', 999999, 'unknown'>>()
+
+  expectTypeOf<ChainDefinition<'evm', 999999, 'unknown'>>().not.toBeNever()
+})
+
+test('getChainById URL methods remain callable for generic chain IDs', () => {
+  function getExplorerUrls<TChainId extends ChainId>(
+    chainId: TChainId,
+    address: AddressFor<TChainId>,
+    txHash: TxHashFor<TChainId>,
+  ) {
+    const chain = getChainById(chainId)
+
+    return {
+      account: chain.getAccountUrl(address),
+      token: chain.getTokenUrl(address),
+      transaction: chain.getTransactionUrl(txHash),
+    }
+  }
+
+  expectTypeOf(getExplorerUrls).toBeCallableWith(
+    1 as EvmChainId | SvmChainId,
+    'address' as AddressFor<EvmChainId | SvmChainId>,
+    'hash' as TxHashFor<EvmChainId | SvmChainId>,
+  )
+})

package/generic/chain/chains.ts

@@ -48,9 +48,11 @@ export function isChainId(chainId: number): chainId is ChainId {
   return chains.some((chain) => chain.chainId === chainId)
 }
 
-type ChainById<C extends ChainId> = Extract<
-  (typeof chains)[number],
-  { chainId: C }
+type ChainUrlMethod = 'getTransactionUrl' | 'getAccountUrl' | 'getTokenUrl'
+
+type ChainById<C extends ChainId> = Omit<
+  Extract<(typeof chains)[number], { chainId: C }>,
+  ChainUrlMethod
 > & {
   getTransactionUrl: (input: TxHashFor<C>) => string
   getAccountUrl: (input: AddressFor<C>) => string
@@ -58,7 +60,9 @@ type ChainById<C extends ChainId> = Extract<
 }
 
 export function getChainById<C extends ChainId>(chainId: C) {
-  return chains.find((chain) => chain.chainId === chainId)! as ChainById<C>
+  return chains.find(
+    (chain) => chain.chainId === chainId,
+  )! as unknown as ChainById<C>
 }
 
 // MainnetChainId

package/generic/chain/define-chain.ts

@@ -0,0 +1,45 @@
+import type {
+  BlockExplorers,
+  ChainDefinition,
+  ChainType,
+  NetType,
+} from './interface.js'
+
+type ChainBase<
+  TType extends ChainType,
+  TAddress extends string,
+> = ChainDefinition<
+  TType,
+  number,
+  string,
+  string,
+  string,
+  NetType,
+  BlockExplorers,
+  TAddress,
+  string
+>
+
+export type ChainUrlBuilders<TAddress extends string> = {
+  transaction: (baseUrl: string, input: string) => string
+  account: (baseUrl: string, input: string) => string
+  token: (baseUrl: string, input: TAddress) => string
+}
+
+export function defineChain<
+  const TType extends ChainType,
+  TAddress extends string,
+  const T extends Omit<
+    ChainBase<TType, TAddress>,
+    'type' | 'getTransactionUrl' | 'getAccountUrl' | 'getTokenUrl'
+  >,
+>(type: TType, chain: T, urls: ChainUrlBuilders<TAddress>) {
+  const baseUrl = chain.blockExplorers.default.url
+  return {
+    ...chain,
+    type,
+    getTransactionUrl: (input: string) => urls.transaction(baseUrl, input),
+    getAccountUrl: (input: string) => urls.account(baseUrl, input),
+    getTokenUrl: (input: TAddress) => urls.token(baseUrl, input),
+  } as const satisfies ChainBase<TType, TAddress>
+}

package/generic/chain/index.ts

@@ -1,2 +1,3 @@
 export * from './chains.js'
+export * from './define-chain.js'
 export type * from './interface.js'