comments_integrity/lib.rs
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
pub mod commented_to_comments;
pub use commented_to_comments::*;
pub mod comment;
pub use comment::*;
use hdi::prelude::*;
#[derive(Serialize, Deserialize)]
#[serde(tag = "type")]
#[hdk_entry_types]
#[unit_enum(UnitEntryTypes)]
pub enum EntryTypes {
Comment(Comment),
}
#[derive(Serialize, Deserialize)]
#[hdk_link_types]
pub enum LinkTypes {
CommentToComments,
CommentUpdates,
CommentedToComments,
}
// Validation you perform during the genesis process. Nobody else on the network performs it, only you.
// There *is no* access to network calls in this callback
#[hdk_extern]
pub fn genesis_self_check(_data: GenesisSelfCheckData) -> ExternResult<ValidateCallbackResult> {
Ok(ValidateCallbackResult::Valid)
}
// Validation the network performs when you try to join, you can't perform this validation yourself as you are not a member yet.
// There *is* access to network calls in this function
pub fn validate_agent_joining(
_agent_pub_key: AgentPubKey,
_membrane_proof: &Option<MembraneProof>,
) -> ExternResult<ValidateCallbackResult> {
Ok(ValidateCallbackResult::Valid)
}
// This is the unified validation callback for all entries and link types in this integrity zome
// Below is a match template for all of the variants of `DHT Ops` and entry and link types
// Holochain has already performed the following validation for you:
// - The action signature matches on the hash of its content and is signed by its author
// - The previous action exists, has a lower timestamp than the new action, and incremented sequence number
// - The previous action author is the same as the new action author
// - The timestamp of each action is after the DNA's origin time
// - AgentActivity authorities check that the agent hasn't forked their chain
// - The entry hash in the action matches the entry content
// - The entry type in the action matches the entry content
// - The entry size doesn't exceed the maximum entry size (currently 4MB)
// - Private entry types are not included in the Op content, and public entry types are
// - If the `Op` is an update or a delete, the original action exists and is a `Create` or `Update` action
// - If the `Op` is an update, the original entry exists and is of the same type as the new one
// - If the `Op` is a delete link, the original action exists and is a `CreateLink` action
// - Link tags don't exceed the maximum tag size (currently 1KB)
// - Countersigned entries include an action from each required signer
// You can read more about validation here: https://docs.rs/hdi/latest/hdi/index.html#data-validation
#[hdk_extern]
pub fn validate(op: Op) -> ExternResult<ValidateCallbackResult> {
match op.flattened::<EntryTypes, LinkTypes>()? {
FlatOp::StoreEntry(store_entry) => match store_entry {
OpEntry::CreateEntry { app_entry, action } => match app_entry {
EntryTypes::Comment(comment) => {
validate_create_comment(EntryCreationAction::Create(action), comment)
}
},
OpEntry::UpdateEntry {
app_entry, action, ..
} => match app_entry {
EntryTypes::Comment(comment) => {
validate_create_comment(EntryCreationAction::Update(action), comment)
}
},
_ => Ok(ValidateCallbackResult::Valid),
},
FlatOp::RegisterUpdate(update_entry) => match update_entry {
OpUpdate::Entry { app_entry, action } => {
let original_action = must_get_action(action.clone().original_action_address)?
.action()
.to_owned();
let original_create_action = match EntryCreationAction::try_from(original_action) {
Ok(action) => action,
Err(e) => {
return Ok(ValidateCallbackResult::Invalid(format!(
"Expected to get EntryCreationAction from Action: {e:?}"
)));
}
};
match app_entry {
EntryTypes::Comment(comment) => {
let original_app_entry =
must_get_valid_record(action.clone().original_action_address)?;
let original_comment = match Comment::try_from(original_app_entry) {
Ok(entry) => entry,
Err(e) => {
return Ok(ValidateCallbackResult::Invalid(format!(
"Expected to get Comment from Record: {e:?}"
)));
}
};
validate_update_comment(
action,
comment,
original_create_action,
original_comment,
)
}
}
}
_ => Ok(ValidateCallbackResult::Valid),
},
FlatOp::RegisterDelete(delete_entry) => {
let original_action_hash = delete_entry.clone().action.deletes_address;
let original_record = must_get_valid_record(original_action_hash)?;
let original_record_action = original_record.action().clone();
let original_action = match EntryCreationAction::try_from(original_record_action) {
Ok(action) => action,
Err(e) => {
return Ok(ValidateCallbackResult::Invalid(format!(
"Expected to get EntryCreationAction from Action: {e:?}"
)));
}
};
let app_entry_type = match original_action.entry_type() {
EntryType::App(app_entry_type) => app_entry_type,
_ => {
return Ok(ValidateCallbackResult::Valid);
}
};
let entry = match original_record.entry().as_option() {
Some(entry) => entry,
None => {
return Ok(ValidateCallbackResult::Invalid(
"Original record for a delete must contain an entry".to_string(),
));
}
};
let original_app_entry = match EntryTypes::deserialize_from_type(
app_entry_type.zome_index,
app_entry_type.entry_index,
entry,
)? {
Some(app_entry) => app_entry,
None => {
return Ok(ValidateCallbackResult::Invalid(
"Original app entry must be one of the defined entry types for this zome"
.to_string(),
));
}
};
match original_app_entry {
EntryTypes::Comment(original_comment) => validate_delete_comment(
delete_entry.clone().action,
original_action,
original_comment,
),
}
}
FlatOp::RegisterCreateLink {
link_type,
base_address,
target_address,
tag,
action,
} => match link_type {
LinkTypes::CommentToComments => {
validate_create_link_comment_to_comments(action, base_address, target_address, tag)
}
LinkTypes::CommentUpdates => {
validate_create_link_comment_updates(action, base_address, target_address, tag)
}
LinkTypes::CommentedToComments => validate_create_link_commented_to_comments(
action,
base_address,
target_address,
tag,
),
},
FlatOp::RegisterDeleteLink {
link_type,
base_address,
target_address,
tag,
original_action,
action,
} => match link_type {
LinkTypes::CommentToComments => validate_delete_link_comment_to_comments(
action,
original_action,
base_address,
target_address,
tag,
),
LinkTypes::CommentUpdates => validate_delete_link_comment_updates(
action,
original_action,
base_address,
target_address,
tag,
),
LinkTypes::CommentedToComments => validate_delete_link_commented_to_comments(
action,
original_action,
base_address,
target_address,
tag,
),
},
FlatOp::StoreRecord(store_record) => {
match store_record {
// Complementary validation to the `StoreEntry` Op, in which the record itself is validated
// If you want to optimize performance, you can remove the validation for an entry type here and keep it in `StoreEntry`
// Notice that doing so will cause `must_get_valid_record` for this record to return a valid record even if the `StoreEntry` validation failed
OpRecord::CreateEntry { app_entry, action } => match app_entry {
EntryTypes::Comment(comment) => {
validate_create_comment(EntryCreationAction::Create(action), comment)
}
},
// Complementary validation to the `RegisterUpdate` Op, in which the record itself is validated
// If you want to optimize performance, you can remove the validation for an entry type here and keep it in `StoreEntry` and in `RegisterUpdate`
// Notice that doing so will cause `must_get_valid_record` for this record to return a valid record even if the other validations failed
OpRecord::UpdateEntry {
original_action_hash,
app_entry,
action,
..
} => {
let original_record = must_get_valid_record(original_action_hash)?;
let original_action = original_record.action().clone();
let original_action = match original_action {
Action::Create(create) => EntryCreationAction::Create(create),
Action::Update(update) => EntryCreationAction::Update(update),
_ => {
return Ok(ValidateCallbackResult::Invalid(
"Original action for an update must be a Create or Update action"
.to_string(),
));
}
};
match app_entry {
EntryTypes::Comment(comment) => {
let result = validate_create_comment(
EntryCreationAction::Update(action.clone()),
comment.clone(),
)?;
if let ValidateCallbackResult::Valid = result {
let original_comment: Option<Comment> = original_record
.entry()
.to_app_option()
.map_err(|e| wasm_error!(e))?;
let original_comment = match original_comment {
Some(comment) => comment,
None => {
return Ok(
ValidateCallbackResult::Invalid(
"The updated entry type must be the same as the original entry type"
.to_string(),
),
);
}
};
validate_update_comment(
action,
comment,
original_action,
original_comment,
)
} else {
Ok(result)
}
}
}
}
// Complementary validation to the `RegisterDelete` Op, in which the record itself is validated
// If you want to optimize performance, you can remove the validation for an entry type here and keep it in `RegisterDelete`
// Notice that doing so will cause `must_get_valid_record` for this record to return a valid record even if the `RegisterDelete` validation failed
OpRecord::DeleteEntry {
original_action_hash,
action,
..
} => {
let original_record = must_get_valid_record(original_action_hash)?;
let original_action = original_record.action().clone();
let original_action = match original_action {
Action::Create(create) => EntryCreationAction::Create(create),
Action::Update(update) => EntryCreationAction::Update(update),
_ => {
return Ok(ValidateCallbackResult::Invalid(
"Original action for a delete must be a Create or Update action"
.to_string(),
));
}
};
let app_entry_type = match original_action.entry_type() {
EntryType::App(app_entry_type) => app_entry_type,
_ => {
return Ok(ValidateCallbackResult::Valid);
}
};
let entry = match original_record.entry().as_option() {
Some(entry) => entry,
None => {
return Ok(ValidateCallbackResult::Invalid(
"Original record for a delete must contain an entry".to_string(),
));
}
};
let original_app_entry = match EntryTypes::deserialize_from_type(
app_entry_type.zome_index,
app_entry_type.entry_index,
entry,
)? {
Some(app_entry) => app_entry,
None => {
return Ok(
ValidateCallbackResult::Invalid(
"Original app entry must be one of the defined entry types for this zome"
.to_string(),
),
);
}
};
match original_app_entry {
EntryTypes::Comment(original_comment) => {
validate_delete_comment(action, original_action, original_comment)
}
}
}
// Complementary validation to the `RegisterCreateLink` Op, in which the record itself is validated
// If you want to optimize performance, you can remove the validation for an entry type here and keep it in `RegisterCreateLink`
// Notice that doing so will cause `must_get_valid_record` for this record to return a valid record even if the `RegisterCreateLink` validation failed
OpRecord::CreateLink {
base_address,
target_address,
tag,
link_type,
action,
} => match link_type {
LinkTypes::CommentToComments => validate_create_link_comment_to_comments(
action,
base_address,
target_address,
tag,
),
LinkTypes::CommentUpdates => validate_create_link_comment_updates(
action,
base_address,
target_address,
tag,
),
LinkTypes::CommentedToComments => validate_create_link_commented_to_comments(
action,
base_address,
target_address,
tag,
),
},
// Complementary validation to the `RegisterDeleteLink` Op, in which the record itself is validated
// If you want to optimize performance, you can remove the validation for an entry type here and keep it in `RegisterDeleteLink`
// Notice that doing so will cause `must_get_valid_record` for this record to return a valid record even if the `RegisterDeleteLink` validation failed
OpRecord::DeleteLink {
original_action_hash,
base_address,
action,
} => {
let record = must_get_valid_record(original_action_hash)?;
let create_link = match record.action() {
Action::CreateLink(create_link) => create_link.clone(),
_ => {
return Ok(ValidateCallbackResult::Invalid(
"The action that a DeleteLink deletes must be a CreateLink"
.to_string(),
));
}
};
let link_type = match LinkTypes::from_type(
create_link.zome_index,
create_link.link_type,
)? {
Some(lt) => lt,
None => {
return Ok(ValidateCallbackResult::Valid);
}
};
match link_type {
LinkTypes::CommentToComments => validate_delete_link_comment_to_comments(
action,
create_link.clone(),
base_address,
create_link.target_address,
create_link.tag,
),
LinkTypes::CommentUpdates => validate_delete_link_comment_updates(
action,
create_link.clone(),
base_address,
create_link.target_address,
create_link.tag,
),
LinkTypes::CommentedToComments => {
validate_delete_link_commented_to_comments(
action,
create_link.clone(),
base_address,
create_link.target_address,
create_link.tag,
)
}
}
}
OpRecord::CreatePrivateEntry { .. } => Ok(ValidateCallbackResult::Valid),
OpRecord::UpdatePrivateEntry { .. } => Ok(ValidateCallbackResult::Valid),
OpRecord::CreateCapClaim { .. } => Ok(ValidateCallbackResult::Valid),
OpRecord::CreateCapGrant { .. } => Ok(ValidateCallbackResult::Valid),
OpRecord::UpdateCapClaim { .. } => Ok(ValidateCallbackResult::Valid),
OpRecord::UpdateCapGrant { .. } => Ok(ValidateCallbackResult::Valid),
OpRecord::Dna { .. } => Ok(ValidateCallbackResult::Valid),
OpRecord::OpenChain { .. } => Ok(ValidateCallbackResult::Valid),
OpRecord::CloseChain { .. } => Ok(ValidateCallbackResult::Valid),
OpRecord::InitZomesComplete { .. } => Ok(ValidateCallbackResult::Valid),
_ => Ok(ValidateCallbackResult::Valid),
}
}
FlatOp::RegisterAgentActivity(agent_activity) => match agent_activity {
OpActivity::CreateAgent { agent, action } => {
let previous_action = must_get_action(action.prev_action)?;
match previous_action.action() {
Action::AgentValidationPkg(
AgentValidationPkg { membrane_proof, .. },
) => validate_agent_joining(agent, membrane_proof),
_ => {
Ok(
ValidateCallbackResult::Invalid(
"The previous action for a `CreateAgent` action must be an `AgentValidationPkg`"
.to_string(),
),
)
}
}
}
_ => Ok(ValidateCallbackResult::Valid),
},
}
}