Struct IdentityPublicKeyV1 

pub struct IdentityPublicKeyV1 {
    pub id: KeyID,
    pub purpose: Purpose,
    pub security_level: SecurityLevel,
    pub contract_bounds: Option<ContractBounds>,
    pub key_type: KeyType,
    pub read_only: bool,
    pub data: BinaryData,
    pub disabled_at: Option<TimestampMillis>,
    pub total_budget: Option<Credits>,
    pub expires_at: Option<TimestampMillis>,
}

An identity public key that may carry usage limits.

The first eight fields are the IdentityPublicKeyV0 fields in the same order. total_budget and expires_at exist from protocol version 14 and are only allowed on AUTHENTICATION keys below the MASTER security level. A key without limits keeps being written as V0.

Fields

id: KeyID

purpose: Purpose

security_level: SecurityLevel

contract_bounds: Option<ContractBounds>

key_type: KeyType

read_only: bool

data: BinaryData

disabled_at: Option<TimestampMillis>

total_budget: Option<Credits>

The total credits that state transitions signed with this key may take from the identity over its lifetime. It never changes: how much of it is left lives in Drive, not in the key.

expires_at: Option<TimestampMillis>

The block time, in milliseconds, from which the key can no longer sign.

Implementations

impl IdentityPublicKeyV1

pub fn from_v0_with_limits( key: IdentityPublicKeyV0, total_budget: Option<Credits>, expires_at: Option<TimestampMillis>, ) -> Self

Adds usage limits to a V0 key.

Trait Implementations

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

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 IdentityPublicKeyV1

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 IdentityPublicKeyV1

fn clone(&self) -> IdentityPublicKeyV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IdentityPublicKeyV1

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for IdentityPublicKeyV1

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 IdentityPublicKeyV1

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

Decode with explicit untrusted field dispatch and resource handling.

impl Default for IdentityPublicKeyV1

fn default() -> IdentityPublicKeyV1

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IdentityPublicKeyV1

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encode for IdentityPublicKeyV1

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

Encode a given type.

impl Eq for IdentityPublicKeyV1

impl From<&IdentityPublicKeyV1> for IdentityPublicKeyInCreationV1

Available on crate feature state-transitions only.

fn from(key: &IdentityPublicKeyV1) -> Self

Converts to this type from the input type.

impl From<IdentityPublicKeyV1> for IdentityPublicKey

fn from(value: IdentityPublicKeyV1) -> Self

Converts to this type from the input type.

impl Hash for IdentityPublicKeyV1

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 IdentityPublicKeyGettersV0 for IdentityPublicKeyV1

fn id(&self) -> KeyID

Returns the KeyID

fn purpose(&self) -> Purpose

Returns the Purpose

fn security_level(&self) -> SecurityLevel

Returns the SecurityLevel

fn key_type(&self) -> KeyType

Returns the KeyType

fn read_only(&self) -> bool

Returns the read_only flag

fn data(&self) -> &BinaryData

Returns the data as BinaryData

fn data_owned(self) -> BinaryData

Returns the data as BinaryData

fn disabled_at(&self) -> Option<TimestampMillis>

Returns the disabled_at timestamp as Option

fn is_disabled(&self) -> bool

Is public key disabled

fn contract_bounds(&self) -> Option<&ContractBounds>

Contract bounds

impl IdentityPublicKeyGettersV1 for IdentityPublicKeyV1

fn total_budget(&self) -> Option<Credits>

The total credits that state transitions signed with this key may take from the identity over its lifetime, None when the key has no budget. What is left of it is not in the key: Drive tracks it.

fn expires_at(&self) -> Option<TimestampMillis>

The block time, in milliseconds, from which the key can no longer sign, None when the key does not expire.

fn is_expired_at(&self, time_ms: TimestampMillis) -> bool

Has the key expired at the given block time. The expiry instant itself is already expired.

fn has_limits(&self) -> bool

Does the key carry a budget or an expiry

impl IdentityPublicKeyHashMethodsV0 for IdentityPublicKeyV1

fn public_key_hash(&self) -> Result<[u8; 20], ProtocolError>

Get the original public key hash

fn validate_private_key_bytes( &self, private_key_bytes: &[u8; 32], network: Network, ) -> Result<bool, ProtocolError>

Verifies that the private key bytes match this identity public key

impl IdentityPublicKeySettersV0 for IdentityPublicKeyV1

fn set_id(&mut self, id: KeyID)

Sets the KeyID

fn set_purpose(&mut self, purpose: Purpose)

Sets the Purpose

fn set_security_level(&mut self, security_level: SecurityLevel)

Sets the SecurityLevel

fn set_key_type(&mut self, key_type: KeyType)

Sets the KeyType

fn set_read_only(&mut self, read_only: bool)

Sets the read_only flag

fn set_data(&mut self, data: BinaryData)

Sets the data as BinaryData

fn set_disabled_at(&mut self, timestamp_millis: u64)

Sets the disabled_at timestamp

fn remove_disabled_at(&mut self)

impl JsonSafeFields for IdentityPublicKeyV1

impl Ord for IdentityPublicKeyV1

fn cmp(&self, other: &IdentityPublicKeyV1) -> 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 IdentityPublicKeyV1

fn eq(&self, other: &IdentityPublicKeyV1) -> 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 IdentityPublicKeyV1

fn partial_cmp(&self, other: &IdentityPublicKeyV1) -> 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 IdentityPublicKeyV1

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 IdentityPublicKeyV1