bluefin-pro 1.13.0

Software Development Kit for Bluefin Pro
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
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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
/// Useful details for testing in Bluefin's Dev and Staging environments.
#[derive(Clone)]
pub struct TestKeySet {
    pub address: &'static str,
    pub public_key: &'static str,
    pub private_key: &'static str,
}

/// The address and keys are currently identical for dev and staging.
const TEST_KEYS: TestKeySet = TestKeySet {
    address: "0x9b11fafc580f23932f379d99ab6cc4c638e85ba4c252fc909296f3f9e6cea786",
    public_key: "989e35904229360dfbf53a9277db36d401f597c4c0a693acc286bf439269a5cb",
    private_key: "3427d19dcf5781f0874c36c78aec22c03acda435d69efcbf249e8821793567a1",
};

#[derive(Clone, Copy)]
pub enum Environment {
    Dev,
    Staging,
    Production,

    // Deprecated aliases
    #[deprecated(note = "Use Dev instead")]
    Devnet,
    #[deprecated(note = "Use Staging instead")]
    Testnet,
    #[deprecated(note = "Use Production instead")]
    Mainnet,
}

impl Environment {
    /// Returns details of this environment, or None if `self` is Production.
    #[must_use]
    pub fn test_keys(self) -> Option<TestKeySet> {
        #[allow(deprecated)]
        match self {
            Environment::Dev
            | Environment::Devnet
            | Environment::Staging
            | Environment::Testnet => Some(TEST_KEYS.clone()),
            Environment::Production | Environment::Mainnet => None,
        }
    }
}

#[deprecated(note = "Will not be updated anymore.")]
pub mod symbols {
    #[deprecated(note = "Use exchange::info::markets() function instead")]
    pub mod perps {
        pub const ETH: &str = "ETH-PERP";
        pub const BTC: &str = "BTC-PERP";
        pub const SUI: &str = "SUI-PERP";
    }

    #[deprecated(note = "Use exchange::info::assets() function instead")]
    pub mod assets {
        pub const USDC: &str = "USDC";
    }
}

pub mod test {
    pub mod account {
        #[deprecated(note = "Please use Environment::test_keys() instead")]
        pub mod dev {
            pub const ADDRESS: &str = crate::env::TEST_KEYS.address;
            pub const PUBLIC_KEY: &str = crate::env::TEST_KEYS.public_key;
            pub const PRIVATE_KEY: &str = crate::env::TEST_KEYS.private_key;
        }

        #[deprecated(note = "Please use Environment::test_keys() instead")]
        pub mod staging {
            pub const ADDRESS: &str = crate::env::TEST_KEYS.address;
            pub const PUBLIC_KEY: &str = crate::env::TEST_KEYS.public_key;
            pub const PRIVATE_KEY: &str = crate::env::TEST_KEYS.private_key;
        }

        #[deprecated(note = "Use dev instead")]
        pub mod devnet {
            #[allow(deprecated)]
            pub use super::dev::*;
        }
        #[deprecated(note = "Use staging instead")]
        pub mod testnet {
            #[allow(deprecated)]
            pub use super::staging::*;
        }
    }
}

pub mod auth {
    use super::Environment;

    pub mod dev {
        pub const AUDIENCE: &str = "api";
        pub const URL: &str = "https://auth.api.sui-dev.bluefin.io";
    }

    pub mod staging {
        pub const AUDIENCE: &str = "api";
        pub const URL: &str = "https://auth.api.sui-staging.bluefin.io";
    }

    pub mod production {
        pub const AUDIENCE: &str = "api";
        pub const URL: &str = "https://auth.api.sui-prod.bluefin.io";
    }

    #[deprecated(note = "Use dev instead")]
    pub mod devnet {
        pub use super::dev::*;
    }
    #[deprecated(note = "Use staging instead")]
    pub mod testnet {
        pub use super::staging::*;
    }
    #[deprecated(note = "Use production instead")]
    pub mod mainnet {
        pub use super::production::*;
    }

    #[must_use]
    pub fn url<'a>(environment: Environment) -> &'a str {
        #[allow(deprecated)]
        match environment {
            Environment::Dev | Environment::Devnet => dev::URL,
            Environment::Staging | Environment::Testnet => staging::URL,
            Environment::Production | Environment::Mainnet => production::URL,
        }
    }

    #[must_use]
    pub fn audience<'a>(environment: Environment) -> &'a str {
        #[allow(deprecated)]
        match environment {
            Environment::Dev | Environment::Devnet => dev::AUDIENCE,
            Environment::Staging | Environment::Testnet => staging::AUDIENCE,
            Environment::Production | Environment::Mainnet => production::AUDIENCE,
        }
    }
}

pub mod trade {
    use super::Environment;

    pub const AUTH_TOKEN_PREFIX: &str = "Bearer";

