sushi 6.3.0 → 6.4.0

package/generic/chain/chains.ts

@@ -2,6 +2,7 @@ import { evmChains } from '../../evm/chain/index.js'
 import { kvmChains } from '../../kvm/chain/chains.js'
 import { mvmChains } from '../../mvm/chain/chains.js'
 import { stellarChains } from '../../stellar/chain/chains.js'
+import { svmChains } from '../../svm/chain/chains.js'
 import { tvmChains } from '../../tvm/chain/chains.js'
 import type { Replace } from '../types/replace.js'
 import type { UnionToIntersection } from '../types/union-to-intersection.js'
@@ -12,6 +13,7 @@ export const chains = [
   ...tvmChains,
   ...kvmChains,
   ...stellarChains,
+  ...svmChains,
 ] as const
 
 // ChainId

package/generic/chain/interface.ts

@@ -2,6 +2,7 @@ import type { EvmChainType } from '../../evm/chain/define-chain.js'
 import type { KvmChainType } from '../../kvm/chain/define-chain.js'
 import type { MvmChainType } from '../../mvm/chain/define-chain.js'
 import type { StellarChainType } from '../../stellar/chain/define-chain.js'
+import type { SvmChainType } from '../../svm/chain/define-chain.js'
 import type { TvmChainType } from '../../tvm/chain/define-chain.js'
 import type { ChainId, ChainKey } from './chains.js'
 
@@ -11,6 +12,7 @@ export type ChainType =
   | TvmChainType
   | KvmChainType
   | StellarChainType
+  | SvmChainType
 
 export type NetType = 'mainnet' | 'testnet'
 

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

@@ -5,6 +5,7 @@ import type { EvmChainId } from '~/evm/chain/chains.js'
 import type { EvmCurrency } from '~/evm/currency/currency.js'
 import type { EvmID } from '~/evm/types/id.js'
 import { KvmToken } from '~/kvm/index.js'
