Skip to main content

platform_version/version/drive_versions/
v9.rs

1use crate::version::drive_versions::drive_address_funds_method_versions::v2::DRIVE_ADDRESS_FUNDS_METHOD_VERSIONS_V2;
2use crate::version::drive_versions::drive_contract_group_method_versions::v1::DRIVE_CONTRACT_GROUP_METHOD_VERSIONS_V1;
3use crate::version::drive_versions::drive_contract_method_versions::v4::DRIVE_CONTRACT_METHOD_VERSIONS_V4;
4use crate::version::drive_versions::drive_credit_pool_method_versions::v1::CREDIT_POOL_METHOD_VERSIONS_V1;
5use crate::version::drive_versions::drive_document_method_versions::v4::DRIVE_DOCUMENT_METHOD_VERSIONS_V4;
6use crate::version::drive_versions::drive_group_method_versions::v1::DRIVE_GROUP_METHOD_VERSIONS_V1;
7use crate::version::drive_versions::drive_group_method_versions::DriveShieldedMethodVersions;
8use crate::version::drive_versions::drive_grove_method_versions::v1::DRIVE_GROVE_METHOD_VERSIONS_V1;
9use crate::version::drive_versions::drive_identity_method_versions::v2::DRIVE_IDENTITY_METHOD_VERSIONS_V2;
10use crate::version::drive_versions::drive_state_transition_method_versions::v4::DRIVE_STATE_TRANSITION_METHOD_VERSIONS_V4;
11use crate::version::drive_versions::drive_structure_version::v1::DRIVE_STRUCTURE_V1;
12use crate::version::drive_versions::drive_token_method_versions::v1::DRIVE_TOKEN_METHOD_VERSIONS_V1;
13use crate::version::drive_versions::drive_verify_method_versions::v2::DRIVE_VERIFY_METHOD_VERSIONS_V2;
14use crate::version::drive_versions::drive_vote_method_versions::v2::DRIVE_VOTE_METHOD_VERSIONS_V2;
15use crate::version::drive_versions::{
16    DriveAssetLockMethodVersions, DriveBalancesMethodVersions, DriveBatchOperationsMethodVersion,
17    DriveEstimatedCostsMethodVersions, DriveFeesMethodVersions, DriveFetchMethodVersions,
18    DriveInitializationMethodVersions, DriveMethodVersions, DriveOperationsMethodVersion,
19    DrivePlatformStateMethodVersions, DrivePlatformSystemMethodVersions,
20    DrivePrefundedSpecializedMethodVersions, DriveProtocolUpgradeVersions,
21    DriveProveMethodVersions, DriveSavedBlockTransactionsMethodVersions,
22    DriveSystemEstimationCostsMethodVersions, DriveVersion,
23};
24use grovedb_version::version::v4::GROVE_V4;
25
26/// Drive version 9.
27/// Introduced in protocol v14, carrying both of v14's drive-side changes:
28///
29/// * **Shared-prefix aggregate index fix** —
30///   `DRIVE_DOCUMENT_METHOD_VERSIONS_V4` bumps the four index walkers to v2
31///   (and the document update walker to v1) so contracts that pair an
32///   aggregating (countable / summable) index with a compound index sharing
33///   its leading property can insert, update, and delete documents.
34/// * **Contract-level ranked aggregates** — the same V4 table adds the
35///   `detect_ranked_mode` routing slot, `grove_methods.batch` gains the
36///   three indexed-tree creation slots, and `methods.verify` gains
37///   `document_ranked.verify_ranked_top_k_proof`. All are 0 at
38///   introduction; the ranked grammar itself is gated one layer up by
39///   `CONTRACT_VERSIONS_V6`'s meta schema v3.
40/// * **Contest restart over orphaned vote trees** — the same V4 table bumps
41///   `insert_contested.add_contested_vote_subtree_for_non_identities_operations`
42///   to 1 so a new contest recreates the abstain or lock vote tree over the
43///   storage an earlier poll's cleanup left behind (it only removed the
44///   trees that received votes) instead of failing with
45///   `CorruptedContractIndexes`.
46/// * **Contract groups** — `create_initial_state_structure` 4 creates the
47///   `ContractGroups` root tree (key 68) with its groups and members subtrees;
48///   `DRIVE_CONTRACT_GROUP_METHOD_VERSIONS_V1` carries the insert, fetch, prove
49///   and estimation slots; `DRIVE_STATE_TRANSITION_METHOD_VERSIONS_V4` moves
50///   the contract create converter to 1 so a version 1 create transition also
51///   emits the group registration and membership operations.
52///
53/// Everything else matches `DRIVE_VERSION_V8`.
54pub const DRIVE_VERSION_V9: DriveVersion = DriveVersion {
55    structure: DRIVE_STRUCTURE_V1,
56    methods: DriveMethodVersions {
57        initialization: DriveInitializationMethodVersions {
58            create_initial_state_structure: 4, // changed in v9: adds the ContractGroups root tree with its groups and members subtrees (v3 added the shielded pool trees)
59        },
60        credit_pools: CREDIT_POOL_METHOD_VERSIONS_V1,
61        protocol_upgrade: DriveProtocolUpgradeVersions {
62            clear_version_information: 0,
63            fetch_versions_with_counter: 0,
64            fetch_proved_versions_with_counter: 0,
65            fetch_validator_version_votes: 0,
66            fetch_proved_validator_version_votes: 0,
67            remove_validators_proposed_app_versions: 0,
68            update_validator_proposed_app_version: 0,
69        },
70        prove: DriveProveMethodVersions {
71            prove_elements: 0,
72            prove_multiple_state_transition_results: 0,
73            prove_state_transition: 0,
74        },
75        balances: DriveBalancesMethodVersions {
76            add_to_system_credits: 0,
77            add_to_system_credits_operations: 0,
78            remove_from_system_credits: 0,
79            remove_from_system_credits_operations: 0,
80            calculate_total_credits_balance: 2, // ShieldedBalances root tree adds a fifth term to the equation
81        },
82        document: DRIVE_DOCUMENT_METHOD_VERSIONS_V4, // changed in v9: v2 index walkers + v1 update walker (shared-prefix aggregate indexes become insertable) and the detect_ranked_mode slot
83        vote: DRIVE_VOTE_METHOD_VERSIONS_V2,
84        contract: DRIVE_CONTRACT_METHOD_VERSIONS_V4, // changed in v9: add_contract_to_storage v1 writes the contract version item beside the contract
85        fees: DriveFeesMethodVersions { calculate_fee: 0 },
86        estimated_costs: DriveEstimatedCostsMethodVersions {
87            add_estimation_costs_for_levels_up_to_contract: 0,
88            add_estimation_costs_for_levels_up_to_contract_document_type_excluded: 0,
89            add_estimation_costs_for_contested_document_tree_levels_up_to_contract: 0,
90            add_estimation_costs_for_contested_document_tree_levels_up_to_contract_document_type_excluded: 0,
91        },
92        asset_lock: DriveAssetLockMethodVersions {
93            add_asset_lock_outpoint: 0,
94            add_estimation_costs_for_adding_asset_lock: 0,
95            fetch_asset_lock_outpoint_info: 0,
96        },
97        verify: DRIVE_VERIFY_METHOD_VERSIONS_V2, // changed in v8: compacted address-balance proof envelope (verify v1)
98        identity: DRIVE_IDENTITY_METHOD_VERSIONS_V2, // changed in v9: v1 withdrawal-by-transaction-index query builder (structural, identical lowering)
99        token: DRIVE_TOKEN_METHOD_VERSIONS_V1,
100        platform_system: DrivePlatformSystemMethodVersions {
101            estimation_costs: DriveSystemEstimationCostsMethodVersions {
102                for_total_system_credits_update: 0,
103            },
104        },
105        operations: DriveOperationsMethodVersion {
106            rollback_transaction: 0,
107            drop_cache: 0,
108            commit_transaction: 0,
109            apply_partial_batch_low_level_drive_operations: 0,
110            apply_partial_batch_grovedb_operations: 0,
111            apply_batch_low_level_drive_operations: 1, // changed: coalesces bound current-key alias writes per batch
112            apply_batch_grovedb_operations: 0,
113        },
114        state_transitions: DRIVE_STATE_TRANSITION_METHOD_VERSIONS_V4, // changed: document_from_action generation 1 stamps built documents with the contract version (create assigns, replace re-assigns; paired with document serialization format 3)
115        batch_operations: DriveBatchOperationsMethodVersion {
116            convert_drive_operations_to_grove_operations: 0,
117            apply_drive_operations: 0,
118        },
119        platform_state: DrivePlatformStateMethodVersions {
120            fetch_platform_state_bytes: 0,
121            store_platform_state_bytes: 0,
122            fetch_platform_state_recent_bytes: 0,
123            store_platform_state_recent_bytes: 0,
124            fetch_platform_state_entries_bytes: 0,
125            store_platform_state_entry_bytes: 0,
126            delete_platform_state_entry: 0,
127        },
128        fetch: DriveFetchMethodVersions { fetch_elements: 0 },
129        prefunded_specialized_balances: DrivePrefundedSpecializedMethodVersions {
130            fetch_single: 0,
131            prove_single: 0,
132            add_prefunded_specialized_balance: 0,
133            add_prefunded_specialized_balance_operations: 1,
134            deduct_from_prefunded_specialized_balance: 1,
135            deduct_from_prefunded_specialized_balance_operations: 0,
136            estimated_cost_for_prefunded_specialized_balance_update: 0,
137            empty_prefunded_specialized_balance: 0,
138        },
139        group: DRIVE_GROUP_METHOD_VERSIONS_V1,
140        contract_group: DRIVE_CONTRACT_GROUP_METHOD_VERSIONS_V1,
141        address_funds: DRIVE_ADDRESS_FUNDS_METHOD_VERSIONS_V2,
142        shielded: DriveShieldedMethodVersions {
143            insert_note: 0,
144            insert_nullifiers: 0,
145            update_total_balance: 0,
146            record_anchor_if_changed: 0,
147            prune_anchors: 0,
148            has_anchor: 0,
149            has_nullifier: 0,
150            read_total_balance: 0,
151            notes_count: 0,
152        },
153        saved_block_transactions: DriveSavedBlockTransactionsMethodVersions {
154            store_address_balances: 0,
155            fetch_address_balances: 0,
156            prove_compacted_address_balance_changes: 1,
157            compact_address_balances: 0,
158            cleanup_expired_address_balances: 0,
159            max_blocks_before_compaction: 64,
160            max_addresses_before_compaction: 2048,
161        },
162    },
163    grove_methods: DRIVE_GROVE_METHOD_VERSIONS_V1,
164    // changed in v9: GROVE_V4 activates the indexed-tree batch cleanup
165    // gates (overwrite inspection + delete-tree actual-type cleanup).
166    // Indexed trees only exist from protocol v14, so activating the
167    // stricter cleanup with them costs older versions nothing; staying
168    // on V3 would let a batch overwrite of a ranked index orphan its
169    // per-axis secondary storage.
170    grove_version: GROVE_V4,
171};