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
|
use crate::config::Config;
/// NIP-11 Relay Information Document
///
/// Implements NIP-11 relay information endpoint with GRASP-01 extensions.
/// See: https://github.com/nostr-protocol/nips/blob/master/11.md
use serde::{Deserialize, Serialize};
/// NIP-11 Relay Information Document
///
/// This structure represents the relay metadata served at the HTTP(S) endpoint
/// when the client sends `Accept: application/nostr+json` header.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RelayInformationDocument {
/// Relay name
pub name: String,
/// Relay description
pub description: String,
/// Relay owner's public key (hex format)
#[serde(skip_serializing_if = "Option::is_none")]
pub pubkey: Option<String>,
/// Contact information for relay admin
#[serde(skip_serializing_if = "Option::is_none")]
pub contact: Option<String>,
/// List of NIPs supported by this relay
pub supported_nips: Vec<u16>,
/// Relay software identifier
pub software: String,
/// Software version
pub version: String,
/// Relay icon URL (NIP-11 optional field)
#[serde(skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
// GRASP-01 Extensions (lines 11-14 of GRASP-01 spec)
/// List of supported GRASPs (e.g., ["GRASP-01"])
/// Required by GRASP-01 specification line 12
pub supported_grasps: Vec<String>,
/// Repository acceptance criteria description
/// Required by GRASP-01 specification line 13
pub repo_acceptance_criteria: String,
/// Curation policy (present if curated, absent otherwise)
/// Optional per GRASP-01 specification line 14
#[serde(skip_serializing_if = "Option::is_none")]
pub curation: Option<String>,
}
impl RelayInformationDocument {
/// Create NIP-11 relay information document from configuration
pub fn from_config(config: &Config) -> Self {
Self {
name: config.relay_name(),
description: config.relay_description.clone(),
pubkey: config.relay_owner_npub().ok(),
contact: None, // Could be added to config if needed
supported_nips: vec![
1, // NIP-01: Basic protocol flow
11, // NIP-11: Relay information document (this!)
34, // NIP-34: Git repository announcements
77, // NIP-77: Negentropy sync (reconciliation protocol)
],
software: "https://gitworkshop.dev/danconwaydev.com/ngit-grasp".to_string(),
version: match option_env!("GIT_COMMIT_SHORT") {
Some(commit) => format!("{}-{}", env!("CARGO_PKG_VERSION"), commit),
None => env!("CARGO_PKG_VERSION").to_string(),
},
icon: Some(format!("https://{}/icon.png", config.domain)),
// GRASP-01 Extensions
supported_grasps: vec!["GRASP-01".to_string()],
repo_acceptance_criteria: "None".to_string(),
curation: None, // Not a curated relay - only SPAM prevention via GRASP-01 policy
}
}
/// Serialize to JSON string
pub fn to_json(&self) -> Result<String, serde_json::Error> {
serde_json::to_string_pretty(self)
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_relay_information_document_structure() {
let mut config = Config::for_testing();
config.domain = "relay.example.com".to_string();
config.relay_name_override = Some("Test Relay".to_string());
config.relay_description = "A test relay".to_string();
let doc = RelayInformationDocument::from_config(&config);
assert_eq!(doc.name, "Test Relay");
assert_eq!(doc.description, "A test relay");
// Verify pubkey is present and is a valid npub
assert!(doc.pubkey.is_some());
let pubkey = doc.pubkey.unwrap();
assert!(pubkey.starts_with("npub1"));
assert!(doc.supported_nips.contains(&1));
assert!(doc.supported_nips.contains(&11));
assert!(doc.supported_nips.contains(&34));
assert!(doc.supported_nips.contains(&77));
assert_eq!(doc.supported_grasps, vec!["GRASP-01"]);
assert!(doc.repo_acceptance_criteria.contains("None"));
assert!(doc.curation.is_none());
assert_eq!(
doc.icon,
Some("https://relay.example.com/icon.png".to_string())
);
}
#[test]
fn test_relay_information_document_json() {
let mut config = Config::for_testing();
config.domain = "relay.example.com".to_string();
config.relay_name_override = Some("Test Relay".to_string());
config.relay_description = "A test relay".to_string();
let doc = RelayInformationDocument::from_config(&config);
let json = doc.to_json().expect("Failed to serialize to JSON");
// Verify JSON contains expected fields
assert!(json.contains("\"name\""));
assert!(json.contains("\"description\""));
assert!(json.contains("\"supported_nips\""));
assert!(json.contains("\"supported_grasps\""));
assert!(json.contains("\"repo_acceptance_criteria\""));
assert!(json.contains("GRASP-01"));
// Verify it's valid JSON by parsing
let parsed: serde_json::Value = serde_json::from_str(&json).expect("Invalid JSON");
assert_eq!(parsed["name"], "Test Relay");
assert_eq!(parsed["supported_grasps"][0], "GRASP-01");
assert_eq!(parsed["icon"], "https://relay.example.com/icon.png");
}
}
|