grovedb-version 5.0.0

Versioning library for Platform
Documentation 
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

use versioned_feature_core::FeatureVersion;

#[derive(Clone, Debug, Default)]
pub struct GroveDBVersions {
    pub apply_batch: GroveDBApplyBatchVersions,
    pub element: GroveDBElementMethodVersions,
    pub operations: GroveDBOperationsVersions,
    pub aggregate_sum_path_query_methods: GroveDBAggregateSumPathQueryMethodVersions,
    pub path_query_methods: GroveDBPathQueryMethodVersions,
    pub replication: GroveDBReplicationVersions,
    pub query_limits: GroveDBQueryLimits,
}

#[derive(Clone, Debug)]
pub struct GroveDBQueryLimits {
    pub max_aggregate_sum_query_elements_scanned: u16,
}

impl Default for GroveDBQueryLimits {
    fn default() -> Self {
        Self {
            max_aggregate_sum_query_elements_scanned: 1024,
        }
    }
}

#[derive(Clone, Debug, Default)]
pub struct GroveDBAggregateSumPathQueryMethodVersions {
    pub merge: FeatureVersion,
}

#[derive(Clone, Debug, Default)]
pub struct GroveDBPathQueryMethodVersions {
    pub terminal_keys: FeatureVersion,
    pub merge: FeatureVersion,
    pub query_items_at_path: FeatureVersion,
    pub should_add_parent_tree_at_path: FeatureVersion,
}

#[derive(Clone, Debug, Default)]
pub struct GroveDBApplyBatchVersions {
    pub apply_batch_structure: FeatureVersion,
    pub apply_body: FeatureVersion,
    pub continue_partial_apply_body: FeatureVersion,
    pub apply_operations_without_batching: FeatureVersion,
    pub apply_batch: FeatureVersion,
    pub apply_partial_batch: FeatureVersion,
    pub open_batch_transactional_merk_at_path: FeatureVersion,
    pub open_batch_merk_at_path: FeatureVersion,
    pub apply_batch_with_element_flags_update: FeatureVersion,
    pub apply_partial_batch_with_element_flags_update: FeatureVersion,
    pub estimated_case_operations_for_batch: FeatureVersion,
}

#[derive(Clone, Debug, Default)]
pub struct GroveDBOperationsVersions {
    pub get: GroveDBOperationsGetVersions,
    pub insert: GroveDBOperationsInsertVersions,
    pub delete: GroveDBOperationsDeleteVersions,
    pub delete_up_tree: GroveDBOperationsDeleteUpTreeVersions,
    pub query: GroveDBOperationsQueryVersions,
    pub proof: GroveDBOperationsProofVersions,
    pub average_case: GroveDBOperationsAverageCaseVersions,
    pub worst_case: GroveDBOperationsWorstCaseVersions,
}

#[derive(Clone, Debug, Default)]
pub struct GroveDBOperationsGetVersions {
    pub get: FeatureVersion,
    pub get_caching_optional: FeatureVersion,
    pub follow_reference: FeatureVersion,
    pub follow_reference_once: FeatureVersion,
    pub get_raw: FeatureVersion,
    pub get_raw_caching_optional: FeatureVersion,
    pub get_raw_optional: FeatureVersion,
    pub get_raw_optional_caching_optional: FeatureVersion,
    pub has_raw: FeatureVersion,
    pub check_subtree_exists_invalid_path: FeatureVersion,
    pub average_case_for_has_raw: FeatureVersion,
    pub average_case_for_has_raw_tree: FeatureVersion,
    pub average_case_for_get_raw: FeatureVersion,
    pub average_case_for_get: FeatureVersion,
    pub average_case_for_get_tree: FeatureVersion,
    pub worst_case_for_has_raw: FeatureVersion,
    pub worst_case_for_get_raw: FeatureVersion,
    pub worst_case_for_get: FeatureVersion,
    pub is_empty_tree: FeatureVersion,
}

#[derive(Clone, Debug, Default)]
pub struct GroveDBOperationsProofVersions {
    pub prove_query: FeatureVersion,
    pub prove_query_many: FeatureVersion,
    pub prove_query_non_serialized: FeatureVersion,
    pub prove_trunk_chunk: FeatureVersion,
    pub prove_trunk_chunk_non_serialized: FeatureVersion,
    pub prove_branch_chunk: FeatureVersion,
    pub prove_branch_chunk_non_serialized: FeatureVersion,
    pub verify_query_with_options: FeatureVersion,
    pub verify_query_raw: FeatureVersion,
    pub verify_layer_proof: FeatureVersion,
    pub verify_query: FeatureVersion,
    pub verify_subset_query: FeatureVersion,
    pub verify_query_with_absence_proof: FeatureVersion,
    pub verify_subset_query_with_absence_proof: FeatureVersion,
    pub verify_query_with_chained_path_queries: FeatureVersion,
    pub verify_query_get_parent_tree_info_with_options: FeatureVersion,
}

