sushi 6.4.5 → 6.4.6

package/_types/tvm/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './normalize-address.js';
+//# sourceMappingURL=index.d.ts.map

package/_types/tvm/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../tvm/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA"}

package/_types/tvm/utils/normalize-address.d.ts

@@ -0,0 +1,3 @@
+import type { TvmAddress } from '../currency/token.js';
+export declare function normalizeTvmAddress(address: TvmAddress): TvmAddress;
+//# sourceMappingURL=normalize-address.d.ts.map

package/_types/tvm/utils/normalize-address.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalize-address.d.ts","sourceRoot":"","sources":["../../../tvm/utils/normalize-address.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEtD,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,UAAU,GAAG,UAAU,CAEnE"}

package/evm/config/simple-constants.ts

@@ -1,4 +1,4 @@
-export const nativeAddress = '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee'
+export const evmNativeAddress = '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee'
 
 export const API_BASE_URL = 'https://api.sushi.com'
 

package/evm/currency/currency.ts

@@ -1,6 +1,6 @@
 import * as z from 'zod'
 import type { CurrencyMetadata } from '../../generic/currency/currency.js'
-import { nativeAddress } from '../config/simple-constants.js'
+import { evmNativeAddress } from '../config/simple-constants.js'
 import { type EvmNative, serializedEvmNativeSchema } from './native.js'
 import { type EvmToken, serializedEvmTokenSchema } from './token.js'
 
@@ -23,7 +23,7 @@ export const serializedEvmCurrencySchema = <
  * @returns The address of the currency. If the currency is native, returns the native address constant.
  */
 export function getEvmCurrencyAddress(currency: EvmCurrency) {
-  return currency.type === 'native' ? nativeAddress : currency.address
+  return currency.type === 'native' ? evmNativeAddress : currency.address
 }
 
 export type SerializedEvmCurrency<

package/evm/currency/native.ts

@@ -1,5 +1,5 @@
 import * as z from 'zod'
-import type { CurrencyMetadata } from '~/generic/currency/currency.js'
+import type { CurrencyMetadata } from '../../generic/currency/currency.js'
 import { Native } from '../../generic/currency/native.js'
 import {
   type EvmChainId,

package/evm/currency/token.ts

@@ -4,6 +4,7 @@ import * as z from 'zod'
 import type { CurrencyMetadata } from '../../generic/currency/currency.js'
 import { Token } from '../../generic/currency/token.js'
 import { type EvmChainId, isEvmChainId } from '../chain/chains.js'
+import { normalizeEvmAddress } from '../utils/normalize-address.js'
 
 export type EvmAddress = Address
 
@@ -32,7 +33,7 @@ export class EvmToken<
   } & ConstructorParameters<
     typeof Token<EvmChainId, EvmAddress, TMetadata>
   >[0]) {
-    super({ address: address.toLowerCase() as EvmAddress, ...rest })
+    super({ address: normalizeEvmAddress(address), ...rest })
     this.origin = origin
   }
 

package/evm/utils/index.ts

@@ -1,2 +1,3 @@
 export * from './add-gas-margin.js'
 export * from './get-create-2-address.js'
+export * from './normalize-address.js'

package/evm/utils/normalize-address.ts

@@ -0,0 +1,5 @@
+import type { EvmAddress } from '../currency/token.js'
+
+export function normalizeEvmAddress(address: EvmAddress): EvmAddress {
+  return address.toLowerCase() as EvmAddress
+}

package/generic/types/for-chain.ts

@@ -1,32 +1,72 @@
-import type { EvmCurrency } from '~/evm/currency/currency.js'
-import type { SvmCurrency } from '~/svm/currency/currency.js'
 import type { EvmChainId } from '../../evm/chain/chains.js'
+import type { EvmCurrency } from '../../evm/currency/currency.js'
 import type { EvmAddress, EvmToken } from '../../evm/currency/token.js'
