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
use proc_macro2::TokenStream;
use quote::quote;
pub fn initial_cargo_toml(zome_name: &str) -> String {
format!(
r#"[package]
name = "{zome_name}"
version = "0.0.1"
edition = "2021"
[lib]
crate-type = ["cdylib", "rlib"]
name = "{zome_name}"
[dependencies]
hdi = {{ workspace = true }}
serde = {{ workspace = true }}
"#,
)
}
pub fn initial_lib_rs() -> TokenStream {
quote! {
use hdi::prelude::*;
/// 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::<(), ()>()? {
FlatOp::StoreEntry(store_entry) => match store_entry {
OpEntry::CreateEntry {
app_entry,
action,
} => Ok(ValidateCallbackResult::Invalid(
"There are no entry types in this integrity zome".to_string(),
)),
OpEntry::UpdateEntry {
app_entry,
action,
..
} => Ok(ValidateCallbackResult::Invalid(
"There are no entry types in this integrity zome".to_string(),
)),
_ => Ok(ValidateCallbackResult::Valid)
},
FlatOp::RegisterUpdate(update_entry) => match update_entry {
OpUpdate::Entry { app_entry, action } => {
Ok(ValidateCallbackResult::Invalid(
"There are no entry types in this integrity zome".to_string(),
))
},
_ => Ok(ValidateCallbackResult::Valid)
},
FlatOp::RegisterDelete(delete_entry) => Ok(ValidateCallbackResult::Invalid(
"There are no entry types in this integrity zome".to_string(),
)),
FlatOp::RegisterCreateLink {
link_type,
base_address,
target_address,
tag,
action
} => Ok(ValidateCallbackResult::Invalid(
"There are no link types in this integrity zome".to_string()
)),
FlatOp::RegisterDeleteLink {
link_type,
base_address,
target_address,
tag,
original_action,
action
} => Ok(ValidateCallbackResult::Invalid("There are no link types in this integrity zome".to_string())),
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
} => Ok(ValidateCallbackResult::Invalid("There are no entry types in this integrity zome".to_string())),
/// 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,
..
} => Ok(ValidateCallbackResult::Invalid("There are no entry types in this integrity zome".to_string())),
/// 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,
..
} => Ok(ValidateCallbackResult::Invalid("There are no entry types in this integrity zome".to_string())),
/// 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
} => Ok(ValidateCallbackResult::Invalid("There are no link types in this integrity zome".to_string())),
/// 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
} => Ok(ValidateCallbackResult::Invalid("There are no link types in this integrity zome".to_string())),
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)
},
}
}
}
}