tempo.ts 0.10.4 → 0.11.0

package/src/ox/Order.ts

@@ -1,125 +0,0 @@
-import type * as Address from 'ox/Address'
-import * as Hex from 'ox/Hex'
-
-/**
- * Represents an order from the DEX orderbook.
- */
-export type Order<bigintType = bigint> = {
-  /** Original order amount. */
-  amount: bigintType
-  /** Address of the base token. */
-  baseToken: Address.Address
-  /** Target tick to flip to when order is filled. */
-  flipTick: number
-  /** Order side: true for buy (bid), false for sell (ask). */
-  isBid: boolean
-  /** Whether this is a flip order that auto-flips when filled. */
-  isFlip: boolean
-  /** Address of order maker. */
-  maker: Address.Address
-  /** Next order ID in FIFO queue. */
-  next: bigintType
-  /** Unique order ID. */
-  orderId: bigintType
-  /** Address of the quote token. */
-  quoteToken: Address.Address
-  /** Previous order ID in FIFO queue. */
-  prev: bigintType
-  /** Remaining amount to fill. */
-  remaining: bigintType
-  /** Price tick. */
-  tick: number
-}
-
-/**
- * RPC-formatted order from the DEX orderbook.
- */
-export type Rpc = Order<Hex.Hex>
-
-/**
- * Converts an RPC-formatted order to an internal order representation.
- *
- * @example
- * ```ts twoslash
- * import { Order } from 'tempo.ts/ox'
- *
- * const order = Order.fromRpc({
- *   amount: '0x64',
- *   baseToken: '0x20c0000000000000000000000000000000000001',
- *   flipTick: 0,
- *   isBid: true,
- *   isFlip: false,
- *   maker: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
- *   next: '0x0',
- *   orderId: '0x1',
- *   quoteToken: '0x20c0000000000000000000000000000000000002',
- *   prev: '0x0',
- *   remaining: '0x64',
- *   tick: 100,
- * })
- * // @log: { amount: 100n, orderId: 1n, ... }
- * ```
- *
- * @param order - RPC-formatted order.
- * @returns Internal order representation.
- */
-export function fromRpc(order: Rpc): Order {
-  return {
-    amount: Hex.toBigInt(order.amount),
-    baseToken: order.baseToken,
-    flipTick: order.flipTick,
-    isBid: order.isBid,
-    isFlip: order.isFlip,
-    maker: order.maker,
-    next: Hex.toBigInt(order.next),
-    orderId: Hex.toBigInt(order.orderId),
-    quoteToken: order.quoteToken,
-    prev: Hex.toBigInt(order.prev),
-    remaining: Hex.toBigInt(order.remaining),
-    tick: order.tick,
-  }
-}
-
-/**
- * Converts an internal order representation to RPC format.
- *
- * @example
- * ```ts twoslash
- * import { Order } from 'tempo.ts/ox'
- *
- * const rpcOrder = Order.toRpc({
- *   amount: 100n,
- *   baseToken: '0x20c0000000000000000000000000000000000001',
- *   flipTick: 0,
- *   isBid: true,
- *   isFlip: false,
- *   maker: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
- *   next: 0n,
- *   orderId: 1n,
- *   quoteToken: '0x20c0000000000000000000000000000000000002',
- *   prev: 0n,
- *   remaining: 100n,
- *   tick: 100,
- * })
- * // @log: { amount: '0x64', orderId: '0x1', ... }
- * ```
- *
- * @param order - Internal order representation.
- * @returns RPC-formatted order.
- */
-export function toRpc(order: Order): Rpc {
-  return {
-    amount: Hex.fromNumber(order.amount),
-    baseToken: order.baseToken,
-    flipTick: order.flipTick,
-    isBid: order.isBid,
-    isFlip: order.isFlip,
-    maker: order.maker,
-    next: Hex.fromNumber(order.next),
-    orderId: Hex.fromNumber(order.orderId),
-    quoteToken: order.quoteToken,
-    prev: Hex.fromNumber(order.prev),
-    remaining: Hex.fromNumber(order.remaining),
-    tick: order.tick,
-  }
-}

package/src/ox/OrdersFilters.test.ts

