Crate optionstratlib

Crate optionstratlib 

Source
Expand description

§OptionStratLib v0.13.1: Financial Options Library

§Table of Contents

  1. Introduction
  2. Features
  3. Core Modules
  4. Trading Strategies
  5. Setup Instructions
  6. Library Usage
  7. Usage Examples
  8. Testing
  9. Contribution and Contact

§Introduction

OptionStratLib is a comprehensive Rust library for options trading and strategy development across multiple asset classes. This versatile toolkit enables traders, quants, and developers to model, analyze, and visualize options strategies with a robust, type-safe approach. The library focuses on precision with decimal-based calculations, extensive test coverage, and a modular architecture built on modern Rust 2024 edition.

§Features

§1. Pricing Models

  • Black-Scholes Model: European options pricing with full Greeks support
  • Binomial Tree Model: American and European options with early exercise capability
  • Monte Carlo Simulations: Complex pricing scenarios and path-dependent options
  • Telegraph Process Model: Advanced stochastic modeling for jump-diffusion processes

§2. Greeks Calculation

  • Complete Greeks suite: Delta, Gamma, Theta, Vega, Rho, Vanna, Vomma, Veta, Charm, Color
  • Real-time sensitivity analysis
  • Greeks visualization and risk profiling
  • Custom Greeks implementations with adjustable parameters

§3. Volatility Models

  • Implied volatility calculation using Newton-Raphson method
  • Volatility surface construction and interpolation
  • Historical volatility estimation
  • Advanced volatility modeling tools

§4. Option Chain Management

  • Complete option chain construction and analysis
  • Strike price generation algorithms
  • Chain data import/export (CSV/JSON formats)
  • Advanced filtering and selection tools
  • Option data grouping and organization

§5. Trading Strategies (25+ Strategies)

  • Single Leg: Long/Short Calls and Puts
  • Spreads: Bull/Bear Call/Put Spreads
  • Butterflies: Long/Short Butterfly Spreads, Call Butterfly
  • Complex: Iron Condor, Iron Butterfly
  • Volatility: Long/Short Straddles and Strangles
  • Income: Covered Calls, Poor Man’s Covered Call
  • Protection: Protective Puts, Collars
  • Custom: Flexible custom strategy framework

§6. Risk Management & Analysis

  • Position tracking and management
  • Break-even analysis with multiple break-even points
  • Profit/Loss calculations at various price points
  • Risk profiles and comprehensive visualizations
  • Delta neutrality analysis and adjustment
  • Probability analysis for strategy outcomes

§7. Backtesting Framework

  • Comprehensive backtesting engine
  • Performance metrics calculation
  • Strategy optimization tools
  • Historical analysis capabilities

§8. Simulation Tools

  • Monte Carlo simulations for strategy testing
  • Telegraph process implementation
  • Random walk simulations
  • Custom simulation frameworks
  • Parametrized simulations with adjustable inputs

§9. Visualization & Plotting

  • Strategy payoff diagrams
  • Greeks visualization
  • 3D volatility surfaces
  • Risk profiles and P&L charts
  • Interactive charts (powered by plotly.rs)
  • Binomial tree visualization
  • Comprehensive plotting utilities

§10. Data Management

  • Efficient decimal-based calculations using rust_decimal
  • CSV/JSON import/export functionality
  • Time series data handling
  • Price series management and manipulation
  • Robust data validation and error handling

§11. Mathematical Tools

  • Curve interpolation techniques
  • Surface construction and analysis
  • Geometric operations for financial modeling
  • Advanced mathematical utilities for options pricing

§Core Modules

The library is organized into the following key modules:

§Model (model/)

Core data structures and types for options trading:

  • option.rs: Complete option structures with pricing and Greeks
  • position.rs: Position management and P&L tracking
  • expiration.rs: Flexible expiration date handling (Days/DateTime)
  • positive.rs: Type-safe positive number implementation
  • types.rs: Common enums (OptionType, Side, OptionStyle)
  • trade.rs: Trade execution and management
  • format.rs: Data formatting utilities

§Pricing Models (pricing/)

