PredictX logoPredictX Docs

PredictX Paper CLOB Implementation Plan

Safe paper-market CLOB implementation plan for PredictX.

PredictX Paper CLOB Implementation Plan

Status: Partially implemented.

This document tracks the safe paper-market version of the PredictX CLOB work.

Added now

Code added in this phase:

  • src/lib/paper-clob/types.ts
  • src/lib/paper-clob/store.ts
  • src/app/api/predictx/paper-clob/orderbook/route.ts
  • src/app/api/predictx/paper-clob/activity/route.ts
  • src/app/api/predictx/paper-clob/balance/route.ts
  • src/app/api/predictx/paper-clob/summary/route.ts

Current capabilities

The paper engine currently supports:

  • Typed paper market model.
  • Seeded paper market depth.
  • Paper credit balance model.
  • In-memory paper entries.
  • In-memory price-time style matching.
  • Paper activity list.
  • Paper market depth API.
  • Paper balance API.
  • Paper summary API.

API endpoints

Get book

GET /api/predictx/paper-clob/orderbook?marketId=arsenal-top-four-finish

Returns:

  • YES bid levels.
  • YES ask levels.
  • NO bid levels.
  • NO ask levels.
  • Last paper activity item.

Get activity

GET /api/predictx/paper-clob/activity?marketId=arsenal-top-four-finish

Returns the latest paper activity list.

Get balance

GET /api/predictx/paper-clob/balance?userId=paper-user

Returns available and reserved paper credits.

Get summary

GET /api/predictx/paper-clob/summary?marketId=arsenal-top-four-finish&userId=paper-user

Returns book, activity, balance, and readiness checks in one response.

Not enabled yet

The write endpoints are intentionally not enabled yet in the live app. The next safe step is to add them after the database-backed ledger is in place.

Pending:

  • Persistent paper balance table.
  • Persistent paper market entries table.
  • Persistent paper activity table.
  • Atomic server action for creating entries.
  • Atomic server action for cancellation.
  • Admin pause flag.
  • Integration tests.
  • UI connected to paper APIs.