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.22 PortfolioHedger

3.22 PortfolioHedger

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

PortfolioHedger monitors the user's Polymarket portfolio for correlated exposure flagged by the Risk guardrail and builds offsetting positions to reduce net directional risk. When correlated market clusters exceed target_residual_corr and hedging cost is within max_hedge_cost_bps, the bot emits hedge OrderIntents to neutralise the correlation.

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 toUser Polymarket portfolios where correlated market clusters are identified by the Risk guardrail and residual correlation exceeds target_residual_corr
Default modeshadow_only
User-visibleAdvanced details only
Developer ownerPolytraders core — Strategy pod

2. Purpose

PortfolioHedger monitors the user's Polymarket portfolio for correlated exposure flagged by the Risk guardrail and builds offsetting positions to reduce net directional risk. When correlated market clusters exceed target_residual_corr and hedging cost is within max_hedge_cost_bps, the bot emits hedge OrderIntents to neutralise the correlation.

3. Why This Bot Matters

  • Correlation model misjudges relationship between markets

    If two markets are assumed correlated but resolve independently, the hedge creates unintended net short exposure rather than neutralising risk.

  • Stale input data

    Acting on stale signals for PortfolioHedger 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.
PortfolioHedger analytics signalinternal (analytics engine)YesProvides the core PortfolioHedger signal that drives trade decisions.
Builder code bytes32internal configYesInjected into builder field on every signed V2 OrderIntent.

6. Parameter Guide

ParameterDefaultWarningHardWhat it controls
target_residual_corr0.30.50.7Target maximum pairwise correlation between positions after hedging. Bot enters hedges until residual correlation falls below this threshold.
max_hedge_cost_bps100200400Maximum acceptable hedging cost in bps of the hedged position value before the bot declines to hedge.
auto_hedge_clustersTrueNoneNoneIf true, automatically hedge all market clusters identified by the Risk correlation analysis. If false, requires manual approval per cluster.
require_explicit_optinTrueNoneNoneIf true, user must explicitly opt in to portfolio hedging before any hedge OrderIntents are emitted.

7. Detailed Parameter Instructions

target_residual_corr

What it means

Target maximum pairwise correlation between positions after hedging. Bot enters hedges until residual correlation falls below this threshold.

Default

{ "target_residual_corr": 0.3 }

Why this default matters

0.30 ensures meaningful diversification; allowing higher correlation reduces hedging effectiveness.

Threshold logic

ConditionAction
<= 0.30No hedge needed
0.50–0.70WARN PH_HIGH_CORRELATION; reduce new positions
> 0.70EMIT hedge OrderIntents

Developer check

if residual_corr > params.hard: emit hedge intents

User-facing English

Correlated positions exceeded the threshold; hedge trades were placed.

max_hedge_cost_bps

What it means

Maximum acceptable hedging cost in bps of the hedged position value before the bot declines to hedge.

Default

{ "max_hedge_cost_bps": 100 }

Why this default matters

100 bps ensures hedging is cost-effective relative to the correlation risk being neutralised.

Threshold logic

ConditionAction
<= 100 bpsProceed with hedge
200–400 bpsWARN PH_EXPENSIVE_HEDGE; log but skip
> 400 bpsSKIP PH_HEDGE_TOO_COSTLY

Developer check

if hedge_cost_bps > params.hard: return skip('PH_HEDGE_TOO_COSTLY')

User-facing English

The hedging cost was too high relative to the risk being neutralised.

auto_hedge_clusters

What it means

If true, automatically hedge all market clusters identified by the Risk correlation analysis. If false, requires manual approval per cluster.

Default

{ "auto_hedge_clusters": true }

Why this default matters

Auto-hedging responds faster to correlation spikes; manual mode provides more control.

Threshold logic

ConditionAction
auto=true and cluster identifiedEmit hedge intent automatically

Developer check

if auto_hedge_clusters: emit for all clusters; else require approval per cluster

User-facing English

Hedge trades are placed automatically for correlated market clusters.

require_explicit_optin

What it means

If true, user must explicitly opt in to portfolio hedging before any hedge OrderIntents are emitted.

Default

{ "require_explicit_optin": true }

Why this default matters

Prevents unexpected hedge positions without user awareness.

Threshold logic

ConditionAction
not opted inHARD_REJECT PH_OPTIN_REQUIRED

Developer check

if require_explicit_optin and not user_optedin: return skip('PH_OPTIN_REQUIRED')

User-facing English

User opt-in is required before portfolio hedging can begin.

8. Default Configuration