+import { svmAddress } from '~/svm/currency/token.js'
 import { EvmNative } from '../../evm/currency/native.js'
 import {
   type EvmAddress,
@@ -13,6 +14,12 @@ import {
   serializedEvmTokenSchema,
 } from '../../evm/currency/token.js'
 import { MvmToken } from '../../mvm/currency/token.js'
+import {
+  type SvmAddress,
+  type SvmChainId,
+  SvmNative,
+  SvmToken,
+} from '../../svm/index.js'
 import { TvmNative } from '../../tvm/currency/native.js'
 import { TvmToken } from '../../tvm/currency/token.js'
 import { getChainIdAddressFromId } from '../utils/id.js'
@@ -37,6 +44,17 @@ describe('generic/currency/currency.ts types', () => {
       expectTypeOf(evmMockNative.id).toEqualTypeOf<`${EvmChainId}:NATIVE`>()
     })
 
+    it('should return the correct id for SvmNative', () => {
+      const svmMockNative = new SvmNative({
+        chainId: -5,
+        symbol: 'SVM',
+        name: 'Svm Native',
+        decimals: 9,
+      })
+
+      expectTypeOf(svmMockNative.id).toEqualTypeOf<`${SvmChainId}:NATIVE`>()
+    })
+
     it('should return the correct id for EvmToken', () => {
       const evmMockToken = new EvmToken({
         chainId: 1,
@@ -50,6 +68,20 @@ describe('generic/currency/currency.ts types', () => {
         evmMockToken.id,
       ).toEqualTypeOf<`${EvmChainId}:${EvmAddress}`>()
     })
+
+    it('should return the correct id for SvmToken', () => {
+      const svmMockToken = new SvmToken({
+        chainId: -5,
+        address: svmAddress('EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v'),
+        symbol: 'USDC',
+        name: 'USD Coin',
+        decimals: 6,
+      })
+
+      expectTypeOf(
+        svmMockToken.id,
+      ).toEqualTypeOf<`${SvmChainId}:${SvmAddress}`>()
+    })
   })
 
   describe('wrapCurrency', () => {
@@ -100,7 +132,7 @@ describe('generic/currency/currency.ts types', () => {
       expect(tvmMockToken.address).toBe('t1234567890abcdef1234567890abcdef1')
     })
 
-    it('should not lowercase the address - Kvm', () => {
+    it('should not lowercase the address - Kvm / Svm', () => {
       const kvmMockToken = new KvmToken({
         chainId: -3,
         symbol: 'KVM',
@@ -110,6 +142,18 @@ describe('generic/currency/currency.ts types', () => {
       })
 
       expect(kvmMockToken.address).toBe('My-Namespace.My-Token')
+
+      const svmMockToken = new SvmToken({
+        chainId: -5,
+        symbol: 'USDC',
+        name: 'USD Coin',
+        decimals: 6,
+        address: svmAddress('EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v'),
+      })
+
+      expect(svmMockToken.address).toBe(
+        'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
+      )
     })
 
     it('should return the same chaintype - Mvm', () => {
@@ -135,6 +179,17 @@ describe('generic/currency/currency.ts types', () => {
       expectTypeOf(tvmMockToken.wrap()).toEqualTypeOf<TvmToken>()
     })
 
+    it('should return the same chaintype - Svm', () => {
+      const svmMockNative = new SvmNative({
+        chainId: -5,
+        symbol: 'SVM',
+        name: 'Svm Native',
+        decimals: 9,
+      })
+
+      expectTypeOf(svmMockNative.wrap()).toEqualTypeOf<SvmToken>()
+    })
+
     it('should return the same chaintype - Kvm', () => {
       const kvmMockToken = new KvmToken({
         chainId: -3,

package/generic/currency/serialized-currency.ts

@@ -4,6 +4,9 @@ import type { serializedEvmNativeSchema } from '../../evm/currency/native.js'
 import type { serializedEvmTokenSchema } from '../../evm/currency/token.js'
 import { serializedKvmTokenSchema } from '../../kvm/currency/token.js'
 import { serializedMvmTokenSchema } from '../../mvm/currency/token.js'
+import { serializedSvmCurrencySchema } from '../../svm/currency/currency.js'
+import type { serializedSvmNativeSchema } from '../../svm/currency/native.js'
+import type { serializedSvmTokenSchema } from '../../svm/index.js'
 import {
   serializedTvmCurrencySchema,
   type serializedTvmNativeSchema,
@@ -23,6 +26,9 @@ export type SerializedCurrencySchema<
   | typeof serializedTvmCurrencySchema<TMetadata>
   | typeof serializedCurrencySchema<TMetadata>
   | typeof serializedKvmTokenSchema<TMetadata>
+  | typeof serializedSvmNativeSchema<TMetadata>
+  | typeof serializedSvmTokenSchema<TMetadata>
+  | typeof serializedSvmCurrencySchema<TMetadata>
 >
 
 export const serializedCurrencySchema = <
@@ -35,6 +41,7 @@ export const serializedCurrencySchema = <
     serializedMvmTokenSchema(opts),
     serializedTvmCurrencySchema(opts),
     serializedKvmTokenSchema(opts),
+    serializedSvmCurrencySchema(opts),
   ])
 
 export type SerializedCurrency<

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "sushi",
   "description": "Sushi",
-  "version": "6.3.0",
+  "version": "6.4.0",
   "type": "module",
   "main": "./_cjs/generic/index.js",
   "module": "./_esm/generic/index.js",
@@ -17,6 +17,7 @@
     "tvm",
     "kvm",
     "stellar",
+    "svm",
     "package.json"
   ],
   "exports": {
@@ -56,6 +57,12 @@
       "require": "./_cjs/stellar/index.js",
       "default": "./_esm/stellar/index.js"
     },
+    "./svm": {
+      "types": "./_types/svm/index.d.ts",
+      "import": "./_esm/svm/index.js",
+      "require": "./_cjs/svm/index.js",
+      "default": "./_esm/svm/index.js"
+    },
     "./package.json": "./package.json"
   },
   "typesVersions": {
@@ -71,6 +78,12 @@
       ],
       "kvm": [
         "_types/kvm/index.d.ts"
+      ],
+      "stellar": [
+        "_types/stellar/index.d.ts"
+      ],
+      "svm": [
+        "_types/svm/index.d.ts"
       ]
     }
   },
@@ -79,11 +92,15 @@
     "tiny-invariant": "1.3.3"
   },
   "peerDependencies": {
+    "@solana/addresses": ">=5",
     "typescript": ">= 5.8.3 < 6",
     "viem": "*",
     "zod": ">=4"
   },
   "peerDependenciesMeta": {
+    "@solana/addresses": {
+      "optional": true
+    },
     "typescript": {
       "optional": true
     },

package/svm/chain/chains.ts

@@ -0,0 +1,93 @@
+import type { Replace } from '../../generic/types/replace.js'
+import type { UnionToIntersection } from '../../generic/types/union-to-intersection.js'
+import { defineSvmChain } from './define-chain.js'
+
+const solana = defineSvmChain({
+  chainId: -5,
+  key: 'solana',
+  shortName: 'sol',
+  name: 'Solana',
+  blockExplorers: {
+    default: {
+      name: 'Solscan',
+      url: 'https://solscan.io',
+    },
+  },
+  netType: 'mainnet',
+  nativeCurrency: {
+    name: 'Solana',
+    symbol: 'SOL',
+    decimals: 9,
+  },
+})
+
+export const svmChains = [solana] as const
+
+export const svmChainIds = /* @__PURE__ */ svmChains.map(
+  (chain) => chain.chainId,
+)
+
+export type SvmChainId = (typeof svmChainIds)[number]
+
+type SvmChainIdMap = UnionToIntersection<
+  (typeof svmChains)[number] extends infer I
+    ? I extends { key: infer K; chainId: infer C }
+      ? K extends string
+        ? { [key in K as Uppercase<Replace<key, '-', '_'>>]: C }
+        : never
+      : never
+    : never
+>
+
+export const SvmChainId = /* @__PURE__ */ new Proxy<SvmChainIdMap>(
+  {} as SvmChainIdMap,
+  {
+    get: (_: unknown, key: keyof SvmChainIdMap) => {
+      const _key = key.toLowerCase().replace(/_/g, '-') as SvmChainKey
+      const chain = svmChains.find((chain) => chain.key === _key)
+
+      if (!chain) return undefined
+
+      return chain.chainId
+    },
+  },
+)
+
+export function isSvmChainId(chainId: number): chainId is SvmChainId {
+  return svmChains.some((chain) => chain.chainId === chainId)
+}
+
+export function getSvmChainById<C extends SvmChainId>(chainId: C) {
+  return svmChains.find((chain) => chain.chainId === chainId)! as Extract<
+    (typeof svmChains)[number],
+    { chainId: C }
+  >
+}
+
+// SvmMainnetChainId
+export type SvmMainnetChainId = Extract<
+  (typeof svmChains)[number],
+  { netType: 'mainnet' }
+>['chainId']
+
+export function isSvmMainnetChainId(
+  chainId: number,
+): chainId is SvmMainnetChainId {
+  return svmChains.some(
+    (chain) => chain.chainId === chainId && chain.netType === 'mainnet',
+  )
+}
+
+// SvmChainKey
+export type SvmChainKey = (typeof svmChains)[number]['key']
+
+export function isSvmChainKey(key: string): key is SvmChainKey {
+  return svmChains.some((chain) => chain.key === key)
+}
+
+export function getSvmChainByKey<C extends SvmChainKey>(key: C) {
+  return svmChains.find((chain) => chain.key === key)! as Extract<
+    (typeof svmChains)[number],
+    { key: C }
+  >
+}

package/svm/chain/define-chain.ts

@@ -0,0 +1,50 @@
+import type {
+  BlockExplorers,
+  Chain,
+  NetType,
+} from '../../generic/chain/interface.js'
+import type { SvmAddress } from '../currency/token.js'
+import type { SvmChainId, SvmChainKey } from './chains.js'
+
+export type SvmChainType = 'svm'
+
+type SvmChainNativeCurrency = {
+  name: string
+  symbol: string
+  decimals: number
+}
+
+type SvmChainBase<TChainId extends number, TChainKey extends string> = Chain<
+  SvmChainType,
+  // @ts-expect-error infinite loop
+  TChainId,
+  TChainKey,
+  Readonly<string>,
+  Readonly<string>,
+  NetType,
+  BlockExplorers,
+  SvmAddress,
+  string
+> & {
+  nativeCurrency: SvmChainNativeCurrency
+}
+
+export type SvmChain = SvmChainBase<SvmChainId, SvmChainKey>
+
+type SvmChainInput = Omit<
+  SvmChainBase<number, string>,
+  'type' | 'getTransactionUrl' | 'getAccountUrl' | 'getTokenUrl'
+>
+
+export function defineSvmChain<const T extends SvmChainInput>(chain: T) {
+  return {
+    ...chain,
+    type: 'svm' as const,
+    getTransactionUrl: (input: string) =>
+      `${chain.blockExplorers.default.url}/tx/${input}`,
+    getAccountUrl: (input: string) =>
+      `${chain.blockExplorers.default.url}/account/${input}`,
+    getTokenUrl: (input: SvmAddress) =>
+      `${chain.blockExplorers.default.url}/token/${input}`,
+  } as const satisfies SvmChainBase<number, string>
+}

package/svm/chain/index.ts

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

package/svm/config/index.ts

@@ -0,0 +1,2 @@
+export * from './simple-constants.js'
+export * from './tokens/index.js'

package/svm/config/simple-constants.ts

@@ -0,0 +1,3 @@
+import { svmAddress } from '../currency/token.js'
+
+export const svmNativeAddress = svmAddress('11111111111111111111111111111111')

package/svm/config/tokens/index.ts

@@ -0,0 +1,2 @@
+export * from './tokens/index.js'
+export * from './wrapped-native.js'

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

@@ -0,0 +1,19 @@
+import { SvmChainId } from '../../../../svm/chain/index.js'
+import type { SvmCurrency } from '../../../../svm/currency/currency.js'
+import { SvmNative } from '../../../../svm/currency/native.js'
+import { SVM_USDC } from '../tokens/USDC.js'
+import { SVM_USDT } from '../tokens/USDT.js'
+import { SVM_WBTC } from '../tokens/WBTC.js'
+import { SVM_WETH } from '../tokens/WETH.js'
+import { WSOL } from '../tokens/WSOL.js'
+
+export const SVM_DEFAULT_BASES = {
+  [SvmChainId.SOLANA]: [
+    SvmNative.fromChainId(SvmChainId.SOLANA),
+    WSOL[SvmChainId.SOLANA],
+    SVM_USDC[SvmChainId.SOLANA],
+    SVM_USDT[SvmChainId.SOLANA],
+    SVM_WBTC[SvmChainId.SOLANA],
+    SVM_WETH[SvmChainId.SOLANA],
+  ],
+} as const satisfies Record<SvmChainId, Readonly<SvmCurrency[]>>

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

@@ -0,0 +1,14 @@
+import { SvmChainId, svmChainIds } from '../../../../svm/chain/index.js'
+import type { SvmCurrency } from '../../../../svm/currency/currency.js'
+import { SvmNative } from '../../../../svm/currency/native.js'
+import { SVM_USDC } from '../tokens/USDC.js'
+
+export const svmDefaultCurrency = {
+  ...(Object.fromEntries(
+    svmChainIds.map((chainId) => [chainId, SvmNative.fromChainId(chainId)]),
+  ) as Record<SvmChainId, SvmCurrency>),
+} as const satisfies Record<SvmChainId, SvmCurrency>
+
+export const svmDefaultQuoteCurrency = {
+  [SvmChainId.SOLANA]: SVM_USDC[SvmChainId.SOLANA],
+} as const satisfies Record<SvmChainId, SvmCurrency>

package/svm/config/tokens/token-maps/index.ts

@@ -0,0 +1,3 @@
+export * from './default-bases.js'
+export * from './default-quote.js'
+export * from './stables.js'

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

@@ -0,0 +1,22 @@
+import { SvmChainId } from '../../../../svm/chain/index.js'
+import type { SvmCurrency } from '../../../../svm/currency/currency.js'
+import type { SvmToken } from '../../../../svm/currency/token.js'
+import { SVM_USDC } from '../tokens/USDC.js'
+import { SVM_USDT } from '../tokens/USDT.js'
+
+export const SVM_STABLES = {
+  [SvmChainId.SOLANA]: [
+    SVM_USDC[SvmChainId.SOLANA],
+    SVM_USDT[SvmChainId.SOLANA],
+  ],
+} as const satisfies Record<SvmChainId, SvmToken[]>
+
+export function isSvmStable(currency: SvmCurrency): boolean {
+  if (currency.type === 'native') {
+    return false
+  }
+
+  return SVM_STABLES[currency.chainId]?.some(
+    (stable) => stable.address.toLowerCase() === currency.address.toLowerCase(),
+  )
+}

package/svm/config/tokens/tokens/USDC.ts

@@ -0,0 +1,18 @@
+import { SvmChainId } from '../../../../svm/chain/index.js'
+import { SvmToken, svmAddress } from '../../../../svm/currency/token.js'
+
+export const SVM_USDC_ADDRESS = {
+  [SvmChainId.SOLANA]: svmAddress(
+    'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
+  ),
+} as const
+
+export const SVM_USDC = {
+  [SvmChainId.SOLANA]: new SvmToken({
+    chainId: SvmChainId.SOLANA,
+    address: SVM_USDC_ADDRESS[SvmChainId.SOLANA],
+    decimals: 6,
+    symbol: 'USDC',
+    name: 'USD Coin',
+  }),
+} as const

package/svm/config/tokens/tokens/USDT.ts

@@ -0,0 +1,18 @@
+import { SvmChainId } from '../../../../svm/chain/index.js'
+import { SvmToken, svmAddress } from '../../../../svm/currency/token.js'
+
+export const SVM_USDT_ADDRESS = {
+  [SvmChainId.SOLANA]: svmAddress(
+    'Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB',
+  ),
+} as const
+
+export const SVM_USDT = {
+  [SvmChainId.SOLANA]: new SvmToken({
+    chainId: SvmChainId.SOLANA,
+    address: SVM_USDT_ADDRESS[SvmChainId.SOLANA],
+    decimals: 6,
+    symbol: 'USDT',
+    name: 'Tether USD',
+  }),
+} as const

package/svm/config/tokens/tokens/WBTC.ts

@@ -0,0 +1,18 @@
+import { SvmChainId } from '../../../../svm/chain/index.js'
+import { SvmToken, svmAddress } from '../../../../svm/currency/token.js'
+
+export const SVM_WBTC_ADDRESS = {
+  [SvmChainId.SOLANA]: svmAddress(
+    '3NZ9JMVBmGAqocybic2c7LQCJScmgsAZ6vQqTDzcqmJh',
+  ),
+} as const
+
+export const SVM_WBTC = {
+  [SvmChainId.SOLANA]: new SvmToken({
+    chainId: SvmChainId.SOLANA,
+    address: SVM_WBTC_ADDRESS[SvmChainId.SOLANA],
+    decimals: 8,
+    symbol: 'WBTC',
+    name: 'Wrapped BTC (Wormhole)',
+  }),
+} as const

package/svm/config/tokens/tokens/WETH.ts

@@ -0,0 +1,18 @@
+import { SvmChainId } from '../../../../svm/chain/index.js'
+import { SvmToken, svmAddress } from '../../../../svm/currency/token.js'
+
+export const SVM_WETH_ADDRESS = {
+  [SvmChainId.SOLANA]: svmAddress(
+    '7vfCXTUXx5WJV5JADk17DUJ4ksgau7utNKj4b963voxs',
+  ),
+} as const
+
+export const SVM_WETH = {
+  [SvmChainId.SOLANA]: new SvmToken({
+    chainId: SvmChainId.SOLANA,
+    address: SVM_WETH_ADDRESS[SvmChainId.SOLANA],
+    decimals: 8,
+    symbol: 'WETH',
+    name: 'Wrapped Ether (Wormhole)',
+  }),
+} as const

package/svm/config/tokens/tokens/WSOL.ts

@@ -0,0 +1,18 @@
+import { SvmChainId } from '../../../../svm/chain/index.js'
+import { SvmToken, svmAddress } from '../../../../svm/currency/token.js'
+
+export const WSOL_ADDRESS = {
+  [SvmChainId.SOLANA]: svmAddress(
+    'So11111111111111111111111111111111111111112',
+  ),
+} as const
+
+export const WSOL = {
+  [SvmChainId.SOLANA]: new SvmToken({
+    chainId: SvmChainId.SOLANA,
+    address: WSOL_ADDRESS[SvmChainId.SOLANA],
+    decimals: 9,
+    symbol: 'WSOL',
+    name: 'Wrapped SOL',
+  }),
+} as const

package/svm/config/tokens/tokens/index.ts

@@ -0,0 +1,5 @@
+export * from './USDC.js'
+export * from './USDT.js'
+export * from './WBTC.js'
+export * from './WETH.js'
+export * from './WSOL.js'

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

@@ -0,0 +1,10 @@
+import { SvmChainId } from '../../../svm/chain/index.js'
+import { WSOL, WSOL_ADDRESS } from './tokens/WSOL.js'
+
+export const SVM_WNATIVE_ADDRESS = {
+  [SvmChainId.SOLANA]: WSOL_ADDRESS[SvmChainId.SOLANA],
+}
+
+export const SVM_WNATIVE = {
+  [SvmChainId.SOLANA]: WSOL[SvmChainId.SOLANA],
+}

package/svm/currency/currency.ts

@@ -0,0 +1,31 @@
+import { z } from 'zod'
+import type { CurrencyMetadata } from '../../generic/currency/currency.js'
+import { svmNativeAddress } from '../config/simple-constants.js'
+import { type SvmNative, serializedSvmNativeSchema } from './native.js'
+import { type SvmToken, serializedSvmTokenSchema } from './token.js'
+
+export type SvmCurrency<
+  TMetadata extends CurrencyMetadata = Record<string, unknown>,
+> = SvmToken<TMetadata> | SvmNative
+
+export const serializedSvmCurrencySchema = <
+  TMetadata extends {} = CurrencyMetadata,
+>(
+  opts: { metadata?: z.ZodType<TMetadata> } = {},
+) =>
+  z.discriminatedUnion('type', [
+    serializedSvmTokenSchema(opts),
+    serializedSvmNativeSchema(opts),
+  ])
+
+/**
+ *
+ * @returns The address of the currency. If the currency is native, returns the native address constant.
+ */
+export function getSvmCurrencyAddress(currency: SvmCurrency) {
+  return currency.type === 'native' ? svmNativeAddress : currency.address
+}
+
+export type SerializedSvmCurrency<
+  TMetadata extends CurrencyMetadata = CurrencyMetadata,
+> = z.infer<ReturnType<typeof serializedSvmCurrencySchema<TMetadata>>>

package/svm/currency/deserialize-currency.ts

@@ -0,0 +1,17 @@
+import { type SerializedSvmNative, SvmNative } from './native.js'
+import { type SerializedSvmToken, SvmToken } from './token.js'
+
+function deserializeSvmCurrency(data: SerializedSvmToken): SvmToken
+function deserializeSvmCurrency(data: SerializedSvmNative): SvmNative
+
+function deserializeSvmCurrency(
+  data: SerializedSvmNative | SerializedSvmToken,
+) {
+  if (data.type === 'native') {
+    return new SvmNative(data)
+  } else {
+    return new SvmToken(data)
+  }
+}
+
+export { deserializeSvmCurrency }

package/svm/currency/index.ts

@@ -0,0 +1,5 @@
+export * from './currency.js'
+export * from './deserialize-currency.js'
+export * from './native.js'
+export * from './token.js'
+export * from './unwrap-token.js'