ORE Studio 0.0.4
Loading...
Searching...
No Matches
commodity_instrument.hpp
1/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 *
3 * Copyright (C) 2026 Marco Craveiro <marco.craveiro@gmail.com>
4 *
5 * This program is free software; you can redistribute it and/or modify it under
6 * the terms of the GNU General Public License as published by the Free Software
7 * Foundation; either version 3 of the License, or (at your option) any later
8 * version.
9 *
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
13 * details.
14 *
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 *
19 */
20#ifndef ORES_TRADING_DOMAIN_COMMODITY_INSTRUMENT_HPP
21#define ORES_TRADING_DOMAIN_COMMODITY_INSTRUMENT_HPP
22
23#include <chrono>
24#include <optional>
25#include <string>
26#include <boost/uuid/uuid.hpp>
27#include "ores.utility/uuid/tenant_id.hpp"
28
29namespace ores::trading::domain {
30
52 int version = 0;
53
58
62 boost::uuids::uuid id;
63
67 std::string trade_type_code;
68
72 std::string commodity_code;
73
77 std::string currency;
78
82 double quantity = 0.0;
83
87 std::string unit;
88
92 std::string start_date;
93
97 std::string maturity_date;
98
102 std::optional<double> fixed_price;
103
107 std::string option_type;
108
112 std::optional<double> strike_price;
113
117 std::string exercise_type;
118
122 std::string average_type;
123
128
133
138
142 std::optional<double> spread_amount;
143
148
152 std::optional<double> variance_strike;
153
157 std::optional<double> accumulation_amount;
158
162 std::optional<double> knock_out_barrier;
163
167 std::string barrier_type;
168
172 std::optional<double> lower_barrier;
173
177 std::optional<double> upper_barrier;
178
182 std::string basket_json;
183
187 std::string day_count_code;
188
193
198
202 std::string description;
203
207 std::string modified_by;
208
212 std::string performed_by;
213
218
222 std::string change_commentary;
223
227 std::chrono::system_clock::time_point recorded_at;
228};
229
230}
231
232#endif
Commodity instrument economics for all commodity ORE product types.
Definition commodity_instrument.hpp:48
std::string option_type
Option type: 'Call' or 'Put'. Empty for non-option products.
Definition commodity_instrument.hpp:107
std::string modified_by
Username of the person who last modified this record.
Definition commodity_instrument.hpp:207
std::string commodity_code
Commodity identifier code (e.g. NGAS, WTI, GOLD).
Definition commodity_instrument.hpp:72
std::string spread_commodity_code
Second commodity code for spread options.
Definition commodity_instrument.hpp:137
std::string unit
Unit of measure for the commodity (e.g. BBL, MMBTU, MT).
Definition commodity_instrument.hpp:87
std::optional< double > knock_out_barrier
Knock-out barrier level for accumulator products.
Definition commodity_instrument.hpp:162
std::string exercise_type
Exercise type: 'European' or 'American'.
Definition commodity_instrument.hpp:117
std::string start_date
Start date for swaps, forwards, and strips.
Definition commodity_instrument.hpp:92
std::string change_commentary
Free-text commentary explaining the change.
Definition commodity_instrument.hpp:222
std::string description
Optional free-text description.
Definition commodity_instrument.hpp:202
double quantity
Contract quantity. Must be positive.
Definition commodity_instrument.hpp:82
std::optional< double > spread_amount
Spread amount for spread options. Nullopt when not applicable.
Definition commodity_instrument.hpp:142
std::optional< double > lower_barrier
Lower barrier level. Nullopt when not applicable.
Definition commodity_instrument.hpp:172
std::string swaption_expiry_date
Swaption expiry date for CommoditySwaption products.
Definition commodity_instrument.hpp:197
std::optional< double > variance_strike
Strike variance for variance swap products. Nullopt when not applicable.
Definition commodity_instrument.hpp:152
std::optional< double > upper_barrier
Upper barrier level. Nullopt when not applicable.
Definition commodity_instrument.hpp:177
std::string average_type
Averaging type for Asian options: 'Arithmetic' or 'Geometric'.
Definition commodity_instrument.hpp:122
std::optional< double > accumulation_amount
Per-fixing accumulation amount for accumulator products.
Definition commodity_instrument.hpp:157
std::string strip_frequency_code
Strip frequency code for option strips (e.g. Monthly, Quarterly).
Definition commodity_instrument.hpp:147
std::chrono::system_clock::time_point recorded_at
Timestamp when this version of the record was recorded.
Definition commodity_instrument.hpp:227
std::string averaging_start_date
Start of the averaging window for Asian options.
Definition commodity_instrument.hpp:127
std::optional< double > strike_price
Option strike price. Nullopt for non-option products.
Definition commodity_instrument.hpp:112
std::string basket_json
JSON array of {code, weight} constituents for basket products.
Definition commodity_instrument.hpp:182
std::string payment_frequency_code
Payment frequency code for swap products.
Definition commodity_instrument.hpp:192
boost::uuids::uuid id
UUID uniquely identifying this commodity instrument.
Definition commodity_instrument.hpp:62
int version
Version number for optimistic locking and change tracking.
Definition commodity_instrument.hpp:52
std::string day_count_code
Day count fraction code for swap products.
Definition commodity_instrument.hpp:187
std::optional< double > fixed_price
Fixed price for forwards and fixed-leg swaps. Nullopt if not applicable.
Definition commodity_instrument.hpp:102
std::string maturity_date
Maturity/expiry date.
Definition commodity_instrument.hpp:97
std::string performed_by
Username of the account that performed this action.
Definition commodity_instrument.hpp:212
std::string trade_type_code
ORE product type code (CommodityForward, CommodityOption, etc.).
Definition commodity_instrument.hpp:67
utility::uuid::tenant_id tenant_id
Tenant identifier for multi-tenancy isolation.
Definition commodity_instrument.hpp:57
std::string change_reason_code
Code identifying the reason for the change.
Definition commodity_instrument.hpp:217
std::string currency
ISO 4217 currency code.
Definition commodity_instrument.hpp:77
std::string averaging_end_date
End of the averaging window for Asian options.
Definition commodity_instrument.hpp:132
std::string barrier_type
Barrier type: e.g. 'UpIn', 'UpOut', 'DownIn', 'DownOut'.
Definition commodity_instrument.hpp:167
A strongly-typed wrapper around a UUID representing a tenant identifier.
Definition tenant_id.hpp:66
static tenant_id system()
Creates a tenant_id representing the system tenant.
Definition tenant_id.cpp:41