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
//! Builder-related types.
use crate::*;
use std::sync::Arc;
/// The general Kitsune2 builder.
/// This contains both configuration and factory instances,
/// allowing construction of runtime module instances.
#[derive(Debug, Clone)]
pub struct Builder {
/// The module configuration to be used when building modules.
/// This can be loaded from disk or modified before freezing the builder.
pub config: Config,
/// The [Verifier] to use for this Kitsune2 instance.
pub verifier: DynVerifier,
/// Any auth_material required to connect to
/// the bootstrap service.
pub auth_material_bootstrap: Option<Vec<u8>>,
/// Any auth_material required to connect to
/// the relay service.
pub auth_material_relay: Option<Vec<u8>>,
/// The [KitsuneFactory] to be used for creating
/// [Kitsune] module instances.
pub kitsune: DynKitsuneFactory,
/// The [SpaceFactory] to be used for creating
/// [Space] instances.
pub space: DynSpaceFactory,
/// The [PeerStoreFactory] to be used for creating
/// [PeerStore] instances.
pub peer_store: DynPeerStoreFactory,
/// The [BootstrapFactory] to be used for creating
/// [Bootstrap] instances for initial WAN discovery.
pub bootstrap: DynBootstrapFactory,
/// The [FetchFactory] to be used for creating
/// [Fetch] instances.
pub fetch: DynFetchFactory,
/// The [ReportFactory] to be used for creating
/// the [Report] instance.
pub report: DynReportFactory,
/// The [TransportFactory] to be used for creating
/// [Transport] instances.
pub transport: DynTransportFactory,
/// The [OpStoreFactory] to be used for creating
/// [OpStore] instances.
pub op_store: DynOpStoreFactory,
/// The [PeerMetaStoreFactory] to be used for creating
/// [PeerMetaStore] instances.
pub peer_meta_store: DynPeerMetaStoreFactory,
/// The [GossipFactory] to be used for creating
/// [Gossip] instances.
pub gossip: DynGossipFactory,
/// The [LocalAgentStoreFactory] to be used for creating
/// [LocalAgentStore] instances.
pub local_agent_store: Arc<dyn LocalAgentStoreFactory>,
/// The [PublishFactory] to be used for creating [Publish]
/// instances
pub publish: DynPublishFactory,
/// The [`BlocksFactory`] to be used for creating [`Blocks`] instances.
pub blocks: DynBlocksFactory,
/// The [`KnownPeersFactory`] to be used for creating [`KnownPeers`]
/// instances.
pub known_peers: DynKnownPeersFactory,
}
impl Builder {
/// Construct a default config given the configured module factories.
///
/// Note, this should be called before [Self::build] or otherwise
/// freezing the Builder instance in an Arc<>.
pub fn with_default_config(mut self) -> K2Result<Self> {
{
let Self {
config,
verifier: _,
auth_material_bootstrap: _,
auth_material_relay: _,
kitsune,
space,
peer_store,
bootstrap,
fetch,
report,
transport,
op_store,
peer_meta_store,
gossip,
local_agent_store,
publish,
blocks,
known_peers,
} = &mut self;
kitsune.default_config(config)?;
space.default_config(config)?;
peer_store.default_config(config)?;
bootstrap.default_config(config)?;
fetch.default_config(config)?;
report.default_config(config)?;
transport.default_config(config)?;
op_store.default_config(config)?;
peer_meta_store.default_config(config)?;
gossip.default_config(config)?;
local_agent_store.default_config(config)?;
publish.default_config(config)?;
blocks.default_config(config)?;
known_peers.default_config(config)?;
config.mark_defaults_set();
}
Ok(self)
}
/// Validate the current configuration.
pub fn validate_config(&self) -> K2Result<()> {
self.kitsune.validate_config(&self.config)?;
self.space.validate_config(&self.config)?;
self.peer_store.validate_config(&self.config)?;
self.bootstrap.validate_config(&self.config)?;
self.fetch.validate_config(&self.config)?;
self.report.validate_config(&self.config)?;
self.transport.validate_config(&self.config)?;
self.op_store.validate_config(&self.config)?;
self.peer_meta_store.validate_config(&self.config)?;
self.gossip.validate_config(&self.config)?;
self.local_agent_store.validate_config(&self.config)?;
self.publish.validate_config(&self.config)?;
self.blocks.validate_config(&self.config)?;
self.known_peers.validate_config(&self.config)?;
self.config.mark_validated();
Ok(())
}
/// Merge in configuration overrides.
///
/// Merged config is validated before returning.
pub fn with_config_overrides(&self, overrides: Config) -> K2Result<Self> {
let mut builder = self.clone();
// merge config
builder.config = builder.config.merge_config_overrides(&overrides)?;
// validate
builder.validate_config()?;
Ok(builder)
}
/// Generate the actual kitsune instance, validating configuration
/// if that has not already explicitly been done.
pub async fn build(self) -> K2Result<DynKitsune> {
if !self.config.mark_validated() {
self.validate_config()?;
}
self.config.mark_runtime();
let builder = Arc::new(self);
builder.kitsune.create(builder.clone()).await
}
}