Struct ContractModerationConfig 

pub struct ContractModerationConfig {
    pub banlist: bool,
    pub suspensions: bool,
    pub moderators: ContractModerators,
    pub warnings: bool,
}

The moderation a data contract declares in its config.

An unknown key is refused: which lists a contract keeps is fixed when it is created, so a misspelled suspensions must not quietly leave the contract without the list for good.

Fields

banlist: bool

The contract keeps a banlist (Drive key 128 of the contract’s other tree).

suspensions: bool

The contract keeps a suspension list (Drive key 192 of the contract’s other tree).

moderators: ContractModerators

Who may edit the lists.

warnings: bool

The contract keeps a warning list (Drive key 224 of the contract’s other tree). Last in the bincode layout: it joined after the rest, and a declaration stored by a 4.2 beta without it fails to decode at its end rather than misreading the moderators. Such networks are reset.

Implementations

impl ContractModerationConfig

pub fn keeps(&self, list: ContractModerationList) -> bool

Whether the contract keeps list.

pub fn lists(&self) -> impl Iterator<Item = ContractModerationList> + '_

The lists the contract keeps, in tree key order: the banlist, the suspension list, the warning list.

pub fn barring_lists(&self) -> impl Iterator<Item = ContractModerationList> + '_

The lists the contract keeps whose entries bar an identity from its documents: the banlist and the suspension list, never the warning list. What the document gate reads, and what a ban’s proof covers.

pub fn may_moderate( &self, owner_id: &Identifier, identity_id: &Identifier, ) -> bool

Whether identity_id may moderate a contract owned by owner_id. Whoever may moderate cannot be put on a list either, though an entry it already carries may be removed.

pub fn protects(&self, owner_id: &Identifier, identity_id: &Identifier) -> bool

Whether identity_id is protected from moderation on a contract owned by owner_id. See ContractModerators::protects.

pub fn interim_blocks_document_type(&self, document_type_name: &str) -> bool

Whether every document transition of the document type is refused until a moderation team is seated. See ContractModerators::interim_blocks_document_type.

pub fn team(&self, owner_id: &Identifier) -> BTreeSet<Identifier>

The moderation team of a contract owned by owner_id: the identities that share its moderators fee pot. See ContractModerators::team.

pub fn validate( &self, document_schemas: &BTreeMap<DocumentName, Value>, network: Network, platform_version: &PlatformVersion, ) -> Result<SimpleConsensusValidationResult, ProtocolError>

The pure-data rules of the declaration: it gives the moderators something to do, and a moderator set is non-empty and within SystemLimits::max_contract_moderators (a named owner counts). Something to do is a list to edit or, failing that, a document type whose documents they may delete, read from the raw document_schemas of the contract the declaration belongs to, which an elected declaration is also checked against: its moderated types must name document types of the contract (ElectedModerators::validation_error has its rules). Whether the named identities exist is state validation, done by the contract create and update transitions: a moderator that does not exist can never sign, so naming one is a mistake, caught where it is cheapest. The network is the one the node runs: an elected declaration’s windows have a floor on mainnet only.

Trait Implementations

impl<'__de, __Context> BorrowDecode<'__de, __Context> for ContractModerationConfig

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl<'__de, __Context> BorrowDecodeUntrusted<'__de, __Context> for ContractModerationConfig

fn borrow_decode_untrusted<__D: BorrowUntrustedDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Borrow-decode with explicit untrusted field dispatch and resource handling.

impl Clone for ContractModerationConfig

fn clone(&self) -> ContractModerationConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContractModerationConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for ContractModerationConfig

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl<__Context> DecodeUntrusted<__Context> for ContractModerationConfig

fn decode_untrusted<__D: UntrustedDecoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Decode with explicit untrusted field dispatch and resource handling.

impl<'de> Deserialize<'de> for ContractModerationConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encode for ContractModerationConfig

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl Eq for ContractModerationConfig

impl JsonSafeFields for ContractModerationConfig

Available on crate feature json-conversion only.

impl PartialEq for ContractModerationConfig

fn eq(&self, other: &ContractModerationConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ContractModerationConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ContractModerationConfig