sushi 6.0.22 → 6.0.24

package/generic/currency/serialized-currency.ts

@@ -8,21 +8,32 @@ import {
   type serializedTvmNativeSchema,
   type serializedTvmTokenSchema,
 } from '../../tvm/index.js'
+import type { CurrencyMetadata } from './currency.js'
 
-export type SerializedCurrencySchema =
-  | typeof serializedEvmTokenSchema
-  | typeof serializedEvmNativeSchema
-  | typeof serializedEvmCurrencySchema
-  | typeof serializedMvmTokenSchema
-  | typeof serializedTvmTokenSchema
-  | typeof serializedTvmNativeSchema
-  | typeof serializedTvmCurrencySchema
-  | typeof serializedCurrencySchema
+export type SerializedCurrencySchema<
+  TMetadata extends CurrencyMetadata = CurrencyMetadata,
+> = ReturnType<
+  | typeof serializedEvmTokenSchema<TMetadata>
+  | typeof serializedEvmNativeSchema<TMetadata>
+  | typeof serializedEvmCurrencySchema<TMetadata>
+  | typeof serializedMvmTokenSchema<TMetadata>
+  | typeof serializedTvmTokenSchema<TMetadata>
+  | typeof serializedTvmNativeSchema<TMetadata>
+  | typeof serializedTvmCurrencySchema<TMetadata>
+  | typeof serializedCurrencySchema<TMetadata>
+>
 
-export const serializedCurrencySchema = z.union([
-  serializedEvmCurrencySchema,
-  serializedMvmTokenSchema,
-  serializedTvmCurrencySchema,
-])
+export const serializedCurrencySchema = <
+  TMetadata extends {} = CurrencyMetadata,
+>(
+  opts: { metadata?: z.ZodType<TMetadata> } = {},
+) =>
+  z.union([
+    serializedEvmCurrencySchema(opts),
+    serializedMvmTokenSchema(opts),
+    serializedTvmCurrencySchema(opts),
+  ])
 
-export type SerializedCurrency = z.infer<typeof serializedCurrencySchema>
+export type SerializedCurrency<
+  TMetadata extends CurrencyMetadata = CurrencyMetadata,
+> = z.infer<ReturnType<typeof serializedCurrencySchema<TMetadata>>>

package/mvm/currency/token.ts

@@ -17,7 +17,7 @@ export class MvmToken<
     return this
   }
 
