Polytraders Dev Guide
internal
v3 spine Phase 1 · Shared contracts 9 demo-wired · 0 shadow-ready · 0 production-live · 100 pending · 109 total 15/33 infra tasks the plan status board
HomeBy LayerStrategy3.23 BasisTrader

3.23 BasisTrader

Strategy Alpha Strategy Trade PLANNED Spec started capital · Direct P8 · Additional strategies pending stub

BasisTrader identifies and trades the price basis between a Polymarket market and an off-platform reference (sportsbook line, futures price, or consensus poll) when the resolution rules of both platforms are provably identical. The bot buys the Polymarket leg when it is cheap relative to the reference and the basis exceeds min_basis_bps after fees.

v3 readiness

Docs27/27
donehow scored
Impl0/15
pendinghow scored
Backtest0/4
pendinghow scored
Runtime0/8
pendinghow scored

A bot is done when all four scores are. What does done mean?

1. Bot Identity

LayerStrategy  Strategy
Bot classAlpha Strategy
AuthorityTrade
StatusPLANNED
ReadinessSpec started
Runs beforeRisk guardrail pipeline
Runs afterObservation bus / internal analytics
Applies toPolymarket binary markets with an identified off-platform reference (sportsbook, futures, poll) sharing identical resolution rules, where the basis exceeds min_basis_bps after fees
Default modeshadow_only
User-visibleAdvanced details only
Developer ownerPolytraders core — Strategy pod

2. Purpose

BasisTrader identifies and trades the price basis between a Polymarket market and an off-platform reference (sportsbook line, futures price, or consensus poll) when the resolution rules of both platforms are provably identical. The bot buys the Polymarket leg when it is cheap relative to the reference and the basis exceeds min_basis_bps after fees.

3. Why This Bot Matters

  • Reference instrument diverges post-entry due to rule change

    If the off-platform reference changes its resolution criteria after the basis trade is entered, the position is no longer hedged and becomes an unprotected directional bet.

  • Stale input data

    Acting on stale signals for BasisTrader produces trades based on outdated market conditions, generating adverse fills.

  • KillSwitch not respected

    Emitting OrderIntents while KillSwitch is active bypasses risk controls.

No worked examples on this bot yet. Worked examples are optional but strongly recommended — they turn an abstract failure mode into something a developer can verify in a fixture.

4. Required Polymarket Inputs

InputSourceRequired?Use
CLOB book (mid, depth, spread)ws_marketYesRead current market price and available depth for order sizing.
Market status (open/closed/resolved)clob_publicYesSkip closed or resolved markets.

5. Required Internal Inputs

InputSourceRequired?Use
KillSwitch active flagKillSwitchYesAbort all intent emission if KillSwitch active.
BasisTrader analytics signalinternal (analytics engine)YesProvides the core BasisTrader signal that drives trade decisions.
Builder code bytes32internal configYesInjected into builder field on every signed V2 OrderIntent.

6. Parameter Guide

ParameterDefaultWarningHardWhat it controls
min_basis_bps1507525Minimum basis in bps between Polymarket and the reference instrument required to emit an OrderIntent.
require_rule_parityTrueNoneNoneBoth Polymarket and the reference must have provably identical resolution rules before trading. Locked true.
max_position_per_leg400600800Maximum pUSD per leg of the basis trade.
halt_on_reference_staleTrueNoneNoneIf true, halt all basis trades when the reference instrument price is stale (> 30s).

7. Detailed Parameter Instructions

min_basis_bps

What it means

Minimum basis in bps between Polymarket and the reference instrument required to emit an OrderIntent.

Default

{ "min_basis_bps": 150 }

Why this default matters

150 bps provides margin after fees on both legs (~50 bps each).

Threshold logic

ConditionAction
>= 150 bpsEMIT IOC basis trade
75–150 bpsWARN BT_BASIS_MARGINAL; halve size
< 25 bpsSKIP BT_NO_BASIS

Developer check

