Struct ADOContract

pub struct ADOContract<'a> { /* private fields */ }

Implementations

impl<'a> ADOContract<'a>

pub fn get_app_contract( &self, storage: &dyn Storage, ) -> Result<Option<Addr>, ContractError>

pub fn execute_update_app_contract( &self, deps: DepsMut<'_>, info: MessageInfo, address: String, addresses: Option<Vec<AndrAddr>>, ) -> Result<Response, ContractError>

impl<'a> ADOContract<'a>

pub fn instantiate( &self, storage: &mut dyn Storage, env: Env, api: &dyn Api, querier: &QuerierWrapper<'_>, info: MessageInfo, msg: InstantiateMsg, ) -> Result<Response, ContractError>

pub fn execute( &self, ctx: ExecuteContext<'_>, msg: impl Serialize, ) -> Result<Response, ContractError>

Handles execution of ADO specific messages.

pub fn migrate( &self, deps: DepsMut<'_>, contract_name: &str, contract_version: &str, ) -> Result<Response, ContractError>

pub fn validate_andr_addresses( &self, deps: &Deps<'_>, addresses: Vec<AndrAddr>, ) -> Result<(), ContractError>

Validates all provided AndrAddr addresses.

Requires the VFS address to be set if any address is a VFS path. Automatically validates all stored modules.

pub fn get_kernel_address( &self, storage: &dyn Storage, ) -> Result<Addr, ContractError>

Gets the stored address for the Kernel contract

pub fn get_vfs_address( &self, storage: &dyn Storage, querier: &QuerierWrapper<'_>, ) -> Result<Addr, ContractError>

Gets the current address for the VFS contract.

pub fn get_adodb_address( &self, storage: &dyn Storage, querier: &QuerierWrapper<'_>, ) -> Result<Addr, ContractError>

Gets the current address for the VFS contract.

pub fn execute_amp_receive<M: DeserializeOwned>( &self, ctx: ExecuteContext<'_>, packet: AMPPkt, handler: fn(ExecuteContext<'_>, M) -> Result<Response, ContractError>, ) -> Result<Response, ContractError>

Handles receiving and verifies an AMPPkt from the Kernel before executing the appropriate messages.

Calls the provided handler with the AMP packet attached within the context.

pub fn pay_fee( &self, storage: &dyn Storage, querier: &QuerierWrapper<'_>, action: String, payee: Addr, ) -> Result<SubMsg, ContractError>

Generates a message to pay a fee for a given action by the given payee

Fees are paid in the following fallthrough priority:

1. ADO Contract
2. App Contract for sending ADO
3. Provided Payee

If any of the above cannot pay the fee the remainder is paid by the next in the list until no remainder remains. If there is still a remainder after all 3 payments then the fee cannot be paid and the message will error.

pub fn update_kernel_address( &self, deps: DepsMut<'_>, info: MessageInfo, address: Addr, ) -> Result<Response, ContractError>

Updates the current kernel address used by the ADO Requires the sender to be the owner of the ADO

impl<'a> ADOContract<'a>

pub fn execute_ownership( &self, deps: DepsMut<'_>, env: Env, info: MessageInfo, msg: OwnershipMessage, ) -> Result<Response, ContractError>

pub fn update_owner( &self, deps: DepsMut<'_>, info: MessageInfo, new_owner: Addr, expiration: Option<MillisecondsExpiration>, ) -> Result<Response, ContractError>

Updates the current contract owner. Only executable by the current contract owner.

pub fn revoke_ownership_offer( &self, deps: DepsMut<'_>, info: MessageInfo, ) -> Result<Response, ContractError>

Revokes the ownership offer. Only executable by the current contract owner.

pub fn accept_ownership( &self, deps: DepsMut<'_>, env: Env, info: MessageInfo, ) -> Result<Response, ContractError>

Accepts the ownership of the contract. Only executable by the new contract owner.

pub fn disown( &self, deps: DepsMut<'_>, info: MessageInfo, ) -> Result<Response, ContractError>

Disowns the contract. Only executable by the current contract owner.

pub fn owner(&self, storage: &dyn Storage) -> Result<Addr, ContractError>

Helper function to query if a given address is the current contract owner.

Returns a boolean value indicating if the given address is the contract owner.

pub fn is_contract_owner( &self, storage: &dyn Storage, addr: &str, ) -> Result<bool, ContractError>

Helper function to query if a given address is the current contract owner.

Returns a boolean value indicating if the given address is the contract owner.

pub fn is_owner_or_operator( &self, storage: &dyn Storage, addr: &str, ) -> Result<bool, ContractError>

Helper function to query if a given address is the current contract owner or operator.

Returns a boolean value indicating if the given address is the contract owner or operator.

pub fn ownership_request( &self, storage: &dyn Storage, ) -> Result<ContractPotentialOwnerResponse, ContractError>

impl<'a> ADOContract<'a>

pub fn execute_permissioning( &self, ctx: ExecuteContext<'_>, msg: PermissioningMessage, ) -> Result<Response, ContractError>

pub fn is_permissioned( &self, store: &mut dyn Storage, env: Env, action: impl Into<String>, actor: impl Into<String>, ) -> Result<(), ContractError>

Determines if the provided actor is authorised to perform the given action

Returns an error if the given action is not permissioned for the given actor

pub fn is_permissioned_strict( &self, store: &mut dyn Storage, env: Env, action: impl Into<String>, actor: impl Into<String>, ) -> Result<(), ContractError>

Determines if the provided actor is authorised to perform the given action

Ignores the PERMISSIONED_ACTIONS map

Returns an error if the permission has expired or if no permission exists for a restricted ADO

pub fn get_permission( store: &dyn Storage, action: impl Into<String>, actor: impl Into<String>, ) -> Result<Option<Permission>, ContractError>

Gets the permission for the given action and actor

pub fn set_permission( store: &mut dyn Storage, action: impl Into<String>, actor: impl Into<String>, permission: Permission, ) -> Result<(), ContractError>

Sets the permission for the given action and actor

pub fn remove_permission( store: &mut dyn Storage, action: impl Into<String>, actor: impl Into<String>, ) -> Result<(), ContractError>

Removes the permission for the given action and actor

pub fn execute_set_permission( &self, ctx: ExecuteContext<'_>, actor: AndrAddr, action: impl Into<String>, permission: Permission, ) -> Result<Response, ContractError>

Execute handler for setting permission

Whitelisted/Limited permissions will only work for permissioned actions

pub fn execute_remove_permission( &self, ctx: ExecuteContext<'_>, actor: AndrAddr, action: impl Into<String>, ) -> Result<Response, ContractError>

Execute handler for setting permission

pub fn permission_action( &self, action: impl Into<String>, store: &mut dyn Storage, ) -> Result<(), ContractError>

Enables permissioning for a given action

pub fn disable_action_permission( &self, action: impl Into<String>, store: &mut dyn Storage, )

Disables permissioning for a given action

pub fn execute_permission_action( &self, ctx: ExecuteContext<'_>, action: impl Into<String>, ) -> Result<Response, ContractError>

pub fn execute_disable_action_permission( &self, ctx: ExecuteContext<'_>, action: impl Into<String>, ) -> Result<Response, ContractError>

pub fn query_permissions( &self, deps: Deps<'_>, actor: impl Into<String>, limit: Option<u32>, start_after: Option<String>, ) -> Result<Vec<PermissionInfo>, ContractError>

Queries all permissions for a given actor

pub fn query_permissioned_actions( &self, deps: Deps<'_>, ) -> Result<Vec<String>, ContractError>

pub fn query_permissioned_actors( &self, deps: Deps<'_>, action: impl Into<String>, start_after: Option<String>, limit: Option<u32>, order_by: Option<OrderBy>, ) -> Result<Vec<String>, ContractError>

impl<'a> ADOContract<'a>

pub fn query( &self, deps: Deps<'_>, _env: Env, msg: impl Serialize, ) -> Result<Binary, ContractError>

impl<'a> ADOContract<'a>

pub fn query_contract_owner( &self, deps: Deps<'_>, ) -> Result<ContractOwnerResponse, ContractError>

pub fn query_kernel_address( &self, deps: Deps<'_>, ) -> Result<KernelAddressResponse, ContractError>

pub fn query_original_publisher( &self, deps: Deps<'_>, ) -> Result<PublisherResponse, ContractError>

pub fn query_block_height_upon_creation( &self, deps: Deps<'_>, ) -> Result<BlockHeightResponse, ContractError>

pub fn query_type(&self, deps: Deps<'_>) -> Result<TypeResponse, ContractError>

pub fn query_version( &self, deps: Deps<'_>, ) -> Result<VersionResponse, ContractError>

Trait Implementations

impl<'a> Default for ADOContract<'a>

fn default() -> Self

Returns the “default value” for a type.