Advanced pricing engines for options valuation:

  • black_scholes_model.rs: European options pricing with Greeks
  • binomial_model.rs: American/European options with early exercise
  • monte_carlo.rs: Path-dependent and exotic options pricing
  • telegraph.rs: Jump-diffusion process modeling
  • payoff.rs: Payoff function implementations

§Strategies (strategies/)

Comprehensive trading strategy implementations:

  • base.rs: Core traits (Strategable, BasicAble, Positionable, etc.)
  • Single Leg: long_call.rs, short_call.rs, long_put.rs, short_put.rs
  • Spreads: bull_call_spread.rs, bear_call_spread.rs, bull_put_spread.rs, bear_put_spread.rs
  • Butterflies: long_butterfly_spread.rs, short_butterfly_spread.rs, call_butterfly.rs
  • Complex: iron_condor.rs, iron_butterfly.rs
  • Volatility: long_straddle.rs, short_straddle.rs, long_strangle.rs, short_strangle.rs
  • Income: covered_call.rs, poor_mans_covered_call.rs
  • Protection: protective_put.rs, collar.rs
  • custom.rs: Flexible custom strategy framework
  • probabilities/: Probability analysis for strategy outcomes
  • delta_neutral/: Delta neutrality analysis and adjustment

§Volatility (volatility/)

Volatility modeling and analysis:

  • utils.rs: Implied volatility calculation (Newton-Raphson method)
  • traits.rs: Volatility model interfaces
  • Advanced volatility surface construction

§Greeks (greeks/)

Complete Greeks calculation suite:

  • Delta, Gamma, Theta, Vega, Rho, Vanna, Vomma, Veta, Charm, Color calculations
  • Real-time sensitivity analysis
  • Greeks-based risk management

§Chains (chains/)

Option chain management and analysis:

  • chain.rs: Option chain construction and manipulation
  • utils.rs: Chain analysis and filtering tools
  • CSV/JSON import/export functionality
  • Strike price generation algorithms

§Backtesting (backtesting/)

Strategy performance analysis:

  • metrics.rs: Performance metrics calculation
  • results.rs: Backtesting results management
  • types.rs: Backtesting data structures

§Simulation (simulation/)

Monte Carlo and stochastic simulations:

  • Random walk implementations
  • Telegraph process modeling
  • Custom simulation frameworks
  • Parametrized simulation tools

§Visualization (visualization/)

Comprehensive plotting and charting:

  • plotly.rs: Interactive charts with Plotly integration
  • Strategy payoff diagrams
  • Greeks visualization
  • 3D volatility surfaces
  • Risk profile charts

§Risk Management (risk/)

Risk analysis and management tools:

  • Position risk metrics
  • Break-even analysis
  • Risk profile generation

§P&L (pnl/)

Profit and loss calculation:

  • Real-time P&L tracking
  • Historical P&L analysis
  • Performance attribution

§Curves & Surfaces (curves/, surfaces/)

Mathematical tools for financial modeling:

  • Curve interpolation techniques
  • Surface construction and analysis
  • 3D visualization capabilities

§Error Handling (error/)

Robust error management:

  • Comprehensive error types for each module
  • Type-safe error propagation
  • Detailed error reporting

§Core Components

classDiagram
class Options {
+option_type: OptionType
+side: Side
+underlying_symbol: String
+strike_price: Positive
+expiration_date: ExpirationDate
+implied_volatility: Positive
+quantity: Positive
+underlying_price: Positive
+risk_free_rate: Decimal
+option_style: OptionStyle
+dividend_yield: Positive
+exotic_params: Option~ExoticParams~
+calculate_price_black_scholes()
+calculate_price_binomial()
+time_to_expiration()
+is_long()
+is_short()
+validate()
+to_plot()
+calculate_implied_volatility()
+delta()
+gamma()
+theta()
+vega()
+rho()
+vanna()
+vomma()
+veta()
+charm()
+color()
}

class Position {
+option: Options
+position_cost: Positive
+entry_date: DateTime<Utc>
+open_fee: Positive
+close_fee: Positive
+net_cost()
+net_premium_received()
+unrealized_pnl()
+pnl_at_expiration()
+validate()
}

