Struct ClientState

pub struct ClientState {
    pub chain_id: ChainId,
    pub trust_level: TrustThreshold,
    pub trusting_period: Duration,
    pub unbonding_period: Duration,
    pub max_clock_drift: Duration,
    pub latest_height: Height,
    pub proof_specs: ProofSpecs,
    pub upgrade_path: Vec<String>,
    pub allow_update: AllowUpdate,
    pub frozen_height: Option<Height>,
}

Defines data structure for Tendermint client state.

Fields

chain_id: ChainId

trust_level: TrustThreshold

trusting_period: Duration

unbonding_period: Duration

max_clock_drift: Duration

latest_height: Height

proof_specs: ProofSpecs

upgrade_path: Vec<String>

allow_update: AllowUpdate

frozen_height: Option<Height>

Implementations

impl ClientState

pub fn new( chain_id: ChainId, trust_level: TrustThreshold, trusting_period: Duration, unbonding_period: Duration, max_clock_drift: Duration, latest_height: Height, proof_specs: ProofSpecs, upgrade_path: Vec<String>, allow_update: AllowUpdate, ) -> Result<ClientState, TendermintClientError>

Constructs a new Tendermint ClientState by given parameters and checks if the parameters are valid.

pub fn with_header( self, header: Header, ) -> Result<ClientState, TendermintClientError>

pub fn with_frozen_height(self, h: Height) -> ClientState

pub fn validate(&self) -> Result<(), TendermintClientError>

pub fn refresh_time(&self) -> Option<Duration>

Get the refresh time to ensure the state does not expire

pub fn as_light_client_options(&self) -> Result<Options, TendermintClientError>

Helper method to produce a Options struct for use in Tendermint-specific light client verification.

pub fn chain_id(&self) -> &ChainId

pub fn is_frozen(&self) -> bool

pub fn zero_custom_fields(&mut self)

Trait Implementations

impl Clone for ClientState

fn clone(&self) -> ClientState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClientState

fn deserialize<__D>( __deserializer: __D, ) -> Result<ClientState, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ClientState> for Any

fn from(client_state: ClientState) -> Any

Converts to this type from the input type.

impl From<ClientState> for ClientState

fn from(value: ClientState) -> ClientState

Converts to this type from the input type.

impl PartialEq for ClientState

fn eq(&self, other: &ClientState) -> 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 Protobuf<Any> for ClientState

fn encode<B>(self, buf: &mut B) -> Result<(), Error>

where B: BufMut,

Encode into a buffer in Protobuf format.

fn encode_length_delimited<B>(self, buf: &mut B) -> Result<(), Error>

where B: BufMut,

Encode with a length-delimiter to a buffer in Protobuf format.

fn decode<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Constructor that attempts to decode an instance from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Constructor that attempts to decode a length-delimited instance from the buffer.

fn encoded_len(self) -> usize

Returns the encoded length of the message without a length delimiter.

fn encode_vec(self) -> Vec<u8>

Encodes into a Protobuf-encoded Vec<u8>.

fn decode_vec(v: &[u8]) -> Result<Self, Error>

Constructor that attempts to decode a Protobuf-encoded instance from a Vec<u8> (or equivalent).

fn encode_length_delimited_vec(self) -> Vec<u8>

Encode with a length-delimiter to a Vec<u8> Protobuf-encoded message.

fn decode_length_delimited_vec(v: &[u8]) -> Result<Self, Error>

Constructor that attempts to decode a Protobuf-encoded instance with a length-delimiter from a Vec<u8> or equivalent.

impl Protobuf<ClientState> for ClientState

fn encode<B>(self, buf: &mut B) -> Result<(), Error>

where B: BufMut,

Encode into a buffer in Protobuf format.

fn encode_length_delimited<B>(self, buf: &mut B) -> Result<(), Error>

where B: BufMut,

Encode with a length-delimiter to a buffer in Protobuf format.

fn decode<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Constructor that attempts to decode an instance from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Constructor that attempts to decode a length-delimited instance from the buffer.

fn encoded_len(self) -> usize

Returns the encoded length of the message without a length delimiter.

fn encode_vec(self) -> Vec<u8>

Encodes into a Protobuf-encoded Vec<u8>.

fn decode_vec(v: &[u8]) -> Result<Self, Error>

Constructor that attempts to decode a Protobuf-encoded instance from a Vec<u8> (or equivalent).

fn encode_length_delimited_vec(self) -> Vec<u8>

Encode with a length-delimiter to a Vec<u8> Protobuf-encoded message.

fn decode_length_delimited_vec(v: &[u8]) -> Result<Self, Error>

Constructor that attempts to decode a Protobuf-encoded instance with a length-delimiter from a Vec<u8> or equivalent.

impl Serialize for ClientState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Any> for ClientState

type Error = DecodingError

The type returned in the event of a conversion error.

fn try_from( raw: Any, ) -> Result<ClientState, <ClientState as TryFrom<Any>>::Error>

Performs the conversion.

impl TryFrom<ClientState> for ClientState

type Error = DecodingError

The type returned in the event of a conversion error.

fn try_from( raw: ClientState, ) -> Result<ClientState, <ClientState as TryFrom<ClientState>>::Error>

Performs the conversion.

impl StructuralPartialEq for ClientState