{"id":29601939,"url":"https://github.com/joaquinbejar/optionchain-simulator","last_synced_at":"2025-10-09T17:36:34.729Z","repository":{"id":287530358,"uuid":"965034631","full_name":"joaquinbejar/OptionChain-Simulator","owner":"joaquinbejar","description":"A lightweight RESTful simulator for option chains that evolves over time with each API request. Useful for testing trading algorithms, visualizations, and analytics pipelines without relying on real-time market data. NO PRODUCTION READY YET","archived":false,"fork":false,"pushed_at":"2025-05-02T07:07:19.000Z","size":1364,"stargazers_count":6,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-23T07:52:35.550Z","etag":null,"topics":["chain","clickhouse","derivatives","finance","financial-engineering","fintech","options","options-trading","quantitative-finance","redis","rest-api","rust","trading"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joaquinbejar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-12T09:09:16.000Z","updated_at":"2025-09-18T10:09:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"20bc4ba3-c47f-458c-9ca3-f0261ec0448e","html_url":"https://github.com/joaquinbejar/OptionChain-Simulator","commit_stats":null,"previous_names":["joaquinbejar/optionchain-simulator"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/joaquinbejar/OptionChain-Simulator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joaquinbejar%2FOptionChain-Simulator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joaquinbejar%2FOptionChain-Simulator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joaquinbejar%2FOptionChain-Simulator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joaquinbejar%2FOptionChain-Simulator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joaquinbejar","download_url":"https://codeload.github.com/joaquinbejar/OptionChain-Simulator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joaquinbejar%2FOptionChain-Simulator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279001871,"owners_count":26083197,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chain","clickhouse","derivatives","finance","financial-engineering","fintech","options","options-trading","quantitative-finance","redis","rest-api","rust","trading"],"created_at":"2025-07-20T13:32:28.638Z","updated_at":"2025-10-09T17:36:34.712Z","avatar_url":"https://github.com/joaquinbejar.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv style=\"text-align: center;\"\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/joaquinbejar/OptionChain-Simulator/refs/heads/main/doc/images/logo.png\" alt=\"optionchain_simulator\" style=\"width: 100%; height: 100%;\"\u003e\n\u003c/div\u003e\n\n[![Dual License](https://img.shields.io/badge/license-MIT%20and%20Apache%202.0-blue)](./LICENSE)\n[![Crates.io](https://img.shields.io/crates/v/optionchain_simulator.svg)](https://crates.io/crates/optionchain_simulator)\n[![Downloads](https://img.shields.io/crates/d/optionchain_simulator.svg)](https://crates.io/crates/optionchain_simulator)\n[![Stars](https://img.shields.io/github/stars/joaquinbejar/OptionChain-Simulator.svg)](https://github.com/joaquinbejar/OptionChain-Simulator/stargazers)\n[![Issues](https://img.shields.io/github/issues/joaquinbejar/OptionChain-Simulator.svg)](https://github.com/joaquinbejar/OptionChain-Simulator/issues)\n[![PRs](https://img.shields.io/github/issues-pr/joaquinbejar/OptionChain-Simulator.svg)](https://github.com/joaquinbejar/OptionChain-Simulator/pulls)\n[![Build Status](https://img.shields.io/github/workflow/status/joaquinbejar/OptionChain-Simulator/CI)](https://github.com/joaquinbejar/OptionChain-Simulator/actions)\n[![Coverage](https://img.shields.io/codecov/c/github/joaquinbejar/OptionChain-Simulator)](https://codecov.io/gh/joaquinbejar/OptionChain-Simulator)\n[![Dependencies](https://img.shields.io/librariesio/github/joaquinbejar/OptionChain-Simulator)](https://libraries.io/github/joaquinbejar/OptionChain-Simulator)\n[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://docs.rs/optionchain_simulator)\n\n\n\n## OptionChain-Simulator API and Architecture\n\n### System Architecture\n\n```mermaid\nflowchart TD\nClient[Client Applications] --\u003e API[API Layer]\nAPI --\u003e SM[Session Management]\nSM --\u003e App[Application Layer]\nApp --\u003e Domain[Domain Layer]\nApp --\u003e Infra[Infrastructure Layer]\nDomain --\u003e SimEngine[Simulation Engine]\nInfra --\u003e ClickHouse[(ClickHouse DB)]\nInfra --\u003e Redis[(Redis)]\nInfra --\u003e MongoDB[(MongoDB)]\n```\n\n### Session State Transitions\n\n```mermaid\nstateDiagram-v2\n[*] --\u003e Initialized: POST /api/v1/chain\nInitialized --\u003e InProgress: GET\nInProgress --\u003e InProgress: GET\nInProgress --\u003e Modified: PATCH\nModified --\u003e InProgress: GET\nInProgress --\u003e Reinitialized: PUT\nModified --\u003e Reinitialized: PUT\nReinitialized --\u003e InProgress: GET\nInitialized --\u003e [*]: DELETE\nInProgress --\u003e [*]: DELETE\nModified --\u003e [*]: DELETE\nReinitialized --\u003e [*]: DELETE\n```\n\n### API Request Flow\n\n```mermaid\nsequenceDiagram\nparticipant Client\nparticipant API as REST API\nparticipant SM as Session Manager\nparticipant SS as Simulator Service\n\nClient-\u003e\u003eAPI: POST /api/v1/chain\nAPI-\u003e\u003eSM: Create new session\nSM-\u003e\u003eSS: Initialize simulation\nSS--\u003e\u003eSM: Initial state\nSM--\u003e\u003eAPI: Session created (id: abc123)\nAPI--\u003e\u003eClient: 201 Created (session details)\n\nClient-\u003e\u003eAPI: GET /api/v1/chain\nAPI-\u003e\u003eSM: Get next step\nSM-\u003e\u003eSS: Advance simulation\nSS--\u003e\u003eSM: Step data\nSM--\u003e\u003eAPI: Chain data\nAPI--\u003e\u003eClient: 200 OK (Chain data)\n```\n\n### REST API Endpoints\n\nThe OptionChain-Simulator exposes the following REST API endpoints:\n\n| Method | Endpoint       | Action           | Description                                      |\n|--------|---------------|------------------|--------------------------------------------------|\n| POST   | /api/v1/chain | Create Session   | Creates a new simulation session                 |\n| GET    | /api/v1/chain | Read Next Step   | Gets the next step in the simulation            |\n| PUT    | /api/v1/chain | Replace Session  | Completely replaces session parameters          |\n| PATCH  | /api/v1/chain | Update Parameters| Updates specific session parameters             |\n| DELETE | /api/v1/chain | Delete Session   | Terminates and removes a session                 |\n\n### Request/Response Models\n\n#### 1. Create Session (POST /api/v1/chain)\n\n**Request Body:**\n```json\n{\n  \"symbol\": \"AAPL\",\n  \"steps\": 10,\n  \"initial_price\": 185.5,\n  \"days_to_expiration\": 45.0,\n  \"volatility\": 0.25,\n  \"risk_free_rate\": 0.04,\n  \"dividend_yield\": 0.005,\n  \"method\": {\n    \"GeometricBrownian\": {\n      \"dt\": 0.004,\n      \"drift\": 0.05,\n      \"volatility\": 0.25\n    }\n  },\n  \"time_frame\": \"Day\",\n  \"chain_size\": 15,\n  \"strike_interval\": 5.0,\n  \"smile_curve\": 0.0005,\n  \"spread\": 0.02\n}\n```\n\n**Response (201 Created):**\n```json\n{\n    \"id\": \"6af613b6-569c-5c22-9c37-2ed93f31d3af\",\n    \"created_at\": \"2025-04-21T15:37:30.518022+00:00\",\n    \"updated_at\": \"2025-04-21T15:37:30.518022+00:00\",\n    \"parameters\": {\n        \"symbol\": \"AAPL\",\n        \"initial_price\": 185.5,\n        \"volatility\": 0.25,\n        \"risk_free_rate\": 0.04,\n        \"method\": \"GeometricBrownian { dt: 0.004, drift: 0.05, volatility: 0.25 }\",\n        \"time_frame\": \"day\",\n        \"dividend_yield\": 0.005,\n        \"smile_curve\": 0.0005,\n        \"spread\": 0.02\n    },\n    \"current_step\": 0,\n    \"total_steps\": 10,\n    \"state\": \"Initialized\"\n}\n```\n\n#### 2. Get Next Step (GET /api/v1/chain?sessionid=6af613b6-569c-5c22-9c37-2ed93f31d3af)\n\n**Response (200 OK):**\n```json\n{\n    \"underlying\": \"AAPL\",\n    \"timestamp\": \"2025-04-21T15:33:03.597061+00:00\",\n    \"price\": 185.299430466522,\n    \"contracts\": [\n        {\n            \"strike\": 160.0,\n            \"expiration\": \"2025-06-05\",\n            \"call\": {\n                \"bid\": 26.08,\n                \"ask\": 26.1,\n                \"mid\": 26.09,\n                \"delta\": 0.9993778215543331\n            },\n            \"put\": {\n                \"bid\": null,\n                \"ask\": null,\n                \"mid\": null,\n                \"delta\": -4.2479708093406946e-6\n            },\n            \"implied_volatility\": 0.09731095458186256,\n            \"gamma\": 3.121236702609213e-6\n        },\n        {\n            \"strike\": 165.0,\n            \"expiration\": \"2025-06-05\",\n            \"call\": {\n                \"bid\": 21.14,\n                \"ask\": 21.16,\n                \"mid\": 21.15,\n                \"delta\": 0.9888998386575956\n            },\n            \"put\": {\n                \"bid\": 0.03,\n                \"ask\": 0.05,\n                \"mid\": 0.04,\n                \"delta\": -0.010482230867546823\n            },\n            \"implied_volatility\": 0.15077922021760087,\n            \"gamma\": 0.0028266289100911603\n        },\n        {\n            \"strike\": 170.0,\n            \"expiration\": \"2025-06-05\",\n            \"call\": {\n                \"bid\": 16.62,\n                \"ask\": 16.64,\n                \"mid\": 16.63,\n                \"delta\": 0.9153696474659715\n            },\n            \"put\": {\n                \"bid\": 0.49,\n                \"ask\": 0.51,\n                \"mid\": 0.5,\n                \"delta\": -0.08401242205917087\n            },\n            \"implied_volatility\": 0.1927733286389461,\n            \"gamma\": 0.012279670056243013\n        },\n        {\n            \"strike\": 175.0,\n            \"expiration\": \"2025-06-05\",\n            \"call\": {\n                \"bid\": 12.87,\n                \"ask\": 12.89,\n                \"mid\": 12.88,\n                \"delta\": 0.7964192920937592\n            },\n            \"put\": {\n                \"bid\": 1.71,\n                \"ask\": 1.73,\n                \"mid\": 1.72,\n                \"delta\": -0.2029627774313833\n            },\n            \"implied_volatility\": 0.22329327984589836,\n            \"gamma\": 0.019409579420062936\n        },\n        {\n            \"strike\": 180.0,\n            \"expiration\": \"2025-06-05\",\n            \"call\": {\n                \"bid\": 9.76,\n                \"ask\": 9.78,\n                \"mid\": 9.77,\n                \"delta\": 0.6700429413591044\n            },\n            \"put\": {\n                \"bid\": 3.57,\n                \"ask\": 3.59,\n                \"mid\": 3.58,\n                \"delta\": -0.3293391281660381\n            },\n            \"implied_volatility\": 0.24233907383845762,\n            \"gamma\": 0.022910122989513254\n        },\n        {\n            \"strike\": 185.0,\n            \"expiration\": \"2025-06-05\",\n            \"call\": {\n                \"bid\": 7.09,\n                \"ask\": 7.11,\n                \"mid\": 7.1,\n                \"delta\": 0.5468721177394451\n            },\n            \"put\": {\n                \"bid\": 5.87,\n                \"ask\": 5.89,\n                \"mid\": 5.88,\n                \"delta\": -0.45250995178569736\n            },\n            \"implied_volatility\": 0.24991071061662393,\n            \"gamma\": 0.024315069945191076\n        },\n        {\n            \"strike\": 190.0,\n            \"expiration\": \"2025-06-05\",\n            \"call\": {\n                \"bid\": 4.68,\n                \"ask\": 4.7,\n                \"mid\": 4.69,\n                \"delta\": 0.4237521134194814\n            },\n            \"put\": {\n                \"bid\": 8.45,\n                \"ask\": 8.47,\n                \"mid\": 8.46,\n                \"delta\": -0.5756299561056611\n            },\n            \"implied_volatility\": 0.24385078722742481,\n            \"gamma\": 0.024638652336979393\n        },\n        {\n            \"strike\": 195.0,\n            \"expiration\": \"2025-06-05\",\n            \"call\": {\n                \"bid\": 2.62,\n                \"ask\": 2.64,\n                \"mid\": 2.63,\n                \"delta\": 0.29452137751494756\n            },\n            \"put\": {\n                \"bid\": 11.36,\n                \"ask\": 11.38,\n                \"mid\": 11.37,\n                \"delta\": -0.7048606920101947\n            },\n            \"implied_volatility\": 0.22617927813392658,\n            \"gamma\": 0.023389127623181388\n        },\n        {\n            \"strike\": 200.0,\n            \"expiration\": \"2025-06-05\",\n            \"call\": {\n                \"bid\": 1.03,\n                \"ask\": 1.05,\n                \"mid\": 1.04,\n                \"delta\": 0.15952905609846607\n            },\n            \"put\": {\n                \"bid\": 14.75,\n                \"ask\": 14.77,\n                \"mid\": 14.76,\n                \"delta\": -0.8398530134266764\n            },\n            \"implied_volatility\": 0.19703361182603538,\n            \"gamma\": 0.01891326128023662\n        },\n        {\n            \"strike\": 205.0,\n            \"expiration\": \"2025-06-05\",\n            \"call\": {\n                \"bid\": 0.16,\n                \"ask\": 0.18,\n                \"mid\": 0.17,\n                \"delta\": 0.04271051015963935\n            },\n            \"put\": {\n                \"bid\": 18.85,\n                \"ask\": 18.87,\n                \"mid\": 18.86,\n                \"delta\": -0.9566715593655031\n            },\n            \"implied_volatility\": 0.15641378830375124,\n            \"gamma\": 0.008916660747165772\n        },\n        {\n            \"strike\": 210.0,\n            \"expiration\": \"2025-06-05\",\n            \"call\": {\n                \"bid\": null,\n                \"ask\": null,\n                \"mid\": null,\n                \"delta\": 0.0005597778266970925\n            },\n            \"put\": {\n                \"bid\": 23.66,\n                \"ask\": 23.68,\n                \"mid\": 23.67,\n                \"delta\": -0.9988222916984453\n            },\n            \"implied_volatility\": 0.10431980756707404,\n            \"gamma\": 0.0002902662707065403\n        }\n    ],\n    \"session_info\": {\n        \"id\": \"6af613b6-569c-5c22-9c37-2ed93f31d3af\",\n        \"current_step\": 1,\n        \"total_steps\": 10\n    }\n}\n```\n\n#### 3. Update Session Parameters (PATCH /api/v1/chain?sessionid=6af613b6-569c-5c22-9c37-2ed93f31d3af)\n\n**Request Body:**\n```json\n{\n  \"symbol\": \"AAPL\",\n   \"initial_price\": 385.5,\n  \"steps\": 8,\n  \"volatility\": 0.2,\n  \"risk_free_rate\": 0.03,\n  \"dividend_yield\": 0.005,\n  \"days_to_expiration\": 30.0,\n  \"time_frame\": \"Day\"\n}\n```\n\n**Response (200 OK):**\n```json\n{\n    \"id\": \"6af613b6-569c-5c22-9c37-2ed93f31d3af\",\n    \"created_at\": \"2025-04-21T15:32:59.551486+00:00\",\n    \"updated_at\": \"2025-04-21T15:33:19.515911+00:00\",\n    \"parameters\": {\n        \"symbol\": \"AAPL\",\n        \"initial_price\": 385.5,\n        \"volatility\": 0.2,\n        \"risk_free_rate\": 0.03,\n        \"method\": \"GeometricBrownian { dt: 0.004, drift: 0.05, volatility: 0.25 }\",\n        \"time_frame\": \"day\",\n        \"dividend_yield\": 0.005,\n        \"smile_curve\": 0.0005,\n        \"spread\": 0.02\n    },\n    \"current_step\": 0,\n    \"total_steps\": 30,\n    \"state\": \"Reinitialized\"\n}\n```\n\n#### 4. Replace Session (PUT /api/v1/chain)\n\n**Request Body:**\n```json\n{\n  \"symbol\": \"AAPL\",\n  \"steps\": 30,\n  \"initial_price\": 385.5,\n  \"days_to_expiration\": 45.0,\n  \"volatility\": 0.25,\n  \"risk_free_rate\": 0.04,\n  \"dividend_yield\": 0.005,\n  \"method\": {\n    \"GeometricBrownian\": {\n      \"dt\": 0.004,\n      \"drift\": 0.05,\n      \"volatility\": 0.25\n    }\n  },\n  \"time_frame\": \"Day\",\n  \"chain_size\": 15,\n  \"strike_interval\": 5.0,\n  \"smile_curve\": 0.0005,\n  \"spread\": 0.02\n}\n```\n\n**Response (200 OK):**\n```json\n{\n    \"id\": \"6af613b6-569c-5c22-9c37-2ed93f31d3af\",\n    \"created_at\": \"2025-04-21T15:37:30.518022+00:00\",\n    \"updated_at\": \"2025-04-21T15:37:33.951540+00:00\",\n    \"parameters\": {\n        \"symbol\": \"AAPL\",\n        \"initial_price\": 385.5,\n        \"volatility\": 0.25,\n        \"risk_free_rate\": 0.04,\n        \"method\": \"GeometricBrownian { dt: 0.004, drift: 0.05, volatility: 0.25 }\",\n        \"time_frame\": \"day\",\n        \"dividend_yield\": 0.005,\n        \"smile_curve\": 0.0005,\n        \"spread\": 0.02\n    },\n    \"current_step\": 0,\n    \"total_steps\": 30,\n    \"state\": \"Reinitialized\"\n}\n```\n\n#### 5. Delete Session (DELETE /api/v1/chain?sessionid=6af613b6-569c-5c22-9c37-2ed93f31d3af)\n\n**Response (200 OK):**\n```json\n{\n    \"message\": \"Session deleted successfully: 6af613b6-569c-5c22-9c37-2ed93f31d3af\",\n    \"session_id\": \"6af613b6-569c-5c22-9c37-2ed93f31d3af\"\n}\n```\n\n### Domain Models\n\n```mermaid\nclassDiagram\nclass SessionManager {\n+createSession(params) Session\n+getNextStep(id) (Session, OptionChain)\n+updateSession(id, params) Session\n+reinitializeSession(id, params) Session\n+deleteSession(id) bool\n}\n\nclass Session {\n+id UUID\n+createdAt DateTime\n+updatedAt DateTime\n+parameters SimulationParameters\n+currentStep usize\n+totalSteps usize\n+state SessionState\n+advanceStep() Result\n+modifyParameters(params)\n+reinitialize(params, steps)\n}\n\nclass SessionState {\n\u003c\u003cenumeration\u003e\u003e\nInitialized\nInProgress\nModified\nReinitialized\nCompleted\nError\n}\n\nclass SimulationParameters {\n+symbol String\n+initialPrice Positive\n+volatility Positive\n+riskFreeRate Decimal\n+strikes Vec~Positive~\n+expirations Vec~String~\n+method SimulationMethod\n+timeFrame TimeFrame\n}\n\nclass Simulator {\n+simulateNextStep(session) OptionChain\n-createRandomWalk(session) RandomWalk\n}\n\nclass OptionChain {\n+underlying String\n+timestamp DateTime\n+price Positive\n+contracts Vec~OptionContract~\n}\n\nclass OptionContract {\n+strike Positive\n+expiration String\n+call OptionData\n+put OptionData\n+impliedVolatility Positive\n+gamma Positive\n}\n\nSession --\u003e SimulationParameters\nSession --\u003e SessionState\nSessionManager --\u003e Session: manages\nSessionManager --\u003e Simulator: uses\nSimulator --\u003e OptionChain: produces\nOptionChain --\u003e OptionContract: contains\n```\n\n### Infrastructure Components\n\n```mermaid\nclassDiagram\nclass SessionStore {\n\u003c\u003cinterface\u003e\u003e\n+get(id) Session\n+save(session) void\n+delete(id) bool\n+cleanup() int\n}\n\nclass InMemorySessionStore {\n-sessions Map~UUID, Session~\n+get(id) Session\n+save(session) void\n+delete(id) bool\n+cleanup() int\n}\n\nclass RedisSessionStore {\n-client RedisClient\n+get(id) Session\n+save(session) void\n+delete(id) bool\n+cleanup() int\n}\n\nclass HistoricalDataRepository {\n\u003c\u003cinterface\u003e\u003e\n+getHistoricalPrices(symbol, timeframe, startDate, endDate) Vec~Positive~\n+listAvailableSymbols() Vec~String~\n+getDateRangeForSymbol(symbol) (DateTime, DateTime)\n}\n\nclass ClickHouseHistoricalRepository {\n-client ClickHouseClient\n+getHistoricalPrices(symbol, timeframe, startDate, endDate) Vec~Positive~\n+listAvailableSymbols() Vec~String~\n+getDateRangeForSymbol(symbol) (DateTime, DateTime)\n}\n\nSessionStore \u003c|.. InMemorySessionStore: implements\nSessionStore \u003c|.. RedisSessionStore: implements\nHistoricalDataRepository \u003c|.. ClickHouseHistoricalRepository: implements\n```\n\n#### 🚀 Deploy the project\n\nTo deploy the services defined in `Docker/docker-compose.yml`, run the following command:\n\n```bash\nmake deploy\n```\n\nThis will:\n- Build the Docker images (`--build`)\n- Force container recreation (`--force-recreate`)\n- Run everything in detached mode (`-d`)\n- Use `optionchain-simulator` as the project name to namespace containers and resources\n\nMake sure Docker and Docker Compose are installed and running on your system.\n### Makefile Commands for Development\n\nThe project includes a Makefile with useful commands for development:\n\n| Command | Description |\n|---------|-------------|\n| `make build` | Builds the project |\n| `make release` | Builds the project in release mode |\n| `make test` | Runs all tests |\n| `make fmt` | Formats the code using rustfmt |\n| `make lint` | Runs clippy for linting |\n| `make check` | Runs tests, formatting check, and linting |\n| `make run` | Runs the project |\n| `make clean` | Cleans build artifacts |\n| `make doc` | Generates documentation |\n| `make coverage` | Generates code coverage report |\n| `make bench` | Runs benchmarks |\n| `make deploy` | deploy the services in local |\n\nAdditional commands for CI/CD and deployment:\n\n| Command | Description |\n|---------|-------------|\n| `make pre-push` | Runs fixes, formatting, linting, and tests before pushing |\n| `make workflow` | Runs all GitHub Actions workflows locally |\n| `make publish` | Publishes the package to crates.io |\n| `make zip` | Creates a ZIP archive of the project |\n\n\n\n\n## Contribution and Contact\n\nWe welcome contributions to this project! If you would like to contribute, please follow these steps:\n\n1. Fork the repository.\n2. Create a new branch for your feature or bug fix.\n3. Make your changes and ensure that the project still builds and all tests pass.\n4. Commit your changes and push your branch to your forked repository.\n5. Submit a pull request to the main repository.\n\nIf you have any questions, issues, or would like to provide feedback, please feel free to contact the project maintainer:\n\n**Joaquín Béjar García**\n- Email: jb@taunais.com\n- GitHub: [joaquinbejar](https://github.com/joaquinbejar)\n\nWe appreciate your interest and look forward to your contributions!\n\n## ✍️ License\n\nLicensed under MIT license\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoaquinbejar%2Foptionchain-simulator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoaquinbejar%2Foptionchain-simulator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoaquinbejar%2Foptionchain-simulator/lists"}