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; 11] = [
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    StateTransitionType::IdentityCreateFromShieldedPool,
21    StateTransitionType::IdentityTopUpFromShieldedPool,
22    StateTransitionType::IdentityKeyLimitsUpdate,
23];
24
25pub const VOTING_TRANSITION_TYPE: [StateTransitionType; 1] = [StateTransitionType::MasternodeVote];
26
27pub const DATA_CONTRACT_TRANSITION_TYPES: [StateTransitionType; 2] = [
28    StateTransitionType::DataContractCreate,
29    StateTransitionType::DataContractUpdate,
30];
31
32/// The StateTransitionLike represents set of methods that are shared for all types of State Transition.
33/// Every type of state transition should also implement Debug, Clone, and support conversion to compounded [`StateTransition`]
34pub trait StateTransitionLike:
35    StateTransitionFieldTypes + Clone + Debug + Into<StateTransition>
36{
37    /// returns the protocol version
38    fn state_transition_protocol_version(&self) -> FeatureVersion;
39    /// returns the type of State Transition
40    fn state_transition_type(&self) -> StateTransitionType;
41    /// get modified ids list
42    fn modified_data_ids(&self) -> Vec<Identifier>;
43
44    /// returns true if state transition is a document state transition
45    fn is_document_state_transition(&self) -> bool {
46        DOCUMENT_TRANSITION_TYPES.contains(&self.state_transition_type())
47    }
48    /// returns true if state transition is a data contract state transition
49    fn is_data_contract_state_transition(&self) -> bool {
50        DATA_CONTRACT_TRANSITION_TYPES.contains(&self.state_transition_type())
51    }
52    /// return true if state transition is an identity state transition
53    fn is_identity_state_transition(&self) -> bool {
54        IDENTITY_TRANSITION_TYPE.contains(&self.state_transition_type())
55    }
56
57    /// return true if state transition is a voting state transition
58    fn is_voting_state_transition(&self) -> bool {
59        VOTING_TRANSITION_TYPE.contains(&self.state_transition_type())
60    }
61
62    /// unique identifiers for the state transition
63    /// This is often only one String except in the case of a documents batch state transition
64    fn unique_identifiers(&self) -> Vec<String>;
65}
dpp/state_transition/traits/state_transition_like.rs

dpp/state_transition/traits/
state_transition_like.rs