@@ -1,182 +0,0 @@
-import { OrdersFilters } from 'tempo.ts/ox'
-import { describe, expect, test } from 'vitest'
-
-describe('fromRpc', () => {
-  test('default', () => {
-    const rpcFilters: OrdersFilters.Rpc = {
-      baseToken: '0x20c0000000000000000000000000000000000001',
-      isBid: true,
-      remaining: {
-        min: '0x64',
-        max: '0x3e8',
-      },
-    }
-
-    const filters = OrdersFilters.fromRpc(rpcFilters)
-
-    expect(filters).toMatchInlineSnapshot(`
-      {
-        "baseToken": "0x20c0000000000000000000000000000000000001",
-        "isBid": true,
-        "remaining": {
-          "max": 1000n,
-          "min": 100n,
-        },
-      }
-    `)
-  })
-
-  test('with all fields', () => {
-    const rpcFilters: OrdersFilters.Rpc = {
-      baseToken: '0x20c0000000000000000000000000000000000001',
-      quoteToken: '0x20c0000000000000000000000000000000000002',
-      maker: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
-      isBid: true,
-      isFlip: false,
-      remaining: {
-        min: '0x64',
-        max: '0x3e8',
-      },
-      tick: {
-        min: -100,
-        max: 100,
-      },
-    }
-
-    const filters = OrdersFilters.fromRpc(rpcFilters)
-
-    expect(filters).toMatchInlineSnapshot(`
-      {
-        "baseToken": "0x20c0000000000000000000000000000000000001",
-        "isBid": true,
-        "isFlip": false,
-        "maker": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
-        "quoteToken": "0x20c0000000000000000000000000000000000002",
-        "remaining": {
-          "max": 1000n,
-          "min": 100n,
-        },
-        "tick": {
-          "max": 100,
-          "min": -100,
-        },
-      }
-    `)
-  })
-
-  test('with partial remaining range', () => {
-    const rpcFilters: OrdersFilters.Rpc = {
-      baseToken: '0x20c0000000000000000000000000000000000001',
-      remaining: {
-        min: '0x64',
-      },
-    }
-
-    const filters = OrdersFilters.fromRpc(rpcFilters)
-
-    expect(filters.remaining).toMatchInlineSnapshot(`
-      {
-        "max": null,
-        "min": 100n,
-      }
-    `)
-  })
-
-  test('with empty filters', () => {
-    const rpcFilters: OrdersFilters.Rpc = {}
-
-    const filters = OrdersFilters.fromRpc(rpcFilters)
-
-    expect(filters).toMatchInlineSnapshot(`{}`)
-  })
-})
-
-describe('toRpc', () => {
-  test('default', () => {
-    const filters: OrdersFilters.OrdersFilters = {
-      baseToken: '0x20c0000000000000000000000000000000000001',
-      isBid: true,
-      remaining: {
-        min: 100n,
-        max: 1000n,
-      },
-    }
-
-    const rpcFilters = OrdersFilters.toRpc(filters)
-
-    expect(rpcFilters).toMatchInlineSnapshot(`
-      {
-        "baseToken": "0x20c0000000000000000000000000000000000001",
-        "isBid": true,
-        "remaining": {
-          "max": "0x3e8",
-          "min": "0x64",
-        },
-      }
-    `)
-  })
-
-  test('with all fields', () => {
-    const filters: OrdersFilters.OrdersFilters = {
-      baseToken: '0x20c0000000000000000000000000000000000001',
-      quoteToken: '0x20c0000000000000000000000000000000000002',
-      maker: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
-      isBid: false,
-      isFlip: true,
-      remaining: {
-        min: 100n,
-        max: 1000n,
-      },
-      tick: {
-        min: -100,
-        max: 100,
-      },
-    }
-
-    const rpcFilters = OrdersFilters.toRpc(filters)
-
-    expect(rpcFilters).toMatchInlineSnapshot(`
-      {
-        "baseToken": "0x20c0000000000000000000000000000000000001",
-        "isBid": false,
-        "isFlip": true,
-        "maker": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
-        "quoteToken": "0x20c0000000000000000000000000000000000002",
-        "remaining": {
-          "max": "0x3e8",
-          "min": "0x64",
-        },
-        "tick": {
-          "max": 100,
-          "min": -100,
-        },
-      }
-    `)
-  })
-
-  test('with partial remaining range', () => {
-    const filters: OrdersFilters.OrdersFilters = {
-      baseToken: '0x20c0000000000000000000000000000000000001',
-      remaining: {
-        max: 1000n,
-      },
-    }
-
-    const rpcFilters = OrdersFilters.toRpc(filters)
-
-    expect(rpcFilters.remaining).toMatchInlineSnapshot(`
-      {
-        "max": "0x3e8",
-        "min": null,
-      }
-    `)
-  })
-
-  test('with empty filters', () => {
-    const filters: OrdersFilters.OrdersFilters = {}
-
-    const rpcFilters = OrdersFilters.toRpc(filters)
-
-    expect(rpcFilters).toMatchInlineSnapshot(`{}`)
-  })
-})