{
  "bot_id": "strat.portfoliohedger",
  "version": "0.1.0",
  "mode": "shadow_only",
  "defaults": {
    "target_residual_corr": 0.3,
    "max_hedge_cost_bps": 100,
    "auto_hedge_clusters": true,
    "require_explicit_optin": true
  },
  "locked": {
    "target_residual_corr": {
      "min": 0.7
    },
    "max_hedge_cost_bps": {
      "min": 400
    }
  }
}

9. Implementation Flow

  1. Check KillSwitch; if active, emit no OrderIntents.
  2. FETCH PortfolioHedger analytics signal from internal engine.
  3. IF signal below hard floor: SKIP, emit sampled DecisionReport PH_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 PH_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=PH_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.target_residual_corr_hard:
    IF random() < 0.01:
      EMIT DecisionReport(intent_emitted=false, reason='PH_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.target_residual_corr_warn ELSE 1.0
  IF sizeMultiplier < 1.0: WARN('PH_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.max_hedge_cost_bps * 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='PH_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

PortfolioHedger analytics signalinternal (analytics engine)

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

Output — what the bot emits

OrderIntent — PortfolioHedger IOC buy YES

{
  "intent_id": "oi_01HPH0000001A",
  "market_id": "0xportfoli000000000000000000000000000000000000000000000000000000000001",
  "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": [
      "PH_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_01HPH0000001A",
  "trace_id": "tr_01HPH000TR001",
  "market_id": "0xportfoli000000000000000000000000000000000000000000000000000000000001",
  "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": [
      "PH_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
PH_TRADEINFOAll gates passed. IOC OrderIntent emitted for PortfolioHedger.Emit IOC OrderIntent.A PortfolioHedger trade was placed.
PH_MARGINALWARNEdge is within the warning threshold; size reduced 50%.Emit at 50% size; log warning.A small edge was found; a reduced-size PortfolioHedger trade was placed.
PH_NO_EDGEINFOEdge below hard floor. Skipping.Skip; emit sampled DecisionReport.The edge was too small to justify a trade.
PH_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_portfoliohedger_decisions_totalcountercountverdict, reason_codeTotal evaluation cycles by verdict and reason code.
polytraders_strat_portfoliohedger_signal_scorehistogramscoreDistribution of analytics signal scores at evaluation.
polytraders_strat_portfoliohedger_intents_emitted_totalcountercountoutcomeTotal IOC OrderIntents emitted.
polytraders_strat_portfoliohedger_eval_latency_mshistogrammillisecondsLatency from signal receipt to OrderIntent emit.

Alerts

AlertConditionSeverityRunbook
PortfolioHedgerStaleFeedrate(polytraders_strat_portfoliohedger_decisions_total{reason_code='STALE_MARKET_DATA'}[5m]) > 0.1warn#runbook-portfoliohedger-stale
PortfolioHedgerKillSwitchrate(polytraders_strat_portfoliohedger_decisions_total{reason_code='KILL_SWITCH_ACTIVE'}[1m]) > 0page#runbook-killswitch
PortfolioHedgerNoEdgerate(polytraders_strat_portfoliohedger_decisions_total{verdict='skip',reason_code='PH_NO_EDGE'}[10m]) / rate(polytraders_strat_portfoliohedger_decisions_total[10m]) > 0.95warn#runbook-portfoliohedger-edge

16. Developer Reporting

{
  "bot_id": "strat.portfoliohedger",
  "market_id": "0xportfoli000000000000000000000000000000000000000000000000000000000001",
  "signal_score": 0.75,
  "intent_emitted": true,
  "reason": "PH_TRADE",
  "emitted_at_ms": 1746790800000
}

17. Plain-English Reporting

SituationUser-facing explanation
PortfolioHedger trade placedThe PortfolioHedger 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 two markets are assumed correlated but resolve independently, the hedge creates unintended net short exposure rather than neutralising risk.
false_positive_riskSignal mis-fires when market conditions change rapidly, producing trades that quickly move against the PortfolioHedger 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 PortfolioHedger 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 PortfolioHedger analytics engineinternal SLA

23. Security Surfaces

Abuse vectors considered

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

Mitigations

  • PortfolioHedger 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=PH_TRADE
Skip when signal below hard floorsignal=below_hardNo OrderIntent; sampled reason=PH_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

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

On-call actions

AlertFirst stepDiagnosisMitigationEscalate to
PortfolioHedgerStaleFeed
PortfolioHedgerKillSwitch
PortfolioHedgerNoEdge

Manual overrides

Healthcheck

GET /internal/health/portfoliohedger -> 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_portfoliohedger_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