OUTRIDER docs
v1.1.0
Live demo Get help
● Set up · config.json → modules

Optional modules
perps, Polymarket and Jev, off by default.

OUTRIDER is a memecoin research desk. The package also contains three groups of strategies outside that core: perpetual-futures books, Polymarket books and the TypeSafe Jev forecaster. They ship with the code but are switched off until you turn them on in config.json.

New in 1.1.0All off by defaultSource: docs/OPTIONAL-MODULES.md

01Turn a module on

The setting lives in config.json. The default, also written in config.example.json:

{ "modules": { "perps": false, "polymarket": false, "jev": false } }
  1. Edit config.jsonSet the module you want to true, for example "modules": { "perps": true }. The other modules stay off.
  2. Restart the deskPress Ctrl+C once and start again (npm start), or pm2 reload outrider, or docker compose restart. Modules are read at start.
  3. CheckThe module's sections appear in the dashboard header, and node src/cli.mjs doctor treats the module's data sources as required (a failure shows ❌ instead of ·).
Single books inside a module

When a module is on, each of its books still follows its own enabled flag. So you can switch the perps module on and leave one book off, for example "basis": { "enabled": false }.

02What "off" means

WhereWhile a module is off
AgentsIts agents do not run, whatever their own enabled flag says (applyModules in src/config.mjs).
DashboardIts sections and header links, its figures in the top strip, its strategy rows, research tabs and ledger rows are hidden. /api/state reports the modules that are on in stats.modules; /api/journal and the ledger counts leave out rows of modules that are off.
Operator consoleIts settings and keys are left out (MODULE_ITEMS in src/admin/manifest.ts). Their environment variables are not locked into the console either.
Command linenode src/cli.mjs help lists the module's commands on a separate line. They still run as research tools and print a note first that the module is off.
doctorThe module's data sources (for example the Polymarket APIs or the Hyperliquid leaderboard) are optional checks: a failure is shown with · and does not count as failed.

03perps

Perpetual-futures books on Hyperliquid and other venues (details: Trend, leverage & books).

Config sectionWhat it is
trendVolatility-targeted trend following on BTC, ETH and SOL. leverage.defaultProfile sets its leverage profile (safe, growth, aggressive).
hlcopyCopies scored Hyperliquid leaders (node src/cli.mjs leaders refreshes the list).
fundingFunding carry: holds a perp leg where the funding rate pays.
xarbCross-venue funding: the same coin long on one venue and short on another.
basisHIP-3 basis: fades a builder market (tokenized stocks, commodities) whose mark drifts far from its oracle, hedged at the oracle. Paper only.
macroNews-reaction perps on majors, driven by the news scores.
flowHyperliquid order flow, whale trades and the OI quadrant. It also feeds the funding rates the other books read.
  • Dashboard: the Flow, Books and Perps sections, HL leaders, the HL copy, Carry and News perps figures, and the Trend vs BTC research tab.
  • Console: the Trend & leverage section, the Hyperliquid fields of Live trading, and the Hyperliquid API wallet key and account address in Integrations.
  • CLI: leaders, funding-backtest, trend-backtest, leverage, leverage-backtest, evolve.
  • Live trading: live.hyperliquid trades the trend and HL copy books through an API wallet that can trade but cannot withdraw (HL_API_WALLET_KEY, HL_ACCOUNT_ADDRESS). Carry, cross-venue funding, basis and news perps stay on paper (Live trading).
  • Portfolio cap: portfolio.maxGrossUsd limits the gross exposure of all perp books together.

04polymarket

Paper only. Prediction markets are regulated differently per country, so check your local law before you trade them.

Config sectionWhat it is
polymarket5- and 15-minute crypto Up/Down markets, priced with a fair-value model from the Hyperliquid mid and volatility.
polymmLiquidity-rewards market making: quotes inside the rewarded spread and tracks rewards, fills and inventory.
  • Dashboard: the PolyMM section (Polymarket MM) and the POLY and POLYMM strategy rows.

05jev

The TypeSafe Jev forecaster. It needs TYPESAFE_API_KEY (how to get access). Jev answers one yes/no question per coin ("higher in 60 minutes?"), and two control arms answer the same question: momentum and the running base rate. Every arm is scored at the horizon (Brier skill, AUC with a confidence interval, reliability). Jev is paper-traded when it is confident after costs, and node src/cli.mjs jev-report applies a promotion rule fixed in advance (Jev, measured).

  • Dashboard: the Jev section and the JEV strategy row.
  • Console: the TypeSafe Jev API key in Integrations.
  • CLI: jev-report.

06Example

{
  "modules": { "perps": true, "polymarket": false, "jev": false },
  "basis": { "enabled": false },
  "leverage": { "defaultProfile": "safe" }
}

This switches the perps books on, but not HIP-3 basis, and runs trend with the safe leverage profile.

07Coming from 1.0.0

In 1.0.0 these books ran without a module switch. After the update they are off until you add the module: "perps": true for trend, HL copy, carry, cross-venue, basis or news perps; "polymarket": true for Polymarket and PolyMM; "jev": true for Jev. Your data and the other settings keep working (upgrade steps).