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 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
use crate::ExternalApiWireError;
use holo_hash::AgentPubKey;
use holochain_keystore::LairResult;
use holochain_keystore::MetaLairClient;
use holochain_types::prelude::*;
use kitsune_p2p::dependencies::kitsune_p2p_fetch::FetchPoolInfo;
use std::collections::HashMap;
/// Represents the available conductor functions to call over an app interface
/// and will result in a corresponding [`AppResponse`] message being sent back over the
/// interface connection.
///
/// # Errors
///
/// Returns an [`AppResponse::Error`] with a reason why the request failed.
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, SerializedBytes)]
#[serde(rename_all = "snake_case", tag = "type", content = "data")]
pub enum AppRequest {
/// Get info about the app identified by the given `installed_app_id` argument,
/// including info about each cell installed by this app.
///
/// Requires `installed_app_id`, because an app interface can be the interface to multiple
/// apps at the same time.
///
/// # Returns
///
/// [`AppResponse::AppInfo`]
AppInfo {
/// The app ID for which to get information
installed_app_id: InstalledAppId,
},
/// Call a zome function. See [`ZomeCall`]
/// to understand the data that must be provided.
///
/// # Returns
///
/// [`AppResponse::ZomeCalled`]
CallZome(Box<ZomeCall>),
/// Clone a DNA (in the biological sense), thus creating a new `Cell`.
///
/// Using the provided, already-registered DNA, create a new DNA with a unique
/// ID and the specified properties, create a new cell from this cloned DNA,
/// and add the cell to the specified app.
///
/// # Returns
///
/// [`AppResponse::CloneCellCreated`]
CreateCloneCell(Box<CreateCloneCellPayload>),
/// Disable a clone cell.
///
/// Providing a [`CloneId`] or [`CellId`], disable an existing clone cell.
/// When the clone cell exists, it is disabled and can not be called any
/// longer. If it doesn't exist, the call is a no-op.
///
/// # Returns
///
/// [`AppResponse::CloneCellDisabled`] if the clone cell existed
/// and has been disabled.
DisableCloneCell(Box<DisableCloneCellPayload>),
/// Enable a clone cell that was previously disabled.
///
/// # Returns
///
/// [`AppResponse::CloneCellEnabled`]
EnableCloneCell(Box<EnableCloneCellPayload>),
/// Info about networking processes
///
/// # Returns
///
/// [`AppResponse::NetworkInfo`]
NetworkInfo(Box<NetworkInfoRequestPayload>),
/// List all host functions available to wasm on this conductor.
///
/// # Returns
///
/// [`AppResponse::ListWasmHostFunctions`]
ListWasmHostFunctions,
}
/// Represents the possible responses to an [`AppRequest`].
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, SerializedBytes)]
#[serde(rename_all = "snake_case", tag = "type", content = "data")]
pub enum AppResponse {
/// Can occur in response to any [`AppRequest`].
///
/// There has been an error during the handling of the request.
Error(ExternalApiWireError),
/// The succesful response to an [`AppRequest::AppInfo`].
///
/// Option will be `None` if there is no installed app with the given `installed_app_id`.
AppInfo(Option<AppInfo>),
/// The successful response to an [`AppRequest::CallZome`].
///
/// Note that [`ExternIO`] is simply a structure of [`struct@SerializedBytes`], so the client will have
/// to decode this response back into the data provided by the zome using a [msgpack] library to utilize it.
///
/// [msgpack]: https://msgpack.org/
ZomeCalled(Box<ExternIO>),
/// The successful response to an [`AppRequest::CreateCloneCell`].
///
/// The response contains the created clone [`ClonedCell`].
CloneCellCreated(ClonedCell),
/// The successful response to an [`AppRequest::DisableCloneCell`].
///
/// An existing clone cell has been disabled.
CloneCellDisabled,
/// The successful response to an [`AppRequest::EnableCloneCell`].
///
/// A previously disabled clone cell has been enabled. The [`ClonedCell`]
/// is returned.
CloneCellEnabled(ClonedCell),
/// NetworkInfo is returned
NetworkInfo(Vec<NetworkInfo>),
/// All the wasm host functions supported by this conductor.
ListWasmHostFunctions(Vec<String>),
}
/// The data provided over an app interface in order to make a zome call
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct ZomeCall {
/// The ID of the cell containing the zome to be called
pub cell_id: CellId,
/// The zome containing the function to be called
pub zome_name: ZomeName,
/// The name of the zome function to call
pub fn_name: FunctionName,
/// The serialized data to pass as an argument to the zome function call
pub payload: ExternIO,
/// The capability request authorization
///
/// This can be `None` and still succeed in the case where the function
/// in the zome being called has been given an `Unrestricted` status
/// via a `CapGrant`. Otherwise it will be necessary to provide a `CapSecret` for every call.
pub cap_secret: Option<CapSecret>,
/// The provenance (source) of the call
/// MUST match the signature.
pub provenance: AgentPubKey,
pub signature: Signature,
pub nonce: Nonce256Bits,
pub expires_at: Timestamp,
}
impl From<ZomeCall> for ZomeCallUnsigned {
fn from(zome_call: ZomeCall) -> Self {
Self {
cell_id: zome_call.cell_id,
zome_name: zome_call.zome_name,
fn_name: zome_call.fn_name,
payload: zome_call.payload,
cap_secret: zome_call.cap_secret,
provenance: zome_call.provenance,
nonce: zome_call.nonce,
expires_at: zome_call.expires_at,
}
}
}
impl ZomeCall {
pub async fn try_from_unsigned_zome_call(
keystore: &MetaLairClient,
unsigned_zome_call: ZomeCallUnsigned,
) -> LairResult<Self> {
let signature = unsigned_zome_call
.provenance
.sign_raw(
keystore,
unsigned_zome_call
.data_to_sign()
.map_err(|e| e.to_string())?,
)
.await?;
Ok(Self {
cell_id: unsigned_zome_call.cell_id,
zome_name: unsigned_zome_call.zome_name,
fn_name: unsigned_zome_call.fn_name,
payload: unsigned_zome_call.payload,
cap_secret: unsigned_zome_call.cap_secret,
provenance: unsigned_zome_call.provenance,
nonce: unsigned_zome_call.nonce,
expires_at: unsigned_zome_call.expires_at,
signature,
})
}
pub async fn resign_zome_call(
self,
keystore: &MetaLairClient,
agent_key: AgentPubKey,
) -> LairResult<Self> {
let zome_call_unsigned = ZomeCallUnsigned {
provenance: agent_key,
cell_id: self.cell_id,
zome_name: self.zome_name,
fn_name: self.fn_name,
cap_secret: self.cap_secret,
payload: self.payload,
nonce: self.nonce,
expires_at: self.expires_at,
};
ZomeCall::try_from_unsigned_zome_call(keystore, zome_call_unsigned).await
}
}
///
#[derive(Clone, Debug, Eq, PartialEq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum CellInfo {
/// Cells provisioned at app installation as defined in the bundle.
Provisioned(ProvisionedCell),
// Cells created at runtime by cloning provisioned cells.
Cloned(ClonedCell),
/// Potential cells with deferred installation as defined in the bundle.
/// Not yet implemented.
Stem(StemCell),
}
impl CellInfo {
pub fn new_provisioned(cell_id: CellId, dna_modifiers: DnaModifiers, name: String) -> Self {
Self::Provisioned(ProvisionedCell {
cell_id,
dna_modifiers,
name,
})
}
pub fn new_cloned(
cell_id: CellId,
clone_id: CloneId,
original_dna_hash: DnaHash,
dna_modifiers: DnaModifiers,
name: String,
enabled: bool,
) -> Self {
Self::Cloned(ClonedCell {
cell_id,
clone_id,
original_dna_hash,
dna_modifiers,
name,
enabled,
})
}
}
/// Cell whose instantiation has been deferred.
/// Not yet implemented.
#[derive(Clone, Debug, Eq, PartialEq, serde::Serialize, serde::Deserialize)]
pub struct StemCell {
/// The hash of the DNA that this cell would be instantiated from
pub original_dna_hash: DnaHash,
/// The DNA modifiers that will be used when instantiating the cell
pub dna_modifiers: DnaModifiers,
/// An optional name to override the cell's bundle name when instantiating
pub name: Option<String>,
}
/// Provisioned cell, a cell instantiated from a DNA on app installation.
#[derive(Clone, Debug, Eq, PartialEq, serde::Serialize, serde::Deserialize)]
pub struct ProvisionedCell {
/// The cell's identifying data
pub cell_id: CellId,
/// The DNA modifiers that were used to instantiate the cell
pub dna_modifiers: DnaModifiers,
/// The name the cell was instantiated with
pub name: String,
}
// Export moved type to avoid breaking the crate API here.
pub use holochain_zome_types::prelude::ClonedCell;
/// Info about an installed app, returned as part of [`AppResponse::AppInfo`]
#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize, SerializedBytes)]
pub struct AppInfo {
/// The unique identifier for an installed app in this conductor
pub installed_app_id: InstalledAppId,
/// Info about the cells installed in this app. Lists of cells are ordered
/// and contain first the provisioned cell, then enabled clone cells and
/// finally disabled clone cells.
pub cell_info: HashMap<RoleName, Vec<CellInfo>>,
/// The app's current status, in an API-friendly format
pub status: AppInfoStatus,
/// The app's agent pub key.
pub agent_pub_key: AgentPubKey,
/// The original AppManifest used to install the app, which can also be used to
/// install the app again under a new agent.
pub manifest: AppManifest,
}
impl AppInfo {
pub fn from_installed_app(
app: &InstalledApp,
dna_definitions: &HashMap<CellId, DnaDefHashed>,
) -> Self {
let installed_app_id = app.id().clone();
let status = app.status().clone().into();
let agent_pub_key = app.agent_key().to_owned();
let mut manifest = app.manifest().clone();
let mut cell_info: HashMap<RoleName, Vec<CellInfo>> = HashMap::new();
app.roles().iter().for_each(|(role_name, role_assignment)| {
// create a vector with info of all cells for this role
let mut cell_info_for_role: Vec<CellInfo> = Vec::new();
// push the base cell to the vector of cell infos
if let Some(provisioned_cell) = role_assignment.provisioned_cell() {
if let Some(dna_def) = dna_definitions.get(provisioned_cell) {
// TODO: populate `enabled` with cell state once it is implemented for a base cell
let cell_info = CellInfo::new_provisioned(
provisioned_cell.clone(),
dna_def.modifiers.to_owned(),
dna_def.name.to_owned(),
);
cell_info_for_role.push(cell_info);
// Update the manifest with the installed hash
match &mut manifest {
AppManifest::V1(manifest) => {
if let Some(role) =
manifest.roles.iter_mut().find(|r| r.name == *role_name)
{
role.dna.installed_hash = Some(dna_def.hash.clone().into());
}
}
}
} else {
tracing::error!("no DNA definition found for cell id {}", provisioned_cell);
}
} else {
// no provisioned cell, thus there must be a deferred cell
// this is not implemented as of now
unimplemented!()
};
// push enabled clone cells to the vector of cell infos
if let Some(clone_cells) = app.clone_cells_for_role_name(role_name) {
clone_cells.iter().for_each(|(clone_id, cell_id)| {
if let Some(dna_def) = dna_definitions.get(cell_id) {
let cell_info = CellInfo::new_cloned(
cell_id.to_owned(),
clone_id.to_owned(),
dna_def.hash.to_owned(),
dna_def.modifiers.to_owned(),
dna_def.name.to_owned(),
true,
);
cell_info_for_role.push(cell_info);
} else {
tracing::error!("no DNA definition found for cell id {}", cell_id);
}
});
}
// push disabled clone cells to the vector of cell infos
if let Some(clone_cells) = app.disabled_clone_cells_for_role_name(role_name) {
clone_cells.iter().for_each(|(clone_id, cell_id)| {
if let Some(dna_def) = dna_definitions.get(cell_id) {
let cell_info = CellInfo::new_cloned(
cell_id.to_owned(),
clone_id.to_owned(),
dna_def.hash.to_owned(),
dna_def.modifiers.to_owned(),
dna_def.name.to_owned(),
false,
);
cell_info_for_role.push(cell_info);
} else {
tracing::error!("no DNA definition found for cell id {}", cell_id);
}
});
}
cell_info.insert(role_name.clone(), cell_info_for_role);
});
Self {
installed_app_id,
cell_info,
status,
agent_pub_key,
manifest,
}
}
}
/// A flat, slightly more API-friendly representation of [`AppInfo`]
#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize, SerializedBytes)]
#[serde(rename_all = "snake_case")]
pub enum AppInfoStatus {
Paused { reason: PausedAppReason },
Disabled { reason: DisabledAppReason },
Running,
}
impl From<AppStatus> for AppInfoStatus {
fn from(i: AppStatus) -> Self {
match i {
AppStatus::Running => AppInfoStatus::Running,
AppStatus::Disabled(reason) => AppInfoStatus::Disabled { reason },
AppStatus::Paused(reason) => AppInfoStatus::Paused { reason },
}
}
}
impl From<AppInfoStatus> for AppStatus {
fn from(i: AppInfoStatus) -> Self {
match i {
AppInfoStatus::Running => AppStatus::Running,
AppInfoStatus::Disabled { reason } => AppStatus::Disabled(reason),
AppInfoStatus::Paused { reason } => AppStatus::Paused(reason),
}
}
}
#[derive(Clone, Debug, PartialEq, serde::Serialize, serde::Deserialize, SerializedBytes)]
pub struct NetworkInfo {
pub fetch_pool_info: FetchPoolInfo,
pub current_number_of_peers: u32,
pub arc_size: f64,
pub total_network_peers: u32,
pub bytes_since_last_time_queried: u64,
pub completed_rounds_since_last_time_queried: u32,
}
#[test]
fn status_serialization() {
use kitsune_p2p::dependencies::kitsune_p2p_types::dependencies::serde_json;
let status: AppInfoStatus =
AppStatus::Disabled(DisabledAppReason::Error("because".into())).into();
assert_eq!(
serde_json::to_string(&status).unwrap(),
"{\"disabled\":{\"reason\":{\"error\":\"because\"}}}"
);
let status: AppInfoStatus = AppStatus::Paused(PausedAppReason::Error("because".into())).into();
assert_eq!(
serde_json::to_string(&status).unwrap(),
"{\"paused\":{\"reason\":{\"error\":\"because\"}}}"
);
let status: AppInfoStatus = AppStatus::Disabled(DisabledAppReason::User).into();
assert_eq!(
serde_json::to_string(&status).unwrap(),
"{\"disabled\":{\"reason\":\"user\"}}"
);
}