AndromedaQuery

The set of query messages common to all ADOs in the Andromeda Logic Library.

AndromedaQuery

All of the ADOs can call the base query messages found in the AndromedaMsg.

AMP ADOs are the only ADOs that do not implement the AndromedaQuery base queries.

pub enum AndromedaQuery {
    #[returns(self::ownership::ContractOwnerResponse)]
    Owner {},
    #[returns(self::ownership::ContractPotentialOwnerResponse)]
    OwnershipRequest {},
    #[returns(self::ado_type::TypeResponse)]
    Type {},
    #[returns(self::kernel_address::KernelAddressResponse)]
    KernelAddress {},
    #[returns(self::ownership::PublisherResponse)]
    OriginalPublisher {},
    #[returns(self::block_height::BlockHeightResponse)]
    BlockHeightUponCreation {},
    #[returns(self::version::VersionResponse)]
    Version {},
    #[returns(self::version::ADOBaseVersionResponse)]
    ADOBaseVersion {},
    #[returns(Option<::cosmwasm_std::Addr>)]
    AppContract {},
    #[returns(Vec<self::permissioning::PermissionInfo>)]
    Permissions {
        actor: AndrAddr,
        limit: Option<u32>,
        start_after: Option<String>,
    },
    #[returns(Vec<self::permissioning::PermissionedActionsResponse>)]
    PermissionedActions {},
    #[cfg(feature = "rates")]
    #[returns(Option<self::rates::Rate>)]
    GetRate { action: String },
}

Owner

Queries the owner of the contract.

Rust

pub enum AndromedaQuery {
    #[returns(self::ownership::ContractOwnerResponse)]
    Owner{}
}

JSON

{
  "owner":{}
  }
}

ContractOwnerResponse

Rust

pub struct ContractOwnerResponse {
    pub owner: String
}

JSON

{
"owner":"andr1..."
}

OwnershipRequest

Returns the owner that has a request to take ownership of the ADO.

An OwnershipRequest is present when UpdateOwner is called.

Rust

pub enum AndromedaQuery {
#[returns(self::ownership::ContractPotentialOwnerResponse)]
OwnershipRequest {},
}

JSON

{
"ownership_request":{}
}

ContractPotentialOwnerResponse

A struct that returns the address that has the ownership offer for the ADO.

Rust

pub struct ContractPotentialOwnerResponse {
    pub potential_owner: Option<Addr>,
    pub expiration: Option<MillisecondsExpiration>,
}

JSON

{
"potential_owner":"andr1..."
"expiration": "1717430894672"
}

Name	Type	Description
potential_owner	Option<Addr>	The address that has been offered ownership of the ADO.
expiration	Option<MillisecondsExpiration>	When the ownership request expires. Specified as a timestamp in milliseconds.

Type

Queries the ADO type.

Rust

pub enum AndromedaQuery {
    #[returns(self::ado_type::TypeResponse)]
    Type {}
}

JSON

{
"type":{}
}

TypeResponse

Rust

pub struct TypeResponse {
    pub ado_type: String,
    }

JSON

{
"ado_type":"auction"
}

Name	Type	Description
ado_type	String	The type of the ado.

KernelAddress

Queries the kernel address of the chain the ADO is deployed on.

Rust

pub enum AndromedaQuery {
    #[returns(self::kernel_address::KernelAddressResponse)]
    KernelAddress {},
    }

JSON

{
"kernel_address":{}
}

Returns a String containing the contract address of the Kernel.

BlockHeightUponCreation

Queries the block height when the ADO was created.

Rust

pub enum AndromedaQuery{
      #[returns(self::block_height::BlockHeightResponse)]
      BlockHeightUponCreation {},
      }

JSON

{
"block_height_upon_creation":{}
}

BlockHeightResponse

Rust

pub struct BlockHeightResponse {
    pub block_height: u64,
}

JSON

{
"block_height": 2000134
}

Name	Type	Description
block_height	u64	The block height at the time of creation of the ADO.

Version

Queries the version of the ADO.

Rust

pub enum AndromedaQuery {
     #[returns(self::version::VersionResponse)]
     Version {}
     }

JSON

{
"version":{}
}

VersionResponse

Rust

pub struct VersionResponse {
    pub version: String,
}

JSON

{
"version": "0.1.0"
}

Name	Type	Descripton
version	String	The version of the ADO.

ADOBaseVersion

Queries the version of the andromeda-std..

Rust

pub enum AndromedaQuery {
    #[returns(self::version::ADOBaseVersionResponse)]
    ADOBaseVersion {},
     }

JSON

{
"a_d_o_base_version":{}
}

ADOBaseVersionResponse

Rust

pub struct ADOBaseVersionResponse {
    pub version: String,
}

JSON

{
"version":"0.1.1"
}

AppContract

Returns the address of the App ADO that instantiated the ADO.

Rust

pub enum AndromedaQuery {
 #[returns(self::app_contract::AppContractResponse)]
 AppContract {}
 }

JSON

{
"app_contract":{}
}

AppContractResponse

The struct containing the address of the App ADO.

Rust

pub struct AppContractResponse {
    pub app_contract: Addr,
}

JSON

{
"app_contract":"andr1..."
}

Name	Type	Description
app_contract	Addr	The address of the App that instantiated the ADO.

OriginalPublisher

Queries the orginal address that published/instantiated the ADO.

Rust

pub enum AndromedaQuery {
    #[returns(self::ownership::PublisherResponse)]
    OriginalPublisher {}
    }

JSON

{
"original_publisher":{}
}

PublisherResponse

Rust

pub struct PublisherResponse {
    pub original_publisher: String,
}

JSON

{
"original_publisher":"andr1..."
}

Name	Type	Description
original_publisher	String	The original address that instantiated/published the ADO.

Permisions

Queries the permissions set for the specified actor address.

Rust

pub enum AndromedaQuery {
    #[returns(Vec<self::permissioning::PermissionInfo>)]
    Permissions {
        actor: AndrAddr,
        limit: Option<u32>,
        start_after: Option<String>,
    }
}

JSON

{
"permissions":{
    "actor":"andr1...",
    }
}

Name	Type	Description
actor	AndrAddr	The address we are checking permissions for.
limit	Option<u32>	Optional limit to the number of permissions returned. Defaults to 25 and can be set to a maximum of 50.
start_after	Option<String>	Optional permission to start after. Used for pagination.

PermissionInfo

Returns a vector of the PermissionInfo struct containing all the permissions for the actor.

Rust

pub struct PermissionInfo {
    pub permission: Permission,
    pub action: String,
    pub actor: String,
}

Name	Type	Description
permission	Permission	The permission that the actor was given.
action	String	The action or message that the permission is for.
actor	String	The address that has these permissions.

PermissionedActions

Queries the actions or execute messages that are permissioned in the ADO.

The actions that are permissioned are the ones that have PermissionAction called on them.

Rust

pub enum AndromedaQuery {
    #[returns(Vec<self::permissioning::PermissionedActionsResponse>)]
    PermissionedActions {},
    }

JSON

{
"permissioned_actions":{}
}

Returns a Vector of String containing the actions that are permissioned.

GetRate

Only available to the ADOs that implement modules.

Queries the rates applied for the specified action.

Rust

pub enum AndromedaQuery {
   #[returns(Option<self::rates::Rate>)]
    GetRate { action: String },
    }

JSON

{
"get_rate":{
    "action":"Mint"
    }
}

Returns a rate struct containing the configurations of the rate.