openpit 0.2.0

Embeddable pre-trade risk SDK
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

// Copyright The Pit Project Owners. All rights reserved.
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Please see https://github.com/openpitkit and the OWNERS file for details.

use super::{define_signed_value_type, Error, ParamKind, Quantity, Volume};

define_signed_value_type!(
    /// Price per one instrument unit.
    ///
    /// Can be negative in certain derivative markets (e.g., options, futures with storage costs,
    /// calendar spreads).
    Price,
    ParamKind::Price
);

impl Price {
    /// Calculates volume from price and quantity.
    ///
    /// Uses absolute values of both price and quantity to ensure volume is non-negative.
    ///
    /// # Errors
    ///
    /// Returns [`Error::Overflow`] with [`ParamKind::Price`] if multiplication overflows.
    pub fn calculate_volume(self, quantity: Quantity) -> Result<Volume, Error> {
        let volume_decimal = self
            .to_decimal()
            .abs()
            .checked_mul(quantity.to_decimal().abs())
            .ok_or(Error::Overflow {
                param: ParamKind::Price,
            })?;
        Volume::new(volume_decimal)
    }
}

#[cfg(test)]
mod tests {
    use super::Price;
    use crate::param::{Error, ParamKind, Quantity};
    use rust_decimal::Decimal;

    fn d(value: &str) -> Decimal {
        value
            .parse()
            .expect("decimal literal in tests must be valid")
    }

    #[test]
    fn calculate_volume_works() {
        let price = Price::from_str("42350.75").expect("must be valid");
        let quantity = Quantity::from_str("0.15").expect("must be valid");

        let volume = price
            .calculate_volume(quantity)
            .expect("volume must be calculable");

        assert_eq!(volume.to_decimal(), d("6352.6125"));
    }

    #[test]
    fn calculate_volume_reports_overflow_for_extreme_values() {
        let price = Price::new(Decimal::MAX);
        let quantity = Quantity::from_str("2").expect("must be valid");

        assert_eq!(
            price.calculate_volume(quantity),
            Err(Error::Overflow {
                param: ParamKind::Price
            })
        );
    }
}