chainview 0.1.0

Terminal UI for option chains, Greeks and volatility - real-time market data and backtest replay in your terminal.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

# ChainView

**ChainView** is a terminal UI for options traders: live option chains, Greeks,
volatility surfaces and payoff diagrams, plus a replay mode for backtest
results — rendered with [ratatui](https://ratatui.rs).

The market-data clients and all the options math live upstream. This crate is
the terminal around them: provider adapters, normalization, and the render loop.

```bash
cargo install chainview
chainview
```

That is the whole setup for the default path. Deribit's public data needs no
credentials, so a stock install opens on a live BTC chain.

## Two modes

**Live** — real-time option chains, Greeks and volatility surfaces streamed
through provider adapters.

```bash
chainview --provider deribit --underlying BTC
```

**Replay** — renders an [IronCondor](https://github.com/joaquinbejar/IronCondor)
backtest result bundle read-only: equity curve, P&L attribution by Greek,
per-trade drill-down and the payoff of the position at the scrub head. No
network.

```bash
chainview replay ./path/to/result-bundle
```

## Screens

| Screen | What it shows |
|--------|---------------|
| Chain | The strike matrix — bid/ask/mark, IV and Greeks per call and put, with the leg drill-down |
| Depth | The order-book ladder, where the provider actually has one |
| Payoff | A multi-leg strategy you build in the terminal, at expiration and t+0, with break-evens |
| Surface | The vol smile, one Greek curve at a time, and the single-expiry surface |
| Replay | Equity curve, Greek attribution, fills and the payoff at the head |

`?` opens the help overlay with every key. `q` quits, and the terminal is
restored on every exit path — a normal quit, an error, or a panic.

## Providers

Not every venue does everything, and ChainView says so rather than filling the
gaps with plausible numbers. Each adapter declares its capabilities, and the UI
gates screens off that declaration; a screen a provider cannot feed renders an
explicit unavailable state.

| Provider | Feature flag | Chain | Depth | Greeks/IV | Status |
|----------|-------------|-------|-------|-----------|--------|
| `deribit` | *(default)* | assembled from instruments | yes | from the venue | ships, zero-config, no credentials |
| `alpaca` | `alpaca` | native | crypto spot only | from the venue | ships |
| `ig` | `ig` | from the navigation tree | unverified | computed locally | ships |
| `ibkr` | `ibkr` | assembled | no | from the venue | ships, needs a running TWS/Gateway |
| `tastytrade` | `tastytrade` | native | no | from the venue | **not shipped** — held on an upstream security gate |
| `dxlink` | `dxlink` | none (overlay only) | no | from the venue | **not shipped** — held on an upstream security gate |

The feature flags are dependency-weight gates: a default build pulls only what
the Deribit path needs. The two gated adapters are compiled but deliberately
never registered while their upstream credential-logging gate holds; enabling
one is a typed startup error, never a silent activation.

Credentials come from the environment only, are never logged, never written to a
config file, and never echoed in an error. See
[`.env.example`](./.env.example) for the key names.

## Extending it with your own venue

`chainview` is a binary **and** a library. The provider port — the `Provider`
trait, the `ProviderCapabilities` self-declaration and the normalized types the
trait emits — is a public, semver-governed surface, so integrating a broker
needs no fork:

```rust,ignore
ChainViewApp::builder()
    .with_builtins()
    .register(MyBroker::new())
    .run()?;
```

The port types, the trait contract and a full worked adapter are in the [crate
documentation](https://docs.rs/chainview). A reserved built-in id or a duplicate
registration is a typed startup error, never a panic.

## Status

`v0.1.0` — the first release with an implementation behind it. Live and replay
modes, five screens and six provider adapters are in the tree, with the two
noted above deliberately withheld. Expect the API to move: the provider port is
versioned from here, but it is a `0.x` line.

## Ecosystem

Part of a family of Rust crates for options trading infrastructure:
[OptionStratLib](https://github.com/joaquinbejar/OptionStratLib) (the chain
model, Greeks, payoff and curve math) ·
[IronCondor](https://github.com/joaquinbejar/IronCondor) (the backtester whose
bundles replay mode reads) ·
[OrderBook-rs](https://github.com/joaquinbejar/OrderBook-rs) ·
[Option-Chain-OrderBook](https://github.com/joaquinbejar/Option-Chain-OrderBook)

## License

MIT — see [LICENSE](./LICENSE).

## Contact

Joaquin Bejar — jb@taunais.com