cmn-substrate 0.3.0

CMN protocol core — Ed25519 signatures, BLAKE3 tree hashing, JSON schema validation, URI parsing, and JCS canonicalization. Zero I/O, WASM-compatible.
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
use anyhow::{anyhow, Result};
use serde::{Deserialize, Serialize};

use super::{apply_headers, json_from_response, text_from_response, FetchOptions};
use crate::BondRelation;

const SYNAPSE_ERROR_BODY_MAX_BYTES: usize = 64 * 1024;

/// Synapse search response (Agent-First Data envelope).
#[derive(Debug, Deserialize)]
pub struct SearchResponse {
    pub code: String,
    pub result: SearchResult,
}

#[derive(Debug, Deserialize)]
pub struct SearchResult {
    pub query: SearchResponseQuery,
    pub spores: Vec<SearchResultItem>,
}

#[derive(Debug, Deserialize)]
pub struct SearchResponseQuery {
    pub text: String,
    pub domain: Option<String>,
    pub license: Option<String>,
    pub limit: u32,
}

#[derive(Debug, Deserialize, Serialize)]
pub struct SearchResultItem {
    pub uri: String,
    pub domain: String,
    pub name: String,
    pub synopsis: String,
    pub license: String,
    pub intent: Vec<String>,
    pub relevance: f32,
}

/// Synapse bonds response (Agent-First Data envelope).
#[derive(Debug, Deserialize)]
pub struct BondsResponse {
    pub code: String,
    pub result: BondsResult,
    #[serde(default)]
    pub trace: Option<BondsTrace>,
}

#[derive(Debug, Deserialize)]
pub struct BondsResult {
    pub query: BondsQuery,
    pub bonds: Vec<BondNode>,
}

#[derive(Debug, Deserialize)]
pub struct BondsQuery {
    pub hash: String,
    pub max_depth: u32,
}

#[derive(Debug, Deserialize)]
pub struct BondsTrace {
    #[serde(default)]
    pub max_depth_reached: bool,
}

#[derive(Debug, Deserialize, Serialize)]
pub struct BondNode {
    pub uri: String,
    pub domain: String,
    pub name: String,
    pub synopsis: String,
    pub license: String,
    pub intent: Vec<String>,
    pub relation: BondRelation,
}

/// Synapse cmn response (GET /synapse/cmn/{domain}).
#[derive(Debug, Deserialize)]
pub struct SynapseCmnResponse {
    pub code: String,
    pub result: SynapseCmnResult,
}

#[derive(Debug, Deserialize)]
pub struct SynapseCmnResult {
    pub query: SynapseCmnQuery,
    pub cmn: serde_json::Value,
}

#[derive(Debug, Deserialize)]
pub struct SynapseCmnQuery {
    pub domain: String,
}

/// Synapse taste response (GET /synapse/taste/{hash}).
#[derive(Debug, Deserialize)]
pub struct SynapseTasteResponse {
    pub code: String,
    pub result: SynapseTasteResult,
}

#[derive(Debug, Deserialize)]
pub struct SynapseTasteResult {
    pub query: SynapseTasteQuery,
    pub taste: serde_json::Value,
    #[serde(default)]
    pub replicates: Vec<String>,
}

#[derive(Debug, Deserialize)]
pub struct SynapseTasteQuery {
    pub hash: String,
}

/// Synapse spore response (GET /synapse/spore/{hash}).
#[derive(Debug, Deserialize)]
pub struct SynapseSporeResponse {
    pub code: String,
    pub result: SynapseSporeResult,
}

#[derive(Debug, Deserialize)]
pub struct SynapseSporeResult {
    pub query: SynapseSporeQuery,
    pub spore: serde_json::Value,
    #[serde(default)]
    pub replicates: Vec<String>,
}

#[derive(Debug, Deserialize)]
pub struct SynapseSporeQuery {
    pub hash: String,
}

/// Synapse mycelium-by-hash response (GET /synapse/mycelium/{hash}).
#[derive(Debug, Deserialize)]
pub struct SynapseMyceliumByHashResponse {
    pub code: String,
    pub result: SynapseMyceliumByHashResult,
}