if basis_bps < params.hard: return skip('BT_NO_BASIS')

User-facing English

The basis was too small after fees to justify a trade.

require_rule_parity

What it means

Both Polymarket and the reference must have provably identical resolution rules before trading. Locked true.

Default

{ "require_rule_parity": true }

Why this default matters

Without rule parity the basis is not a true hedge; trading on it creates directional risk.

Threshold logic

ConditionAction
rules differHARD_REJECT BT_RULE_MISMATCH

Developer check

if not rules_match(pm, reference): return skip('BT_RULE_MISMATCH')

User-facing English

The resolution rules differ between platforms — basis trade blocked.

max_position_per_leg

What it means

Maximum pUSD per leg of the basis trade.

Default

{ "max_position_per_leg": 400 }

Why this default matters

400 pUSD limits single-leg exposure in the basis pair.

Threshold logic

ConditionAction
<= 400 pUSDNormal sizing
> 800 pUSDReject config

Developer check

if params.max_position_per_leg > params.hard: raise ConfigError('PARAMETER_CHANGE_REQUIRES_APPROVAL')

User-facing English

Position size capped at per-leg maximum.

halt_on_reference_stale

What it means

If true, halt all basis trades when the reference instrument price is stale (> 30s).

Default

{ "halt_on_reference_stale": true }

Why this default matters

Stale reference prices create phantom basis gaps that evaporate before the Polymarket order lands.

Threshold logic

ConditionAction
reference stale > 30sHARD_REJECT BT_REFERENCE_STALE

Developer check

if reference_age_s > 30: return skip('BT_REFERENCE_STALE')

User-facing English

The reference instrument price was too old to trade on.

8. Default Configuration

{
  "bot_id": "strat.basistrader",
  "version": "0.1.0",
  "mode": "shadow_only",
  "defaults": {
    "min_basis_bps": 150,
    "require_rule_parity": true,
    "max_position_per_leg": 400,
    "halt_on_reference_stale": true
  },
  "locked": {
    "min_basis_bps": {
      "min": 25
    },
    "max_position_per_leg": {
      "min": 800
    }
  }
}

9. Implementation Flow

  1. Check KillSwitch; if active, emit no OrderIntents.
  2. FETCH BasisTrader analytics signal from internal engine.
  3. IF signal below hard floor: SKIP, emit sampled DecisionReport BT_NO_EDGE.
  4. FETCH clob_public market status; skip if closed or resolved.
  5. FETCH ws_market book; compute current mid and available depth.
  6. IF signal < warning threshold: WARN BT_MARGINAL; reduce size 50%.
  7. Compute order size = min(max_size_param, available_depth).
  8. EMIT IOC OrderIntent with builder code.
  9. EMIT DecisionReport with intent_emitted=true, reason=BT_TRADE.

10. Reference Implementation

Pseudocode is language-agnostic. FETCH = read input. EMIT = produce output. IF/THEN/ELSE = decision. Translate directly to TypeScript, Python, Go, or Rust.

FUNCTION onSignalUpdate(market_id, signal):
  ks = FETCH internal.killswitch.status
  IF ks.active: RETURN

  // Hard floor gate
  IF signal.score < params.min_basis_bps_hard:
    IF random() < 0.01:
      EMIT DecisionReport(intent_emitted=false, reason='BT_NO_EDGE')
    RETURN

  mkt = FETCH clob_public.GET('/markets/' + market_id)
  IF mkt.closed OR mkt.resolved: RETURN

  // Warning threshold check
  sizeMultiplier = 0.5 IF signal.score < params.min_basis_bps_warn ELSE 1.0
  IF sizeMultiplier < 1.0: WARN('BT_MARGINAL')

  // Book snapshot
  book = FETCH ws_market.book(market_id)
  mid = (book.best_bid + book.best_ask) / 2
  depth = FETCH clob_public.depth(market_id)

  // Size computation
  orderSize = toPusdUnits(min(params.require_rule_parity * sizeMultiplier, depth.available))

  EMIT OrderIntent(market=market_id, outcome='YES', side='buy', price=mid,
                   size_pUSD=orderSize, tif='IOC', builder=internalBuilderCode)
  EMIT DecisionReport(intent_emitted=true, signal_score=signal.score,
                      reason='BT_TRADE')

