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

#![deny(missing_docs)]
//! Protocol for trycp_server websocket messages.

/// Requests must include a message id.
#[derive(serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "snake_case")]
pub struct RequestWrapper {
    /// The message id.
    pub id: u64,

    /// The request content.
    pub request: Request,
}

/// Trycp server requests.
#[derive(Debug, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "snake_case")]
#[serde(tag = "type")]
pub enum Request {
    /// Given a DNA file, stores the DNA and returns the path at which it is stored.
    SaveDna {
        /// This is actually the dna filename.
        id: String,

        /// Content.
        #[serde(with = "serde_bytes")]
        content: Vec<u8>,
    },

    /// Given a DNA URL, ensures that the DNA is downloaded and returns the path at which it is stored.
    DownloadDna {
        /// Url.
        url: String,
    },

    /// Set up a player.
    ConfigurePlayer {
        /// The player id.
        id: String,

        /// The Holochain configuration data that is not provided by trycp.
        ///
        /// For example:
        /// ```yaml
        /// signing_service_uri: ~
        /// encryption_service_uri: ~
        /// decryption_service_uri: ~
        /// dpki: ~
        /// network: ~
        /// ```
        partial_config: String,
    },

    /// Start a conductor.
    Startup {
        /// The conductor id.
        id: String,

        /// The log level of the conductor.
        log_level: Option<String>,
    },

    /// Shut down a conductor.
    Shutdown {
        /// The id of the conductor to shut down.
        id: String,

        /// The signal with which to shut down the conductor.
        signal: Option<String>,
    },

    /// Shuts down all running conductors.
    Reset,

    /// Make an admin request.
    CallAdminInterface {
        /// The conductor id.
        id: String,

        /// The request.
        #[serde(with = "serde_bytes")]
        message: Vec<u8>,
    },

    /// Hook up an app interface.
    ConnectAppInterface {
        /// Token.
        token: Vec<u8>,

        /// Port.
        port: u16,
    },

    /// Disconnect an app interface.
    DisconnectAppInterface {
        /// Port.
        port: u16,
    },

    /// Make an ap request.
    CallAppInterface {
        /// Port.
        port: u16,

        /// The request.
        #[serde(with = "serde_bytes")]
        message: Vec<u8>,
    },

    /// Request the logs for a player's conductor and keystore.
    DownloadLogs {
        /// The conductor id.
        id: String,
    },
}

/// Message response types.
#[derive(Debug, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "snake_case")]
#[serde(untagged)]
pub enum MessageResponse {
    /// Unit response.
    Null,

    /// Encoded response.
    Bytes(Vec<u8>),
}

impl MessageResponse {
    /// Convert into bytes.
    pub fn into_bytes(self) -> Vec<u8> {
        match self {
            Self::Null => Vec::new(),
            Self::Bytes(v) => v,
        }
    }
}

/// A Message from a trycp_server.
#[derive(Debug, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "snake_case")]
#[serde(tag = "type")]
pub enum MessageToClient {
    /// A signal emitted by a conductor.
    Signal {
        /// The app port from which this signal was emitted.
        port: u16,

        /// The content of the signal.
        data: Vec<u8>,
    },

    /// A response to a trycp server request.
    Response {
        /// request message id.
        id: u64,

        /// message content.
        response: std::result::Result<MessageResponse, String>,
    },
}

/// Messages returned directly by the TryCp server, rather than relayed from Holochain
#[derive(Debug, serde::Deserialize, serde::Serialize)]
#[serde(rename_all = "snake_case", tag = "type", content = "data")]
pub enum TryCpServerResponse {
    /// See [DownloadLogsResponse].
    DownloadLogs(DownloadLogsResponse),
}

/// The successful response type for a [Request::DownloadLogs] request.
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct DownloadLogsResponse {
    /// The lair keystore stderr log.
    pub lair_stderr: Vec<u8>,
    /// The holochain conductor stdout log.
    pub conductor_stdout: Vec<u8>,
    /// The holochain conductor stderr log.
    pub conductor_stderr: Vec<u8>,
}