+import type { EvmID } from '../../evm/types/id.js'
+import type { KvmChainId } from '../../kvm/chain/chains.js'
+import type { KvmToken, KvmTokenAddress } from '../../kvm/currency/token.js'
+import type { MvmChainId } from '../../mvm/chain/chains.js'
+import type { MvmAddress, MvmToken } from '../../mvm/currency/token.js'
+import type { StellarAddress } from '../../stellar/address.js'
+import type { StellarChainId } from '../../stellar/chain/chains.js'
 import type { SvmChainId } from '../../svm/chain/chains.js'
+import type { SvmCurrency } from '../../svm/currency/currency.js'
 import type { SvmAddress, SvmToken } from '../../svm/currency/token.js'
+import type { SvmID } from '../../svm/types/id.js'
+import type { TvmChainId } from '../../tvm/chain/chains.js'
+import type { TvmCurrency } from '../../tvm/currency/currency.js'
+import type { TvmAddress, TvmToken } from '../../tvm/currency/token.js'
 import type { ChainId } from '../chain/chains.js'
 import type { CurrencyMetadata } from '../currency/currency.js'
 
 export type TokenFor<
-  TChainId extends EvmChainId | SvmChainId,
+  TChainId extends Exclude<ChainId, StellarChainId>,
   Metadata extends CurrencyMetadata = CurrencyMetadata,
 > = TChainId extends EvmChainId
   ? EvmToken<Metadata>
-  : TChainId extends SvmChainId
-    ? SvmToken<Metadata>
-    : never
+  : TChainId extends MvmChainId
+    ? MvmToken<Metadata>
+    : TChainId extends TvmChainId
+      ? TvmToken<Metadata>
+      : TChainId extends KvmChainId
+        ? KvmToken<Metadata>
+        : TChainId extends SvmChainId
+          ? SvmToken<Metadata>
+          : never
 
 export type CurrencyFor<
-  TChainId extends EvmChainId | SvmChainId,
+  TChainId extends Exclude<ChainId, StellarChainId>,
   Metadata extends CurrencyMetadata = CurrencyMetadata,
 > = TChainId extends EvmChainId
   ? EvmCurrency<Metadata>
-  : TChainId extends SvmChainId
-    ? SvmCurrency<Metadata>
-    : never
+  : TChainId extends MvmChainId
+    ? MvmToken<Metadata>
+    : TChainId extends KvmChainId
+      ? KvmToken<Metadata>
+      : TChainId extends TvmChainId
+        ? TvmCurrency<Metadata>
+        : TChainId extends SvmChainId
+          ? SvmCurrency<Metadata>
+          : never
 
 export type AddressFor<TChainId extends ChainId> = TChainId extends EvmChainId
   ? EvmAddress
+  : TChainId extends MvmChainId
+    ? MvmAddress
+    : TChainId extends TvmChainId
+      ? TvmAddress
+      : TChainId extends KvmChainId
+        ? KvmTokenAddress
+        : TChainId extends SvmChainId
+          ? SvmAddress
+          : TChainId extends StellarChainId
+            ? StellarAddress
+            : never
+
+export type IDFor<
+  TChainId extends EvmChainId | SvmChainId,
+  TIncludeNative extends boolean = false,
+> = TChainId extends EvmChainId
+  ? EvmID<TIncludeNative>
   : TChainId extends SvmChainId
-    ? SvmAddress
+    ? SvmID<TIncludeNative>
     : never

package/generic/utils/assert-never.ts

@@ -0,0 +1,4 @@
+export function assertNever(value: never, message = 'Unexpected value'): never {
+  void value
+  throw new Error(message)
+}

package/generic/utils/id.test.ts

@@ -0,0 +1,13 @@
+import { describe, expect, it } from 'vitest'
+import { getChainIdAddressFromId } from './id.js'
+
+describe('getChainIdAddressFromId', () => {
+  it('parses MVM addresses containing colons', () => {
+    const id = '-1:0x1::module::token'
+
+    expect(getChainIdAddressFromId(id)).toEqual({
+      chainId: -1,
+      address: '0x1::module::token',
+    })
+  })
+})

