Enum ContractBounds 

#[repr(u8)]
pub enum ContractBounds {
    SingleContract {
        id: Identifier,
    },
    SingleContractDocumentType {
        id: Identifier,
        document_type_name: String,
    },
    ContractGroup {
        id: Identifier,
    },
}

A contract bounds is the bounds that the key has influence on. For authentication keys the bounds mean that the keys can only be used to sign within the specified contract, or within the members of the specified contract group. For encryption decryption this tells clients to only use these keys for specific contracts.

New variants go last: the bincode tag is the declaration index, and every stored identity key carries one.

Variants

SingleContract

this key can only be used within a specific contract

Fields

id: Identifier

SingleContractDocumentType

this key can only be used within a specific contract and for a specific document type

Fields

id: Identifier

document_type_name: String

ContractGroup

this key can only be used within the members of a contract group: the contracts, document types and tokens the group holds when the key signs (protocol version 14)

Fields

id: Identifier

Implementations

impl ContractBounds

pub fn new_from_type( contract_bounds_type: u8, identifier: Vec<u8>, document_type: String, ) -> Result<Self, ProtocolError>

Creates a new contract bounds for the key

pub fn contract_bounds_type(&self) -> ContractBoundsType

Gets the contract bounds type

pub fn contract_bounds_type_from_str( str: &str, ) -> Result<ContractBoundsType, ProtocolError>

pub fn contract_bounds_type_string(&self) -> &str

Gets the contract bounds type

pub fn identifier(&self) -> &Identifier

Gets the identifier: the contract id, or the contract group id for a group bound. Use Self::contract_id or Self::contract_group_id when the kind matters.

pub fn contract_id(&self) -> Option<&Identifier>

The bound contract id, when the bounds name one contract.

pub fn contract_group_id(&self) -> Option<&Identifier>

The bound contract group id, when the bounds name a contract group.

pub fn document_type(&self) -> Option<&String>

Gets the document type

pub fn check_batched_transition( &self, transition: BatchedTransitionRef<'_>, ) -> BatchedTransitionBoundsCheck

What authorizing transition with a key carrying these bounds needs. Consensus uses this to authorize a batch signed by a contract-bound AUTHENTICATION key. Token operations are contract-wide, so a document-type bound never covers them. A contract group bound is answered by state: the member’s contract must hold the returned membership, or be a whole-contract member of the group.

Trait Implementations

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

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 ContractBounds

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 ContractBounds

fn clone(&self) -> ContractBounds

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContractBounds

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for ContractBounds

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 ContractBounds

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 ContractBounds

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encode for ContractBounds

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

Encode a given type.

impl Eq for ContractBounds

impl Hash for ContractBounds

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonConvertible for ContractBounds

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

fn from_json(json: JsonValue) -> Result<Self, ProtocolError>

impl JsonSafeFields for ContractBounds

impl Ord for ContractBounds

fn cmp(&self, other: &ContractBounds) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ContractBounds

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ContractBounds

fn partial_cmp(&self, other: &ContractBounds) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ContractBounds

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 ContractBounds

impl ValueConvertible for ContractBounds

fn to_object(&self) -> Result<Value, ProtocolError>

where Self: Sized,

fn into_object(self) -> Result<Value, ProtocolError>

where Self: Sized,

fn from_object(value: Value) -> Result<Self, ProtocolError>

where Self: Sized,

fn from_object_ref(value: &Value) -> Result<Self, ProtocolError>

where Self: Sized,