class ExpirationDate {
+Days(Positive)
+Date(NaiveDate)
+get_years()
+get_date()
+get_date_string()
+from_string()
}

class Positive {
+value: Decimal
+ZERO: Positive
+ONE: Positive
+format_fixed_places()
+round_to_nice_number()
+is_positive()
}

class OptionStyle {
<<enumeration>>
Call
Put
}

class OptionType {
<<enumeration>>
European
American
}

class Side {
<<enumeration>>
Long
Short
}

class Graph {
<<interface>>
+graph_data()
+graph_config()
+to_plot()
+write_html()
+write_png()
+write_svg()
+write_jpeg()
}

class Greeks {
<<interface>>
+delta()
+gamma()
+theta()
+vega()
+rho()
+calculate_all_greeks()
}

Options --|> Greeks : implements
Options --|> Graph : implements
Position o-- Options : contains
Options *-- OptionStyle : has
Options *-- OptionType : has
Options *-- Side : has
Options *-- ExpirationDate : has
Options *-- Positive : uses

§Trading Strategies

OptionStratLib provides 25+ comprehensive trading strategies organized by complexity and market outlook:

§Single Leg Strategies

Basic directional strategies for beginners:

  • Long Call: Bullish strategy with unlimited upside potential
  • Short Call: Bearish strategy collecting premium with limited profit
  • Long Put: Bearish strategy with high profit potential
  • Short Put: Bullish strategy collecting premium with assignment risk

§Spread Strategies

Defined risk strategies with limited profit/loss:

  • Bull Call Spread: Moderately bullish with limited risk and reward
  • Bear Call Spread: Moderately bearish credit spread
  • Bull Put Spread: Moderately bullish credit spread
  • Bear Put Spread: Moderately bearish debit spread

§Butterfly Strategies

Market neutral strategies profiting from low volatility:

  • Long Butterfly Spread: Profits from price staying near middle strike
  • Short Butterfly Spread: Profits from price moving away from middle strike
  • Call Butterfly: Butterfly using only call options

§Complex Multi-Leg Strategies

Advanced strategies for experienced traders:

  • Iron Condor: Market neutral strategy with wide profit zone
  • Iron Butterfly: Market neutral strategy with narrow profit zone

§Volatility Strategies

Strategies that profit from volatility changes:

  • Long Straddle: Profits from high volatility in either direction
  • Short Straddle: Profits from low volatility (range-bound market)
  • Long Strangle: Similar to straddle but with different strikes
  • Short Strangle: Credit strategy profiting from low volatility

§Income Generation Strategies

Strategies focused on generating regular income:

  • Covered Call: Stock ownership with call selling for income
  • Poor Man’s Covered Call: LEAPS-based covered call alternative

§Protection Strategies

Risk management and hedging strategies:

  • Protective Put: Downside protection for stock positions
  • Collar: Combination of covered call and protective put

§Custom Strategy Framework

  • Custom Strategy: Flexible framework for creating any multi-leg strategy
  • Supports unlimited number of legs
  • Full integration with all analysis tools
  • Complete trait implementation for consistency

§Strategy Analysis Features

All strategies include comprehensive analysis capabilities:

  • Profit/Loss Analysis: P&L at any price point and time
  • Break-Even Points: Multiple break-even calculations
  • Greeks Analysis: Real-time risk metrics
  • Probability Analysis: Success probability calculations
  • Delta Neutrality: Delta-neutral position analysis
  • Visualization: Interactive payoff diagrams and risk profiles
  • Optimization: Find optimal strikes and expirations

§Strategy Traits System

All strategies implement a comprehensive trait system:

  • Strategable: Master trait combining all strategy capabilities
  • BasicAble: Basic strategy information (symbol, price, etc.)
  • Positionable: Position management and modification
  • Strategies: Core strategy calculations (P&L, break-even, etc.)
  • Validable: Strategy validation and error checking
  • BreakEvenable: Break-even point calculations
  • Profit: Profit/loss analysis at various price points
  • Greeks: Greeks calculations for risk management
  • DeltaNeutrality: Delta-neutral analysis and adjustments
  • ProbabilityAnalysis: Outcome probability calculations
  • Graph: Visualization and plotting capabilities

