sushi 6.3.1 → 6.4.0

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'

package/svm/currency/native.ts

@@ -0,0 +1,81 @@
+import * as z from 'zod'
+import type { CurrencyMetadata } from '~/generic/currency/currency.js'
+import { Native } from '../../generic/currency/native.js'
+import {
+  getSvmChainById,
+  isSvmChainId,
+  type SvmChainId,
+} from '../chain/chains.js'
+import { SVM_WNATIVE } from '../config/index.js'
+import { SvmToken } from './token.js'
+
+export class SvmNative<
+  TMetadata extends CurrencyMetadata = Record<string, unknown>,
+> extends Native<SvmChainId, TMetadata> {
+  public override wrap(): SvmToken<TMetadata> {
+    return new SvmToken({
+      ...SVM_WNATIVE[this.chainId],
+      metadata: structuredClone(this.metadata),
+    })
+  }
+
+  public override toJSON(): SerializedSvmNative<TMetadata> {
+    return {
+      chainId: this.chainId,
+      symbol: this.symbol,
+      name: this.name,
+      decimals: this.decimals,
+      type: this.type,
+
+      metadata: this.metadata,
+    } as const
+  }
+
+  static fromJSON<TMetadata extends CurrencyMetadata>(
+    data: Omit<SerializedSvmNative<TMetadata>, 'metadata'> & {
+      metadata?: TMetadata
+    },
+  ): SvmNative<TMetadata> {
+    return new this(data)
+  }
+
+  static fromChainId(chainId: SvmChainId): SvmNative {
+    const chain = getSvmChainById(chainId)
+
+    return new SvmNative({
+      chainId,
+      symbol: chain.nativeCurrency.symbol,
+      name: chain.nativeCurrency.name,
+      decimals: chain.nativeCurrency.decimals,
+    })
+  }
+}
+
+export const serializedSvmNativeSchema = <
+  TMetadata extends {} = CurrencyMetadata,
+>({
+  metadata,
+}: {
+  metadata?: z.ZodType<TMetadata>
+} = {}) =>
+  z.object({
+    chainId: z
+      .number()
+      .int()
+      .refine(isSvmChainId)
+      .transform((chainId) => chainId as SvmChainId),
+    symbol: z.string(),
+    name: z.string(),
+    decimals: z.number().int().nonnegative(),
+    type: z.literal('native'),
+
+    metadata: (metadata ||
+      z
+        .record(z.string(), z.unknown())
+        .optional()
+        .default({})) as z.ZodType<TMetadata>,
+  })
+
+export type SerializedSvmNative<
+  TMetadata extends CurrencyMetadata = CurrencyMetadata,
+> = z.infer<ReturnType<typeof serializedSvmNativeSchema<TMetadata>>>

package/svm/currency/token.ts

@@ -0,0 +1,89 @@
+import {
+  isAddress as isSvmAddress,
+  type Address as SvmAddress,
+  address as svmAddress,
+} from '@solana/addresses'
+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'
+
+export { type SvmAddress, svmAddress, isSvmAddress }
+
+export type SvmTokenOrigin = 'native' | 'native-bridge'
+
+export class SvmToken<
+  TMetadata extends CurrencyMetadata = Record<string, unknown>,
+> extends Token<SvmChainId, SvmAddress, TMetadata> {
+  public readonly origin: SvmTokenOrigin | undefined
+
+  constructor({
+    origin,
+    ...rest
+  }: {
+    origin?: SvmTokenOrigin | undefined
+  } & ConstructorParameters<
+    typeof Token<SvmChainId, SvmAddress, TMetadata>
+  >[0]) {
+    super({ ...rest })
+    this.origin = origin
+  }
+
+  public override wrap(): SvmToken<TMetadata> {
+    return this
+  }
+
+  public override toJSON(): SerializedSvmToken<TMetadata> {
+    return {
+      chainId: this.chainId,
+      address: this.address,
+      symbol: this.symbol,
+      name: this.name,
+      decimals: this.decimals,
+      type: this.type,
+
+      metadata: this.metadata,
+    } as const
+  }
+
+  static fromJSON<TMetadata extends CurrencyMetadata>(
+    data: Omit<SerializedSvmToken<TMetadata>, 'metadata'> & {
+      metadata?: TMetadata
+    },
+  ): SvmToken<TMetadata> {
+    return new this(data)
+  }
+}
+
+export const serializedSvmTokenSchema = <
+  TMetadata extends {} = CurrencyMetadata,
+>({
+  metadata,
+}: {
+  metadata?: z.ZodType<TMetadata>
+} = {}) =>
+  z.object({
+    chainId: z
+      .number()
+      .int()
+      .refine(isSvmChainId)
+      .transform((chainId) => chainId as SvmChainId),
+    address: z
+      .string()
+      .refine(isSvmAddress)
+      .transform((address) => address as SvmAddress),
+    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>,
+  })
+
+export type SerializedSvmToken<
+  TMetadata extends CurrencyMetadata = CurrencyMetadata,
+> = z.infer<ReturnType<typeof serializedSvmTokenSchema<TMetadata>>>

package/svm/currency/unwrap-token.ts

@@ -0,0 +1,15 @@
+import { SVM_WNATIVE_ADDRESS } from '../config/index.js'
+import type { SvmCurrency } from './currency.js'
+import { SvmNative } from './native.js'
+
+export function unwrapSvmToken(currency: SvmCurrency): SvmCurrency {
+  if (currency.type === 'native') {
+    return currency
+  }
+
+  if (currency.address === SVM_WNATIVE_ADDRESS[currency.chainId]) {
+    return SvmNative.fromChainId(currency.chainId)
+  }
+
+  return currency
+}

package/svm/index.ts

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