Struct ClientState

pub struct ClientState {
    pub chain_id: String,
    pub trust_level: Option<Fraction>,
    pub trusting_period: Option<Duration>,
    pub unbonding_period: Option<Duration>,
    pub max_clock_drift: Option<Duration>,
    pub frozen_height: Option<Height>,
    pub latest_height: Option<Height>,
    pub proof_specs: Vec<ProofSpec>,
    pub upgrade_path: Vec<String>,
    pub allow_update_after_expiry: bool,
    pub allow_update_after_misbehaviour: bool,
}

ClientState from Tendermint tracks the current validator set, latest height, and a possible frozen height.

Fields

chain_id: String

trust_level: Option<Fraction>

trusting_period: Option<Duration>

duration of the period since the LastestTimestamp during which the submitted headers are valid for upgrade

unbonding_period: Option<Duration>

duration of the staking unbonding period

max_clock_drift: Option<Duration>

defines how much new (untrusted) header’s Time can drift into the future.

frozen_height: Option<Height>

Block height when the client was frozen due to a misbehaviour

latest_height: Option<Height>

Latest height the client was updated to

proof_specs: Vec<ProofSpec>

Proof specifications used in verifying counterparty state

upgrade_path: Vec<String>

Path at which next upgraded client will be committed. Each element corresponds to the key for a single CommitmentProof in the chained proof. NOTE: ClientState must stored under {upgradePath}/{upgradeHeight}/clientState ConsensusState must be stored under {upgradepath}/{upgradeHeight}/consensusState For SDK chains using the default upgrade module, upgrade_path should be []string{“upgrade”, “upgradedIBCState”}`

allow_update_after_expiry: bool

This flag, when set to true, will allow governance to recover a client which has expired

allow_update_after_misbehaviour: bool

This flag, when set to true, will allow governance to unfreeze a client whose chain has experienced a misbehaviour event

Trait Implementations

impl Clone for ClientState

fn clone(&self) -> ClientState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientState

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

Formats the value using the given formatter.

impl Default for ClientState

fn default() -> Self

Returns the “default value” for a type.

impl Message for ClientState

fn encoded_len(&self) -> usize

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

fn clear(&mut self)

Clears the message, resetting all fields to their default.

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

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

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

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

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 StructuralPartialEq for ClientState