shape-runtime 0.3.1

Bytecode compiler, builtins, and runtime infrastructure for Shape
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

// Finance Type Definitions
//
// Standard financial data structures used across the Shape ecosystem.
// These types enable:
// - Static type checking for function parameters
// - JIT optimization (direct field access for known types)
// - IDE/LSP support (type hints and autocompletion)

/// Canonical OHLCV candle shape used across market-data APIs.
pub type Candle = {
    /// Exchange or feed timestamp for the bar.
    timestamp: timestamp;
    /// Opening price.
    open: number;
    /// Highest traded price in the interval.
    high: number;
    /// Lowest traded price in the interval.
    low: number;
    /// Closing price.
    close: number;
    /// Executed volume during the interval.
    volume: number;
};

/// Canonical trade record emitted by backtests and execution reports.
pub type Trade = {
    /// Stable identifier for the trade.
    id: string;
    /// Instrument or symbol identifier.
    symbol: string;
    /// Trade direction, typically `"buy"` or `"sell"`.
    side: string;
    /// Entry fill price.
    entry_price: number;
    /// Exit fill price.
    exit_price: number;
    /// Filled quantity.
    quantity: number;
    /// Entry timestamp.
    entry_time: timestamp;
    /// Exit timestamp.
    exit_time: timestamp;
    /// Profit and loss in quote currency.
    pnl: number;
    /// Profit and loss as a fraction of entry value.
    pnl_pct: number;
};