Struct Context

pub struct Context<'a, C, Q = Empty>
where
    C: ClientType<'a>,
    Q: CustomQuery,
    <C::ClientState as TryFrom<Any>>::Error: Display,
    <C::ConsensusState as TryFrom<Any>>::Error: Display,
{ /* private fields */ }

Context is a wrapper around the deps and env that provides access to the methods under the ibc-rs Validation and Execution traits.

Implementations

impl<'a, C, Q> Context<'a, C, Q>

where C: ClientType<'a>, Q: CustomQuery, <C::ClientState as TryFrom<Any>>::Error: Display, <C::ConsensusState as TryFrom<Any>>::Error: Display,

pub fn new_ref(deps: Deps<'a, Q>, env: Env) -> Result<Self, ContractError>

Constructs a new Context object with the given deps and env.

pub fn new_mut( deps_mut: DepsMut<'a, Q>, env: Env, ) -> Result<Self, ContractError>

Constructs a new Context object with the given deps_mut and env.

pub fn env(&self) -> &Env

Returns the env of the context.

pub fn log(&self, msg: &str) -> Option<()>

Logs the given message.

pub fn client_id(&self) -> ClientId

Returns the client id of the context.

pub fn set_checksum(&mut self, checksum: Binary)

Sets the checksum of the context.

pub fn set_subject_prefix(&mut self)

Enables the migration mode with the subject prefix.

pub fn set_substitute_prefix(&mut self)

Enables the migration mode with the substitute prefix.

pub fn prefixed_key(&self, key: impl AsRef<[u8]>) -> Vec<u8>

Prefixes the given key with the migration prefix.

pub fn retrieve(&self, key: impl AsRef<[u8]>) -> Result<Vec<u8>, HostError>

Retrieves the value of the given key.

pub fn insert(&mut self, key: impl AsRef<[u8]>, value: impl AsRef<[u8]>)

Inserts the given key-value pair.

pub fn remove(&mut self, key: impl AsRef<[u8]>)

Removes the value of the given key.

pub fn get_heights(&self) -> Result<Vec<Height>, HostError>

Returns the storage of the context.

pub fn get_adjacent_height( &self, height: &Height, travel: HeightTravel, ) -> Result<Option<Height>, HostError>

Searches for either the earliest next or latest previous height based on the given height and travel direction.

pub fn client_update_time_key(&self, height: &Height) -> Vec<u8>

Returns the key for the client update time.

pub fn client_update_height_key(&self, height: &Height) -> Vec<u8>

Returns the key for the client update height.

pub fn obtain_checksum(&self) -> Result<Binary, HostError>

Returns the checksum of the current contract.

pub fn encode_client_state( &self, client_state: C::ClientState, ) -> Result<Vec<u8>, HostError>

Encodes the given client state into a byte vector.

impl<'a, C: ClientType<'a>> Context<'a, C>

where <C::ClientState as TryFrom<Any>>::Error: Display, <C::ConsensusState as TryFrom<Any>>::Error: Display,

pub fn instantiate( &mut self, msg: InstantiateMsg, ) -> Result<Binary, ContractError>

Instantiates a new client with the given InstantiateMsg message.

pub fn sudo(&mut self, msg: SudoMsg) -> Result<Binary, ContractError>

Executes the given SudoMsg.

pub fn query(&self, msg: QueryMsg) -> Result<Binary, ContractError>

Queries the client with the given QueryMsg message.

Trait Implementations

impl<'a, C: ClientType<'a>> ClientExecutionContext for Context<'a, C>

where <C::ClientState as TryFrom<Any>>::Error: Display, <C::ConsensusState as TryFrom<Any>>::Error: Display,

type ClientStateMut = <C as ClientType<'a>>::ClientState

fn store_client_state( &mut self, _client_state_path: ClientStatePath, client_state: Self::ClientStateMut, ) -> Result<(), HostError>

Called upon successful client creation and update

fn store_consensus_state( &mut self, consensus_state_path: ClientConsensusStatePath, consensus_state: Self::ConsensusStateRef, ) -> Result<(), HostError>

Called upon successful client creation and update

fn delete_consensus_state( &mut self, consensus_state_path: ClientConsensusStatePath, ) -> Result<(), HostError>

Delete the consensus state from the store located at the given ClientConsensusStatePath

fn store_update_meta( &mut self, _client_id: ClientId, height: Height, host_timestamp: Timestamp, host_height: Height, ) -> Result<(), HostError>

Called upon successful client update.

fn delete_update_meta( &mut self, _client_id: ClientId, height: Height, ) -> Result<(), HostError>

Delete the update time and height associated with the client at the specified height.

fn client_state_mut( &self, client_id: &ClientId, ) -> Result<Self::ClientStateMut, HostError>

impl<'a, C: ClientType<'a>> ClientValidationContext for Context<'a, C>

where <C::ClientState as TryFrom<Any>>::Error: Display, <C::ConsensusState as TryFrom<Any>>::Error: Display,

type ClientStateRef = <C as ClientType<'a>>::ClientState

type ConsensusStateRef = <C as ClientType<'a>>::ConsensusState

fn client_state( &self, _client_id: &ClientId, ) -> Result<Self::ClientStateRef, HostError>

Returns the ClientState for the given identifier client_id.

fn consensus_state( &self, client_cons_state_path: &ClientConsensusStatePath, ) -> Result<Self::ConsensusStateRef, HostError>

Retrieve the consensus state for the given client ID at the specified height.

fn client_update_meta( &self, _client_id: &ClientId, height: &Height, ) -> Result<(Timestamp, Height), HostError>

Returns the timestamp and height of the host when it processed a client update request at the specified height.

impl<'a, C: ClientType<'a>> ExtClientValidationContext for Context<'a, C>

where <C::ClientState as TryFrom<Any>>::Error: Display, <C::ConsensusState as TryFrom<Any>>::Error: Display,

fn host_timestamp(&self) -> Result<Timestamp, HostError>

Returns the current timestamp of the local chain.

fn host_height(&self) -> Result<Height, HostError>

Returns the current height of the local chain.

fn consensus_state_heights( &self, _client_id: &ClientId, ) -> Result<Vec<Height>, HostError>

Returns all the heights at which a consensus state is stored.

fn next_consensus_state( &self, client_id: &ClientId, height: &Height, ) -> Result<Option<Self::ConsensusStateRef>, HostError>

Search for the lowest consensus state higher than height.

fn prev_consensus_state( &self, client_id: &ClientId, height: &Height, ) -> Result<Option<Self::ConsensusStateRef>, HostError>

Search for the highest consensus state lower than height.

impl<'a, C, Q> StorageMut for Context<'a, C, Q>

where C: ClientType<'a>, Q: CustomQuery, <C::ClientState as TryFrom<Any>>::Error: Display, <C::ConsensusState as TryFrom<Any>>::Error: Display,

fn storage_mut(&mut self) -> &mut dyn Storage

impl<'a, C, Q> StorageRef for Context<'a, C, Q>

where C: ClientType<'a>, Q: CustomQuery, <C::ClientState as TryFrom<Any>>::Error: Display, <C::ConsensusState as TryFrom<Any>>::Error: Display,

fn storage_ref(&self) -> &dyn Storage