dpp/state_transition/traits/
state_transition_like.rs

1use std::fmt::Debug;
2
3use crate::prelude::Identifier;
4use crate::version::FeatureVersion;
5
6use crate::state_transition::StateTransitionType;
7use crate::state_transition::{StateTransition, StateTransitionFieldTypes};
8
9pub const DOCUMENT_TRANSITION_TYPES: [StateTransitionType; 1] = [StateTransitionType::Batch];
10
11pub const IDENTITY_TRANSITION_TYPE: [StateTransitionType; 8] = [
12    StateTransitionType::IdentityCreate,
13    StateTransitionType::IdentityTopUp,
14    StateTransitionType::IdentityUpdate,
15    StateTransitionType::IdentityCreditTransfer,
16    StateTransitionType::IdentityCreditWithdrawal,
17    StateTransitionType::IdentityTopUpFromAddresses,
18    StateTransitionType::IdentityCreateFromAddresses,
19    StateTransitionType::IdentityCreditTransferToAddresses,
20];
21
22pub const VOTING_TRANSITION_TYPE: [StateTransitionType; 1] = [StateTransitionType::MasternodeVote];
23
24pub const DATA_CONTRACT_TRANSITION_TYPES: [StateTransitionType; 2] = [
25    StateTransitionType::DataContractCreate,
26    StateTransitionType::DataContractUpdate,
27];
28
29/// The StateTransitionLike represents set of methods that are shared for all types of State Transition.
30/// Every type of state transition should also implement Debug, Clone, and support conversion to compounded [`StateTransition`]
31pub trait StateTransitionLike:
32    StateTransitionFieldTypes + Clone + Debug + Into<StateTransition>
33{
34    /// returns the protocol version
35    fn state_transition_protocol_version(&self) -> FeatureVersion;
36    /// returns the type of State Transition
37    fn state_transition_type(&self) -> StateTransitionType;
38    /// get modified ids list
39    fn modified_data_ids(&self) -> Vec<Identifier>;
40
41    /// returns true if state transition is a document state transition
42    fn is_document_state_transition(&self) -> bool {
43        DOCUMENT_TRANSITION_TYPES.contains(&self.state_transition_type())
44    }
45    /// returns true if state transition is a data contract state transition
46    fn is_data_contract_state_transition(&self) -> bool {
47        DATA_CONTRACT_TRANSITION_TYPES.contains(&self.state_transition_type())
48    }
49    /// return true if state transition is an identity state transition
50    fn is_identity_state_transition(&self) -> bool {
51        IDENTITY_TRANSITION_TYPE.contains(&self.state_transition_type())
52    }
53
54    /// return true if state transition is a voting state transition
55    fn is_voting_state_transition(&self) -> bool {
56        VOTING_TRANSITION_TYPE.contains(&self.state_transition_type())
57    }
58
59    /// unique identifiers for the state transition
60    /// This is often only one String except in the case of a documents batch state transition
61    fn unique_identifiers(&self) -> Vec<String>;
62}