#[derive(Debug, Deserialize)]
pub struct SynapseMyceliumByHashResult {
    pub query: SynapseMyceliumByHashQuery,
    pub mycelium: serde_json::Value,
    #[serde(default)]
    pub replicates: Vec<String>,
}

#[derive(Debug, Deserialize)]
pub struct SynapseMyceliumByHashQuery {
    pub hash: String,
}

/// Search spores via a synapse instance.
#[allow(clippy::too_many_arguments)]
pub async fn search(
    client: &reqwest::Client,
    synapse_url: &str,
    query: &str,
    domain: Option<&str>,
    license: Option<&str>,
    bond_filter: Option<&str>,
    limit: u32,
    opts: FetchOptions,
) -> Result<SearchResponse> {
    let mut url = reqwest::Url::parse(&format!(
        "{}/synapse/search",
        synapse_url.trim_end_matches('/')
    ))
    .map_err(|e| anyhow!("Invalid synapse URL: {e}"))?;

    url.query_pairs_mut()
        .append_pair("q", query)
        .append_pair("limit", &limit.to_string());
    if let Some(d) = domain {
        url.query_pairs_mut().append_pair("domain", d);
    }
    if let Some(l) = license {
        url.query_pairs_mut().append_pair("license", l);
    }
    if let Some(r) = bond_filter {
        url.query_pairs_mut().append_pair("bonds", r);
    }

    let req = apply_headers(client.get(url.as_str()), &opts);
    let response = req.send().await?;

    if response.status().as_u16() == 503 {
        return Err(anyhow!(
            "Search engine not configured on this synapse instance"
        ));
    }
    if !response.status().is_success() {
        return Err(anyhow!("Synapse returned HTTP {}", response.status()));
    }

    json_from_response(response, url.as_str(), opts.max_bytes).await
}

/// Fetch bond lineage from synapse.
pub async fn fetch_lineage(
    client: &reqwest::Client,
    synapse_url: &str,
    hash: &str,
    direction: &str,
    max_depth: u32,
    opts: FetchOptions,
) -> Result<BondsResponse> {
    let url = format!(
        "{}/synapse/spore/{}/bonds?direction={}&max_depth={}",
        synapse_url.trim_end_matches('/'),
        hash,
        direction,
        max_depth
    );

    let req = apply_headers(client.get(&url), &opts);
    let response = req.send().await?;

    if response.status().as_u16() == 404 {
        return Err(anyhow!("Spore not found in synapse index"));
    }
    if !response.status().is_success() {
        return Err(anyhow!("Synapse returned HTTP {}", response.status()));
    }

    json_from_response(response, &url, opts.max_bytes).await
}

/// Fetch taste reports for a spore from synapse.
pub async fn fetch_taste_reports(
    client: &reqwest::Client,
    synapse_url: &str,
    hash: &str,
    opts: FetchOptions,
) -> Result<serde_json::Value> {
    let url = format!(
        "{}/synapse/spore/{}/tastes",
        synapse_url.trim_end_matches('/'),
        hash
    );

    let req = apply_headers(client.get(&url), &opts);
    let response = req.send().await?;

    if !response.status().is_success() {
        return Err(anyhow!("Synapse returned HTTP {}", response.status()));
    }

    json_from_response(response, &url, opts.max_bytes).await
}

/// Fetch a cmn.json document from synapse.
///
/// GET /synapse/cmn/{domain} → SynapseCmnResponse
pub async fn fetch_synapse_cmn(
    client: &reqwest::Client,
    synapse_url: &str,
    domain: &str,
    opts: FetchOptions,
) -> Result<SynapseCmnResponse> {
    let url = format!(
        "{}/synapse/cmn/{}",
        synapse_url.trim_end_matches('/'),
        domain
    );

    let req = apply_headers(client.get(&url), &opts);
    let response = req.send().await?;

    if response.status().as_u16() == 404 {
        return Err(anyhow!(
            "CMN entry not found in synapse for domain {}",
            domain
        ));
    }
    if !response.status().is_success() {
        return Err(anyhow!("Synapse returned HTTP {}", response.status()));
    }

    json_from_response(response, &url, opts.max_bytes).await
}

