dpp/data_contract/config/v1/
mod.rs

1use crate::data_contract::config;
2use crate::data_contract::config::v0::{DataContractConfigGettersV0, DataContractConfigSettersV0};
3use crate::data_contract::config::{
4    DataContractConfig, DEFAULT_CONTRACT_CAN_BE_DELETED, DEFAULT_CONTRACT_DOCUMENTS_CAN_BE_DELETED,
5    DEFAULT_CONTRACT_DOCUMENTS_KEEPS_HISTORY, DEFAULT_CONTRACT_DOCUMENT_MUTABILITY,
6    DEFAULT_CONTRACT_KEEPS_HISTORY, DEFAULT_CONTRACT_MUTABILITY, DEFAULT_SIZED_INTEGER_TYPES,
7};
8use crate::data_contract::storage_requirements::keys_for_document_type::StorageKeyRequirements;
9#[cfg(feature = "json-conversion")]
10use crate::serialization::json_safe_fields;
11use crate::ProtocolError;
12use bincode::{Decode, Encode};
13use platform_value::btreemap_extensions::BTreeValueMapHelper;
14use platform_value::Value;
15use serde::{Deserialize, Serialize};
16use std::collections::BTreeMap;
17
18#[cfg_attr(feature = "json-conversion", json_safe_fields)]
19#[derive(Serialize, Deserialize, Decode, Encode, Debug, Clone, Copy, PartialEq, Eq)]
20#[serde(rename_all = "camelCase", default)]
21pub struct DataContractConfigV1 {
22    /// Can the contract ever be deleted. If the contract is deleted, so should be all
23    /// documents associated with it. TODO: There should also be a way to "stop" the contract -
24    /// contract and documents are kept in the system, but no new documents can be added to it
25    pub can_be_deleted: bool,
26    /// Is the contract mutable. Means that the document definitions can be changed or new
27    /// document definitions can be added to the contract
28    pub readonly: bool,
29    /// Does the contract keep history when the contract itself changes
30    pub keeps_history: bool,
31    /// Do documents in the contract keep history. This is a default for all documents in
32    /// the contract, but can be overridden by the document itself
33    pub documents_keep_history_contract_default: bool,
34    /// Are documents in the contract mutable? This specifies whether the documents can be
35    /// changed. This is a default for all document types in the contract, but can be
36    /// overridden by the document type config.
37    pub documents_mutable_contract_default: bool,
38    /// Can documents in the contract be deleted? This specifies whether the documents can be
39    /// deleted. This is a default for all document types in the contract, but can be
40    /// overridden by the document types itself.
41    pub documents_can_be_deleted_contract_default: bool,
42    /// Encryption key storage requirements
43    pub requires_identity_encryption_bounded_key: Option<StorageKeyRequirements>,
44    /// Decryption key storage requirements
45    pub requires_identity_decryption_bounded_key: Option<StorageKeyRequirements>,
46    /// Use sized integer Rust types for `integer` property type based on validation rules
47    pub sized_integer_types: bool,
48}
49
50/// Trait representing getters for `DataContractConfigV1`
51pub trait DataContractConfigGettersV1: DataContractConfigGettersV0 {
52    /// Use sized integer Rust types for `integer` property type based on validation rules
53    fn sized_integer_types(&self) -> bool;
54}
55
56/// Trait representing setters for `DataContractConfigV1`
57pub trait DataContractConfigSettersV1: DataContractConfigSettersV0 {
58    /// Enable/disable sized integer Rust types for `integer` property type
59    fn set_sized_integer_types_enabled(&mut self, enable: bool);
60}
61
62impl Default for DataContractConfigV1 {
63    fn default() -> Self {
64        DataContractConfigV1 {
65            can_be_deleted: DEFAULT_CONTRACT_CAN_BE_DELETED,
66            readonly: !DEFAULT_CONTRACT_MUTABILITY,
67            keeps_history: DEFAULT_CONTRACT_KEEPS_HISTORY,
68            documents_keep_history_contract_default: DEFAULT_CONTRACT_DOCUMENTS_KEEPS_HISTORY,
69            documents_mutable_contract_default: DEFAULT_CONTRACT_DOCUMENT_MUTABILITY,
70            documents_can_be_deleted_contract_default: DEFAULT_CONTRACT_DOCUMENTS_CAN_BE_DELETED,
71            requires_identity_encryption_bounded_key: None,
72            requires_identity_decryption_bounded_key: None,
73            sized_integer_types: true,
74        }
75    }
76}
77
78impl DataContractConfigV1 {
79    pub fn default_with_version() -> DataContractConfig {
80        Self::default().into()
81    }
82}
83
84impl DataContractConfigV1 {
85    /// Retrieve contract configuration properties.
86    ///
87    /// This method takes a BTreeMap representing a contract and retrieves
88    /// the configuration properties based on the values found in the map.
89    ///
90    /// The process of retrieving contract configuration properties is versioned,
91    /// and the version is determined by the platform version parameter.
92    /// If the version is not supported, an error is returned.
93    ///
94    /// # Parameters
95    ///
96    /// * `contract`: BTreeMap representing the contract.
97    /// * `platform_version`: The platform version being used.
98    ///
99    /// # Returns
100    ///
101    /// * `Result<ContractConfig, ProtocolError>`: On success, a ContractConfig.
102    ///   On failure, a ProtocolError.
103    #[inline(always)]
104    pub(super) fn get_contract_configuration_properties_v1(
105        contract: &BTreeMap<String, Value>,
106    ) -> Result<DataContractConfigV1, ProtocolError> {
107        let keeps_history = contract
108            .get_optional_bool(config::property::KEEPS_HISTORY)?
109            .unwrap_or(DEFAULT_CONTRACT_KEEPS_HISTORY);
110        let can_be_deleted = contract
111            .get_optional_bool(config::property::CAN_BE_DELETED)?
112            .unwrap_or(DEFAULT_CONTRACT_CAN_BE_DELETED);
113
114        let readonly = contract
115            .get_optional_bool(config::property::READONLY)?
116            .unwrap_or(!DEFAULT_CONTRACT_MUTABILITY);
117
118        let documents_keep_history_contract_default = contract
119            .get_optional_bool(config::property::DOCUMENTS_KEEP_HISTORY_CONTRACT_DEFAULT)?
120            .unwrap_or(DEFAULT_CONTRACT_DOCUMENTS_KEEPS_HISTORY);
121
122        let documents_mutable_contract_default = contract
123            .get_optional_bool(config::property::DOCUMENTS_MUTABLE_CONTRACT_DEFAULT)?
124            .unwrap_or(DEFAULT_CONTRACT_DOCUMENT_MUTABILITY);
125
126        let documents_can_be_deleted_contract_default = contract
127            .get_optional_bool(config::property::DOCUMENTS_CAN_BE_DELETED_CONTRACT_DEFAULT)?
128            .unwrap_or(DEFAULT_CONTRACT_DOCUMENTS_CAN_BE_DELETED);
129
130        let requires_identity_encryption_bounded_key = contract
131            .get_optional_integer::<u8>(config::property::REQUIRES_IDENTITY_ENCRYPTION_BOUNDED_KEY)?
132            .map(|int| int.try_into())
133            .transpose()?;
134
135        let requires_identity_decryption_bounded_key = contract
136            .get_optional_integer::<u8>(config::property::REQUIRES_IDENTITY_DECRYPTION_BOUNDED_KEY)?
137            .map(|int| int.try_into())
138            .transpose()?;
139
140        let sized_integer_types = contract
141            .get_optional_bool(config::property::SIZED_INTEGER_TYPES)?
142            .unwrap_or(DEFAULT_SIZED_INTEGER_TYPES);
143
144        Ok(DataContractConfigV1 {
145            can_be_deleted,
146            readonly,
147            keeps_history,
148            documents_keep_history_contract_default,
149            documents_mutable_contract_default,
150            documents_can_be_deleted_contract_default,
151            requires_identity_encryption_bounded_key,
152            requires_identity_decryption_bounded_key,
153            sized_integer_types,
154        })
155    }
156}
dpp/data_contract/config/v1/mod.rs

dpp/data_contract/config/v1/
mod.rs