§Setup Instructions

§Prerequisites

  • Rust 1.80 or higher (2024 edition)
  • Cargo package manager

§Installation

Add OptionStratLib to your Cargo.toml:

[dependencies]
optionstratlib = "0.6.1"

Or use cargo to add it to your project:

cargo add optionstratlib

§Optional Features

The library includes optional features for enhanced functionality:

[dependencies]
optionstratlib = { version = "0.6.1", features = ["plotly"] }
  • plotly: Enables interactive visualization using plotly.rs

§Building from Source

Clone the repository and build using Cargo:

git clone https://github.com/joaquinbejar/OptionStratLib.git
cd OptionStratLib
cargo build --release

Run comprehensive test suite:

cargo test --all-features

Generate documentation:

cargo doc --open --all-features

Run benchmarks:

cargo bench

§Library Usage

§Basic Option Creation and Pricing

use optionstratlib::{Options, OptionStyle, OptionType, Side, ExpirationDate};
use optionstratlib::pos;
use rust_decimal_macros::dec;
use optionstratlib::greeks::Greeks;

// Create a European call option
let option = Options::new(
    OptionType::European,
    Side::Long,
    "AAPL".to_string(),
    pos!(150.0),            // strike_price
    ExpirationDate::Days(pos!(30.0)),
    pos!(0.25),             // implied_volatility
    pos!(1.0),              // quantity
    pos!(155.0),            // underlying_price
    dec!(0.05),             // risk_free_rate
    OptionStyle::Call,
    pos!(0.02),             // dividend_yield
    None,                   // exotic_params
);

// Calculate option price using Black-Scholes
let price = option.calculate_price_black_scholes().unwrap();
tracing::info!("Option price: ${:.2}", price);

// Calculate Greeks for risk management
let delta = option.delta().unwrap();
let gamma = option.gamma().unwrap();
let theta = option.theta().unwrap();
let vega = option.vega().unwrap();
let vanna = option.vanna().unwrap();
let vomma = option.vomma().unwrap();
let veta = option.veta().unwrap();
let charm = option.charm().unwrap();
let color = option.color().unwrap();
tracing::info!("Greeks - Delta: {:.4}, Gamma: {:.4}, Theta: {:.4},
    Vega: {:.4}, Vanna: {:.4}, Vomma: {:.4}, Veta: {:.4}
    Charm: {:.4}, Color: {:.4}",
    delta, gamma, theta, vega, vanna, vomma, veta, charm, color);

§Working with Trading Strategies

use optionstratlib::{Positive, ExpirationDate, pos};
use optionstratlib::strategies::Strategies;
use optionstratlib::strategies::bull_call_spread::BullCallSpread;
use optionstratlib::strategies::base::{BreakEvenable, BasicAble};
use optionstratlib::visualization::Graph;
use rust_decimal_macros::dec;
use std::error::Error;

fn main() -> Result<(), Box<dyn Error>> {
    use optionstratlib::pricing::Profit;
let underlying_price = pos!(100.0);

    // Create a Bull Call Spread strategy
    let strategy = BullCallSpread::new(
        "AAPL".to_string(),
        underlying_price,
        pos!(95.0),   // long_strike
        pos!(105.0),  // short_strike  
        ExpirationDate::Days(pos!(30.0)),
        pos!(0.25),   // implied_volatility
        dec!(0.05),   // risk_free_rate
        pos!(2.50),   // long_call_premium
        pos!(2.50),   // long_call_open_fee
        pos!(1.20),   // short_call_premium
        pos!(1.20),   // short_call_close_fee
        Default::default(), Default::default(),
        Default::default(), Default::default()
    );

    // Analyze the strategy
    tracing::info!("Strategy: {}", strategy.get_title());
    tracing::info!("Break-even points: {:?}", strategy.get_break_even_points()?);
    tracing::info!("Max profit: ${:.2}", strategy.get_max_profit().unwrap_or(Positive::ZERO));
    tracing::info!("Max loss: ${:.2}", strategy.get_max_loss().unwrap_or(Positive::ZERO));
    tracing::info!("Net premium: ${:.2}", strategy.get_net_premium_received()?);

    // Calculate P&L at different price points
    let prices = vec![pos!(90.0), pos!(95.0), pos!(100.0), pos!(105.0), pos!(110.0)];
    for price in prices {
        let pnl = strategy.get_point_at_price(&price)?;
        tracing::info!("P&L at ${}: ${:.2}", price, pnl.0);
    }

    // Generate visualization
    #[cfg(feature = "plotly")]
    {
        strategy.write_html("Draws/Visualization/bull_call_spread.html".as_ref())?;
    }

    Ok(())
}

