lnm-sdk 0.4.2

Rust SDK for interacting with LN Markets.
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

use std::{num::NonZero, time::Duration};

use crate::shared::rest::lnm::rate_limit::RateLimiterConfig;

/// Configuration for the v3 REST API client.
///
/// Rate limit defaults were set in line with the [API v3 docs](https://api.lnmarkets.com/v3/#description/rate-limit).
#[derive(Clone, Debug)]
pub struct RestClientConfig {
    timeout: Duration,
    rate_limiter_active: bool,
    rate_limit_auth_requests_per_second: u32,
    rate_limit_unauth_requests_per_second: u32,
}

impl RestClientConfig {
    /// Creates a new v3 REST client configuration with the specified timeout and the rate limiter
    /// disabled.
    ///
    /// To build a configuration with the rate limiter enabled, use
    /// [`with_rate_limiter`](Self::with_rate_limiter) instead.
    pub fn new(timeout: Duration) -> Self {
        Self {
            timeout,
            rate_limiter_active: false,
            ..Default::default()
        }
    }

    /// Creates a new v3 REST client configuration with the specified timeout and the rate limiter
    /// enabled at the given authenticated and unauthenticated requests-per-second limits.
    ///
    /// See the [API v3 rate limit docs](https://api.lnmarkets.com/v3/#description/rate-limit) for
    /// the server-enforced values these should track.
    pub fn with_rate_limiter(
        timeout: Duration,
        rate_limit_auth_rps: NonZero<u32>,
        rate_limit_unauth_rps: NonZero<u32>,
    ) -> Self {
        Self {
            timeout,
            rate_limiter_active: true,
            rate_limit_auth_requests_per_second: rate_limit_auth_rps.get(),
            rate_limit_unauth_requests_per_second: rate_limit_unauth_rps.get(),
        }
    }

    /// Returns the request timeout duration.
    pub fn timeout(&self) -> Duration {
        self.timeout
    }

    /// Returns whether the rate limiter is active.
    pub fn rate_limiter_active(&self) -> bool {
        self.rate_limiter_active
    }

    /// Returns the authenticated requests-per-second limit.
    ///
    /// Only enforced when [`rate_limiter_active`](Self::rate_limiter_active) is `true`.
    pub fn rate_limit_auth_requests_per_second(&self) -> u32 {
        self.rate_limit_auth_requests_per_second
    }

    /// Returns the unauthenticated requests-per-second limit.
    ///
    /// Only enforced when [`rate_limiter_active`](Self::rate_limiter_active) is `true`.
    pub fn rate_limit_unauth_requests_per_second(&self) -> u32 {
        self.rate_limit_unauth_requests_per_second
    }

    /// Sets the request timeout duration.
    ///
    /// Default: `20` seconds
    pub fn with_timeout(mut self, timeout: Duration) -> Self {
        self.timeout = timeout;
        self
    }

    /// Enables or disables the rate limiter.
    ///
    /// Default: `true`
    pub fn with_rate_limiter_active(mut self, active: bool) -> Self {
        self.rate_limiter_active = active;
        self
    }

    /// Sets the authenticated requests-per-second limit.
    ///
    /// Only enforced when [`rate_limiter_active`](Self::rate_limiter_active) is `true`.
    ///
    /// Default: `5`
    pub fn with_rate_limit_auth_requests_per_second(mut self, rps: NonZero<u32>) -> Self {
        self.rate_limit_auth_requests_per_second = rps.get();
        self
    }

    /// Sets the unauthenticated requests-per-second limit.
    ///
    /// Only enforced when [`rate_limiter_active`](Self::rate_limiter_active) is `true`.
    ///
    /// Default: `1`
    pub fn with_rate_limit_unauth_requests_per_second(mut self, rps: NonZero<u32>) -> Self {
        self.rate_limit_unauth_requests_per_second = rps.get();
        self
    }
}

impl RateLimiterConfig for RestClientConfig {
    fn rate_limit_auth_interval(&self) -> Duration {
        Duration::from_secs(1) / self.rate_limit_auth_requests_per_second
    }

    fn rate_limit_unauth_interval(&self) -> Duration {
        Duration::from_secs(1) / self.rate_limit_unauth_requests_per_second
    }
}

impl Default for RestClientConfig {
    fn default() -> Self {
        Self {
            timeout: Duration::from_secs(20),
            rate_limiter_active: true,
            rate_limit_auth_requests_per_second: 5,
            rate_limit_unauth_requests_per_second: 1,
        }
    }
}