sushi 6.6.7 → 6.6.9

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

@@ -1,12 +1,123 @@
 import { describe, expectTypeOf, it } from 'vitest'
+import type { EvmChainId } from '../../evm/chain/chains.js'
+import type { EvmCurrency } from '../../evm/currency/currency.js'
+import type { EvmNative } from '../../evm/currency/native.js'
+import type { EvmToken } from '../../evm/currency/token.js'
+import type { MvmChainId } from '../../mvm/chain/chains.js'
+import type { MvmToken } from '../../mvm/currency/token.js'
 import type { StellarAddress } from '../../stellar/address.js'
 import type { StellarChainId } from '../../stellar/chain/chains.js'
+import type { StellarCurrency } from '../../stellar/currency/currency.js'
+import type { StellarToken } from '../../stellar/currency/token.js'
 import type { StellarID } from '../../stellar/types/id.js'
+import type { SvmCurrency } from '../../svm/currency/currency.js'
+import type { SvmNative } from '../../svm/currency/native.js'
+import type { SvmToken } from '../../svm/currency/token.js'
 import type { SvmChainId } from '../../svm/index.js'
 import type { SvmID } from '../../svm/types/id.js'
-import type { IDFor } from './for-chain.js'
+import type {
+  CurrencyFor,
+  IDFor,
+  NativeChainId,
+  NativeFor,
+  TokenFor,
+} from './for-chain.js'
 
 describe('generic/types/for-chain.ts types', () => {
+  type Metadata = {
+    coingeckoId: string
+    verified: boolean
+  }
+
+  describe('TokenFor', () => {
+    it('should return the correct token type for each chain family', () => {
+      expectTypeOf<TokenFor<EvmChainId, Metadata>>().toEqualTypeOf<
+        EvmToken<Metadata>
+      >()
+      expectTypeOf<TokenFor<MvmChainId, Metadata>>().toEqualTypeOf<
+        MvmToken<Metadata>
+      >()
+      expectTypeOf<TokenFor<SvmChainId, Metadata>>().toEqualTypeOf<
+        SvmToken<Metadata>
+      >()
+      expectTypeOf<TokenFor<StellarChainId, Metadata>>().toEqualTypeOf<
+        StellarToken<Metadata>
+      >()
+    })
+
+    it('should distribute over chain id unions', () => {
+      expectTypeOf<TokenFor<EvmChainId | SvmChainId, Metadata>>().toEqualTypeOf<
+        EvmToken<Metadata> | SvmToken<Metadata>
+      >()
+    })
+  })
+
+  describe('CurrencyFor', () => {
+    it('should return the correct currency type for each chain family', () => {
+      expectTypeOf<CurrencyFor<EvmChainId, Metadata>>().toEqualTypeOf<
+        EvmCurrency<Metadata>
+      >()
+      expectTypeOf<CurrencyFor<MvmChainId, Metadata>>().toEqualTypeOf<
+        MvmToken<Metadata>
+      >()
+      expectTypeOf<CurrencyFor<SvmChainId, Metadata>>().toEqualTypeOf<
+        SvmCurrency<Metadata>
+      >()
+      expectTypeOf<CurrencyFor<StellarChainId, Metadata>>().toEqualTypeOf<
+        StellarCurrency<Metadata>
+      >()
+    })
+
+    it('should distribute over chain id unions', () => {
+      expectTypeOf<
+        CurrencyFor<EvmChainId | SvmChainId, Metadata>
+      >().toEqualTypeOf<EvmCurrency<Metadata> | SvmCurrency<Metadata>>()
+    })
+  })
+
+  describe('NativeFor', () => {
+    it('should only support chain families with native currency classes', () => {
+      expectTypeOf<NativeChainId>().toEqualTypeOf<EvmChainId | SvmChainId>()
+      expectTypeOf<NativeFor<EvmChainId, Metadata>>().toEqualTypeOf<
+        EvmNative<Metadata>
+      >()
+      expectTypeOf<NativeFor<SvmChainId, Metadata>>().toEqualTypeOf<
+        SvmNative<Metadata>
+      >()
+      expectTypeOf<NativeFor<NativeChainId, Metadata>>().toEqualTypeOf<
+        EvmNative<Metadata> | SvmNative<Metadata>
+      >()
+    })
+
+    it('should be assignable to CurrencyFor for native chain families', () => {
+      expectTypeOf<NativeFor<EvmChainId, Metadata>>().toMatchTypeOf<
+        CurrencyFor<EvmChainId, Metadata>
+      >()
+      expectTypeOf<NativeFor<SvmChainId, Metadata>>().toMatchTypeOf<
+        CurrencyFor<SvmChainId, Metadata>
+      >()
+      expectTypeOf<NativeFor<NativeChainId, Metadata>>().toMatchTypeOf<
+        CurrencyFor<NativeChainId, Metadata>
+      >()
+    })
+
+    it('should reject token-only chain families', () => {
+      type NativeForMvm = NativeFor<
+        // @ts-expect-error MVM is intentionally excluded from NativeChainId.
+        MvmChainId,
+        Metadata
+      >
+      type NativeForStellar = NativeFor<
+        // @ts-expect-error Stellar is intentionally excluded from NativeChainId.
+        StellarChainId,
+        Metadata
+      >
+
+      expectTypeOf<NativeForMvm>().toEqualTypeOf<never>()
+      expectTypeOf<NativeForStellar>().toEqualTypeOf<never>()
+    })
+  })
+
   describe('IDFor', () => {
     it('should return the correct id type for SVM chains', () => {
       expectTypeOf<IDFor<SvmChainId>>().toEqualTypeOf<SvmID>()

package/generic/types/for-chain.ts

@@ -1,5 +1,6 @@
 import type { EvmChainId } from '../../evm/chain/chains.js'
 import type { EvmCurrency } from '../../evm/currency/currency.js'
+import type { EvmNative } from '../../evm/currency/native.js'
 import type {
   EvmAddress,
   EvmToken,
@@ -19,6 +20,7 @@ import type { StellarToken } from '../../stellar/currency/token.js'
 import type { StellarID } from '../../stellar/types/id.js'
 import type { SvmChainId } from '../../svm/chain/chains.js'
 import type { SvmCurrency } from '../../svm/currency/currency.js'
+import type { SvmNative } from '../../svm/currency/native.js'
 import type {
   SvmAddress,
   SvmToken,
@@ -54,6 +56,17 @@ export type CurrencyFor<
         ? StellarCurrency<Metadata>
         : never
 
+export type NativeChainId = EvmChainId | SvmChainId
+
+export type NativeFor<
+  TChainId extends NativeChainId,
+  Metadata extends CurrencyMetadata = CurrencyMetadata,
+> = TChainId extends EvmChainId
+  ? EvmNative<Metadata>
+  : TChainId extends SvmChainId
+    ? SvmNative<Metadata>
+    : never
+
 export type AddressFor<TChainId extends ChainId> = TChainId extends EvmChainId
   ? EvmAddress
   : TChainId extends MvmChainId

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "sushi",
   "description": "Sushi",
-  "version": "6.6.7",
+  "version": "6.6.9",
   "type": "module",
   "main": "./_cjs/generic/index.js",
   "module": "./_esm/generic/index.js",

package/svm/currency/currency.ts

@@ -6,7 +6,7 @@ import { type SvmToken, serializedSvmTokenSchema } from './token.js'
 
 export type SvmCurrency<
   TMetadata extends CurrencyMetadata = Record<string, unknown>,
-> = SvmToken<TMetadata> | SvmNative
+> = SvmToken<TMetadata> | SvmNative<TMetadata>
 
 export const serializedSvmCurrencySchema = <
   TMetadata extends {} = CurrencyMetadata,