Enum DataContract

Source

pub enum DataContract {
    V0(DataContractV0),
    V1(DataContractV1),
}

Expand description

Understanding Data Contract versioning Data contract versioning is both for the code structure and for serialization.

The code structure is what is used in code to verify documents and is used in memory There is generally only one code structure running at any given time, except in the case we are switching protocol versions.

There can be a lot of serialization versions that are active, and serialization versions should generally always be supported. This is because when we store something as version 1. 10 years down the line when we unserialize this contract it will still be in version 1. Deserialization of a data contract serialized in that version should be translated to the current code structure version.

There are some scenarios to consider,

One such scenario is that the serialization version does not contain enough information for the current code structure version.

Depending on the situation one of the following occurs:

the contract structure can imply missing parts based on default behavior
the contract structure can disable certain features dependant on missing information
the contract might be unusable until it is updated by the owner

Variants§

§

Enum DataContract Copy item path

Variants§

V0(DataContractV0)

V1(DataContractV1)

Implementations§

impl DataContract

pub fn generate_data_contract_id_v0( owner_id: impl AsRef<[u8]>, identity_nonce: IdentityNonce, ) -> Identifier

impl DataContract

pub fn equal_ignoring_time_fields( &self, other: &DataContract, platform_version: &PlatformVersion, ) -> Result<bool, ProtocolError>

§Arguments

§Returns

impl DataContract

pub fn registration_cost( &self, platform_version: &PlatformVersion, ) -> Result<u64, ProtocolError>

§Arguments

§Returns

§Version Behavior

impl DataContract

pub fn validate_groups( groups: &BTreeMap<GroupContractPosition, Group>, platform_version: &PlatformVersion, ) -> Result<SimpleConsensusValidationResult, ProtocolError>

§Parameters

§Returns

§Behavior

§Errors

impl DataContract

pub fn try_from_platform_versioned( value: DataContractInSerializationFormat, full_validation: bool, validation_operations: &mut Vec<ProtocolValidationOperation>, platform_version: &PlatformVersion, ) -> Result<Self, ProtocolError>

impl DataContract

pub fn feature_version(&self) -> FeatureVersion

impl DataContract

pub fn as_v0(&self) -> Option<&DataContractV0>

pub fn as_v0_mut(&mut self) -> Option<&mut DataContractV0>

pub fn into_v0(self) -> Option<DataContractV0>

pub fn as_v1(&self) -> Option<&DataContractV1>

pub fn as_v1_mut(&mut self) -> Option<&mut DataContractV1>

pub fn into_v1(self) -> Option<DataContractV1>

pub fn check_version_is_active( protocol_version: u32, data_contract_system_version: FeatureVersion, ) -> Result<bool, ProtocolError>

pub fn hash( &self, platform_version: &PlatformVersion, ) -> Result<Vec<u8>, ProtocolError>

Trait Implementations§

impl Clone for DataContract

fn clone(&self) -> DataContract

fn clone_from(&mut self, source: &Self)

impl DataContractDocumentValidationMethodsV0 for DataContract

fn validate_document( &self, name: &str, document: &Document, platform_version: &PlatformVersion, ) -> Result<SimpleConsensusValidationResult, ProtocolError>

fn validate_document_properties( &self, name: &str, properties: Value, platform_version: &PlatformVersion, ) -> Result<SimpleConsensusValidationResult, ProtocolError>

impl DataContractJsonConversionMethodsV0 for DataContract

fn from_json( json_value: JsonValue, full_validation: bool, platform_version: &PlatformVersion, ) -> Result<Self, ProtocolError>where Self: Sized,

fn to_json( &self, platform_version: &PlatformVersion, ) -> Result<JsonValue, ProtocolError>

fn to_validating_json( &self, platform_version: &PlatformVersion, ) -> Result<JsonValue, ProtocolError>

impl DataContractSchemaMethodsV0 for DataContract

fn set_document_schemas( &mut self, schemas: BTreeMap<DocumentName, Value>, defs: Option<BTreeMap<String, Value>>, full_validation: bool, validation_operations: &mut Vec<ProtocolValidationOperation>, platform_version: &PlatformVersion, ) -> Result<(), ProtocolError>

fn set_document_schema( &mut self, name: &str, schema: Value, full_validation: bool, validation_operations: &mut Vec<ProtocolValidationOperation>, platform_version: &PlatformVersion, ) -> Result<(), ProtocolError>

fn document_schemas(&self) -> BTreeMap<DocumentName, &Value>

fn schema_defs(&self) -> Option<&BTreeMap<String, Value>>

fn set_schema_defs( &mut self, defs: Option<BTreeMap<String, Value>>, full_validation: bool, validation_operations: &mut Vec<ProtocolValidationOperation>, platform_version: &PlatformVersion, ) -> Result<(), ProtocolError>

impl DataContractUpdateValidationMethodsV0 for DataContract

fn validate_update( &self, data_contract: &DataContract, block_info: &BlockInfo, platform_version: &PlatformVersion, ) -> Result<SimpleConsensusValidationResult, ProtocolError>

impl DataContractV0Getters for DataContract

fn id(&self) -> Identifier

fn id_ref(&self) -> &Identifier

fn system_version_type(&self) -> u16

fn version(&self) -> u32

fn owner_id(&self) -> Identifier

fn document_type_cloned_for_name( &self, name: &str, ) -> Result<DocumentType, DataContractError>

fn document_type_borrowed_for_name( &self, name: &str, ) -> Result<&DocumentType, DataContractError>

fn document_type_for_name( &self, name: &str, ) -> Result<DocumentTypeRef<'_>, DataContractError>

fn document_type_optional_for_name( &self, name: &str, ) -> Option<DocumentTypeRef<'_>>

fn document_type_cloned_optional_for_name( &self, name: &str, ) -> Option<DocumentType>

fn has_document_type_for_name(&self, name: &str) -> bool

fn document_types_with_contested_indexes( &self, ) -> BTreeMap<&DocumentName, &DocumentType>

fn document_types(&self) -> &BTreeMap<DocumentName, DocumentType>

fn document_types_mut(&mut self) -> &mut BTreeMap<DocumentName, DocumentType>

fn config(&self) -> &DataContractConfig

fn config_mut(&mut self) -> &mut DataContractConfig

impl DataContractV0Setters for DataContract

fn set_id(&mut self, id: Identifier)

fn set_version(&mut self, version: u32)

fn increment_version(&mut self)

fn set_owner_id(&mut self, owner_id: Identifier)

fn set_config(&mut self, config: DataContractConfig)

impl DataContractV1Getters for DataContract

fn groups(&self) -> &BTreeMap<GroupContractPosition, Group>

fn groups_mut(&mut self) -> Option<&mut BTreeMap<GroupContractPosition, Group>>

Enum DataContract

fn from_json( json_value: JsonValue, full_validation: bool, platform_version: &PlatformVersion, ) -> Result<Self, ProtocolError>
where Self: Sized,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

fn versioned_deserialize_with_bytes_len( data: &[u8], full_validation: bool, platform_version: &PlatformVersion, ) -> Result<(Self, usize), ProtocolError>
where Self: Sized,

fn versioned_deserialize( data: &[u8], full_validation: bool, platform_version: &PlatformVersion, ) -> Result<Self, ProtocolError>
where Self: Sized,

fn versioned_limit_deserialize( data: &[u8], platform_version: &PlatformVersion, ) -> Result<Self, ProtocolError>
where Self: Sized,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,