Module client_state

This module includes trait implementations for the ibc_client_tendermint_types::ClientState type. Implemented traits include ClientStateCommon, ClientStateValidation, and ClientStateExecution.

Note that this crate defines a newtype wrapper around the ibc_client_tendermint_types::ClientState type in order to enable implementing a foreign trait on a foreign type (i.e. the orphan rule in Rust). As such, this module also includes some trait implementations that serve to pass through traits implemented on the wrapped ClientState type.

Structs

• ClientState
  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.

Functions

• check_for_misbehaviour
  Check for misbehaviour on the client state as part of the client state validation process.
• check_for_misbehaviour_on_misbehavior
• check_for_misbehaviour_on_update
  Checks for misbehaviour upon receiving a new consensus state as part of a client update.
• check_substitute
  Check that the subject and substitute client states match as part of the client recovery validation step.
• consensus_state_status
  Determines the Status, whether it is Active or Expired, of a consensus state, using its timestamp, the host’s timestamp, and the trusting period.
• initialise
  Seed the host store with initial client and consensus states.
• prune_oldest_consensus_state
  Removes consensus states from the client store whose timestamps are less than or equal to the host timestamp. This ensures that the client store does not amass a buildup of stale consensus states.
• status
  Query the status of the client state.
• update_on_misbehaviour
  Commit a frozen client state, which was frozen as a result of having exhibited misbehaviour, to the store.
• update_on_recovery
  Update the client_state’s ID, trusting period, latest height, processed height, and processed time metadata values to those values provided by a verified substitute client state in response to a successful client recovery.
• update_on_upgrade
  Commit the new client state and consensus state to the store upon a successful client upgrade.
• update_state
  Update the host store with a new client state, pruning old states from the store if need be.
• validate_proof_height
  Validate the given proof height against the client state’s latest height, returning an error if the proof height is greater than the latest height of the client state.
• verify_client_message
  Verify the client message as part of the client state validation process.
• verify_consensus_state
  Verify an Any consensus state by attempting to convert it to a TmConsensusState. Also checks whether the converted consensus state’s root is present.
• verify_header
• verify_membership
  Verify membership of the given value against the client’s merkle proof.
• verify_misbehaviour
  Determines if two conflicting headers at the same height would have convinced the light client.
• verify_misbehaviour_header
• verify_non_membership
  Verify that the given value does not belong in the client’s merkle proof.
• verify_upgrade_client
  Perform client-specific verifications and check all data in the new client state to be the same across all valid Tendermint clients for the new chain.