Struct MockClientState

pub struct MockClientState {
    pub header: MockHeader,
    pub trusting_period: Duration,
    pub frozen: bool,
}

A mock of a client state. For an example of a real structure that this mocks, you can see ClientState of ics07_tendermint/client_state.rs.

Fields

header: MockHeader

trusting_period: Duration

frozen: bool

Implementations

impl MockClientState

pub fn new(header: MockHeader) -> Self

Initializes a new MockClientState with the given MockHeader and a trusting period of 10 seconds as a default. If the trusting period needs to be changed, use the with_trusting_period method to override it.

pub fn latest_height(&self) -> Height

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

pub fn with_trusting_period(self, trusting_period: Duration) -> Self

pub fn frozen(self) -> Self

pub fn unfrozen(self) -> Self

pub fn is_frozen(&self) -> bool

Trait Implementations

impl ClientStateCommon for MockClientState

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 serialize_path(&self, path: Path) -> Result<PathBytes, ClientError>

Serializes a given path object into a raw path bytes.

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 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 MockClientState

where E: ClientExecutionContext + MockClientContext, E::ClientStateRef: From<Self>, MockConsensusState: Convertible<E::ConsensusStateRef>, <MockConsensusState 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 MockClientState

where V: ClientValidationContext + MockClientContext, MockConsensusState: Convertible<V::ConsensusStateRef>, <MockConsensusState as TryFrom<V::ConsensusStateRef>>::Error: Into<ClientError>,

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

verify_client_message must verify a client_message. A client_message could be a Header, Misbehaviour. It must handle each type of client_message appropriately. Calls to check_for_misbehaviour, update_state, and update_state_on_misbehaviour will assume that the content of the client_message has been verified and can be trusted. An error should be returned if the client_message fails to verify.

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 MockClientState

fn clone(&self) -> MockClientState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MockClientState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MockClientState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<MockClientState> for Any

fn from(client_state: MockClientState) -> Self

Converts to this type from the input type.

impl From<MockClientState> for AnyClientState

fn from(value: MockClientState) -> Self

Converts to this type from the input type.

impl From<MockClientState> for ClientState

fn from(value: MockClientState) -> Self

Converts to this type from the input type.

impl From<MockConsensusState> for MockClientState

fn from(cs: MockConsensusState) -> Self

Converts to this type from the input type.

impl PartialEq for MockClientState

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

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 MockClientState

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 MockClientState

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 MockClientState

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 MockClientState

type Error = DecodingError

The type returned in the event of a conversion error.

fn try_from(raw: RawMockClientState) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for MockClientState

impl Eq for MockClientState

impl StructuralPartialEq for MockClientState