SDK calls used

  • ws_market.subscribe('book', [market_id])
  • fetchClobPublic('/markets/' + market_id)
  • internal.analyticsEngine.signal(market_id)
  • buildOrderTypedData(orderParams, {name:'CTFExchange', version:'2', chainId:137})
  • internal.builder_code

Complexity: O(1) per signal update per market

11. Wire Examples

Input — what arrives on the wire

BasisTrader analytics signalinternal (analytics engine)

{
  "market_id": "0xbasistra000000000000000000000000000000000000000000000000000000000001",
  "signal_score": "0.75",
  "received_at_ms": 1746790800000
}

Output — what the bot emits

OrderIntent — BasisTrader IOC buy YES

{
  "intent_id": "oi_01HBT0000001A",
  "market_id": "0xbasistra000000000000000000000000000000000000000000000000000000000001",
  "outcome": "YES",
  "side": "buy",
  "price": "0.540",
  "size_pUSD": "200.00",
  "tif": "IOC",
  "builder": {
    "code": "0x706f6c7974726164657273000000000000000000000000000000000000000000",
    "fee_bps": 25
  },
  "decision": {
    "signal_score": 0.75,
    "reasons": [
      "BT_TRADE"
    ]
  }
}

12. Decision Logic

APPROVE

All gates passed, KillSwitch inactive, market open. Emit IOC OrderIntent.

RESHAPE_REQUIRED

Not applicable — reshaping handled by downstream Risk guardrail.

REJECT

Signal below hard floor; stale data; market closed; KillSwitch active.

WARNING_ONLY

Signal in warning zone triggers 50% size reduction.

13. Standard Decision Output

This bot returns a OrderIntent object. See OrderIntent schema.

{
  "intent_id": "oi_01HBT0000001A",
  "trace_id": "tr_01HBT000TR001",
  "market_id": "0xbasistra000000000000000000000000000000000000000000000000000000000001",
  "outcome": "YES",
  "side": "buy",
  "price": "0.540",
  "size_pUSD": "200.00",
  "tif": "IOC",
  "post_only": false,
  "builder": {
    "code": "0x706f6c7974726164657273000000000000000000000000000000000000000000",
    "fee_bps": 25
  },
  "negrisk_aware": false,
  "decision": {
    "signal_score": 0.75,
    "reasons": [
      "BT_TRADE"
    ]
  },
  "comment": "fees are operator-set at match time in V2 \u2014 feeRateBps is NOT on the signed order"
}

14. Reason Codes

CodeSeverityMeaningActionUser-facing message
BT_TRADEINFOAll gates passed. IOC OrderIntent emitted for BasisTrader.Emit IOC OrderIntent.A BasisTrader trade was placed.
BT_MARGINALWARNEdge is within the warning threshold; size reduced 50%.Emit at 50% size; log warning.A small edge was found; a reduced-size BasisTrader trade was placed.
BT_NO_EDGEINFOEdge below hard floor. Skipping.Skip; emit sampled DecisionReport.The edge was too small to justify a trade.
BT_RULE_MISMATCHHARD_REJECTResolution rules differ between Polymarket and reference instrument.Skip; no OrderIntent.The resolution rules differ — basis trade blocked.
BT_REFERENCE_STALEHARD_REJECTReference instrument price is stale (> 30s).Skip; no OrderIntent.The reference price was too old for a basis trade.
BT_HARD_REJECTHARD_REJECTA critical gate condition blocked the trade (stale data, kill switch, or hard parameter breach).Skip; no OrderIntent.A safety condition blocked the trade.
KILL_SWITCH_ACTIVEHARD_REJECTGlobal kill switch is active.Skip all markets; no OrderIntents emitted.Trading is currently paused.

