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

//! Keeper operations.

use crate::decimals::PositiveDecimal;
use crate::define_enum;
use crate::time::UnixTimestampMicros;
use crate::types::{AdminType, AssetId, FeeTier, MarketId};

mod args;
pub use args::*;

define_enum! {
    /// Keeper operations requiring specific admin privileges.
    ///
    /// These operations are typically called by automated keepers/bots
    /// and require specific admin types (Pricing, Funding, Credits,
    /// FeeTier, Referrals). However, one can also update all admin
    /// addresses with it.
    enum KeeperAction<Address> {
        // =========================================================================
        // Pricing Admin Operations (0-9)
        // =========================================================================
        /// Update oracle prices (PricingAdmin).
        UpdateOraclePrices {
            prices: Vec<OraclePriceUpdateArgs>,
            publish_timestamp: UnixTimestampMicros,
        } = 0,

        /// Update mark prices (PricingAdmin).
        UpdateMarkPrices {
            prices: Vec<MarkPriceUpdateArgs>,
            publish_timestamp: UnixTimestampMicros,
        } = 1,

        /// Update premium indexes for markets (PricingAdmin).
        UpdatePremiumIndexes { market_ids: Vec<MarketId> } = 2,
        // Reserved: 3-9

        // =========================================================================
        // Funding Admin Operations (10-19)
        // =========================================================================
        /// Update funding rates for markets (FundingAdmin).
        UpdateFunding { market_ids: Vec<MarketId> } = 10,
        // Reserved: 11-19

        // =========================================================================
        // Credits Admin Operations (20-29)
        // =========================================================================
        /// Add trading credits to a user (CreditsAdmin).
        AddTradingCredits {
            user_address: Address,
            amount: PositiveDecimal,
        } = 20,

        /// Remove trading credits from a user (CreditsAdmin).
        RemoveTradingCredits {
            user_address: Address,
            amount: PositiveDecimal,
        } = 21,
        // Reserved: 22-29

        // =========================================================================
        // FeeTier Admin Operations (30-39)
        // =========================================================================
        /// Update user's fee tier (FeeTierAdmin).
        UpdateUserFeeTier { address: Address, fee_tier: FeeTier } = 30,

        /// Update a given user's fee discount (in bps) (FeeTierAdmin).
        UpdateUserFeeDiscountBps {
            address: Address,
            fee_discount_bps: u16,
        } = 31,
        // Reserved: 32-39

        // =========================================================================
        // Referrals Admin Operations (40-49)
        // =========================================================================
        /// Set a user's cumulative referral rewards to an absolute amount (ReferralsAdmin).
        SetCumulativeReferralRewards {
            address: Address,
            asset_id: AssetId,
            amount: PositiveDecimal,
        } = 40,
        // Reserved: 41-49
    }
}
impl<Address> KeeperAction<Address> {
    /// Returns the specific admin type required for this keeper operation.
    #[must_use]
    pub fn required_admin_type(&self) -> AdminType {
        match self {
            Self::UpdateOraclePrices { .. }
            | Self::UpdateMarkPrices { .. }
            | Self::UpdatePremiumIndexes { .. } => AdminType::Pricing,
            Self::UpdateFunding { .. } => AdminType::Funding,
            Self::AddTradingCredits { .. } | Self::RemoveTradingCredits { .. } => {
                AdminType::Credits
            }
            Self::UpdateUserFeeTier { .. } | Self::UpdateUserFeeDiscountBps { .. } => {
                AdminType::FeeTier
            }
            Self::SetCumulativeReferralRewards { .. } => AdminType::Referrals,
        }
    }
}