#[derive(Clone, Debug, Default)]
pub struct GroveDBOperationsQueryVersions {
    pub query_encoded_many: FeatureVersion,
    pub query_many_raw: FeatureVersion,
    pub get_proved_path_query: FeatureVersion,
    pub query: FeatureVersion,
    pub query_item_value: FeatureVersion,
    pub query_item_value_or_sum: FeatureVersion,
    pub query_aggregate_sums: FeatureVersion,
    pub query_aggregate_count_on_range: FeatureVersion,
    pub query_aggregate_sum_on_range: FeatureVersion,
    pub query_aggregate_count_and_sum_on_range: FeatureVersion,
    pub query_sums: FeatureVersion,
    pub query_raw: FeatureVersion,
    pub query_keys_optional: FeatureVersion,
    pub query_raw_keys_optional: FeatureVersion,
    pub follow_element: FeatureVersion,
}

#[derive(Clone, Debug, Default)]
pub struct GroveDBOperationsAverageCaseVersions {
    pub add_average_case_get_merk_at_path: FeatureVersion,
    pub average_case_merk_replace_tree: FeatureVersion,
    pub average_case_merk_insert_tree: FeatureVersion,
    pub average_case_merk_delete_tree: FeatureVersion,
    pub average_case_merk_insert_element: FeatureVersion,
    pub average_case_merk_replace_element: FeatureVersion,
    pub average_case_merk_patch_element: FeatureVersion,
    pub average_case_merk_delete_element: FeatureVersion,
    pub add_average_case_has_raw_cost: FeatureVersion,
    pub add_average_case_has_raw_tree_cost: FeatureVersion,
    pub add_average_case_get_raw_cost: FeatureVersion,
    pub add_average_case_get_raw_tree_cost: FeatureVersion,
    pub add_average_case_get_cost: FeatureVersion,
}

#[derive(Clone, Debug, Default)]
pub struct GroveDBOperationsWorstCaseVersions {
    pub add_worst_case_get_merk_at_path: FeatureVersion,
    pub worst_case_merk_replace_tree: FeatureVersion,
    pub worst_case_merk_insert_tree: FeatureVersion,
    pub worst_case_merk_delete_tree: FeatureVersion,
    pub worst_case_merk_insert_element: FeatureVersion,
    pub worst_case_merk_replace_element: FeatureVersion,
    pub worst_case_merk_patch_element: FeatureVersion,
    pub worst_case_merk_delete_element: FeatureVersion,
    pub add_worst_case_has_raw_cost: FeatureVersion,
    pub add_worst_case_get_raw_tree_cost: FeatureVersion,
    pub add_worst_case_get_raw_cost: FeatureVersion,
    pub add_worst_case_get_cost: FeatureVersion,
}

#[derive(Clone, Debug, Default)]
pub struct GroveDBOperationsInsertVersions {
    pub insert: FeatureVersion,
    pub insert_on_transaction: FeatureVersion,
    pub insert_without_transaction: FeatureVersion,
    pub add_element_on_transaction: FeatureVersion,
    pub add_element_without_transaction: FeatureVersion,
    pub insert_if_not_exists: FeatureVersion,
    pub insert_if_not_exists_return_existing_element: FeatureVersion,
    pub insert_if_changed_value: FeatureVersion,
}

#[derive(Clone, Debug, Default)]
pub struct GroveDBOperationsDeleteVersions {
    pub delete: FeatureVersion,
    pub clear_subtree: FeatureVersion,
    pub delete_with_sectional_storage_function: FeatureVersion,
    pub delete_if_empty_tree: FeatureVersion,
    pub delete_if_empty_tree_with_sectional_storage_function: FeatureVersion,
    pub delete_operation_for_delete_internal: FeatureVersion,
    pub delete_internal_on_transaction: FeatureVersion,
    pub delete_internal_without_transaction: FeatureVersion,
    pub average_case_delete_operation_for_delete: FeatureVersion,
    pub worst_case_delete_operation_for_delete: FeatureVersion,
}

#[derive(Clone, Debug, Default)]
pub struct GroveDBOperationsDeleteUpTreeVersions {
    pub delete_up_tree_while_empty: FeatureVersion,
    pub delete_up_tree_while_empty_with_sectional_storage: FeatureVersion,
    pub delete_operations_for_delete_up_tree_while_empty: FeatureVersion,
    pub add_delete_operations_for_delete_up_tree_while_empty: FeatureVersion,
    pub average_case_delete_operations_for_delete_up_tree_while_empty: FeatureVersion,
    pub worst_case_delete_operations_for_delete_up_tree_while_empty: FeatureVersion,
}