15. Metrics & Logs

Metrics emitted

MetricTypeUnitLabelsMeaning
polytraders_strat_basistrader_decisions_totalcountercountverdict, reason_codeTotal evaluation cycles by verdict and reason code.
polytraders_strat_basistrader_signal_scorehistogramscoreDistribution of analytics signal scores at evaluation.
polytraders_strat_basistrader_intents_emitted_totalcountercountoutcomeTotal IOC OrderIntents emitted.
polytraders_strat_basistrader_eval_latency_mshistogrammillisecondsLatency from signal receipt to OrderIntent emit.

Alerts

AlertConditionSeverityRunbook
BasisTraderStaleFeedrate(polytraders_strat_basistrader_decisions_total{reason_code='STALE_MARKET_DATA'}[5m]) > 0.1warn#runbook-basistrader-stale
BasisTraderKillSwitchrate(polytraders_strat_basistrader_decisions_total{reason_code='KILL_SWITCH_ACTIVE'}[1m]) > 0page#runbook-killswitch
BasisTraderNoEdgerate(polytraders_strat_basistrader_decisions_total{verdict='skip',reason_code='BT_NO_EDGE'}[10m]) / rate(polytraders_strat_basistrader_decisions_total[10m]) > 0.95warn#runbook-basistrader-edge

16. Developer Reporting

{
  "bot_id": "strat.basistrader",
  "market_id": "0xbasistra000000000000000000000000000000000000000000000000000000000001",
  "signal_score": 0.75,
  "intent_emitted": true,
  "reason": "BT_TRADE",
  "emitted_at_ms": 1746790800000
}

17. Plain-English Reporting

SituationUser-facing explanation
BasisTrader trade placedThe BasisTrader strategy detected a suitable opportunity and placed a trade.
Edge too small — no tradeThe signal was below the minimum threshold. No trade was placed.
Safety gate active — no tradeA safety condition (stale data, kill switch, or parameter limit) blocked the trade.

18. Failure-Mode Block

main_failure_modeIf the off-platform reference changes its resolution criteria after the basis trade is entered, the position is no longer hedged and becomes an unprotected directional bet.
false_positive_riskSignal mis-fires when market conditions change rapidly, producing trades that quickly move against the BasisTrader thesis.
false_negative_riskHard floor set too conservatively misses genuine opportunities.
safe_fallbackIf ws_market feed stale or analytics signal unavailable, skip without emitting any OrderIntent.
required_dependenciesws_market, clob_public, internal BasisTrader analytics engine, KillSwitch, internal builder code

19. Failure-Injection Recipes

ScenarioHow to injectExpected behaviourRecovery
SIGNAL_UNAVAILABLECut internal analytics engine connectionAutomatic when engine reconnects.
HARD_FLOOR_BREACHInject signal below hard floorAutomatic on next valid signal.
KILL_SWITCH_ONSet killswitch.active=trueAutomatic on manual KillSwitch reset.

20. State & Persistence

Cold-start recovery

On cold start, signals rebuilt from next analytics engine poll.

21. Concurrency & Idempotency

AspectSpecification
Execution modelactor-per-market
Max in-flight25
Idempotency keyintent_id
Per-call timeout (ms)300
Backpressure strategydrop oldest signal per market_id when queue > 2
Locking / mutual exclusionper-market_id mutex for signal state

22. Dependencies

Depends on (must run first)

BotWhyContract
risk.kill_switchChecked first; blocks all intent emission when active.

Emits to (downstream consumers)

External services

ServiceEndpointSLA assumedOn failure
Polymarket CLOB WebSocket (ws_market)best-effort
Internal BasisTrader analytics engineinternal SLA

23. Security Surfaces

Abuse vectors considered

  • Signal injection to produce false BasisTrader trades
  • Order sizing parameter manipulation to exceed position limits