/// Fetch a spore manifest from synapse.
///
/// GET /synapse/spore/{hash} → SynapseSporeResponse
pub async fn fetch_synapse_spore(
    client: &reqwest::Client,
    synapse_url: &str,
    hash: &str,
    opts: FetchOptions,
) -> Result<SynapseSporeResponse> {
    let url = format!(
        "{}/synapse/spore/{}",
        synapse_url.trim_end_matches('/'),
        hash
    );

    let req = apply_headers(client.get(&url), &opts);
    let response = req.send().await?;

    if response.status().as_u16() == 404 {
        return Err(anyhow!("Spore not found in synapse"));
    }
    if !response.status().is_success() {
        return Err(anyhow!("Synapse returned HTTP {}", response.status()));
    }

    json_from_response(response, &url, opts.max_bytes).await
}

/// Fetch a mycelium shard from synapse by hash.
///
/// GET /synapse/mycelium/{hash} → SynapseMyceliumByHashResponse
pub async fn fetch_synapse_mycelium_by_hash(
    client: &reqwest::Client,
    synapse_url: &str,
    hash: &str,
    opts: FetchOptions,
) -> Result<SynapseMyceliumByHashResponse> {
    let url = format!(
        "{}/synapse/mycelium/{}",
        synapse_url.trim_end_matches('/'),
        hash
    );

    let req = apply_headers(client.get(&url), &opts);
    let response = req.send().await?;

    if response.status().as_u16() == 404 {
        return Err(anyhow!("Mycelium not found in synapse for hash {}", hash));
    }
    if !response.status().is_success() {
        return Err(anyhow!("Synapse returned HTTP {}", response.status()));
    }

    json_from_response(response, &url, opts.max_bytes).await
}

/// Fetch a taste document from synapse by hash.
///
/// GET /synapse/taste/{hash} → SynapseTasteResponse
pub async fn fetch_synapse_taste(
    client: &reqwest::Client,
    synapse_url: &str,
    hash: &str,
    opts: FetchOptions,
) -> Result<SynapseTasteResponse> {
    let url = format!(
        "{}/synapse/taste/{}",
        synapse_url.trim_end_matches('/'),
        hash
    );

    let req = apply_headers(client.get(&url), &opts);
    let response = req.send().await?;

    if response.status().as_u16() == 404 {
        return Err(anyhow!("Taste not found in synapse for hash {}", hash));
    }
    if !response.status().is_success() {
        return Err(anyhow!("Synapse returned HTTP {}", response.status()));
    }

    json_from_response(response, &url, opts.max_bytes).await
}

/// Post a document (spore, mycelium, taste, cmn.json) to a synapse pulse endpoint.
///
/// POST /synapse/pulse with JSON body. Returns the synapse response.
pub async fn post_synapse_pulse(
    client: &reqwest::Client,
    synapse_url: &str,
    payload: &serde_json::Value,
    opts: FetchOptions,
) -> Result<serde_json::Value> {
    let url = format!("{}/synapse/pulse", synapse_url.trim_end_matches('/'));

    let req = apply_headers(client.post(&url).json(payload), &opts);
    let response = req.send().await?;

    if !response.status().is_success() {
        let status = response.status();
        let max_body = opts
            .max_bytes
            .unwrap_or(SYNAPSE_ERROR_BODY_MAX_BYTES)
            .min(SYNAPSE_ERROR_BODY_MAX_BYTES);
        let body = text_from_response(response, &url, Some(max_body))
            .await
            .unwrap_or_else(|e| format!("<failed to read bounded error body: {e}>"));
        let body = strip_control_chars(&body);
        return Err(anyhow!("Synapse returned HTTP {status}: {body}"));
    }

    json_from_response(response, &url, opts.max_bytes).await
}

fn strip_control_chars(value: &str) -> String {
    value.chars().filter(|c| !c.is_control()).collect()
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn strip_control_chars_removes_terminal_controls() {
        assert_eq!(
            strip_control_chars("bad\u{1b}[31m\nnext\tline"),
            "bad[31mnextline"
        );
    }
}