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 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
use barter_integration::{error::SocketError, Validator};
use serde::{Deserialize, Serialize};
/// [`Bitfinex`](super::Bitfinex) platform event detailing the variants expected to be received
/// while connecting and subscribing.
///
/// ### Raw Payload Examples
/// See docs: <https://docs.bitfinex.com/docs/ws-general>
/// #### Platform Status Online
/// ``` json
/// {
/// "event": "info",
/// "version": VERSION,
/// "platform": {
/// "status": 1
/// }
/// }
/// ```
///
/// #### Subscription Trades Success
/// ``` json
/// {
/// event: "subscribed",
/// channel: "trades",
/// chanId: CHANNEL_ID,
/// symbol: "tBTCUSD"
/// pair: "BTCUSD"
/// }
/// ```
///
/// #### Subscription Failure
/// ``` json
/// {
/// "event": "error",
/// "msg": ERROR_MSG,
/// "code": ERROR_CODE
/// }
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Deserialize, Serialize)]
#[serde(tag = "event", rename_all = "lowercase")]
pub enum BitfinexPlatformEvent {
#[serde(rename = "info")]
PlatformStatus(BitfinexPlatformStatus),
Subscribed(BitfinexSubResponse),
Error(BitfinexError),
}
impl Validator for BitfinexPlatformEvent {
fn validate(self) -> Result<Self, SocketError>
where
Self: Sized,
{
match &self {
BitfinexPlatformEvent::PlatformStatus(status) => match status.status {
Status::Operative => Ok(self),
Status::Maintenance => Err(SocketError::Subscribe(format!(
"exchange version: {} with server_id: {} is in maintenance mode",
status.api_version, status.server_id,
))),
},
BitfinexPlatformEvent::Subscribed(_) => Ok(self),
BitfinexPlatformEvent::Error(error) => Err(SocketError::Subscribe(format!(
"received failure subscription response code: {} with message: {}",
error.code, error.msg,
))),
}
}
}
/// [`Bitfinex`](super::Bitfinex) platform status message containing the server we are connecting
/// to, the version of the API, and if it is in maintenance mode.
///
/// ### Raw Payload Examples
/// See docs: <https://docs.bitfinex.com/docs/ws-general#info-messages>
/// #### Platform Status Operative
/// ``` json
/// {
/// "event": "info",
/// "version": 2,
/// "serverId": ""
/// "platform": {
/// "status": 1
/// }
/// }
/// ```
///
/// #### Platform Status In Maintenance
/// ``` json
/// {
/// "event": "info",
/// "version": 2,
/// "serverId": ""
/// "platform": {
/// "status": 0
/// }
/// }
/// ```
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Deserialize, Serialize)]
pub struct BitfinexPlatformStatus {
#[serde(rename = "version")]
api_version: u8,
#[serde(rename = "serverId")]
server_id: String,
#[serde(rename = "platform")]
status: Status,
}
/// [`Bitfinex`](super::Bitfinex) platform [`Status`] indicating if the API is in maintenance mode.
///
/// See [`BitfinexPlatformStatus`] for full raw payload examples.
///
/// See docs: <https://docs.bitfinex.com/docs/ws-general#info-messages>
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Serialize)]
pub enum Status {
Maintenance,
Operative,
}
/// [`Bitfinex`](super::Bitfinex) subscription success response variants for each channel.
///
/// ### Raw Payload Examples
/// See docs: <https://docs.bitfinex.com/docs/ws-general>
/// #### Subscription Trades Success
/// ``` json
/// {
/// event: "subscribed",
/// channel: "trades",
/// chanId: CHANNEL_ID,
/// symbol: "tBTCUSD"
/// pair: "BTCUSD"
/// }
/// ```
///
/// #### Subscription Failure
/// ``` json
/// {
/// "event": "error",
/// "msg": ERROR_MSG,
/// "code": ERROR_CODE
/// }
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Deserialize, Serialize)]
pub struct BitfinexSubResponse {
pub channel: String,
#[serde(rename = "symbol")]
pub market: String,
#[serde(rename = "chanId")]
pub channel_id: BitfinexChannelId,
}
/// [`Bitfinex`](super::Bitfinex) channel identifier that is used to identify the subscription
/// associated with incoming events. See the module level "SubscriptionId" documentation notes
/// for more details.
///
/// See docs: <https://docs.bitfinex.com/docs/ws-general#subscribe-to-channels>
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Deserialize, Serialize)]
pub struct BitfinexChannelId(pub u32);
/// [`Bitfinex`](super::Bitfinex) error message that is received if a [`BitfinexSubResponse`]
/// indicates a WebSocket subscription failure.
///
/// ### Subscription Error Codes:
/// 10300: Generic failure
/// 10301: Already subscribed
/// 10302: Unknown channel
///
/// See [`BitfinexPlatformStatus`] for full raw payload examples.
///
/// See docs: <https://docs.bitfinex.com/docs/ws-general>
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Deserialize, Serialize)]
pub struct BitfinexError {
msg: String,
code: u32,
}
impl<'de> Deserialize<'de> for Status {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::de::Deserializer<'de>,
{
#[derive(Deserialize)]
struct Outer {
#[serde(deserialize_with = "de_status_from_u8")]
status: Status,
}
// Deserialise Outer struct
let Outer { status } = Outer::deserialize(deserializer)?;
Ok(status)
}
}
/// Deserialize a `u8` as a `Bitfinex` platform [`Status`].
///
/// 0u8 => [`Status::Maintenance`](Status), <br>
/// 1u8 => [`Status::Operative`](Status), <br>
/// other => [`de::Error`]
fn de_status_from_u8<'de, D>(deserializer: D) -> Result<Status, D::Error>
where
D: serde::de::Deserializer<'de>,
{
match Deserialize::deserialize(deserializer)? {
0 => Ok(Status::Maintenance),
1 => Ok(Status::Operative),
other => Err(serde::de::Error::invalid_value(
serde::de::Unexpected::Unsigned(other as u64),
&"0 or 1",
)),
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_de_bitfinex_platform_event() {
struct TestCase {
input: &'static str,
expected: Result<BitfinexPlatformEvent, SocketError>,
}
let cases = vec![
// TC0: platform status is online
TestCase {
input: r#"{"event": "info", "version": 2, "serverId": "5b73a436-19ca-4a15-8160-9069bdd7f181", "platform": { "status": 1 }}"#,
expected: Ok(BitfinexPlatformEvent::PlatformStatus(
BitfinexPlatformStatus {
api_version: 2,
server_id: "5b73a436-19ca-4a15-8160-9069bdd7f181".to_string(),
status: Status::Operative,
},
)),
},
// TC1: platform status is offline
TestCase {
input: r#"{"event": "info", "version": 2, "serverId": "5b73a436-19ca-4a15-8160-9069bdd7f181", "platform": { "status": 0 }}"#,
expected: Ok(BitfinexPlatformEvent::PlatformStatus(
BitfinexPlatformStatus {
api_version: 2,
server_id: "5b73a436-19ca-4a15-8160-9069bdd7f181".to_string(),
status: Status::Maintenance,
},
)),
},
// TC1: successful trades channel subscription
TestCase {
input: r#"{"event": "subscribed", "channel": "trades", "chanId": 2203, "symbol": "tBTCUSD", "pair": "BTCUSD"}"#,
expected: Ok(BitfinexPlatformEvent::Subscribed(BitfinexSubResponse {
channel: "trades".to_string(),
channel_id: BitfinexChannelId(2203),
market: "tBTCUSD".to_owned(),
})),
},
// TC2: Input response is error
TestCase {
input: r#"{"event": "error", "msg": "Already subscribed", "code": 10202}"#,
expected: Ok(BitfinexPlatformEvent::Error(BitfinexError {
msg: "Already subscribed".to_owned(),
code: 10202,
})),
},
];
for (index, test) in cases.into_iter().enumerate() {
let actual = serde_json::from_str::<BitfinexPlatformEvent>(test.input);
match (actual, test.expected) {
(Ok(actual), Ok(expected)) => {
assert_eq!(actual, expected, "TC{} failed", index)
}
(Err(_), Err(_)) => {
// Test passed
}
(actual, expected) => {
// Test failed
panic!("TC{index} failed because actual != expected. \nActual: {actual:?}\nExpected: {expected:?}\n");
}
}
}
}
#[test]
fn test_bitfinex_platform_sub_response_validate() {
struct TestCase {
input: BitfinexPlatformEvent,
expected: Result<BitfinexPlatformEvent, SocketError>,
}
let tests = vec![
TestCase {
// TC0: bitfinex server is offline
input: BitfinexPlatformEvent::PlatformStatus(BitfinexPlatformStatus {
api_version: 2,
server_id: "server_id".to_string(),
status: Status::Maintenance,
}),
expected: Err(SocketError::Subscribe(format!(
"exchange version: {} with server_id: {} is in maintenance mode",
2, "server_id",
))),
},
TestCase {
// TC1: bitfinex server is online
input: BitfinexPlatformEvent::PlatformStatus(BitfinexPlatformStatus {
api_version: 2,
server_id: "server_id".to_string(),
status: Status::Operative,
}),
expected: Ok(BitfinexPlatformEvent::PlatformStatus(
BitfinexPlatformStatus {
api_version: 2,
server_id: "server_id".to_string(),
status: Status::Operative,
},
)),
},
TestCase {
// TC2: subscription success
input: BitfinexPlatformEvent::Subscribed(BitfinexSubResponse {
channel: "channel".to_string(),
market: "market".to_string(),
channel_id: BitfinexChannelId(1),
}),
expected: Ok(BitfinexPlatformEvent::Subscribed(BitfinexSubResponse {
channel: "channel".to_string(),
market: "market".to_string(),
channel_id: BitfinexChannelId(1),
})),
},
TestCase {
// TC3: subscription error
input: BitfinexPlatformEvent::Error(BitfinexError {
msg: "error message".to_string(),
code: 0,
}),
expected: Err(SocketError::Subscribe(format!(
"received failure subscription response code: {} with message: {}",
0, "error message",
))),
},
];
for (index, test) in tests.into_iter().enumerate() {
let actual = test.input.validate();
match (actual, test.expected) {
(Ok(actual), Ok(expected)) => {
assert_eq!(actual, expected, "TC{} failed", index)
}
(Err(_), Err(_)) => {
// Test passed
}
(actual, expected) => {
// Test failed
panic!("TC{index} failed because actual != expected. \nActual: {actual:?}\nExpected: {expected:?}\n");
}
}
}
}
}