-  public override toJSON(): SerializedMvmToken {
+  public override toJSON(): SerializedMvmToken<TMetadata> {
     return {
       chainId: this.chainId,
       address: this.address,
@@ -25,21 +25,37 @@ export class MvmToken<
       name: this.name,
       decimals: this.decimals,
       type: this.type,
+
+      metadata: this.metadata,
     } as const
   }
 
-  static fromJSON(data: SerializedMvmToken): MvmToken {
+  static fromJSON<TMetadata extends CurrencyMetadata>(
+    data: Omit<SerializedMvmToken<TMetadata>, 'metadata'> & {
+      metadata?: TMetadata
+    },
+  ): MvmToken<TMetadata> {
     return new this(data)
   }
 }
 
-export const serializedMvmTokenSchema = z.object({
-  chainId: z.number().int().refine(isMvmChainId),
-  address: z.string().refine(isMvmAddress),
-  symbol: z.string(),
-  name: z.string(),
-  decimals: z.number().int().nonnegative(),
-  type: z.literal('token'),
-})
+export const serializedMvmTokenSchema = <
+  TMetadata extends {} = CurrencyMetadata,
+>({
+  metadata,
+}: { metadata?: z.ZodType<TMetadata> } = {}) =>
+  z.object({
+    chainId: z.number().int().refine(isMvmChainId),
+    address: z.string().refine(isMvmAddress),
+    symbol: z.string(),
+    name: z.string(),
+    decimals: z.number().int().nonnegative(),
+    type: z.literal('token'),
+
+    metadata: (metadata ||
+      z.record(z.unknown()).optional().default({})) as z.ZodType<TMetadata>,
+  })
 
-export type SerializedMvmToken = z.infer<typeof serializedMvmTokenSchema>
+export type SerializedMvmToken<
+  TMetadata extends CurrencyMetadata = CurrencyMetadata,
+> = z.infer<ReturnType<typeof serializedMvmTokenSchema<TMetadata>>>

package/package.json

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

package/tvm/currency/currency.ts

@@ -15,12 +15,19 @@ export type TvmCurrency<
   TMetadata extends CurrencyMetadata = Record<string, unknown>,
 > = TvmNative | TvmToken<TMetadata>
 
-export const serializedTvmCurrencySchema = z.discriminatedUnion('type', [
-  serializedTvmTokenSchema,
-  serializedTvmNativeSchema,
-])
+export const serializedTvmCurrencySchema = <
+  TMetadata extends {} = CurrencyMetadata,
+>(
+  opts: { metadata?: z.ZodType<TMetadata> } = {},
+) =>
+  z.discriminatedUnion('type', [
+    serializedTvmTokenSchema(opts),
+    serializedTvmNativeSchema(opts),
+  ])
 
-export type SerializedTvmCurrency = z.infer<typeof serializedTvmCurrencySchema>
+export type SerializedTvmCurrency<
+  TMetadata extends CurrencyMetadata = CurrencyMetadata,
+> = z.infer<ReturnType<typeof serializedTvmCurrencySchema<TMetadata>>>
 
 function deserializeTvmCurrency(data: SerializedTvmToken): TvmToken
 function deserializeTvmCurrency(data: SerializedTvmNative): TvmNative

package/tvm/currency/native.ts

@@ -1,40 +1,62 @@
 import * as z from 'zod'
+import type { CurrencyMetadata } from '~/generic/currency/currency.js'
 import { Native } from '../../generic/currency/native.js'
 import { type TvmChainId, isTvmChainId } from '../chain/chains.js'
 import { NATIVE } from '../config/index.js'
 import { WNATIVE } from '../config/tokens/wrapped-native.js'
-import type { TvmToken } from './token.js'
+import { TvmToken } from './token.js'
 
-export class TvmNative extends Native<TvmChainId> {
-  static fromChainId(chainId: TvmChainId): TvmNative {
-    return NATIVE[chainId]
+export class TvmNative<
+  TMetadata extends CurrencyMetadata = Record<string, unknown>,
+> extends Native<TvmChainId, TMetadata> {
+  public override wrap(): TvmToken<TMetadata> {
+    return new TvmToken({
+      ...WNATIVE[this.chainId],
+      metadata: structuredClone(this.metadata),
+    })
   }
 
-  public override wrap(): TvmToken {
-    return WNATIVE[this.chainId]
-  }
-
-  public override toJSON(): SerializedTvmNative {
+  public override toJSON(): SerializedTvmNative<TMetadata> {
     return {
       chainId: this.chainId,
       symbol: this.symbol,
       name: this.name,
       decimals: this.decimals,
       type: this.type,
+
+      metadata: this.metadata,
     } as const
   }
 
-  public static fromJSON(data: SerializedTvmNative): TvmNative {
+  static fromJSON<TMetadata extends CurrencyMetadata>(
+    data: Omit<SerializedTvmNative<TMetadata>, 'metadata'> & {
+      metadata?: TMetadata
+    },
+  ): TvmNative<TMetadata> {
     return new this(data)
   }
+
+  static fromChainId(chainId: TvmChainId): TvmNative {
+    return NATIVE[chainId]
+  }
 }
 
-export const serializedTvmNativeSchema = z.object({
-  chainId: z.number().int().refine(isTvmChainId),
-  symbol: z.string(),
-  name: z.string(),
-  decimals: z.number().int().nonnegative(),
-  type: z.literal('native'),
-})
+export const serializedTvmNativeSchema = <
+  TMetadata extends {} = CurrencyMetadata,
+>({
+  metadata,
+}: { metadata?: z.ZodType<TMetadata> } = {}) =>
+  z.object({
+    chainId: z.number().int().refine(isTvmChainId),
+    symbol: z.string(),
+    name: z.string(),
+    decimals: z.number().int().nonnegative(),
+    type: z.literal('native'),
+
+    metadata: (metadata ||
+      z.record(z.unknown()).optional().default({})) as z.ZodType<TMetadata>,
+  })
 
-export type SerializedTvmNative = z.infer<typeof serializedTvmNativeSchema>
+export type SerializedTvmNative<
+  TMetadata extends CurrencyMetadata = CurrencyMetadata,
+> = z.infer<ReturnType<typeof serializedTvmNativeSchema<TMetadata>>>

package/tvm/currency/token.ts

@@ -32,7 +32,7 @@ export class TvmToken<
     return this
   }
 
-  public override toJSON(): SerializedTvmToken {
+  public override toJSON(): SerializedTvmToken<TMetadata> {
     return {
       chainId: this.chainId,
       address: this.address,
@@ -40,17 +40,37 @@ export class TvmToken<
       name: this.name,
       decimals: this.decimals,
       type: this.type,
+
+      metadata: this.metadata,
     } as const
   }
+
+  static fromJSON<TMetadata extends CurrencyMetadata>(
+    data: Omit<SerializedTvmToken<TMetadata>, 'metadata'> & {
+      metadata?: TMetadata
+    },
+  ): TvmToken<TMetadata> {
+    return new this(data)
+  }
 }
 
-export const serializedTvmTokenSchema = z.object({
-  chainId: z.number().int().refine(isTvmChainId),
-  address: z.string().refine(isTvmAddress),
-  symbol: z.string(),
-  name: z.string(),
-  decimals: z.number().int().nonnegative(),
-  type: z.literal('token'),
-})
+export const serializedTvmTokenSchema = <
+  TMetadata extends {} = CurrencyMetadata,
+>({
+  metadata,
+}: { metadata?: z.ZodType<TMetadata> } = {}) =>
+  z.object({
+    chainId: z.number().int().refine(isTvmChainId),
+    address: z.string().refine(isTvmAddress),
+    symbol: z.string(),
+    name: z.string(),
+    decimals: z.number().int().nonnegative(),
+    type: z.literal('token'),
+
+    metadata: (metadata ||
+      z.record(z.unknown()).optional().default({})) as z.ZodType<TMetadata>,
+  })
 
-export type SerializedTvmToken = z.infer<typeof serializedTvmTokenSchema>
+export type SerializedTvmToken<
+  TMetadata extends CurrencyMetadata = CurrencyMetadata,
+> = z.infer<ReturnType<typeof serializedTvmTokenSchema<TMetadata>>>