sushi 6.6.7 → 6.6.9

package/generic/currency/currency.test-d.ts

@@ -16,6 +16,7 @@ import { MvmToken } from '../../mvm/currency/token.js'
 import {
   type SvmAddress,
   type SvmChainId,
+  type SvmCurrency,
   SvmNative,
   SvmToken,
 } from '../../svm/index.js'
@@ -199,6 +200,46 @@ describe('generic/currency/currency.ts types', () => {
     })
   })
 
+  describe('metadata generics', () => {
+    type Metadata = {
+      coingeckoId: string
+      verified: boolean
+    }
+
+    it('should preserve metadata on generic currency variants', () => {
+      const mockCurrency = {} as Currency<EvmChainId, Metadata>
+
+      expectTypeOf(mockCurrency)
+        .extract<{ isNative: true }>()
+        .toEqualTypeOf<Native<EvmChainId, Metadata>>()
+      expectTypeOf(mockCurrency)
+        .extract<{ isToken: true }>()
+        .toEqualTypeOf<Token<EvmChainId, string, Metadata>>()
+    })
+
+    it('should preserve metadata on EVM currency variants', () => {
+      const mockCurrency = {} as EvmCurrency<Metadata>
+
+      expectTypeOf(mockCurrency)
+        .extract<{ isNative: true }>()
+        .toEqualTypeOf<EvmNative<Metadata>>()
+      expectTypeOf(mockCurrency)
+        .extract<{ isToken: true }>()
+        .toEqualTypeOf<EvmToken<Metadata>>()
+    })
+
+    it('should preserve metadata on SVM currency variants', () => {
+      const mockCurrency = {} as SvmCurrency<Metadata>
+
+      expectTypeOf(mockCurrency)
+        .extract<{ isNative: true }>()
+        .toEqualTypeOf<SvmNative<Metadata>>()
+      expectTypeOf(mockCurrency)
+        .extract<{ isToken: true }>()
+        .toEqualTypeOf<SvmToken<Metadata>>()
+    })
+  })
+
   describe('currency type extension', () => {
     type CustomAddress = `${EvmAddress}-${EvmAddress}`
     type SerializedCustomToken = {

package/generic/currency/currency.ts

@@ -69,4 +69,4 @@ export abstract class BaseCurrency<
 export type Currency<
   TChainId extends ChainId = ChainId,
   TMetadata extends CurrencyMetadata = Record<string, unknown>,
-> = Native<TChainId> | Token<TChainId, string, TMetadata>
+> = Native<TChainId, TMetadata> | Token<TChainId, string, TMetadata>

package/generic/currency/for-chain.test-d.ts

@@ -0,0 +1,248 @@
+import { describe, expectTypeOf, it } from 'vitest'
+import { EvmChainId } from '../../evm/chain/chains.js'
+import type { EvmNative } from '../../evm/currency/native.js'
+import type {
+  EvmAddress,
+  EvmToken,
+  EvmTokenOrigin,
+} from '../../evm/currency/token.js'
+import { MvmChainId } from '../../mvm/chain/chains.js'
+import type { MvmAddress, MvmToken } from '../../mvm/currency/token.js'
+import type { StellarContractAddress } from '../../stellar/address.js'
+import { StellarChainId } from '../../stellar/chain/chains.js'
+import type { StellarToken } from '../../stellar/currency/token.js'
+import { SvmChainId } from '../../svm/chain/chains.js'
+import type { SvmNative } from '../../svm/currency/native.js'
+import {
+  type SvmAddress,
+  type SvmToken,
+  svmAddress,
+} from '../../svm/currency/token.js'
+import type { AddressFor, NativeChainId, TokenFor } from '../types/for-chain.js'
+import {
+  getNativeFor,
+  getTokenFor,
+  type TokenConstructorDataFor,
+} from './for-chain.js'
+
+describe('generic/currency/for-chain.ts types', () => {
+  type Metadata = {
+    coingeckoId: string
+    verified: boolean
+  }
+
+  describe('getNativeFor', () => {
+    it('returns the native currency class for each supported native chain family', () => {
+      const metadata: Metadata = { coingeckoId: 'ethereum', verified: true }
+
+      expectTypeOf(getNativeFor(EvmChainId.ETHEREUM, metadata)).toEqualTypeOf<
+        EvmNative<Metadata>
+      >()
+      expectTypeOf(getNativeFor(SvmChainId.SOLANA, metadata)).toEqualTypeOf<
+        SvmNative<Metadata>
+      >()
+    })
+
+    it('returns a native union for native chain id unions', () => {
+      const chainId = {} as NativeChainId
+      const metadata: Metadata = { coingeckoId: 'native', verified: true }
+
+      expectTypeOf(getNativeFor(chainId, metadata)).toEqualTypeOf<
+        EvmNative<Metadata> | SvmNative<Metadata>
+      >()
+    })
+
+    it('rejects chain families without native currency classes', () => {
+      // @ts-expect-error MVM currently models currencies as tokens only.
+      getNativeFor(MvmChainId.APTOS, {})
+
+      // @ts-expect-error Stellar currently models currencies as tokens only.
+      getNativeFor(StellarChainId.STELLAR, {})
+    })
+  })
+
+  describe('TokenConstructorDataFor', () => {
+    it('matches EVM token constructor data without chainId', () => {
+      expectTypeOf<
+        TokenConstructorDataFor<EvmChainId, Metadata>
+      >().toMatchTypeOf<{
+        chainId?: EvmChainId
+        address: EvmAddress
+        symbol: string
+        name: string
+        decimals: number
+        metadata?: Metadata
+        origin?: EvmTokenOrigin | undefined
+      }>()
+
+      const data = {
+        address: '0x1234567890abcdef1234567890abcdef12345678',
+        symbol: 'TEST',
+        name: 'Test Token',
+        decimals: 18,
+        metadata: { coingeckoId: 'test-token', verified: true },
+      } satisfies TokenConstructorDataFor<EvmChainId, Metadata>
+
+      expectTypeOf(data.metadata).toMatchTypeOf<Metadata>()
+    })
+
+    it('matches MVM token constructor data without EVM/SVM/Stellar-only fields', () => {
+      const data = {
+        address: '0x1::aptos_coin::AptosCoin',
+        symbol: 'APT',
+        name: 'Aptos Coin',
+        decimals: 8,
+      } satisfies TokenConstructorDataFor<MvmChainId>
+
+      expectTypeOf(data.address).toMatchTypeOf<MvmAddress>()
+
+      const dataWithOrigin = {
+        address: '0x1::aptos_coin::AptosCoin',
+        symbol: 'APT',
+        name: 'Aptos Coin',
+        decimals: 8,
+        // @ts-expect-error origin is not part of MVM token constructor data.
+        origin: 'native',
+      } satisfies TokenConstructorDataFor<MvmChainId>
+
+      void dataWithOrigin
+    })
+
+    it('matches SVM token constructor data and preserves branded addresses', () => {
+      const data = {
+        address: svmAddress('EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v'),
+        symbol: 'USDC',
+        name: 'USD Coin',
+        decimals: 6,
+        metadata: { coingeckoId: 'usd-coin', verified: true },
+      } satisfies TokenConstructorDataFor<SvmChainId, Metadata>
+
+      expectTypeOf(data.address).toMatchTypeOf<SvmAddress>()
+      expectTypeOf(data.metadata).toMatchTypeOf<Metadata>()
+    })
+
+    it('matches Stellar token constructor data including issuer and origin', () => {
+      const data = {
+        address: 'CAS3J7GYLGXMF6TDJBBYYSE3HQ6BBSMLNUQ34T6TZMYMW2EVH34XOWMA',
+        issuer: 'GDMTVHLWJTHSUDMZVVMXXH6VJHA2ZV3HNG5LYNAZ6RTWB7GISM6PGTUV',
+        symbol: 'XLM',
+        name: 'XLM',
+        decimals: 7,
+        origin: 'stellar.org',
+      } satisfies TokenConstructorDataFor<StellarChainId>
+
+      expectTypeOf(data.address).toMatchTypeOf<StellarContractAddress>()
+      expectTypeOf(data.origin).toMatchTypeOf<string>()
+    })
+
+    it('accepts chainId for compatibility', () => {
+      const dataWithChainId = {
+        address: '0x1234567890abcdef1234567890abcdef12345678',
+        symbol: 'TEST',
+        name: 'Test Token',
+        decimals: 18,
+        chainId: EvmChainId.ETHEREUM,
+      } satisfies TokenConstructorDataFor<EvmChainId>
+
+      void dataWithChainId
+    })
+  })
+
+  describe('getTokenFor', () => {
+    it('returns the token class selected by the chain id', () => {
+      expectTypeOf(
+        getTokenFor(EvmChainId.ETHEREUM, {
+          chainId: EvmChainId.POLYGON,
+          address: '0x1234567890abcdef1234567890abcdef12345678',
+          symbol: 'TEST',
+          name: 'Test Token',
+          decimals: 18,
+          metadata: { coingeckoId: 'test-token', verified: true },
+        }),
+      ).toEqualTypeOf<EvmToken<Metadata>>()
+
+      expectTypeOf(
+        getTokenFor(MvmChainId.APTOS, {
+          address: '0x1::aptos_coin::AptosCoin',
+          symbol: 'APT',
+          name: 'Aptos Coin',
+          decimals: 8,
+        }),
+      ).toEqualTypeOf<MvmToken<Record<string, unknown>>>()
+
+      expectTypeOf(
+        getTokenFor(SvmChainId.SOLANA, {
+          address: svmAddress('EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v'),
+          symbol: 'USDC',
+          name: 'USD Coin',
+          decimals: 6,
+          metadata: { coingeckoId: 'usd-coin', verified: true },
+        }),
+      ).toEqualTypeOf<SvmToken<Metadata>>()
+
+      expectTypeOf(
+        getTokenFor(StellarChainId.STELLAR, {
+          address: 'CAS3J7GYLGXMF6TDJBBYYSE3HQ6BBSMLNUQ34T6TZMYMW2EVH34XOWMA',
+          symbol: 'XLM',
+          name: 'XLM',
+          decimals: 7,
+        }),
+      ).toEqualTypeOf<StellarToken<Record<string, unknown>>>()
+    })
+
+    it('returns a token union for generic chain id unions', () => {
+      const chainId = {} as EvmChainId | SvmChainId
+      const data = {} as TokenConstructorDataFor<
+        EvmChainId | SvmChainId,
+        Metadata
+      >
+
+      expectTypeOf(getTokenFor(chainId, data)).toEqualTypeOf<
+        EvmToken<Metadata> | SvmToken<Metadata>
+      >()
+    })
+
+    it('accepts generic EVM/SVM token input with address derived from the chain id', () => {
+      type GenericTokenInput<TChainId extends EvmChainId | SvmChainId> = {
+        address: AddressFor<TChainId>
+        symbol: string
+        name: string
+        decimals: number
+        metadata: Metadata
+      }
+
+      function getGenericTokenFor<TChainId extends EvmChainId | SvmChainId>(
+        chainId: TChainId,
+        input: GenericTokenInput<TChainId>,
+      ) {
+        return getTokenFor(chainId, input)
+      }
+
+      const chainId = {} as EvmChainId | SvmChainId
+      const input = {} as GenericTokenInput<typeof chainId>
+
+      expectTypeOf(getGenericTokenFor(chainId, input)).toEqualTypeOf<
+        TokenFor<EvmChainId | SvmChainId, Metadata>
+      >()
+    })
+
+    it('rejects constructor data for a different chain family', () => {
+      getTokenFor(SvmChainId.SOLANA, {
+        // @ts-expect-error SVM token data requires an SVM address.
+        address: '0x1234567890abcdef1234567890abcdef12345678',
+        symbol: 'TEST',
+        name: 'Test Token',
+        decimals: 18,
+      })
+
+      getTokenFor(MvmChainId.APTOS, {
+        address: '0x1::aptos_coin::AptosCoin',
+        symbol: 'APT',
+        name: 'Aptos Coin',
+        decimals: 8,
+        // @ts-expect-error issuer is Stellar-specific token data.
+        issuer: 'GDMTVHLWJTHSUDMZVVMXXH6VJHA2ZV3HNG5LYNAZ6RTWB7GISM6PGTUV',
+      })
+    })
+  })
+})

package/generic/currency/for-chain.test.ts

@@ -0,0 +1,108 @@
+import { describe, expect, expectTypeOf, it } from 'vitest'
+import { EvmChainId } from '../../evm/chain/chains.js'
+import { EvmNative } from '../../evm/currency/native.js'
+import { EvmToken } from '../../evm/currency/token.js'
+import { MvmChainId } from '../../mvm/chain/chains.js'
+import { MvmToken } from '../../mvm/currency/token.js'
+import { StellarChainId } from '../../stellar/chain/chains.js'
+import { StellarToken } from '../../stellar/currency/token.js'
+import { SvmChainId } from '../../svm/chain/chains.js'
+import { SvmNative } from '../../svm/currency/native.js'
+import { SvmToken, svmAddress } from '../../svm/currency/token.js'
+import { getNativeFor, getTokenFor } from './for-chain.js'
+
+describe('generic/currency/for-chain.ts', () => {
+  describe('getNativeFor', () => {
+    it('creates EVM native currencies with metadata', () => {
+      type Metadata = { verified: boolean }
+      const metadata: Metadata = { verified: true }
+
+      const native = getNativeFor(EvmChainId.ETHEREUM, metadata)
+
+      expect(native).toBeInstanceOf(EvmNative)
+      expect(native.chainId).toBe(EvmChainId.ETHEREUM)
+      expect(native.metadata).toBe(metadata)
+      expectTypeOf(native).toEqualTypeOf<EvmNative<Metadata>>()
+    })
+
+    it('creates SVM native currencies with metadata', () => {
+      type Metadata = { coingeckoId: string }
+      const metadata: Metadata = { coingeckoId: 'solana' }
+
+      const native = getNativeFor(SvmChainId.SOLANA, metadata)
+
+      expect(native).toBeInstanceOf(SvmNative)
+      expect(native.chainId).toBe(SvmChainId.SOLANA)
+      expect(native.metadata).toBe(metadata)
+      expectTypeOf(native).toEqualTypeOf<SvmNative<Metadata>>()
+    })
+  })
+
+  describe('getTokenFor', () => {
+    it('creates EVM tokens from constructor data', () => {
+      type Metadata = { logoUrl: string }
+      const metadata: Metadata = { logoUrl: 'https://example.com/token.png' }
+
+      const token = getTokenFor(EvmChainId.ETHEREUM, {
+        chainId: EvmChainId.POLYGON,
+        address: '0x1234567890abcdef1234567890abcdef12345678',
+        symbol: 'TEST',
+        name: 'Test Token',
+        decimals: 18,
+        metadata,
+      })
+
+      expect(token).toBeInstanceOf(EvmToken)
+      expect(token.chainId).toBe(EvmChainId.ETHEREUM)
+      expect(token.metadata).toBe(metadata)
+      expectTypeOf(token).toEqualTypeOf<EvmToken<Metadata>>()
+    })
+
+    it('creates MVM tokens from constructor data', () => {
+      const token = getTokenFor(MvmChainId.APTOS, {
+        address: '0x1::aptos_coin::AptosCoin',
+        symbol: 'APT',
+        name: 'Aptos Coin',
+        decimals: 8,
+      })
+
+      expect(token).toBeInstanceOf(MvmToken)
+      expect(token.chainId).toBe(MvmChainId.APTOS)
+      expectTypeOf(token).toEqualTypeOf<MvmToken<Record<string, unknown>>>()
+    })
+
+    it('creates SVM tokens from constructor data', () => {
+      type Metadata = { tags: string[] }
+      const metadata: Metadata = { tags: ['stablecoin'] }
+
+      const token = getTokenFor(SvmChainId.SOLANA, {
+        address: svmAddress('EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v'),
+        symbol: 'USDC',
+        name: 'USD Coin',
+        decimals: 6,
+        metadata,
+      })
+
+      expect(token).toBeInstanceOf(SvmToken)
+      expect(token.chainId).toBe(SvmChainId.SOLANA)
+      expect(token.metadata).toBe(metadata)
+      expectTypeOf(token).toEqualTypeOf<SvmToken<Metadata>>()
+    })
+
+    it('creates Stellar tokens from constructor data', () => {
+      const token = getTokenFor(StellarChainId.STELLAR, {
+        address: 'CAS3J7GYLGXMF6TDJBBYYSE3HQ6BBSMLNUQ34T6TZMYMW2EVH34XOWMA',
+        issuer: 'GDMTVHLWJTHSUDMZVVMXXH6VJHA2ZV3HNG5LYNAZ6RTWB7GISM6PGTUV',
+        symbol: 'XLM',
+        name: 'XLM',
+        decimals: 7,
+        origin: 'stellar.org',
+      })
+
+      expect(token).toBeInstanceOf(StellarToken)
+      expect(token.chainId).toBe(StellarChainId.STELLAR)
+      expect(token.origin).toBe('stellar.org')
+      expectTypeOf(token).toEqualTypeOf<StellarToken<Record<string, unknown>>>()
+    })
+  })
+})

package/generic/currency/for-chain.ts

@@ -0,0 +1,152 @@
+import {
+  type EvmChainId,
+  getEvmChainById,
+  isEvmChainId,
+} from '../../evm/chain/chains.js'
+import { EvmNative } from '../../evm/currency/native.js'
+import { EvmToken } from '../../evm/currency/token.js'
+import { isMvmChainId, type MvmChainId } from '../../mvm/chain/chains.js'
+import { MvmToken } from '../../mvm/currency/token.js'
+import {
+  isStellarChainId,
+  type StellarChainId,
+} from '../../stellar/chain/chains.js'
+import { StellarToken } from '../../stellar/currency/token.js'
+import {
+  getSvmChainById,
+  isSvmChainId,
+  type SvmChainId,
+} from '../../svm/chain/chains.js'
+import { SvmNative } from '../../svm/currency/native.js'
+import { SvmToken } from '../../svm/currency/token.js'
+import type { ChainId } from '../chain/chains.js'
+import type {
+  AddressFor,
+  NativeChainId,
+  NativeFor,
+  TokenFor,
+} from '../types/for-chain.js'
+import { assertNever } from '../utils/assert-never.js'
+import type { CurrencyMetadata } from './currency.js'
+
+type ConstructorData<T extends abstract new (...args: any) => any> =
+  ConstructorParameters<T>[0] extends { chainId: infer TChainId }
+    ? Omit<ConstructorParameters<T>[0], 'chainId'> & { chainId?: TChainId }
+    : never
+
+type EvmTokenConstructorData<TMetadata extends CurrencyMetadata> =
+  ConstructorData<typeof EvmToken<TMetadata>>
+type MvmTokenConstructorData<TMetadata extends CurrencyMetadata> =
+  ConstructorData<typeof MvmToken<TMetadata>>
+type SvmTokenConstructorData<TMetadata extends CurrencyMetadata> =
+  ConstructorData<typeof SvmToken<TMetadata>>
+type StellarTokenConstructorData<TMetadata extends CurrencyMetadata> =
+  ConstructorData<typeof StellarToken<TMetadata>>
+
+type GenericTokenConstructorData<
+  TChainId extends ChainId,
+  TMetadata extends CurrencyMetadata,
+> = {
+  chainId?: TChainId
+  address: AddressFor<TChainId>
+  symbol: string
+  name: string
+  decimals: number
+  metadata?: TMetadata
+}
+
+export type TokenConstructorDataFor<
+  TChainId extends ChainId,
+  TMetadata extends CurrencyMetadata = CurrencyMetadata,
+> =
+  | GenericTokenConstructorData<TChainId, TMetadata>
+  | (TChainId extends EvmChainId
+      ? EvmTokenConstructorData<TMetadata>
+      : TChainId extends MvmChainId
+        ? MvmTokenConstructorData<TMetadata>
+        : TChainId extends SvmChainId
+          ? SvmTokenConstructorData<TMetadata>
+          : TChainId extends StellarChainId
+            ? StellarTokenConstructorData<TMetadata>
+            : never)
+
+export function getNativeFor<
+  TChainId extends NativeChainId,
+  TMetadata extends CurrencyMetadata,
+>(chainId: TChainId, metadata: TMetadata): NativeFor<TChainId, TMetadata> {
+  if (isEvmChainId(chainId)) {
+    const chain = getEvmChainById(chainId)
+
+    return new EvmNative({
+      chainId,
+      symbol: chain.viemChain.nativeCurrency.symbol,
+      name: chain.viemChain.nativeCurrency.name,
+      decimals: chain.viemChain.nativeCurrency.decimals,
+      metadata,
+    }) as NativeFor<TChainId, TMetadata>
+  }
+
+  if (isSvmChainId(chainId)) {
+    const chain = getSvmChainById(chainId)
+
+    return new SvmNative({
+      chainId,
+      symbol: chain.nativeCurrency.symbol,
+      name: chain.nativeCurrency.name,
+      decimals: chain.nativeCurrency.decimals,
+      metadata,
+    }) as NativeFor<TChainId, TMetadata>
+  }
+
+  assertNever(chainId, `getNativeFor, unsupported chainId: ${chainId}`)
+}
+
+export function getTokenFor<
+  TChainId extends ChainId,
+  TMetadata extends CurrencyMetadata = Record<string, unknown>,
+>(
+  chainId: TChainId,
+  data: TokenConstructorDataFor<TChainId, TMetadata>,
+): TokenFor<TChainId, TMetadata> {
+  if (isEvmChainId(chainId)) {
+    return new EvmToken({
+      ...data,
+      chainId,
+    } as ConstructorParameters<typeof EvmToken<TMetadata>>[0]) as TokenFor<
+      TChainId,
+      TMetadata
+    >
+  }
+
+  if (isMvmChainId(chainId)) {
+    return new MvmToken({
+      ...data,
+      chainId,
+    } as ConstructorParameters<typeof MvmToken<TMetadata>>[0]) as TokenFor<
+      TChainId,
+      TMetadata
+    >
+  }
+
+  if (isSvmChainId(chainId)) {
+    return new SvmToken({
+      ...data,
+      chainId,
+    } as ConstructorParameters<typeof SvmToken<TMetadata>>[0]) as TokenFor<
+      TChainId,
+      TMetadata
+    >
+  }
+
+  if (isStellarChainId(chainId)) {
+    return new StellarToken({
+      ...data,
+      chainId,
+    } as ConstructorParameters<typeof StellarToken<TMetadata>>[0]) as TokenFor<
+      TChainId,
+      TMetadata
+    >
+  }
+
+  assertNever(chainId, `getTokenFor, unsupported chainId: ${chainId}`)
+}

package/generic/currency/index.ts

@@ -1,5 +1,6 @@
 export * from './amount.js'
 export * from './currency.js'
+export * from './for-chain.js'
 export * from './native.js'
 export * from './price.js'
 export * from './serialized-currency.js'