§Advanced Features: Volatility Analysis

use optionstratlib::prelude::*;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Create an option for implied volatility calculation
    let mut option = Options::new(
        OptionType::European,
        Side::Long,
        "AAPL".to_string(),
        pos!(105.0), // strike
        ExpirationDate::Days(pos!(90.0)),
        pos!(0.20), // initial IV guess
        pos!(1.0), // quantity
        pos!(100.0), // underlying price
        dec!(0.05), // risk free rate
        OptionStyle::Call,
        pos!(0.02), // dividend yield
        None,
    );

    let market_price = pos!(5.50);
    let iv = implied_volatility(market_price, &mut option, 100)?;

    tracing::info!("Implied volatility: {:.2}%", iv.to_f64() * 100.0);
    Ok(())
}

§Custom Strategy Creation

use optionstratlib::prelude::*;

// Define common parameters
let underlying_symbol = "DAX".to_string();
let underlying_price = pos!(24000.0);
let expiration = ExpirationDate::Days(pos!(30.0));
let implied_volatility = pos!(0.25);
let risk_free_rate = dec!(0.05);
let dividend_yield = pos!(0.02);
let fee = pos!(2.0);

// Create a long put option
let long_put_option = Options::new(
    OptionType::European,
    Side::Long,
    underlying_symbol.clone(),
    pos!(24070.0), // strike
    expiration.clone(),
    implied_volatility,
    pos!(1.0), // quantity
    underlying_price,
    risk_free_rate,
    OptionStyle::Put,
    dividend_yield,
    None,
);
let long_put = Position::new(
    long_put_option,
    pos!(150.0), // premium
    Utc::now(),
    fee,
    fee,
    None,
    None,
);

// Create a long call option  
let long_call_option = Options::new(
    OptionType::European,
    Side::Long,
    underlying_symbol.clone(),
    pos!(24030.0), // strike
    expiration.clone(),
    implied_volatility,
    pos!(1.0), // quantity
    underlying_price,
    risk_free_rate,
    OptionStyle::Call,
    dividend_yield,
    None,
);
let long_call = Position::new(
    long_call_option,
    pos!(120.0), // premium
    Utc::now(),
    fee,
    fee,
    None,
    None,
);

// Create CustomStrategy with the positions
let positions = vec![long_call, long_put];
let strategy = CustomStrategy::new(
    "DAX Straddle Strategy".to_string(),
    underlying_symbol,
    "A DAX long straddle strategy".to_string(),
    underlying_price,
    positions,
    pos!(1.0),
    30,
    implied_volatility,
);

tracing::info!("Strategy created: {}", strategy.get_title());

§Testing

OptionStratLib includes a comprehensive test suite with over 1000 unit and integration tests:

§Running Tests

Run all tests:

cargo test --all-features

Run tests for specific modules:

cargo test strategies::bull_call_spread
cargo test pricing::black_scholes
cargo test volatility::utils

Run tests with output:

cargo test -- --nocapture

§Test Categories

  • Unit Tests: Individual function and method testing
  • Integration Tests: Cross-module functionality testing
  • Strategy Tests: Comprehensive strategy validation
  • Pricing Model Tests: Accuracy and performance testing
  • Greeks Tests: Mathematical precision validation
  • Visualization Tests: Chart generation and export testing

