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
//! Module containing the HolochainP2p actor definition.
#![allow(clippy::too_many_arguments)]
use crate::event::GetRequest;
use crate::*;
use holochain_types::activity::AgentActivityResponse;
/// Request a validation package.
#[derive(Clone, Debug)]
pub struct GetValidationPackage {
/// The dna_hash / space_hash context.
pub dna_hash: DnaHash,
/// Request the package from this agent.
pub request_from: AgentPubKey,
/// Request the package for this Header
pub header_hash: HeaderHash,
}
#[derive(Clone, Debug)]
/// Get options help control how the get is processed at various levels.
/// Fields tagged with ```[Network]``` are network-level controls.
/// Fields tagged with ```[Remote]``` are controls that will be forwarded to the
/// remote agent processing this `Get` request.
pub struct GetOptions {
/// ```[Network]```
/// How many remote nodes should we make requests of / aggregate.
/// Set to `None` for a default "best-effort".
pub remote_agent_count: Option<u8>,
/// ```[Network]```
/// Timeout to await responses for aggregation.
/// Set to `None` for a default "best-effort".
/// Note - if all requests time-out you will receive an empty result,
/// not a timeout error.
pub timeout_ms: Option<u64>,
/// ```[Network]```
/// We are interested in speed. If `true` and we have any results
/// when `race_timeout_ms` is expired, those results will be returned.
/// After `race_timeout_ms` and before `timeout_ms` the first result
/// received will be returned.
pub as_race: bool,
/// ```[Network]```
/// See `as_race` for details.
/// Set to `None` for a default "best-effort" race.
pub race_timeout_ms: Option<u64>,
/// ```[Remote]```
/// Whether the remote-end should follow redirects or just return the
/// requested entry.
pub follow_redirects: bool,
/// ```[Remote]```
/// Return all live headers even if there is deletes.
/// Useful for metadata calls.
pub all_live_headers_with_metadata: bool,
/// ```[Remote]```
/// The type of data this get request requires.
pub request_type: GetRequest,
}
impl Default for GetOptions {
fn default() -> Self {
Self {
remote_agent_count: None,
timeout_ms: None,
as_race: true,
race_timeout_ms: None,
follow_redirects: true,
all_live_headers_with_metadata: false,
request_type: Default::default(),
}
}
}
impl GetOptions {
/// Using defaults is dangerous in a must_get as it can undermine determinism.
/// We want refactors to explicitly consider this.
pub fn must_get_options() -> Self {
Self {
remote_agent_count: None,
timeout_ms: None,
as_race: true,
race_timeout_ms: None,
// Never redirect as the returned value must always match the hash.
follow_redirects: false,
all_live_headers_with_metadata: false,
// Redundant with retrieve_entry internals.
request_type: GetRequest::Pending,
}
}
}
impl From<holochain_zome_types::entry::GetOptions> for GetOptions {
fn from(_: holochain_zome_types::entry::GetOptions) -> Self {
Self::default()
}
}
/// Get metadata from the DHT.
/// Fields tagged with ```[Network]``` are network-level controls.
/// Fields tagged with ```[Remote]``` are controls that will be forwarded to the
/// remote agent processing this `GetLinks` request.
#[derive(Clone, Debug)]
pub struct GetMetaOptions {
/// ```[Network]```
/// How many remote nodes should we make requests of / aggregate.
/// Set to `None` for a default "best-effort".
pub remote_agent_count: Option<u8>,
/// ```[Network]```
/// Timeout to await responses for aggregation.
/// Set to `None` for a default "best-effort".
/// Note - if all requests time-out you will receive an empty result,
/// not a timeout error.
pub timeout_ms: Option<u64>,
/// ```[Network]```
/// We are interested in speed. If `true` and we have any results
/// when `race_timeout_ms` is expired, those results will be returned.
/// After `race_timeout_ms` and before `timeout_ms` the first result
/// received will be returned.
pub as_race: bool,
/// ```[Network]```
/// See `as_race` for details.
/// Set to `None` for a default "best-effort" race.
pub race_timeout_ms: Option<u64>,
/// ```[Remote]```
/// Tells the remote-end which metadata to return
pub metadata_request: MetadataRequest,
}
impl Default for GetMetaOptions {
fn default() -> Self {
Self {
remote_agent_count: None,
timeout_ms: None,
as_race: true,
race_timeout_ms: None,
metadata_request: MetadataRequest::default(),
}
}
}
#[derive(Debug, Clone, Default)]
/// Get links from the DHT.
/// Fields tagged with ```[Network]``` are network-level controls.
/// Fields tagged with ```[Remote]``` are controls that will be forwarded to the
/// remote agent processing this `GetLinks` request.
pub struct GetLinksOptions {
/// ```[Network]```
/// Timeout to await responses for aggregation.
/// Set to `None` for a default "best-effort".
/// Note - if all requests time-out you will receive an empty result,
/// not a timeout error.
pub timeout_ms: Option<u64>,
}
#[derive(Debug, Clone)]
/// Get agent activity from the DHT.
/// Fields tagged with ```[Network]``` are network-level controls.
/// Fields tagged with ```[Remote]``` are controls that will be forwarded to the
/// remote agent processing this `GetLinks` request.
pub struct GetActivityOptions {
/// ```[Network]```
/// Timeout to await responses for aggregation.
/// Set to `None` for a default "best-effort".
/// Note - if all requests time-out you will receive an empty result,
/// not a timeout error.
pub timeout_ms: Option<u64>,
/// Number of times to retry getting elements in parallel.
/// For a small dht a large parallel get can overwhelm a single
/// agent and it can be worth retrying the elements that didn't
/// get found.
pub retry_gets: u8,
/// ```[Remote]```
/// Include the all valid activity headers in the response.
/// If this is false the call becomes a lightweight response with
/// just the chain status and highest observed header.
/// This is useful when you want to ask an authority about the
/// status of a chain but do not need all the headers.
pub include_valid_activity: bool,
/// Include any rejected headers in the response.
pub include_rejected_activity: bool,
/// Include the full signed headers and hashes in the response
/// instead of just the hashes.
pub include_full_headers: bool,
}
impl Default for GetActivityOptions {
fn default() -> Self {
Self {
timeout_ms: None,
retry_gets: 0,
include_valid_activity: true,
include_rejected_activity: false,
include_full_headers: false,
}
}
}
ghost_actor::ghost_chan! {
/// The HolochainP2pSender struct allows controlling the HolochainP2p
/// actor instance.
pub chan HolochainP2p<HolochainP2pError> {
/// The p2p module must be informed at runtime which dna/agent pairs it should be tracking.
fn join(dna_hash: DnaHash, agent_pub_key: AgentPubKey, initial_arc: Option<crate::dht_arc::DhtArc>) -> ();
/// If a cell is disabled, we'll need to \"leave\" the network module as well.
fn leave(dna_hash: DnaHash, agent_pub_key: AgentPubKey) -> ();
/// Invoke a zome function on a remote node (if you have been granted the capability).
fn call_remote(
dna_hash: DnaHash,
from_agent: AgentPubKey,
to_agent: AgentPubKey,
zome_name: ZomeName,
fn_name: FunctionName,
cap_secret: Option<CapSecret>,
payload: ExternIO,
) -> SerializedBytes;
/// Invoke a zome function on a remote node (if you have been granted the capability).
/// This is a fire-and-forget operation, a best effort will be made
/// to forward the signal, but if the conductor network is overworked
/// it may decide not to deliver some of the signals.
fn remote_signal(
dna_hash: DnaHash,
from_agent: AgentPubKey,
to_agent_list: Vec<AgentPubKey>,
zome_name: ZomeName,
fn_name: FunctionName,
cap: Option<CapSecret>,
payload: ExternIO,
) -> ();
/// Publish data to the correct neighborhood.
fn publish(
dna_hash: DnaHash,
request_validation_receipt: bool,
countersigning_session: bool,
dht_hash: holo_hash::AnyDhtHash,
ops: Vec<holochain_types::dht_op::DhtOp>,
timeout_ms: Option<u64>,
) -> ();
/// Request a validation package.
fn get_validation_package(input: GetValidationPackage) -> ValidationPackageResponse;
/// Get an entry from the DHT.
fn get(
dna_hash: DnaHash,
dht_hash: holo_hash::AnyDhtHash,
options: GetOptions,
) -> Vec<WireOps>;
/// Get metadata from the DHT.
fn get_meta(
dna_hash: DnaHash,
dht_hash: holo_hash::AnyDhtHash,
options: GetMetaOptions,
) -> Vec<MetadataSet>;
/// Get links from the DHT.
fn get_links(
dna_hash: DnaHash,
link_key: WireLinkKey,
options: GetLinksOptions,
) -> Vec<WireLinkOps>;
/// Get agent activity from the DHT.
fn get_agent_activity(
dna_hash: DnaHash,
agent: AgentPubKey,
query: ChainQueryFilter,
options: GetActivityOptions,
) -> Vec<AgentActivityResponse<HeaderHash>>;
/// Send a validation receipt to a remote node.
fn send_validation_receipt(dna_hash: DnaHash, to_agent: AgentPubKey, receipt: SerializedBytes) -> ();
/// New data has been integrated and is ready for gossiping.
fn new_integrated_data(dna_hash: DnaHash) -> ();
/// Check if any local agent in this space is an authority for a hash.
fn authority_for_hash(dna_hash: DnaHash, dht_hash: AnyDhtHash) -> bool;
/// Response from an authority to agents that are
/// part of a session.
fn countersigning_authority_response(
dna_hash: DnaHash,
agents: Vec<AgentPubKey>,
signed_headers: Vec<SignedHeader>,
) -> ();
/// Dump network metrics.
fn dump_network_metrics(
dna_hash: Option<DnaHash>,
) -> String;
}
}
/// Convenience type for referring to the HolochainP2p GhostSender
pub type HolochainP2pRef = ghost_actor::GhostSender<HolochainP2p>;
/// Extension trait for converting GhostSender<HolochainP2p> into HolochainP2pDna
pub trait HolochainP2pRefToDna {
/// Partially apply dna_hash && agent_pub_key to this sender,
/// binding it to a specific dna context.
fn into_dna(self, dna_hash: DnaHash) -> crate::HolochainP2pDna;
/// Clone and partially apply dna_hash && agent_pub_key to this sender,
/// binding it to a specific dna context.
fn to_dna(&self, dna_hash: DnaHash) -> crate::HolochainP2pDna;
}
impl HolochainP2pRefToDna for HolochainP2pRef {
fn into_dna(self, dna_hash: DnaHash) -> crate::HolochainP2pDna {
crate::HolochainP2pDna {
sender: self,
dna_hash: Arc::new(dna_hash),
}
}
fn to_dna(&self, dna_hash: DnaHash) -> crate::HolochainP2pDna {
self.clone().into_dna(dna_hash)
}
}