package/src/ox/OrdersFilters.ts

@@ -1,125 +0,0 @@
-import type * as Address from 'ox/Address'
-import * as Hex from 'ox/Hex'
-import type * as Pagination from './Pagination.js'
-import type * as Tick from './Tick.js'
-
-/**
- * Filter configuration for orders query.
- */
-export type OrdersFilters<bigintType = bigint> = {
-  /** Filter by specific base token. */
-  baseToken?: Address.Address | undefined
-  /** Filter by order side (true=buy, false=sell). */
-  isBid?: boolean | undefined
-  /** Filter flip orders. */
-  isFlip?: boolean | undefined
-  /** Filter by maker address. */
-  maker?: Address.Address | undefined
-  /** Filter by quote token. */
-  quoteToken?: Address.Address | undefined
-  /** Remaining amount in range. */
-  remaining?: Pagination.FilterRange<bigintType> | undefined
-  /** Tick in range (from -2000 to 2000). */
-  tick?: Pagination.FilterRange<Tick.Tick> | undefined
-}
-
-/**
- * RPC-formatted orders filters.
- */
-export type Rpc = OrdersFilters<Hex.Hex>
-
-/**
- * Converts RPC-formatted orders filters to internal representation.
- *
- * @example
- * ```ts twoslash
- * import { OrdersRequest } from 'tempo.ts/ox'
- *
- * const filters = OrdersRequest.fromRpc({
- *   baseToken: '0x20c0000000000000000000000000000000000001',
- *   isBid: true,
- *   remaining: {
- *     min: '0x64',
- *     max: '0x3e8',
- *   },
- * })
- * // @log: { baseToken: '0x20c0...', isBid: true, remaining: { min: 100n, max: 1000n } }
- * ```
- *
- * @param filters - RPC-formatted filters.
- * @returns Internal filters representation.
- */
-export function fromRpc(filters: Rpc): OrdersFilters {
-  const result: OrdersFilters = {}
-
-  if (filters.baseToken !== undefined) result.baseToken = filters.baseToken
-  if (filters.isBid !== undefined) result.isBid = filters.isBid
-  if (filters.isFlip !== undefined) result.isFlip = filters.isFlip
-  if (filters.maker !== undefined) result.maker = filters.maker
-  if (filters.quoteToken !== undefined) result.quoteToken = filters.quoteToken
-
-  if (filters.remaining !== undefined) {
-    const remaining: Pagination.FilterRange<bigint> = {}
-    remaining.min =
-      typeof filters.remaining.min === 'string'
-        ? Hex.toBigInt(filters.remaining.min)
-        : null
-    remaining.max =
-      typeof filters.remaining.max === 'string'
-        ? Hex.toBigInt(filters.remaining.max)
-        : null
-    result.remaining = remaining
-  }
-
-  if (filters.tick !== undefined) result.tick = filters.tick
-
-  return result
-}
-
-/**
- * Converts internal orders filters to RPC format.
- *
- * @example
- * ```ts twoslash
- * import { OrdersRequest } from 'tempo.ts/ox'
- *
- * const rpcFilters = OrdersRequest.toRpc({
- *   baseToken: '0x20c0000000000000000000000000000000000001',
- *   isBid: true,
- *   remaining: {
- *     min: 100n,
- *     max: 1000n,
- *   },
- * })
- * // @log: { baseToken: '0x20c0...', isBid: true, remaining: { min: '0x64', max: '0x3e8' } }
- * ```
- *
- * @param filters - Internal filters representation.
- * @returns RPC-formatted filters.
- */
-export function toRpc(filters: OrdersFilters): Rpc {
-  const result: Rpc = {}
-
-  if (filters.baseToken !== undefined) result.baseToken = filters.baseToken
-  if (filters.isBid !== undefined) result.isBid = filters.isBid
-  if (filters.isFlip !== undefined) result.isFlip = filters.isFlip
-  if (filters.maker !== undefined) result.maker = filters.maker
-  if (filters.quoteToken !== undefined) result.quoteToken = filters.quoteToken
-
-  if (filters.remaining !== undefined) {
-    const remaining: Pagination.FilterRange<Hex.Hex> = {}
-    remaining.min =
-      typeof filters.remaining.min === 'bigint'
-        ? Hex.fromNumber(filters.remaining.min)
-        : null
-    remaining.max =
-      typeof filters.remaining.max === 'bigint'
-        ? Hex.fromNumber(filters.remaining.max)
-        : null
-    result.remaining = remaining
-  }
-
-  if (filters.tick !== undefined) result.tick = filters.tick
-
-  return result
-}