§Benchmarking

Run performance benchmarks:

cargo bench

Generate test coverage report:

cargo tarpaulin --all-features --out Html

§Examples

The library includes extensive examples organized by functionality:

  • examples/examples_strategies/: Complete strategy examples (25+ strategies)
  • examples/examples_chains/: Option chain analysis examples
  • examples/examples_pricing/: Pricing model demonstrations
  • examples/examples_visualization/: Interactive chart examples
  • examples/examples_volatility/: Volatility analysis examples
  • examples/examples_simulation/: Monte Carlo and simulation examples

Run examples:

cargo run --example bull_call_spread --features plotly
cargo run --example black_scholes_pricing
cargo run --example volatility_surface

§Contribution and Contact

§Contributing

Contributions are welcome! Please follow these guidelines:

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Commit your changes: git commit -m 'Add amazing feature'
  4. Push to the branch: git push origin feature/amazing-feature
  5. Open a Pull Request

§Development Setup

git clone https://github.com/joaquinbejar/OptionStratLib.git
cd OptionStratLib
cargo build --all-features
cargo test --all-features

§Code Quality

  • All code must pass cargo clippy without warnings
  • Format code with cargo fmt
  • Add tests for new functionality
  • Update documentation for API changes
  • Follow Rust 2024 edition best practices

§Support

  • Issues: Report bugs and request features on GitHub
  • Discussions: Join community discussions on GitHub Discussions
  • Documentation: Comprehensive docs available at docs.rs

OptionStratLib v0.7.0 - Built with ❤️ in Rust for the financial community

Re-exports§

pub use model::ExpirationDate;
pub use model::Options;
pub use model::positive::Positive;
pub use model::types::OptionStyle;
pub use model::types::OptionType;
pub use model::types::Side;

Modules§

backtesting
backtesting - Tools for historical performance evaluation of options strategies.
chains
chains - Functionality for working with options chains and series data.
constants
constants - Library-wide mathematical and financial constants.
curves
curves - Tools for yield curves, term structures, and other financial curves.
error
error - Error types and handling functionality for the library.
geometrics
geometrics - Mathematical utilities for geometric calculations relevant to options.
greeks
greeks - Calculation and management of option sensitivity metrics (Delta, Gamma, etc.).
model
model - Core data structures and models for options and derivatives.
pnl
pnl - Profit and loss analysis tools for options positions.
prelude
prelude - Convenient re-exports of commonly used types and traits.
pricing
pricing - Option pricing models including Black-Scholes and numerical methods.
risk
risk - Risk assessment and management tools for options portfolios.
series
series - Functionality for working with collections of option chains across expirations.
simulation
simulation - Simulation techniques for scenario analysis.
strategies
strategies - Pre-defined option strategy templates and building blocks.
surfaces
surfaces - Volatility surface and other 3D financial data modeling.
utils
utils - General utility functions for data manipulation and calculations.
visualization
visualization - Tools for plotting and visual representation of options data.
volatility
volatility - Volatility modeling, forecasting, and analysis utilities.

Macros§

assert_decimal_eq
Asserts that two Decimal values are approximately equal within a given epsilon
assert_pos_relative_eq
Asserts that two Positive values are relatively equal within a given epsilon.
d2f
Converts a Decimal value to f64 with error propagation.
d2fu
Converts a Decimal value to f64 without error checking.
f2d
Converts an f64 value to Decimal with error propagation.
f2du
Converts an f64 value to Decimal without error checking.
impl_graph_for_payoff_strategy
Macro impl_graph_for_payoff_strategy generates implementations of the Graph trait for one or more given types. This is specifically designed for types that represent payoff strategies, enabling them to produce graph data and configurations for financial visualizations, such as profit/loss graphs based on an underlying price range.
pos
Macro for creating a new Positive value with simplified syntax.
spos
A macro to create an optional Positive value from the given expression.
test_strategy_traits
Macro to test trait implementations for a specific strategy type.

Constants§

VERSION
Library version

Functions§

version
Returns the library version