bullet-exchange-interface 0.1.0

Type definitions and message formats for the Bullet exchange protocol.
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
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179

//! Protocol admin operations.

use crate::decimals::PositiveDecimal;
use crate::define_enum;
use crate::message::CreateVaultArgs;
use crate::types::{AdminType, AssetId, MarketId, OrderId, TriggerOrderId};

mod args;
pub use args::*;

define_enum! {
    /// Protocol admin operations.
    ///
    /// These operations require Protocol admin authorization and are used for
    /// protocol-level configuration, market management, and emergency actions.
    enum AdminAction<Address> {
        // =========================================================================
        // Market Operations (0-19)
        // =========================================================================
        /// Initialize a new perp market.
        InitPerpMarket { args: InitPerpMarketArgs } = 0,

        /// Update perp market configuration.
        UpdatePerpMarket { args: UpdatePerpMarketArgs } = 1,

        /// Initialize a new spot market.
        InitSpotMarket { args: InitSpotMarketArgs } = 2,

        /// Update spot market configuration.
        UpdateSpotMarket { args: UpdateSpotMarketArgs } = 3,

        /// Halt a perp market with settlement price.
        HaltPerpMarket {
            market_id: MarketId,
            settlement_price: PositiveDecimal,
        } = 4,

        /// Unhalt a perp market.
        UnhaltPerpMarket { market_id: MarketId } = 5,

        /// Halt a spot market.
        HaltSpotMarket { market_id: MarketId } = 6,

        /// Unhalt a spot market.
        UnhaltSpotMarket { market_id: MarketId } = 7,

        /// Prune market data.
        PruneMarket { market_id: MarketId } = 8,

        /// Delete a market.
        DeleteMarket { market_id: MarketId } = 9,

        /// Cleanup user market state.
        CleanupUserMarketState {
            market_id: MarketId,
            users: Vec<Address>,
        } = 10,

        /// Update perp market leverage table.
        UpdatePerpLeverageTable {
            market_id: MarketId,
            args: SurrogateLeverageTableArgs,
        } = 11,

        /// Delete an asset.
        DeleteAsset { asset_id: AssetId } = 12,

        // Reserved: 13-19

        // =========================================================================
        // Asset Operations (20-29)
        // =========================================================================
        /// Initialize asset info.
        InitAssetInfo { args: InitAssetInfoArgs } = 20,

        /// Update asset info.
        UpdateAssetInfo { args: UpdateAssetInfoArgs } = 21,
        // Reserved: 22-29

        // =========================================================================
        // Borrow/Lend Operations (30-39)
        // =========================================================================
        /// Initialize a borrow/lend pool.
        InitBorrowLendPool { args: InitBorrowLendPoolArgs } = 30,

        /// Update borrow/lend pool configuration.
        UpdateBorrowLendPool { args: UpdateBorrowLendPoolArgs } = 31,

        /// Halt a borrow/lend pool.
        HaltBorrowLendPool { asset_id: AssetId } = 32,

        /// Unhalt a borrow/lend pool.
        UnhaltBorrowLendPool { asset_id: AssetId } = 33,
        // Reserved: 34-39

        // =========================================================================
        // Configuration Operations (40-49)
        // =========================================================================
        /// Update global configuration.
        UpdateGlobalConfig {
            args: UpdateGlobalConfigArgs<Address>,
        } = 40,

        /// Update perp liquidation configuration.
        UpdatePerpLiquidationConfig {
            args: UpdatePerpLiquidationConfigArgs,
        } = 41,

        /// Update global vault configuration.
        UpdateGlobalVaultConfig { args: UpdateGlobalVaultConfigArgs } = 42,

        /// Update admin addresses.
        UpdateAdmin {
            admin_type: AdminType,
            new_admin: Address,
        } = 43,

        // Reserved: 44-49

        // =========================================================================
        // Treasury Operations (50-59)
        // =========================================================================
        /// Withdraw from protocol treasury.
        WithdrawFromTreasury {
            asset_id: AssetId,
            amount: PositiveDecimal,
            to: Address,
        } = 50,
        // Reserved: 51-59

        // =========================================================================
        // Force/Emergency Operations (60-69)
        // =========================================================================
        /// Force cancel user orders.
        CancelOrders {
            cancels: Vec<(MarketId, OrderId, Address)>,
        } = 60,

        /// Force cancel user trigger orders.
        CancelTriggerOrders {
            cancels: Vec<(MarketId, TriggerOrderId, Address)>,
        } = 61,

        /// Force settle perp positions.
        ForceSettlePerpPosition {
            market_id: MarketId,
            users: Vec<Address>,
        } = 62,

        /// Auto-deleverage positions.
        AutoDeleverage {
            counterparty_a: Address,
            counterparty_a_sub_account_index: Option<u8>,
            counterparty_b: Address,
            counterparty_b_sub_account_index: Option<u8>,
            market_id: MarketId,
            size: Option<PositiveDecimal>,
            settlement_price: PositiveDecimal,
        } = 63,

        /// Admin deposit to any user account (creates account if needed).
        /// Funds come from the admin's wallet.
        Deposit {
            user_address: Address,
            asset_id: AssetId,
            amount: PositiveDecimal,
        } = 64,

        ForceRemoveDelegate { delegator: Address, delegate: Address } = 65,

        /// Initialize a new protocol-owned vault.
        ///
        /// Behaves identically to a user-created vault but is flagged with
        /// `AccountVariant::ProtocolVault` so future protocol-specific behavior
        /// (e.g. governance-only withdrawals, fee exemptions) can branch on it.
        InitProtocolVault { args: CreateVaultArgs<Address> } = 66,
        // Reserved: 67-69
    }
}