Mitigations

  • BasisTrader analytics signals sourced from authenticated internal engine only
  • Hard limits on position size enforced before OrderIntent emission
  • Builder code injected from secure internal config

24. Polymarket V2 Compatibility

AspectValue
CLOB versionv2
Collateral assetpUSD
EIP-712 Exchange domain version2
Aware of builderCode fieldyes
Aware of negative-risk marketsno
Multi-chain readyno
SDK usedpy-clob-client-v2
Settlement contractCTFExchangeV2
NotesBot not yet implemented; designed against V2 schema (pUSD, builder codes, V2 EIP-712 domain). feeRateBps not present on any signed OrderIntent.

API surfaces declared

clob_publicclob_authws_marketinternal

Networks supported

polygon

25. Versioning & Migration

FieldValue
spec2.0.0
implementation0.1.0
schema2
releasedNone
planned_releaseQ3-2026

Migration history

DateFromToReasonAction taken
2026-04-28n/av2-specSpec drafted post-CLOB-V2 cutover; bot not yet implementedDesigned against V2 schema (pUSD, builder codes, V2 EIP-712 domain)

26. Acceptance Tests

Unit Tests

TestSetupExpected result
Emit IOC when signal=0.75 and all gates passstandard configIOC OrderIntent; reason=BT_TRADE
Skip when signal below hard floorsignal=below_hardNo OrderIntent; sampled reason=BT_NO_EDGE
Skip when KillSwitch activekillswitch.active=trueNo OrderIntents emitted

Integration Tests

TestExpected result
Full cycle: signal → computation → IOC OrderIntent on Polygon testnetOrder has builder.code, no feeRateBps, EIP-712 domain v2

Property Tests

PropertyRequired behaviour
Bot never emits OrderIntent when KillSwitch is activeAlways true
feeRateBps never present on any signed OrderIntentAlways true

27. Operational Runbook

BasisTrader incidents are typically stale analytics feeds or kill-switch activations. Hard-floor skips are normal.

On-call actions

AlertFirst stepDiagnosisMitigationEscalate to
BasisTraderStaleFeed
BasisTraderKillSwitch
BasisTraderNoEdge

Manual overrides

Healthcheck

GET /internal/health/basistrader -> 200 if Analytics engine active; signal age < 60s; KillSwitch inactive.. Red: Analytics engine down or KillSwitch active..

28. Promotion Gates

A bot does not advance to the next readiness state until every gate below is green. Gates are observable from production data — no subjective sign-off.

Promote to Shadow

GateHow measuredThreshold
Unit tests pass including hard-floor skip and kill-switch blockCI test run100% pass

Promote to Limited live

GateHow measuredThreshold
p99 eval latency < 300ms over 24h shadow runpolytraders_strat_basistrader_eval_latency_ms histogramp99 < 300ms

Promote to General live

GateHow measuredThreshold
E2E: signal → computation → IOC OrderIntent on Polygon testnet with builder.code and no feeRateBpsE2E testPass

29. Developer Checklist

Ready-to-ship score: 27/27 sections complete · 100%

RequirementStatus
Purpose defined✓ done
Required inputs listed✓ done
Parameters defined✓ done
Defaults defined✓ done
Warning thresholds defined✓ done
Hard thresholds defined✓ done
Safe fallback defined✓ done
Structured output defined✓ done
Developer log defined✓ done
Plain-English explanation✓ done
Unit tests defined✓ done
Integration tests defined✓ done
Property tests defined✓ done
Failure-mode block complete✓ done
Reference implementation pseudocode✓ done
Wire examples (input + output)✓ done
Reason codes listed✓ done
Metrics & logs defined✓ done
State & persistence defined✓ done
Concurrency & idempotency defined✓ done
Dependencies declared✓ done
Security surfaces declared✓ done
Polymarket V2 compatibility declared✓ done
Version & migration history declared✓ done
Operational runbook defined✓ done
Promotion gates defined✓ done
Failure-injection recipes defined✓ done