    pub mod dev {
        pub const URL: &str = "https://trade.api.sui-dev.bluefin.io";
        pub const COLOCATED_URL: &str = "http://api.coloc.sui-dev.int.bluefin.io:9090";
    }

    pub mod staging {
        pub const URL: &str = "https://trade.api.sui-staging.bluefin.io";
        pub const COLOCATED_URL: &str = "http://api.coloc.sui-staging.int.bluefin.io:9090";
    }

    pub mod production {
        pub const URL: &str = "https://trade.api.sui-prod.bluefin.io";
        pub const COLOCATED_URL: &str = "http://api.coloc.sui-prod.int.bluefin.io:9090";
    }

    #[deprecated(note = "Use dev instead")]
    pub mod devnet {
        pub use super::dev::*;
    }
    #[deprecated(note = "Use staging instead")]
    pub mod testnet {
        pub use super::staging::*;
    }
    #[deprecated(note = "Use production instead")]
    pub mod mainnet {
        pub use super::production::*;
    }

    #[must_use]
    pub fn url<'a>(environment: Environment) -> &'a str {
        #[allow(deprecated)]
        match environment {
            Environment::Dev | Environment::Devnet => dev::URL,
            Environment::Staging | Environment::Testnet => staging::URL,
            Environment::Production | Environment::Mainnet => production::URL,
        }
    }

    #[must_use]
    pub fn colocated_url<'a>(environment: Environment) -> &'a str {
        #[allow(deprecated)]
        match environment {
            Environment::Dev | Environment::Devnet => dev::COLOCATED_URL,
            Environment::Staging | Environment::Testnet => staging::COLOCATED_URL,
            Environment::Production | Environment::Mainnet => production::COLOCATED_URL,
        }
    }
}

pub mod exchange {
    use super::Environment;

    pub mod dev {
        pub const URL: &str = "https://api.sui-dev.bluefin.io";
    }

    pub mod staging {
        pub const URL: &str = "https://api.sui-staging.bluefin.io";
    }

    pub mod production {
        pub const URL: &str = "https://api.sui-prod.bluefin.io";
    }

    #[deprecated(note = "Use dev instead")]
    pub mod devnet {
        pub use super::dev::*;
    }
    #[deprecated(note = "Use staging instead")]
    pub mod testnet {
        pub use super::staging::*;
    }
    #[deprecated(note = "Use production instead")]
    pub mod mainnet {
        pub use super::production::*;
    }

    pub mod info {
        use super::Environment;
        use bluefin_api::apis::configuration::Configuration;
        use bluefin_api::models::{AssetConfig, ContractsConfig, Market};

        type Error = Box<dyn std::error::Error>;
        type Result<T> = std::result::Result<T, Error>;

        /// Returns the contracts config.
        ///
        /// # Errors
        ///
        /// Will return [`Err`] if client/server communication fails.
        pub async fn contracts_config(environment: Environment) -> Result<ContractsConfig> {
            bluefin_api::apis::exchange_api::get_exchange_info(&Configuration {
                base_path: super::url(environment).to_string(),
                ..Configuration::default()
            })
            .await?
            .contracts_config
            .ok_or("No Contracts Config found".into())
        }

        /// Returns a list of all markets.
        ///
        /// # Errors
        ///
        /// Will return [`Err`] if client/server communication fails.
        pub async fn markets(environment: Environment) -> Result<Vec<Market>> {
            bluefin_api::apis::exchange_api::get_exchange_info(&Configuration {
                base_path: super::url(environment).to_string(),
                ..Configuration::default()
            })
            .await
            .map(|response| response.markets)
            .map_err(Error::from)
        }

        /// Returns a list of all assets.
        ///
        /// # Errors
        ///
        /// Will return [`Err`] if client/server communication fails.
        pub async fn assets(environment: Environment) -> Result<Vec<AssetConfig>> {
            bluefin_api::apis::exchange_api::get_exchange_info(&Configuration {
                base_path: super::url(environment).to_string(),
                ..Configuration::default()
            })
            .await
            .map(|response| response.assets)
            .map_err(Error::from)
        }
    }

    #[must_use]
    pub fn url<'a>(environment: Environment) -> &'a str {
        #[allow(deprecated)]
        match environment {
            Environment::Dev | Environment::Devnet => dev::URL,
            Environment::Staging | Environment::Testnet => staging::URL,
            Environment::Production | Environment::Mainnet => production::URL,
        }
    }
}

pub mod account {
    use super::Environment;

    pub const AUTH_TOKEN_PREFIX: &str = "Bearer";

    pub mod dev {
        pub const URL: &str = "https://api.sui-dev.bluefin.io";
    }

    pub mod staging {
        pub const URL: &str = "https://api.sui-staging.bluefin.io";
    }

    pub mod production {
        pub const URL: &str = "https://api.sui-prod.bluefin.io";
    }