package/src/ox/Pagination.test.ts

@@ -1,162 +0,0 @@
-import { Order, OrdersFilters, Pagination } from 'tempo.ts/ox'
-import { describe, expect, test } from 'vitest'
-
-describe('toRpcParameters', () => {
-  test('default', () => {
-    const params = Pagination.toRpcParameters(
-      {
-        cursor: '0x123',
-        limit: 50,
-        sort: {
-          on: 'orderId',
-          order: 'asc',
-        },
-        filters: {
-          baseToken: '0x20c0000000000000000000000000000000000001',
-          remaining: {
-            max: 1000n,
-          },
-        },
-      },
-      {
-        toRpcFilters: OrdersFilters.toRpc,
-      },
-    )
-
-    expect(params).toMatchInlineSnapshot(`
-      {
-        "cursor": "0x123",
-        "filters": {
-          "baseToken": "0x20c0000000000000000000000000000000000001",
-          "remaining": {
-            "max": "0x3e8",
-            "min": null,
-          },
-        },
-        "limit": 50,
-        "sort": {
-          "on": "orderId",
-          "order": "asc",
-        },
-      }
-    `)
-  })
-})
-
-describe('fromRpcResponse', () => {
-  test('default', () => {
-    const response = Pagination.fromRpcResponse(
-      {
-        nextCursor: '0x123',
-        orders: [
-          {
-            amount: '0x64',
-            baseToken: '0x20c0000000000000000000000000000000000001',
-            flipTick: 0,
-            isBid: true,
-            isFlip: false,
-            maker: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
-            next: '0x0',
-            orderId: '0x1',
-            quoteToken: '0x20c0000000000000000000000000000000000002',
-            prev: '0x0',
-            remaining: '0x64',
-            tick: 100,
-          },
-        ],
-      },
-      {
-        key: 'orders',
-        fromRpc: Order.fromRpc,
-      },
-    )
-
-    expect(response).toMatchInlineSnapshot(`
-      {
-        "nextCursor": "0x123",
-        "orders": [
-          {
-            "amount": 100n,
-            "baseToken": "0x20c0000000000000000000000000000000000001",
-            "flipTick": 0,
-            "isBid": true,
-            "isFlip": false,
-            "maker": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
-            "next": 0n,
-            "orderId": 1n,
-            "prev": 0n,
-            "quoteToken": "0x20c0000000000000000000000000000000000002",
-            "remaining": 100n,
-            "tick": 100,
-          },
-        ],
-      }
-    `)
-  })
-
-  test('with multiple items', () => {
-    const response = Pagination.fromRpcResponse(
-      {
-        nextCursor: '0xabc',
-        orders: [
-          {
-            amount: '0x64',
-            baseToken: '0x20c0000000000000000000000000000000000001',
-            flipTick: 0,
-            isBid: true,
-            isFlip: false,
-            maker: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
-            next: '0x2',
-            orderId: '0x1',
-            quoteToken: '0x20c0000000000000000000000000000000000002',
-            prev: '0x0',
-            remaining: '0x64',
-            tick: 100,
-          },
-          {
-            amount: '0xc8',
-            baseToken: '0x20c0000000000000000000000000000000000001',
-            flipTick: 0,
-            isBid: false,
-            isFlip: false,
-            maker: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
-            next: '0x0',
-            orderId: '0x2',
-            quoteToken: '0x20c0000000000000000000000000000000000002',
-            prev: '0x1',
-            remaining: '0xc8',
-            tick: -100,
-          },
-        ],
-      },
-      {
-        key: 'orders',
-        fromRpc: Order.fromRpc,
-      },
-    )
-
-    expect(response.orders).toHaveLength(2)
-    expect(response.orders[0]?.orderId).toBe(1n)
-    expect(response.orders[1]?.orderId).toBe(2n)
-  })
-
-  test('with null nextCursor', () => {
-    const response = Pagination.fromRpcResponse(
-      {
-        nextCursor: null,
-        orders: [],
-      },
-      {
-        key: 'orders',
-        fromRpc: Order.fromRpc,
-      },
-    )
-
-    expect(response).toMatchInlineSnapshot(`
-      {
-        "nextCursor": null,
-        "orders": [],
-      }
-    `)
-  })
-})