Struct ClientState

pub struct ClientState(/* private fields */);

Newtype wrapper around the ClientState type, imported from the ibc-client-tendermint-types crate. This wrapper exists so that we can bypass Rust’s orphan rules and implement traits from ibc::core::client::context on the ClientState type.

Implementations

impl ClientState

pub fn inner(&self) -> &ClientStateType

Trait Implementations

impl ClientStateCommon for ClientState

fn verify_consensus_state( &self, consensus_state: Any, host_timestamp: &Timestamp, ) -> Result<(), ClientError>

Performs basic validation on the consensus_state.

fn client_type(&self) -> ClientType

Type of client associated with this state (eg. Tendermint)

fn latest_height(&self) -> Height

The latest height the client was updated to

fn validate_proof_height(&self, proof_height: Height) -> Result<(), ClientError>

Validate that the client is at a sufficient height

fn verify_upgrade_client( &self, upgraded_client_state: Any, upgraded_consensus_state: Any, proof_upgrade_client: CommitmentProofBytes, proof_upgrade_consensus_state: CommitmentProofBytes, root: &CommitmentRoot, ) -> Result<(), ClientError>

Verify the upgraded client and consensus states and validate proofs against the given root.

fn serialize_path(&self, path: Path) -> Result<PathBytes, ClientError>

Serializes a given path object into a raw path bytes.

fn verify_membership_raw( &self, prefix: &CommitmentPrefix, proof: &CommitmentProofBytes, root: &CommitmentRoot, path: PathBytes, value: Vec<u8>, ) -> Result<(), ClientError>

Verifies a proof of the existence of a value at a given raw path bytes.

fn verify_non_membership_raw( &self, prefix: &CommitmentPrefix, proof: &CommitmentProofBytes, root: &CommitmentRoot, path: PathBytes, ) -> Result<(), ClientError>

Verifies the absence of a given proof at a given raw path bytes.

fn verify_membership( &self, prefix: &CommitmentPrefix, proof: &CommitmentProofBytes, root: &CommitmentRoot, path: Path, value: Vec<u8>, ) -> Result<(), ClientError>

Verifies a proof of the existence of a value at a given path object.

fn verify_non_membership( &self, prefix: &CommitmentPrefix, proof: &CommitmentProofBytes, root: &CommitmentRoot, path: Path, ) -> Result<(), ClientError>

Verifies the absence of a given proof at a given path object.

impl<E> ClientStateExecution<E> for ClientState

where E: ExtClientExecutionContext, E::ClientStateRef: From<ClientState>, ConsensusState: Convertible<E::ConsensusStateRef>, <ConsensusState as TryFrom<E::ConsensusStateRef>>::Error: Into<ClientError>,

fn initialise( &self, ctx: &mut E, client_id: &ClientId, consensus_state: Any, ) -> Result<(), ClientError>

Initialises the client with the initial client and consensus states.

fn update_state( &self, ctx: &mut E, client_id: &ClientId, header: Any, ) -> Result<Vec<Height>, ClientError>

Updates and stores as necessary any associated information for an IBC client, such as the ClientState and corresponding ConsensusState. Upon successful update, a list of consensus heights is returned. It assumes the client_message has already been verified.

fn update_state_on_misbehaviour( &self, ctx: &mut E, client_id: &ClientId, client_message: Any, ) -> Result<(), ClientError>

update_state_on_misbehaviour should perform appropriate state changes on a client state given that misbehaviour has been detected and verified

fn update_state_on_upgrade( &self, ctx: &mut E, client_id: &ClientId, upgraded_client_state: Any, upgraded_consensus_state: Any, ) -> Result<Height, ClientError>

Update the client state and consensus state in the store with the upgraded ones.

fn update_on_recovery( &self, ctx: &mut E, subject_client_id: &ClientId, substitute_client_state: Any, substitute_consensus_state: Any, ) -> Result<(), ClientError>

Update the subject client using the substitute_client_state in response to a successful client recovery.

impl<V> ClientStateValidation<V> for ClientState

where V: ExtClientValidationContext, ConsensusState: Convertible<V::ConsensusStateRef>, <ConsensusState as TryFrom<V::ConsensusStateRef>>::Error: Into<ClientError>,

fn verify_client_message( &self, ctx: &V, client_id: &ClientId, client_message: Any, ) -> Result<(), ClientError>

The default verification logic exposed by ibc-rs simply delegates to a standalone verify_client_message function. This is to make it as simple as possible for those who merely need the default ProdVerifier behaviour, as well as those who require custom verification logic.

In a situation where the Tendermint ProdVerifier doesn’t provide the desired outcome, users should define a custom verifier struct and then implement the Verifier trait for it.

In order to wire up the custom verifier, create a newtype ClientState wrapper similar to ClientState and implement all client state traits for it. For method implementation, the simplest way is to import and call their analogous standalone versions under the crate::client_state module, unless bespoke logic is desired for any of those functions. Then, when it comes to implementing the verify_client_message method, use the verify_client_message function and pass your custom verifier object as the verifier parameter.

fn check_for_misbehaviour( &self, ctx: &V, client_id: &ClientId, client_message: Any, ) -> Result<bool, ClientError>

Checks for evidence of a misbehaviour in Header or Misbehaviour type. It assumes the client_message has already been verified.

fn status(&self, ctx: &V, client_id: &ClientId) -> Result<Status, ClientError>

Returns the status of the client. Only Active clients are allowed to process packets.

fn check_substitute( &self, _ctx: &V, substitute_client_state: Any, ) -> Result<(), ClientError>

Verifies whether the calling (subject) client state matches the substitute client state for the purposes of client recovery.

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ClientState> for Any

fn from(client_state: ClientState) -> Self

Converts to this type from the input type.

impl From<ClientState> for ClientState

fn from(value: ClientStateType) -> Self

Converts to this type from the input type.

impl From<ClientState> for ClientState

fn from(client_state: ClientState) -> Self

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::Ok, __S::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<Self, Self::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: RawTmClientState) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for ClientState