Struct abstract_ibc_host::state::Host

pub struct Host<Error: ContractError, CustomInitMsg: 'static, CustomExecMsg: 'static, CustomQueryMsg: 'static, CustomMigrateMsg: 'static, Receive: 'static = Empty, SudoMsg: 'static = Empty> {
    pub admin: Admin<'static>,
    pub proxy_address: Option<Addr>,
    /* private fields */
}

The state variables for our host contract.

Fields

admin: Admin<'static>

proxy_address: Option<Addr>

Implementations

impl<Error: ContractError, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg> Host<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg>

pub fn receive_balances( &self, deps: DepsMut<'_> ) -> Result<IbcReceiveResponse, HostError>

pub fn receive_dispatch( &self, deps: DepsMut<'_>, msgs: Vec<CosmosMsg> ) -> Result<IbcReceiveResponse, HostError>

pub fn receive_send_all_back( &self, deps: DepsMut<'_>, env: Env, client_proxy_address: String, client_chain: String ) -> Result<IbcReceiveResponse, HostError>

processes PacketMsg::SendAllBack variant

pub fn send_all_back( &self, deps: Deps<'_>, env: Env, client_proxy_address: String, client_chain: String ) -> Result<CosmosMsg, HostError>

construct the msg to send all the assets back

impl<Error: ContractError, CustomExecMsg: DeserializeOwned, CustomInitMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg> Host<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg>

The host contract base implementation.

pub fn handle_packet<RequestError: ContractError>( self, deps: DepsMut<'_>, env: Env, packet: IbcPacketReceiveMsg, packet_handler: impl FnOnce(DepsMut<'_>, Env, Self, CustomExecMsg) -> Result<IbcReceiveResponse, RequestError> ) -> Result<IbcReceiveResponse, RequestError>

Takes ibc request, matches and executes This fn is the only way to get an Host instance.

pub fn base_execute( self, deps: DepsMut<'_>, _env: Env, info: MessageInfo, message: BaseExecuteMsg ) -> Result<Response, HostError>

impl<Error: ContractError, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg> Host<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg>

pub const fn new( name: &'static str, version: &'static str, chain: &'static str, metadata: Option<&'static str> ) -> Self

pub fn state(&self, store: &dyn Storage) -> StdResult<HostState>

pub fn target(&self) -> Result<&Addr, HostError>

pub const fn with_instantiate( self, instantiate_handler: InstantiateHandlerFn<Self, CustomInitMsg, Error> ) -> Self

pub const fn with_execute( self, execute_handler: ExecuteHandlerFn<Self, CustomExecMsg, Error> ) -> Self

pub const fn with_query( self, query_handler: QueryHandlerFn<Self, CustomQueryMsg, Error> ) -> Self

pub const fn with_replies( self, reply_handlers: &'static [(u64, ReplyHandlerFn<Self, Error>)] ) -> Self

add reply handler to contract

pub const fn with_sudo( self, sudo_handler: SudoHandlerFn<Self, SudoMsg, Error> ) -> Self

pub const fn with_receive( self, receive_handler: ReceiveHandlerFn<Self, ReceiveMsg, Error> ) -> Self

Trait Implementations

impl<Error: ContractError, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg> AbstractNameService for Host<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg>

fn ans_host(&self, deps: Deps<'_>) -> AbstractSdkResult<AnsHost>

Get the ANS host address.

fn name_service<'a>( &'a self, deps: Deps<'a, Empty> ) -> AbstractNameServiceClient<'a, Self>

Construct the name service client.

impl<Error: ContractError, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg> AccountIdentification for Host<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg>

fn proxy_address(&self, _deps: Deps<'_>) -> AbstractSdkResult<Addr>

Get the proxy address for the current account.

fn manager_address(&self, _deps: Deps<'_>) -> AbstractSdkResult<Addr>

Get the manager address for the current account.

fn account_base(&self, _deps: Deps<'_>) -> AbstractSdkResult<AccountBase>

Get the AccountBase for the current account.

fn account_id(&self, _deps: Deps<'_>) -> AbstractSdkResult<AccountId>

Get the Account id for the current account.

impl<Error: ContractError, CustomInitMsg, CustomExecMsg: Serialize + DeserializeOwned + JsonSchema, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg: Serialize + JsonSchema, SudoMsg> ExecuteEndpoint for Host<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg>

The host contract base implementation.

type ExecuteMsg = ExecuteMsg<BaseExecuteMsg, CustomExecMsg, ReceiveMsg>

The message type for the Execute entry point.

fn execute( self, deps: DepsMut<'_>, env: Env, info: MessageInfo, msg: Self::ExecuteMsg ) -> Result<Response, Self::Error>

Handler for the Execute endpoint.

impl<Error: ContractError, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg> Handler for Host<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg>

type Error = Error

Error type for the contract

type CustomInitMsg = CustomInitMsg

Custom init message for the contract

type CustomExecMsg = CustomExecMsg

Custom execute message for the contract

type CustomQueryMsg = CustomQueryMsg

Custom query message for the contract

type CustomMigrateMsg = CustomMigrateMsg

Custom migrate message for the contract

type ReceiveMsg = ReceiveMsg

Receive message for the contract

type SudoMsg = SudoMsg

Sudo message for the contract

fn contract(&self) -> &AbstractContract<Self, Self::Error>

Returns the contract object.

fn stored_version( &self, store: &dyn Storage ) -> Result<ContractVersion, AbstractSdkError>

Returns the cw2 contract version.

fn info(&self) -> (&'static str, &'static str, Option<&'static str>)

Returns the static contract info.

fn dependencies(&self) -> &'static [StaticDependency]

Returns the static contract dependencies.

fn maybe_execute_handler( &self ) -> Option<fn(_: DepsMut<'_, Empty>, _: Env, _: MessageInfo, _: Self, _: Self::CustomExecMsg) -> Result<Response<Empty>, Self::Error>>

Get an execute handler if it exists.

fn execute_handler( &self ) -> Result<fn(_: DepsMut<'_, Empty>, _: Env, _: MessageInfo, _: Self, _: Self::CustomExecMsg) -> Result<Response<Empty>, Self::Error>, AbstractSdkError>

Get an execute handler or return an error.

fn maybe_instantiate_handler( &self ) -> Option<fn(_: DepsMut<'_, Empty>, _: Env, _: MessageInfo, _: Self, _: Self::CustomInitMsg) -> Result<Response<Empty>, Self::Error>>

Get a instantiate handler if it exists.

fn instantiate_handler( &self ) -> Result<fn(_: DepsMut<'_, Empty>, _: Env, _: MessageInfo, _: Self, _: Self::CustomInitMsg) -> Result<Response<Empty>, Self::Error>, AbstractSdkError>

Get an instantiate handler or return an error.

fn maybe_query_handler( &self ) -> Option<fn(_: Deps<'_, Empty>, _: Env, _: &Self, _: Self::CustomQueryMsg) -> Result<Binary, Self::Error>>

Get a query handler if it exists.

fn query_handler( &self ) -> Result<fn(_: Deps<'_, Empty>, _: Env, _: &Self, _: Self::CustomQueryMsg) -> Result<Binary, Self::Error>, AbstractSdkError>

Get a query handler or return an error.

fn maybe_migrate_handler( &self ) -> Option<fn(_: DepsMut<'_, Empty>, _: Env, _: Self, _: Self::CustomMigrateMsg) -> Result<Response<Empty>, Self::Error>>

Get a migrate handler if it exists.

fn migrate_handler( &self ) -> Result<fn(_: DepsMut<'_, Empty>, _: Env, _: Self, _: Self::CustomMigrateMsg) -> Result<Response<Empty>, Self::Error>, AbstractSdkError>

Get a migrate handler or return an error.

fn maybe_sudo_handler( &self ) -> Option<fn(_: DepsMut<'_, Empty>, _: Env, _: Self, _: Self::SudoMsg) -> Result<Response<Empty>, Self::Error>>

Get a sudo handler if it exists.

fn sudo_handler( &self ) -> Result<fn(_: DepsMut<'_, Empty>, _: Env, _: Self, _: Self::SudoMsg) -> Result<Response<Empty>, Self::Error>, AbstractSdkError>

Get a sudo handler or return an error.

fn maybe_receive_handler( &self ) -> Option<fn(_: DepsMut<'_, Empty>, _: Env, _: MessageInfo, _: Self, _: Self::ReceiveMsg) -> Result<Response<Empty>, Self::Error>>

Get a reply handler if it exists.

fn receive_handler( &self ) -> Result<fn(_: DepsMut<'_, Empty>, _: Env, _: MessageInfo, _: Self, _: Self::ReceiveMsg) -> Result<Response<Empty>, Self::Error>, AbstractSdkError>

Get a receive handler or return an error.

fn maybe_ibc_callback_handler( &self, id: &str ) -> Option<fn(_: DepsMut<'_, Empty>, _: Env, _: MessageInfo, _: Self, _: String, _: StdAck) -> Result<Response<Empty>, Self::Error>>

Get an ibc callback handler if it exists.

fn maybe_reply_handler( &self, id: u64 ) -> Option<fn(_: DepsMut<'_, Empty>, _: Env, _: Self, _: Reply) -> Result<Response<Empty>, Self::Error>>

Get a reply handler if it exists.

fn reply_handler( &self, id: u64 ) -> Result<fn(_: DepsMut<'_, Empty>, _: Env, _: Self, _: Reply) -> Result<Response<Empty>, Self::Error>, AbstractSdkError>

Get a reply handler or return an error.

impl<Error: ContractError, CustomInitMsg: Serialize + JsonSchema, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg> InstantiateEndpoint for Host<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg>

type InstantiateMsg = InstantiateMsg<BaseInstantiateMsg, <Host<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg> as Handler>::CustomInitMsg>

Instantiate the api

fn instantiate( self, deps: DepsMut<'_>, env: Env, info: MessageInfo, msg: Self::InstantiateMsg ) -> Result<Response, Error>

Handler for the Instantiate endpoint.

impl<Error: ContractError, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg: Serialize + JsonSchema, ReceiveMsg, SudoMsg> MigrateEndpoint for Host<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg>

type MigrateMsg = MigrateMsg<BaseMigrateMsg, CustomMigrateMsg>

The message type for the Migrate entry point.

fn migrate( self, deps: DepsMut<'_>, env: Env, msg: Self::MigrateMsg ) -> Result<Response, Self::Error>

Handler for the Migrate endpoint.

impl<Error: ContractError, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg> QueryEndpoint for Host<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg>

Where we dispatch the queries for the Host These AdapterQueryMsg declarations can be found in abstract_sdk::core::common_module::app_msg

type QueryMsg = QueryMsg<BaseQueryMsg, <Host<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg> as Handler>::CustomQueryMsg>

The message type for the Query entry point.

fn query( &self, deps: Deps<'_>, env: Env, msg: Self::QueryMsg ) -> Result<Binary, Error>

Handler for the Query endpoint.

impl<Error: ContractError, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg> ReceiveEndpoint for Host<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg>

fn receive( self, deps: DepsMut<'_, Empty>, env: Env, info: MessageInfo, msg: Self::ReceiveMsg ) -> Result<Response<Empty>, Self::Error>

Handler for the ExecuteMsg::Receive() variant.

impl<Error: ContractError, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg> ReplyEndpoint for Host<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg>

fn reply( self, deps: DepsMut<'_>, env: Env, msg: Reply ) -> Result<Response, Self::Error>

Handler for the Reply endpoint.

impl<Error: ContractError, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg> SudoEndpoint for Host<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, CustomMigrateMsg, ReceiveMsg, SudoMsg>

fn sudo( self, deps: DepsMut<'_, Empty>, env: Env, msg: Self::SudoMsg ) -> Result<Response<Empty>, Self::Error>

Handler for the Sudo endpoint.