    #[deprecated(note = "Use dev instead")]
    pub mod devnet {
        pub use super::dev::*;
    }
    #[deprecated(note = "Use staging instead")]
    pub mod testnet {
        pub use super::staging::*;
    }
    #[deprecated(note = "Use production instead")]
    pub mod mainnet {
        pub use super::production::*;
    }

    #[must_use]
    pub fn url<'a>(environment: Environment) -> &'a str {
        #[allow(deprecated)]
        match environment {
            Environment::Dev | Environment::Devnet => dev::URL,
            Environment::Staging | Environment::Testnet => staging::URL,
            Environment::Production | Environment::Mainnet => production::URL,
        }
    }
}

pub mod websocket {
    use super::Environment;

    pub mod account {
        use super::Environment;

        pub mod dev {
            pub const URL: &str = "wss://stream.api.sui-dev.bluefin.io/ws/account";
            pub const COLOCATED_URL: &str = "ws://api.coloc.sui-dev.int.bluefin.io:9091/ws/account";
        }

        pub mod staging {
            pub const URL: &str = "wss://stream.api.sui-staging.bluefin.io/ws/account";
            pub const COLOCATED_URL: &str =
                "ws://api.coloc.sui-staging.int.bluefin.io:9091/ws/account";
        }

        pub mod production {
            pub const URL: &str = "wss://stream.api.sui-prod.bluefin.io/ws/account";
            pub const COLOCATED_URL: &str =
                "ws://api.coloc.sui-prod.int.bluefin.io:9091/ws/account";
        }

        #[deprecated(note = "Use dev instead")]
        pub mod devnet {
            pub use super::dev::*;
        }
        #[deprecated(note = "Use staging instead")]
        pub mod testnet {
            pub use super::staging::*;
        }
        #[deprecated(note = "Use production instead")]
        pub mod mainnet {
            pub use super::production::*;
        }

        /// Returns the WebSocket URL to Market streams for the given environment.
        #[must_use]
        pub fn url<'a>(environment: Environment) -> &'a str {
            #[allow(deprecated)]
            match environment {
                Environment::Dev | Environment::Devnet => dev::URL,
                Environment::Staging | Environment::Testnet => staging::URL,
                Environment::Production | Environment::Mainnet => production::URL,
            }
        }

        /// Returns the colocated WebSocket URL to Account streams for the given environment.
        /// For this URL, the user must be colocated with the exchange.
        #[must_use]
        pub fn colocated_url<'a>(environment: Environment) -> &'a str {
            #[allow(deprecated)]
            match environment {
                Environment::Dev | Environment::Devnet => dev::COLOCATED_URL,
                Environment::Staging | Environment::Testnet => staging::COLOCATED_URL,
                Environment::Production | Environment::Mainnet => production::COLOCATED_URL,
            }
        }
    }

    pub mod market {
        use super::Environment;

        pub mod dev {
            pub const URL: &str = "wss://stream.api.sui-dev.bluefin.io/ws/market";
            pub const COLOCATED_URL: &str = "ws://api.coloc.sui-dev.int.bluefin.io:9091/ws/market";
        }

        pub mod staging {
            pub const URL: &str = "wss://stream.api.sui-staging.bluefin.io/ws/market";
            pub const COLOCATED_URL: &str =
                "ws://api.coloc.sui-staging.int.bluefin.io:9091/ws/market";
        }

        pub mod production {
            pub const URL: &str = "wss://stream.api.sui-prod.bluefin.io/ws/market";
            pub const COLOCATED_URL: &str = "ws://api.coloc.sui-prod.int.bluefin.io:9091/ws/market";
        }

        #[deprecated(note = "Use dev instead")]
        pub mod devnet {
            pub use super::dev::*;
        }
        #[deprecated(note = "Use staging instead")]
        pub mod testnet {
            pub use super::staging::*;
        }
        #[deprecated(note = "Use production instead")]
        pub mod mainnet {
            pub use super::production::*;
        }

        /// Returns the WebSocket URL to Market streams for the given environment.
        #[must_use]
        pub fn url<'a>(environment: Environment) -> &'a str {
            #[allow(deprecated)]
            match environment {
                Environment::Dev | Environment::Devnet => dev::URL,
                Environment::Staging | Environment::Testnet => staging::URL,
                Environment::Production | Environment::Mainnet => production::URL,
            }
        }

        /// Returns the colocated WebSocket URL to Market streams for the given environment.
        /// For this URL, the user must be colocated with the exchange.
        #[must_use]
        pub fn colocated_url<'a>(environment: Environment) -> &'a str {
            #[allow(deprecated)]
            match environment {
                Environment::Dev | Environment::Devnet => dev::COLOCATED_URL,
                Environment::Staging | Environment::Testnet => staging::COLOCATED_URL,
                Environment::Production | Environment::Mainnet => production::COLOCATED_URL,
            }
        }
    }
}