Struct abstract_adapter::state::AdapterContract

pub struct AdapterContract<Error: ContractError, CustomInitMsg: 'static, CustomExecMsg: 'static, CustomQueryMsg: 'static, Receive: 'static = Empty, SudoMsg: 'static = Empty>
where
    Self: Handler,
{
    pub authorized_addresses: Map<'static, Addr, Vec<Addr>>,
    pub target_account: Option<AccountBase>,
    /* private fields */
}

The state variables for our AdapterContract.

Fields

authorized_addresses: Map<'static, Addr, Vec<Addr>>

Map ProxyAddr -> AuthorizedAddrs

target_account: Option<AccountBase>

The Account on which commands are executed. Set each time in the abstract_std::adapter::ExecuteMsg::Base handler.

Implementations

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

Constructor

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

pub fn version(&self) -> &'static str

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

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

Return the address of the proxy for the Account associated with this Adapter. Set each time in the abstract_std::adapter::ExecuteMsg::Base handler.

pub const fn with_dependencies( self, dependencies: &'static [StaticDependency] ) -> Self

add dependencies to the contract

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

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

pub const fn with_ibc_callbacks( self, callbacks: &'static [(&'static str, IbcCallbackHandlerFn<Self, Error>)] ) -> Self

add IBC callback handler to contract

pub const fn with_module_ibc( self, module_handler: ModuleIbcHandlerFn<Self, Error> ) -> Self

add Module IBC to contract

Trait Implementations

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

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

Get the ANS host address.

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

Construct the name service client.

impl<Error: ContractError, CustomInitMsg, CustomExecMsg, CustomQueryMsg, ReceiveMsg, SudoMsg> AbstractRegistryAccess for AdapterContract<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, ReceiveMsg, SudoMsg>

Get the version control contract

fn abstract_registry( &self, deps: Deps<'_> ) -> AbstractSdkResult<VersionControlContract>

Get the address of the registry.

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

Retrieve identifying information about the calling Account

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<'_>) -> Result<AccountId, AbstractSdkError>

Get the Account id for the current account.

impl<Error: ContractError, CustomInitMsg, CustomExecMsg: Serialize + JsonSchema + AdapterExecuteMsg, CustomQueryMsg, ReceiveMsg: Serialize + JsonSchema, SudoMsg> ExecuteEndpoint for AdapterContract<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, ReceiveMsg, SudoMsg>

type ExecuteMsg = ExecuteMsg<BaseExecuteMsg, AdapterRequestMsg<CustomExecMsg>, ReceiveMsg>

The message type for the Execute entry point.

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

Handler for the Execute endpoint.

impl<Error: ContractError, InitMsg, ExecMsg, QueryMsg, ReceiveMsg, SudoMsg> Handler for AdapterContract<Error, InitMsg, ExecMsg, QueryMsg, ReceiveMsg, SudoMsg>

type Error = Error

Error type for the contract

type CustomInitMsg = InitMsg

Custom init message for the contract

type CustomExecMsg = ExecMsg

Custom execute message for the contract

type CustomQueryMsg = QueryMsg

Custom query message for the contract

type CustomMigrateMsg = Empty

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, 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<'_>, _: Env, _: MessageInfo, _: Self, _: Self::CustomExecMsg) -> Result<Response, Self::Error>>

Get an execute handler if it exists.

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

Get an execute handler or return an error.

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

Get a instantiate handler if it exists.

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

Get an instantiate handler or return an error.

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

Get a query handler if it exists.

fn query_handler( &self ) -> Result<fn(_: Deps<'_>, _: 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<'_>, _: Env, _: Self, _: Self::CustomMigrateMsg) -> Result<Response, Self::Error>>

Get a migrate handler if it exists.

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

Get a migrate handler or return an error.

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

Get a sudo handler if it exists.

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

Get a sudo handler or return an error.

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

Get a reply handler if it exists.

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

Get a receive handler or return an error.

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

Get an ibc callback handler if it exists.

fn maybe_module_ibc_handler( &self ) -> Option<fn(_: DepsMut<'_>, _: Env, _: Self, _: ModuleIbcMsg) -> Result<Response, Self::Error>>

Get an IBC module call handler if it exists.

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

Get a reply handler if it exists.

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

Get a reply handler or return an error.

impl<Error: ContractError, CustomInitMsg, CustomExecMsg, CustomQueryMsg, ReceiveMsg, SudoMsg> IbcCallbackEndpoint for AdapterContract<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, ReceiveMsg, SudoMsg>

fn ibc_client(&self, deps: Deps<'_>) -> Result<Addr, Self::Error>

Queries the IBC Client address.

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

Handler for the ExecuteMsg::IbcCallback() variant.

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

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

Instantiate the api

type InstantiateMsg = InstantiateMsg<BaseInstantiateMsg, CustomInitMsg>

The message type for the Instantiate entry point.

impl<Error: ContractError, CustomInitMsg, CustomExecMsg, CustomQueryMsg, ReceiveMsg, SudoMsg> ModuleIbcEndpoint for AdapterContract<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, ReceiveMsg, SudoMsg>

fn ibc_host(&self, deps: Deps<'_>) -> Result<Addr, Self::Error>

Get the address of the ibc host associated with this module

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

Handler for the ExecuteMsg::ModuleIbc(ModuleIbcMsg) variant.

impl<Error: ContractError, CustomInitMsg, CustomExecMsg, CustomQueryMsg: AdapterQueryMsg, ReceiveMsg, SudoMsg> QueryEndpoint for AdapterContract<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, ReceiveMsg, SudoMsg>

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

type QueryMsg = QueryMsg<BaseQueryMsg, 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, ReceiveMsg, SudoMsg> ReceiveEndpoint for AdapterContract<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, ReceiveMsg, SudoMsg>

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

Handler for the ExecuteMsg::Receive() variant.

impl<Error: ContractError, CustomInitMsg, CustomExecMsg, CustomQueryMsg, ReceiveMsg, SudoMsg> ReplyEndpoint for AdapterContract<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, 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, ReceiveMsg, SudoMsg> SudoEndpoint for AdapterContract<Error, CustomInitMsg, CustomExecMsg, CustomQueryMsg, ReceiveMsg, SudoMsg>

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

Handler for the Sudo endpoint.