feat: added serializable functions helper (#132)

* feat: added serializable functions helper

* chore: format

---------

Co-authored-by: maxencerb <[email protected]>

.changeset/polite-mayflies-cheat.md

@@ -0,0 +1,5 @@
+---
+"@mangrovedao/mgv": patch
+---
+
+Added serialize helper functions for markets and offer list keys

biome.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://biomejs.dev/schemas/1.7.2/schema.json",
+  "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
   "files": {
     "ignore": [
       "_cjs",
@@ -61,7 +61,7 @@
   "javascript": {
     "formatter": {
       "quoteStyle": "single",
-      "trailingComma": "all",
+      "trailingCommas": "all",
       "semicolons": "asNeeded"
     }
   },

package.json

@@ -15,29 +15,29 @@
     "clean": "rimraf src/_esm src/_cjs src/_types",
     "format": "biome format . --write",
     "lint": "biome check .",
-    "lint:fix": "bun run lint --apply",
+    "lint:fix": "bun run lint --write",
     "prepublishOnly": "bun scripts/prepublishOnly.ts",
     "test": "vitest -c ./test/vitest.config.ts dev",
     "test:ci": "CI=true vitest -c ./test/vitest.config.ts --retry=3"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.7.2",
-    "@types/bun": "latest",
+    "@biomejs/biome": "1.8.3",
+    "@types/bun": "^1.1.8",
     "@viem/anvil": "^0.0.10",
-    "@vitest/coverage-v8": "^1.5.3",
-    "globby": "^14.0.0",
-    "rimraf": "^5.0.5",
+    "@vitest/coverage-v8": "^2.0.5",
+    "globby": "^14.0.2",
+    "rimraf": "^6.0.1",
     "simple-git-hooks": "^2.11.1",
-    "viem": "^2.12.5",
-    "vitest": "^1.5.3"
+    "viem": "^2.21.2",
+    "vitest": "^2.0.5"
   },
   "peerDependencies": {
-    "typescript": "^5.0.0"
+    "typescript": "^5.5.4"
   },
   "simple-git-hooks": {
     "pre-commit": "bun run format && bun run lint:fix"
   },
   "dependencies": {
-    "@changesets/cli": "^2.27.1"
+    "@changesets/cli": "^2.27.8"
   }
 }

src/actions/book.test.ts

@@ -1,8 +1,9 @@
 import { describe, expect, inject, it } from 'vitest'
 import { getClient } from '~test/src/client.js'
+import { getMarkets } from '~test/src/markets.js'
 import { getBook } from './book.js'
 
-const { wethDAI } = inject('markets')
+const { wethDAI } = getMarkets()
 const params = inject('mangrove')
 
 describe('Getting the book', () => {

src/actions/kandel/populate.test.ts

@@ -1,17 +1,18 @@
-import { type Client, erc20Abi, parseEther, parseUnits } from 'viem'
+import { parseEther, parseUnits } from 'viem'
 import { describe, expect, inject, it } from 'vitest'
-import { minVolume, validateKandelParams } from '~mgv/index.js'
+import { validateKandelParams } from '~mgv/index.js'
 import { BS } from '~mgv/lib/enums.js'
 import { getClient } from '~test/src/client.js'
 import { mintAndApprove } from '~test/src/contracts/index.js'
+import { getMarkets } from '~test/src/markets.js'
 import { getBook } from '../book.js'
 import { simulateMarketOrderByVolumeAndMarket } from '../market-order.js'
 import { simulateBind, simulateDeployRouter } from '../smart-router.js'
 import { simulatePopulate } from './populate.js'
 import { simulateSow } from './sow.js'
 
 const { smartKandelSeeder, kandelSeeder } = inject('kandel')
-const { wethUSDC } = inject('markets')
+const { wethUSDC } = getMarkets()
 const actionParams = inject('mangrove')
 const client = getClient()
 

src/actions/kandel/retract.test.ts

@@ -3,14 +3,15 @@ import { describe, expect, inject, it } from 'vitest'
 import { validateKandelParams } from '~mgv/index.js'
 import { getClient } from '~test/src/client.js'
 import { mintAndApprove } from '~test/src/contracts/index.js'
+import { getMarkets } from '~test/src/markets.js'
 import { getBook } from '../book.js'
 import { simulateBind, simulateDeployRouter } from '../smart-router.js'
 import { simulatePopulate } from './populate.js'
 import { simulateRetract } from './retract.js'
 import { simulateSow } from './sow.js'
 
 const { smartKandelSeeder, kandelSeeder } = inject('kandel')
-const { wethUSDC } = inject('markets')
+const { wethUSDC } = getMarkets()
 const actionParams = inject('mangrove')
 const client = getClient()
 

src/actions/kandel/sow.test.ts

@@ -1,10 +1,11 @@
 import { isAddress } from 'viem'
 import { describe, expect, inject, it } from 'vitest'
 import { getClient } from '~test/src/client.js'
+import { getMarkets } from '~test/src/markets.js'
 import { simulateSow } from './sow.js'
 
 const { smartKandelSeeder, kandelSeeder } = inject('kandel')
-const { wethUSDC } = inject('markets')
+const { wethUSDC } = getMarkets()
 const client = getClient()
 
 describe('sow Smart Kandel', () => {

src/actions/kandel/view.test.ts

@@ -4,6 +4,7 @@ import { validateKandelParams } from '~mgv/index.js'
 import type { KandelParams, MarketParams } from '~mgv/index.js'
 import { BS, Order } from '~mgv/lib/enums.js'
 import { getClient } from '~test/src/client.js'
+import { getMarkets } from '~test/src/markets.js'
 import { getBook } from '../book.js'
 import { simulateLimitOrder } from '../index.js'
 import { simulateBind, simulateDeployRouter } from '../smart-router.js'
@@ -12,7 +13,7 @@ import { simulateSow } from './sow.js'
 import { KandelStatus, getKandelState } from './view.js'
 
 const { smartKandelSeeder } = inject('kandel')
-const { wethUSDC } = inject('markets')
+const { wethUSDC } = getMarkets()
 const actionParams = inject('mangrove')
 const client = getClient()
 

src/actions/order/new.test.ts

@@ -11,13 +11,14 @@ import { describe, expect, inject, it } from 'vitest'
 import { limitOrderResultFromLogs } from '~mgv/lib/limit-order.js'
 import { tickFromVolumes } from '~mgv/lib/tick.js'
 import { getClient } from '~test/src/client.js'
+import { getMarkets } from '~test/src/markets.js'
 import { BS, Order } from '../../lib/enums.js'
 import { getBook } from '../book.js'
 import { getUserRouter } from '../smart-router.js'
 import { getLimitOrderSteps, simulateLimitOrder } from './new.js'
 
 const params = inject('mangrove')
-const { wethUSDC } = inject('markets')
+const { wethUSDC } = getMarkets()
 const client = getClient()
 
 describe('new order', () => {

src/actions/order/remove.test.ts

@@ -6,12 +6,13 @@ import {
   removeOrderResultFromLogs,
 } from '~mgv/lib/limit-order.js'
 import { getClient } from '~test/src/client.js'
+import { getMarkets } from '~test/src/markets.js'
 import { getBook } from '../book.js'
 import { simulateLimitOrder } from './new.js'
 import { simulateRemoveOrder } from './remove.js'
 
 const client = getClient()
-const { wethUSDC } = inject('markets')
+const { wethUSDC } = getMarkets()
 const params = inject('mangrove')
 
 describe('remove order', () => {

src/actions/order/update.test.ts

@@ -8,12 +8,13 @@ import {
 } from '~mgv/lib/limit-order.js'
 import { tickFromVolumes } from '~mgv/lib/tick.js'
 import { getClient } from '~test/src/client.js'
+import { getMarkets } from '~test/src/markets.js'
 import { getBook } from '../book.js'
 import { simulateLimitOrder } from './new.js'
 import { simulateSetExpiration, simulateUpdateOrder } from './update.js'
 
 const client = getClient()
-const { wethUSDC } = inject('markets')
+const { wethUSDC } = getMarkets()
 const params = inject('mangrove')
 
 describe('update order', () => {

src/actions/order/view.test.ts

@@ -3,6 +3,7 @@ import { describe, expect, inject, it } from 'vitest'
 import { limitOrderResultFromLogs } from '~mgv/lib/limit-order.js'
 import { tickFromVolumes } from '~mgv/lib/tick.js'
 import { getClient } from '~test/src/client.js'
+import { getMarkets } from '~test/src/markets.js'
 import { BA, BS, Order } from '../../lib/enums.js'
 import { getBook } from '../book.js'
 import { getUserRouter } from '../smart-router.js'
@@ -11,7 +12,7 @@ import { getOrder, getOrders } from './view.js'
 
 const client = getClient()
 const params = inject('mangrove')
-const { wethUSDC } = inject('markets')
+const { wethUSDC } = getMarkets()
 
 describe('view order', () => {
   it('single order', async () => {

src/index.ts

@@ -87,6 +87,7 @@ export {
 export type {
   MangroveActionsDefaultParams,
   MarketParams,
+  SerializableMarketParams,
   BuiltArgs,
   BuiltArgsWithValue,
   Book,
@@ -105,6 +106,7 @@ export type {
   LocalConfig,
   CompleteToken,
   OLKey,
+  SerializableOLKey,
   RpcOffer,
   RpcOfferDetail,
   RpcCompleteOffer,

src/lib/human-readable.test.ts

@@ -1,5 +1,6 @@
 import { parseUnits } from 'viem'
 import { describe, expect, inject, it } from 'vitest'
+import { getMarkets } from '~test/src/markets.js'
 import { BA } from './enums.js'
 import {
   amounts,
@@ -10,7 +11,7 @@ import {
 } from './human-readable.js'
 import { tickFromVolumes } from './tick.js'
 
-const { wethUSDC } = inject('markets')
+const { wethUSDC } = getMarkets()
 const { USDC, WETH } = inject('tokens')
 
 // price is quote/base

src/lib/index.ts

@@ -142,4 +142,4 @@ export {
 
 // utils
 
-export { mask } from './utils.js'
+export { mask, fromSerializable, toSerializable } from './utils.js'

src/lib/kandel/distribution.test.ts

@@ -2,12 +2,13 @@ import { parseAbi } from 'viem'
 import { expect, it } from 'vitest'
 import { describe, inject } from 'vitest'
 import { getClient } from '~test/src/client.js'
+import { getMarkets } from '~test/src/markets.js'
 import { createGeometricDistribution } from './distribution.js'
 import { getKandelPositionRawParams } from './params.js'
 
 const { kandelLib, smartKandelSeeder } = inject('kandel')
 const { routerProxyFactory, mgv } = inject('mangrove')
-const { wethUSDC } = inject('markets')
+const { wethUSDC } = getMarkets()
 
 const client = getClient()
 

src/lib/kandel/logs.test.ts

@@ -2,11 +2,12 @@ import { isAddress } from 'viem'
 import { describe, expect, inject, it } from 'vitest'
 import { simulateSow } from '~mgv/actions/kandel/sow.js'
 import { getClient } from '~test/src/client.js'
+import { getMarkets } from '~test/src/markets.js'
 import { hash } from '../ol-key.js'
 import { getKandelsFromLogs } from './logs.js'
 
 const { smartKandelSeeder } = inject('kandel')
-const { wethUSDC } = inject('markets')
+const { wethUSDC } = getMarkets()
 const client = getClient()
 
 describe('Kandel logs', () => {

src/lib/kandel/params.test.ts

@@ -1,14 +1,15 @@
 import { describe, expect, inject, it } from 'vitest'
 import { getBook } from '~mgv/actions/book.js'
 import { getClient } from '~test/src/client.js'
+import { getMarkets } from '~test/src/markets.js'
 import {
   humanPriceToRawPrice,
   rawPriceToHumanPrice,
 } from '../human-readable.js'
 import { priceFromTick, tickFromPrice } from '../tick.js'
 import { getKandelPositionRawParams, validateKandelParams } from './params.js'
 
-const { wethUSDC } = inject('markets')
+const { wethUSDC } = getMarkets()
 const params = inject('mangrove')
 
 const client = getClient()

src/lib/market-order-simulation.test.ts

@@ -6,6 +6,7 @@ import { simulateSow } from '~mgv/actions/kandel/sow.js'
 import { validateKandelParams } from '~mgv/index.js'
 import { getClient } from '~test/src/client.js'
 import { mintAndApprove } from '~test/src/contracts/index.js'
+import { getMarkets } from '~test/src/markets.js'
 import type { Book } from '../types/index.js'
 import { BS } from './enums.js'
 import { marketOrderSimulation } from './market-order-simulation.js'
@@ -14,7 +15,7 @@ import { inboundFromOutbound, outboundFromInbound } from './tick.js'
 const client = getClient()
 const actionParams = inject('mangrove')
 const kandelSeeder = inject('kandel')
-const { wethUSDC } = inject('markets')
+const { wethUSDC } = getMarkets()
 
 const KANDEL_GASREQ = 128_000n
 

src/lib/utils.ts

@@ -1,3 +1,34 @@
+import type {
+  MarketParams,
+  OLKey,
+  SerializableMarketParams,
+  SerializableOLKey,
+} from '../types/index.js'
+
 export function mask(n: bigint): bigint {
   return (1n << n) - 1n
 }
+
+export function toSerializable<
+  TType extends MarketParams | OLKey = MarketParams | OLKey,
+>(
+  args: TType,
+): TType extends MarketParams ? SerializableMarketParams : SerializableOLKey {
+  return {
+    ...args,
+    tickSpacing: Number(args.tickSpacing),
+  } as unknown as TType extends MarketParams
+    ? SerializableMarketParams
+    : SerializableOLKey
+}
+
+export function fromSerializable<
+  TType extends SerializableMarketParams | SerializableOLKey =
+    | SerializableMarketParams
+    | SerializableOLKey,
+>(args: TType): TType extends SerializableMarketParams ? MarketParams : OLKey {
+  return {
+    ...args,
+    tickSpacing: BigInt(args.tickSpacing),
+  } as unknown as TType extends SerializableMarketParams ? MarketParams : OLKey
+}

src/types/actions/index.ts

@@ -28,6 +28,18 @@ export type MarketParams = {
   tickSpacing: bigint
 }
 
+/**
+ * A serializable version of a market
+ * @param base The base token
+ * @param quote The quote token
+ * @param tickSpacing The tick spacing
+ */
+export type SerializableMarketParams = {
+  base: Token
+  quote: Token
+  tickSpacing: number
+}
+
 /**
  * List of args that are built by the transaction builders
  */

src/types/index.ts

@@ -1,6 +1,7 @@
 export type {
   MangroveActionsDefaultParams,
   MarketParams,
+  SerializableMarketParams,
   BuiltArgs,
   BuiltArgsWithValue,
   Book,
@@ -22,6 +23,7 @@ export type {
   LocalConfig,
   CompleteToken,
   OLKey,
+  SerializableOLKey,
   RpcOffer,
   RpcOfferDetail,
   RpcCompleteOffer,

src/types/lib.ts

@@ -54,6 +54,18 @@ export type OLKey = {
   tickSpacing: bigint
 }
 
+/**
+ * An OLKey object that is serializable.
+ * @param outbound_tkn The address of the outbound token.
+ * @param inbound_tkn The address of the inbound token.
+ * @param tickSpacing The tick spacing.
+ */
+export type SerializableOLKey = {
+  outbound_tkn: Address
+  inbound_tkn: Address
+  tickSpacing: number
+}
+
 /**
  * The offer object returned by the RPC endpoint.
  */