#[derive(Clone, Debug, Default)]
pub struct GroveDBOperationsApplyBatchVersions {
    pub apply_batch_structure: FeatureVersion,
    pub apply_body: FeatureVersion,
    pub continue_partial_apply_body: FeatureVersion,
    pub apply_operations_without_batching: FeatureVersion,
    pub apply_batch: FeatureVersion,
    pub apply_partial_batch: FeatureVersion,
    pub open_batch_transactional_merk_at_path: FeatureVersion,
    pub open_batch_merk_at_path: FeatureVersion,
    pub apply_batch_with_element_flags_update: FeatureVersion,
    pub apply_partial_batch_with_element_flags_update: FeatureVersion,
    pub estimated_case_operations_for_batch: FeatureVersion,
}

#[derive(Clone, Debug, Default)]
pub struct GroveDBElementMethodVersions {
    pub delete: FeatureVersion,
    pub delete_with_sectioned_removal_bytes: FeatureVersion,
    pub delete_into_batch_operations: FeatureVersion,
    pub element_at_key_already_exists: FeatureVersion,
    pub get: FeatureVersion,
    pub get_optional: FeatureVersion,
    pub get_from_storage: FeatureVersion,
    pub get_optional_from_storage: FeatureVersion,
    pub get_with_absolute_refs: FeatureVersion,
    pub get_value_hash: FeatureVersion,
    pub get_with_value_hash: FeatureVersion,
    pub get_specialized_cost: FeatureVersion,
    pub value_defined_cost: FeatureVersion,
    pub value_defined_cost_for_serialized_value: FeatureVersion,
    pub specialized_costs_for_key_value: FeatureVersion,
    pub required_item_space: FeatureVersion,
    pub required_item_with_sum_item_space: FeatureVersion,
    pub required_reference_with_sum_item_space: FeatureVersion,
    pub insert: FeatureVersion,
    pub insert_into_batch_operations: FeatureVersion,
    pub insert_if_not_exists: FeatureVersion,
    pub insert_if_not_exists_into_batch_operations: FeatureVersion,
    pub insert_if_changed_value: FeatureVersion,
    pub insert_if_changed_value_into_batch_operations: FeatureVersion,
    pub insert_reference: FeatureVersion,
    pub insert_reference_into_batch_operations: FeatureVersion,
    pub insert_reference_if_changed_value: FeatureVersion,
    pub insert_subtree: FeatureVersion,
    pub insert_subtree_into_batch_operations: FeatureVersion,
    pub get_query: FeatureVersion,
    pub get_aggregate_sum_query: FeatureVersion,
    pub get_query_values: FeatureVersion,
    pub get_query_apply_function: FeatureVersion,
    pub get_path_query: FeatureVersion,
    pub get_sized_query: FeatureVersion,
    pub get_aggregate_sum_query_apply_function: FeatureVersion,
    pub path_query_push: FeatureVersion,
    pub aggregate_sum_path_query_push: FeatureVersion,
    pub query_item: FeatureVersion,
    pub basic_push: FeatureVersion,
    pub basic_aggregate_sum_push: FeatureVersion,
    // AUDIT NOTE (issue #717 — intentional, do not re-flag): the element
    // serialize/serialized_size/deserialize codec versions are `0` for EVERY
    // protocol version (v1/v2/v3), and that is correct. Element bincode
    // encoding is protocol-INDEPENDENT: each variant's discriminant is fixed by
    // declaration order and new variants are only ever *appended* (see the
    // append-only discriminant contract in `grovedb-element/src/element_type.rs`
    // and the `ProvableSumTree`/`ProvableCountProvableSumTree` notes in
    // `element/mod.rs`). A newer variant therefore serializes and deserializes
    // identically regardless of the protocol version constant, so there is no
    // "newer variant serialized under an older format" hazard. These codec
    // versions are a cost-accounting selector, NOT a wire-format gate — bumping
    // them for new variants would break the append-only compatibility contract.
    // Whether a given protocol should *construct* a newer variant at all is a
    // concern for the higher-level insert/validation logic, not for this codec,
    // which deliberately stays version-agnostic.
    pub serialize: FeatureVersion,
    pub serialized_size: FeatureVersion,
    pub deserialize: FeatureVersion,
    pub aggregate_sum_query_item: FeatureVersion,
}

#[derive(Clone, Debug, Default)]
pub struct GroveDBReplicationVersions {
    pub get_subtrees_metadata: FeatureVersion,
    pub fetch_chunk: FeatureVersion,
    pub start_snapshot_syncing: FeatureVersion,
    pub apply_chunk: FeatureVersion,
}