percli 0.1.0

Offline CLI simulator for the Percolator risk engine
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Scenario {
    #[serde(default)]
    pub meta: Meta,
    #[serde(default)]
    pub params: percli_core::ParamsConfig,
    #[serde(default)]
    pub market: MarketConfig,
    #[serde(default)]
    pub steps: Vec<Step>,
}

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct Meta {
    #[serde(default)]
    pub name: String,
    #[serde(default)]
    pub description: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MarketConfig {
    #[serde(default = "default_oracle")]
    pub initial_oracle_price: u64,
    #[serde(default)]
    pub initial_slot: u64,
}

fn default_oracle() -> u64 { 1000 }

impl Default for MarketConfig {
    fn default() -> Self {
        Self {
            initial_oracle_price: default_oracle(),
            initial_slot: 0,
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "action", rename_all = "snake_case")]
pub enum Step {
    Deposit {
        account: String,
        amount: u64,
        #[serde(default)]
        comment: Option<String>,
    },
    Withdraw {
        account: String,
        amount: u64,
        #[serde(default)]
        comment: Option<String>,
    },
    Trade {
        long: String,
        short: String,
        /// Position size in whole units (auto-scaled by POS_SCALE)
        size: i64,
        price: u64,
        #[serde(default)]
        comment: Option<String>,
    },
    Crank {
        oracle_price: u64,
        slot: u64,
        #[serde(default)]
        comment: Option<String>,
    },
    Liquidate {
        account: String,
        #[serde(default)]
        comment: Option<String>,
    },
    Settle {
        account: String,
        #[serde(default)]
        comment: Option<String>,
    },
    SetOracle {
        oracle_price: u64,
        #[serde(default)]
        comment: Option<String>,
    },
    SetSlot {
        slot: u64,
        #[serde(default)]
        comment: Option<String>,
    },
    SetFundingRate {
        rate: i64,
        #[serde(default)]
        comment: Option<String>,
    },
    Query {
        metric: QueryMetric,
        #[serde(default)]
        comment: Option<String>,
    },
    Assert {
        condition: AssertCondition,
        #[serde(default)]
        comment: Option<String>,
    },
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum QueryMetric {
    Summary,
    Haircut,
    Vault,
    Accounts,
    Conservation,
    Equity { account: String },
    Margin { account: String },
    Position { account: String },
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum AssertCondition {
    Conservation,
    HaircutBelow { threshold: f64 },
    AboveMaintenanceMargin { account: String },
    BelowMaintenanceMargin { account: String },
}