package/generic/utils/id.ts

@@ -1,8 +1,8 @@
-import { nativeAddress } from '../../evm/config/simple-constants.js'
-import { isKvmTokenAddress } from '../../kvm/currency/token.js'
-import { isSvmAddress } from '../../svm/currency/token.js'
 import type { ChainId } from '../chain/chains.js'
+import type { AddressFor } from '../types/for-chain.js'
 import type { ID } from '../types/id.js'
+import { getNativeAddress } from './native-address.js'
+import { normalizeAddress } from './normalize-address.js'
 
 export function getChainIdAddressFromId<
   TChainId extends ChainId,
@@ -13,30 +13,32 @@ export function getChainIdAddressFromId<
   chainId: TChainId
   address: TAddress
 } {
-  const [chainId, address, ...rest] = id.split(':') as [TChainId, TAddress]
+  const separatorIndex = id.indexOf(':')
 
-  if (rest.length > 0) {
+  if (separatorIndex === -1) {
     throw new Error(
       `Invalid ID format: ${id}. Expected format is "chainId:address".`,
     )
   }
 
+  const chainId = +id.slice(0, separatorIndex) as TChainId
+  const address = id.slice(separatorIndex + 1) as TAddress
+
   if (!chainId || !address) {
     throw new Error(
       `Invalid ID format: ${id}. Expected format is "chainId:address".`,
     )
   }
 
-  return { chainId: +chainId as TChainId, address }
+  return { chainId, address }
 }
 
 export function getIdFromChainIdAddress<
   TChainId extends ChainId,
-  TAddress extends string,
   TTranslateNative extends boolean = false,
 >(
   chainId: TChainId,
-  address: TAddress,
+  address: AddressFor<TChainId>,
   options: { translateNative?: TTranslateNative } = {},
 ) {
   if (!chainId || !address) {
@@ -45,16 +47,13 @@ export function getIdFromChainIdAddress<
     )
   }
 
-  // Kvm and Solana addresses are case-sensitive
-  if (!isKvmTokenAddress(address) && !isSvmAddress(address)) {
-    address = address.toLowerCase() as TAddress
-  }
+  address = normalizeAddress(chainId, address)
 
-  if (address === nativeAddress && options.translateNative) {
-    address = 'NATIVE' as TAddress
+  if (address === getNativeAddress(chainId) && options.translateNative) {
+    address = 'NATIVE' as AddressFor<TChainId>
   }
 
   return `${chainId}:${address}` as TTranslateNative extends true
-    ? ID<TChainId, TAddress | 'NATIVE'>
-    : ID<TChainId, TAddress>
+    ? ID<TChainId, AddressFor<TChainId> | 'NATIVE'>
+    : ID<TChainId, AddressFor<TChainId>>
 }

package/generic/utils/index.ts

@@ -1,3 +1,6 @@
+export * from './assert-never.js'
 export * from './id.js'
 export * from './lowercase-map.js'
+export * from './native-address.js'
+export * from './normalize-address.js'
 export * from './subtract-slippage.js'

package/generic/utils/native-address.ts

@@ -0,0 +1,45 @@
+import { isEvmChainId } from '../../evm/chain/chains.js'
+import { evmNativeAddress } from '../../evm/config/simple-constants.js'
+import { isKvmChainId } from '../../kvm/chain/chains.js'
+import { kvmNativeAddress } from '../../kvm/config/simple-constants.js'
+import { isMvmChainId } from '../../mvm/chain/chains.js'
+import { mvmNativeAddress } from '../../mvm/config/simple-constants.js'
+import { isStellarChainId } from '../../stellar/chain/chains.js'
+import { stellarNativeAddress } from '../../stellar/config/simple-constants.js'
+import { isSvmChainId } from '../../svm/chain/chains.js'
+import { svmNativeAddress } from '../../svm/config/simple-constants.js'
+import { isTvmChainId } from '../../tvm/chain/chains.js'
+import { tvmNativeAddress } from '../../tvm/config/simple-constants.js'
+import type { ChainId } from '../chain/chains.js'
+import type { AddressFor } from '../types/for-chain.js'
+import { assertNever } from './assert-never.js'
+
+export function getNativeAddress<TChainId extends ChainId>(
+  chainId: TChainId,
+): AddressFor<TChainId> {
+  if (isEvmChainId(chainId)) {
+    return evmNativeAddress as AddressFor<TChainId>
+  }
+
+  if (isMvmChainId(chainId)) {
+    return mvmNativeAddress as AddressFor<TChainId>
+  }
+
+  if (isTvmChainId(chainId)) {
+    return tvmNativeAddress as AddressFor<TChainId>
+  }
+
+  if (isKvmChainId(chainId)) {
+    return kvmNativeAddress as AddressFor<TChainId>
+  }
+
+  if (isSvmChainId(chainId)) {
+    return svmNativeAddress as AddressFor<TChainId>
+  }
+
+  if (isStellarChainId(chainId)) {
+    return stellarNativeAddress as AddressFor<TChainId>
+  }
+
+  assertNever(chainId, `getNativeAddress, unsupported chainId: ${chainId}`)
+}

package/generic/utils/normalize-address.ts

@@ -0,0 +1,64 @@
+import type { EvmChainId } from '../../evm/chain/chains.js'
+import { isEvmChainId } from '../../evm/chain/chains.js'
+import { normalizeEvmAddress } from '../../evm/utils/normalize-address.js'
+import type { KvmChainId } from '../../kvm/chain/chains.js'
+import { isKvmChainId } from '../../kvm/chain/chains.js'
+import { normalizeKvmAddress } from '../../kvm/utils/normalize-address.js'
+import type { MvmChainId } from '../../mvm/chain/chains.js'
+import { isMvmChainId } from '../../mvm/chain/chains.js'
+import { normalizeMvmAddress } from '../../mvm/utils/normalize-address.js'
+import type { StellarChainId } from '../../stellar/chain/chains.js'
+import { isStellarChainId } from '../../stellar/chain/chains.js'
+import { normalizeStellarAddress } from '../../stellar/utils/normalize-address.js'
+import type { SvmChainId } from '../../svm/chain/chains.js'
+import { isSvmChainId } from '../../svm/chain/chains.js'
+import { normalizeSvmAddress } from '../../svm/utils/normalize-address.js'
+import type { TvmChainId } from '../../tvm/chain/chains.js'
+import { isTvmChainId } from '../../tvm/chain/chains.js'
+import { normalizeTvmAddress } from '../../tvm/utils/normalize-address.js'
+import type { ChainId } from '../chain/chains.js'
+import type { AddressFor } from '../types/for-chain.js'
+import { assertNever } from './assert-never.js'
+
+export function normalizeAddress<TChainId extends ChainId>(
+  chainId: TChainId,
+  address: AddressFor<TChainId>,
+): AddressFor<TChainId> {
+  if (isEvmChainId(chainId)) {
+    return normalizeEvmAddress(
+      address as AddressFor<EvmChainId>,
+    ) as AddressFor<TChainId>
+  }
+
+  if (isMvmChainId(chainId)) {
+    return normalizeMvmAddress(
+      address as AddressFor<MvmChainId>,
+    ) as AddressFor<TChainId>
+  }
+
+  if (isTvmChainId(chainId)) {
+    return normalizeTvmAddress(
+      address as AddressFor<TvmChainId>,
+    ) as AddressFor<TChainId>
+  }
+
+  if (isKvmChainId(chainId)) {
+    return normalizeKvmAddress(
+      address as AddressFor<KvmChainId>,
+    ) as AddressFor<TChainId>
+  }
+
+  if (isSvmChainId(chainId)) {
+    return normalizeSvmAddress(
+      address as AddressFor<SvmChainId>,
+    ) as AddressFor<TChainId>
+  }
+
+  if (isStellarChainId(chainId)) {
+    return normalizeStellarAddress(
+      address as AddressFor<StellarChainId>,
+    ) as AddressFor<TChainId>
+  }
+
+  assertNever(chainId, `normalizeAddress, unsupported chainId: ${chainId}`)
+}

package/kvm/config/index.ts

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

package/kvm/config/simple-constants.ts

@@ -0,0 +1,3 @@
+import type { KvmTokenAddress } from '../currency/token.js'
+
+export const kvmNativeAddress: KvmTokenAddress = 'coin'

package/kvm/index.ts

@@ -1,2 +1,4 @@
 export * from './chain/index.js'
+export * from './config/index.js'
 export * from './currency/index.js'
+export * from './utils/index.js'

package/kvm/utils/index.ts

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

package/kvm/utils/normalize-address.ts

@@ -0,0 +1,5 @@
+import type { KvmTokenAddress } from '../currency/token.js'
+
+export function normalizeKvmAddress(address: KvmTokenAddress): KvmTokenAddress {
+  return address
+}

package/mvm/config/index.ts

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

package/mvm/config/simple-constants.ts

@@ -0,0 +1,3 @@
+import type { MvmAddress } from '../currency/token.js'
+
+export const mvmNativeAddress: MvmAddress = '0x1::aptos_coin::AptosCoin'

package/mvm/currency/token.ts

@@ -2,6 +2,7 @@ import * as z from 'zod'
 import type { CurrencyMetadata } from '../../generic/currency/currency.js'
 import { Token } from '../../generic/currency/token.js'
 import { isMvmChainId, type MvmChainId } from '../chain/chains.js'
+import { normalizeMvmAddress } from '../utils/normalize-address.js'
 
 export type MvmAddress = `0x${string}::${string}::${string}`
 
@@ -19,7 +20,7 @@ export class MvmToken<
   }: ConstructorParameters<
     typeof Token<MvmChainId, MvmAddress, TMetadata>
   >[0]) {
-    super({ address: address.toLowerCase() as MvmAddress, ...rest })
+    super({ address: normalizeMvmAddress(address), ...rest })
   }
 
   public override wrap(): MvmToken<TMetadata> {

package/mvm/index.ts

@@ -1,2 +1,4 @@
 export * from './chain/index.js'
+export * from './config/index.js'
 export * from './currency/index.js'
+export * from './utils/index.js'

package/mvm/utils/index.ts

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

package/mvm/utils/normalize-address.ts

@@ -0,0 +1,5 @@
+import type { MvmAddress } from '../currency/token.js'
+
+export function normalizeMvmAddress(address: MvmAddress): MvmAddress {
+  return address
+}

package/package.json

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

package/stellar/address.ts

@@ -0,0 +1,7 @@
+export type StellarAddress = `G${string}`
+
+const stellarAddressRegex = /^G[A-Z2-7]{55}$/
+
+export function isStellarAddress(address: string): address is StellarAddress {
+  return stellarAddressRegex.test(address)
+}

package/stellar/config/index.ts

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

package/stellar/config/simple-constants.ts

@@ -0,0 +1,2 @@
+export const stellarNativeAddress =
+  'GAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA' as const

package/stellar/index.ts

@@ -1 +1,4 @@
+export * from './address.js'
 export * from './chain/index.js'
+export * from './config/index.js'
+export * from './utils/index.js'

package/stellar/utils/index.ts

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

package/stellar/utils/normalize-address.ts

@@ -0,0 +1,7 @@
+import type { StellarAddress } from '../address.js'
+
+export function normalizeStellarAddress(
+  address: StellarAddress,
+): StellarAddress {
+  return address.toUpperCase() as StellarAddress
+}

package/svm/currency/native.ts

@@ -1,5 +1,5 @@
 import * as z from 'zod'
-import type { CurrencyMetadata } from '~/generic/currency/currency.js'
+import type { CurrencyMetadata } from '../../generic/currency/currency.js'
 import { Native } from '../../generic/currency/native.js'
 import {
   getSvmChainById,

package/svm/currency/token.ts

@@ -7,6 +7,7 @@ import * as z from 'zod'
 import type { CurrencyMetadata } from '../../generic/currency/currency.js'
 import { Token } from '../../generic/currency/token.js'
 import { isSvmChainId, type SvmChainId } from '../chain/chains.js'
+import { normalizeSvmAddress } from '../utils/normalize-address.js'
 
 export { type SvmAddress, svmAddress, isSvmAddress }
 
@@ -19,13 +20,14 @@ export class SvmToken<
 
   constructor({
     origin,
+    address,
     ...rest
   }: {
     origin?: SvmTokenOrigin | undefined
   } & ConstructorParameters<
     typeof Token<SvmChainId, SvmAddress, TMetadata>
   >[0]) {
-    super({ ...rest })
+    super({ address: normalizeSvmAddress(address), ...rest })
     this.origin = origin
   }
 

package/svm/index.ts

@@ -1,3 +1,4 @@
 export * from './chain/index.js'
 export * from './config/index.js'
 export * from './currency/index.js'
+export * from './utils/index.js'

package/svm/types/id.ts

@@ -0,0 +1,9 @@
+import type { ID } from '../../generic/types/id.js'
+import type { SvmChainId } from '../chain/chains.js'
+import type { SvmAddress } from '../currency/token.js'
+
+export type SvmID<TIncludeNative extends boolean = false> = ID<
+  SvmChainId,
+  SvmAddress,
+  TIncludeNative
+>

package/svm/utils/index.ts

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

package/svm/utils/normalize-address.ts

@@ -0,0 +1,5 @@
+import type { SvmAddress } from '../currency/token.js'
+
+export function normalizeSvmAddress(address: SvmAddress): SvmAddress {
+  return address
+}

package/tvm/config/index.ts

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

package/tvm/config/simple-constants.ts

@@ -0,0 +1,3 @@
+import type { TvmAddress } from '../currency/token.js'
+
+export const tvmNativeAddress: TvmAddress = 'T9yD14Nj9j7xAB4dbGeiX9h8unkKHxuWwb'

package/tvm/currency/native.ts

@@ -1,5 +1,5 @@
 import * as z from 'zod'
-import type { CurrencyMetadata } from '~/generic/currency/currency.js'
+import type { CurrencyMetadata } from '../../generic/currency/currency.js'
 import { Native } from '../../generic/currency/native.js'
 import { isTvmChainId, type TvmChainId } from '../chain/chains.js'
 import { NATIVE } from '../config/index.js'

package/tvm/currency/token.ts

@@ -2,6 +2,7 @@ import * as z from 'zod'
 import type { CurrencyMetadata } from '../../generic/currency/currency.js'
 import { Token } from '../../generic/currency/token.js'
 import { isTvmChainId, type TvmChainId } from '../chain/chains.js'
+import { normalizeTvmAddress } from '../utils/normalize-address.js'
 
 export type TvmAddress = `T${string}`
 
@@ -25,7 +26,7 @@ export class TvmToken<
   } & ConstructorParameters<
     typeof Token<TvmChainId, TvmAddress, TMetadata>
   >[0]) {
-    super({ address: address.toLowerCase() as TvmAddress, ...rest })
+    super({ address: normalizeTvmAddress(address), ...rest })
     this.origin = origin
   }
 

package/tvm/index.ts

@@ -2,3 +2,4 @@ export * from './abi/index.js'
 export * from './chain/index.js'
 export * from './config/index.js'
 export * from './currency/index.js'
+export * from './utils/index.js'

package/tvm/utils/index.ts

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

package/tvm/utils/normalize-address.ts

@@ -0,0 +1,5 @@
+import type { TvmAddress } from '../currency/token.js'
+
+export function normalizeTvmAddress(address: TvmAddress): TvmAddress {
+  return address
+}