bothan-coinbase 0.0.1

Rust client for the Coinbase exchange with Bothan integration
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

//! Types for Coinbase WebSocket API subscription requests and responses.
//!
//! This module provides types for serializing and deserializing subscription requests,
//! channels, and error responses for the Coinbase WebSocket API.

use serde::{Deserialize, Serialize};

use crate::api::types::channels::Channel;

/// Represents the type of request for subscriptions.
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum RequestType {
    /// Subscribe to a channel.
    Subscribe,
    /// Unsubscribe from a channel.
    Unsubscribe,
}

/// Represents a subscription request.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct Request {
    /// The type of request (subscribe or unsubscribe).
    #[serde(rename = "type")]
    pub type_: RequestType,
    /// The list of product IDs to be included in the request.
    pub product_ids: Vec<String>,
    /// The list of channels to be included in the request.
    pub channels: Vec<Channel>,
}

/// Represents a subscription channel.
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
pub struct SubscriptionChannel {
    /// The name of the channel.
    pub name: String,
    /// The list of product IDs subscribed to this channel.
    pub product_ids: Vec<String>,
}

/// Represents the current subscriptions.
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
pub struct Subscriptions {
    /// The list of subscribed channels.
    pub channels: Vec<SubscriptionChannel>,
    /// The list of subscribed product IDs (optional).
    pub product_ids: Option<Vec<String>>,
    /// The list of subscribed account IDs (optional).
    pub account_ids: Option<Vec<String>>,
}

/// Represents an error response from the Coinbase WebSocket API.
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
pub struct Error {
    /// The error message describing what went wrong.
    pub message: String,
    /// The specific reason for the error.
    pub reason: String,
}