Enum VaultStandardQueryMsg 

pub enum VaultStandardQueryMsg<T = ExtensionQueryMsg>
where
    T: JsonSchema,
{
    VaultStandardInfo {},
    Info {},
    PreviewDeposit {
        amount: Uint128,
    },
    PreviewRedeem {
        amount: Uint128,
    },
    TotalAssets {},
    TotalVaultTokenSupply {},
    VaultTokenExchangeRate {
        quote_denom: String,
    },
    ConvertToShares {
        amount: Uint128,
    },
    ConvertToAssets {
        amount: Uint128,
    },
    VaultExtension(T),
}

The default QueryMsg variants that all vaults must implement. This enum can be extended with additional variants by defining an extension enum and then passing it as the generic argument T to this enum.

Variants

VaultStandardInfo

Returns VaultStandardInfoResponse with information on the version of the vault standard used as well as any enabled extensions.

Info

Returns VaultInfoResponse representing vault requirements, lockup, & vault token denom.

PreviewDeposit

👎Deprecated since 0.4.1: PreviewDeposit and PreviewRedeem turned out to be too difficult to implement in most cases. We recommend to use transaction simulation from non-contract clients such as frontends.

Returns Uint128 amount of vault tokens that will be returned for the passed in amount of base tokens.

Allows an on-chain or off-chain user to simulate the effects of their deposit at the current block, given current on-chain conditions.

Must return as close to and no more than the exact amount of vault tokens that would be minted in a deposit call in the same transaction. I.e. Deposit should return the same or more vault tokens as PreviewDeposit if called in the same transaction.

Fields

amount: Uint128

👎Deprecated since 0.4.1: PreviewDeposit and PreviewRedeem turned out to be too difficult to implement in most cases. We recommend to use transaction simulation from non-contract clients such as frontends.

The amount of base tokens to preview depositing.

PreviewRedeem

👎Deprecated since 0.4.1: PreviewDeposit and PreviewRedeem turned out to be too difficult to implement in most cases. We recommend to use transaction simulation from non-contract clients such as frontends.

Returns Uint128 amount of base tokens that would be withdrawn in exchange for redeeming amount of vault tokens.

Allows an on-chain or off-chain user to simulate the effects of their redeem at the current block, given current on-chain conditions.

Must return as close to and no more than the exact amount of base tokens that would be withdrawn in a redeem call in the same transaction.

Fields

amount: Uint128

👎Deprecated since 0.4.1: PreviewDeposit and PreviewRedeem turned out to be too difficult to implement in most cases. We recommend to use transaction simulation from non-contract clients such as frontends.

The amount of vault tokens to preview redeeming.

TotalAssets

Returns the amount of assets managed by the vault denominated in base tokens. Useful for display purposes, and does not have to confer the exact amount of base tokens.

TotalVaultTokenSupply

Returns Uint128 total amount of vault tokens in circulation.

VaultTokenExchangeRate

Returns the exchange rate of vault tokens quoted in terms of the supplied quote_denom. Returns a Decimal containing the amount of quote_denom assets that can be exchanged for 1 unit of vault tokens.

May return an error if the quote denom is not supported by the vault.

Fields

quote_denom: String

The quote denom to quote the exchange rate in.

ConvertToShares

The amount of vault tokens that the vault would exchange for the amount of assets provided, in an ideal scenario where all the conditions are met.

Useful for display purposes and does not have to confer the exact amount of vault tokens returned by the vault if the passed in assets were deposited. This calculation should not reflect the “per-user” price-per-share, and instead should reflect the “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and from.

Fields

amount: Uint128

The amount of base tokens to convert to vault tokens.

ConvertToAssets

Returns the amount of base tokens that the Vault would exchange for the amount of vault tokens provided, in an ideal scenario where all the conditions are met.

Useful for display purposes and does not have to confer the exact amount of assets returned by the vault if the passed in vault tokens were redeemed. This calculation should not reflect the “per-user” price-per-share, and instead should reflect the “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and from.

Fields

amount: Uint128

The amount of vault tokens to convert to base tokens.

VaultExtension(T)

Handle queries of any enabled extensions.

Trait Implementations

impl<T> Clone for VaultStandardQueryMsg<T>

where T: JsonSchema + Clone,

fn clone(&self) -> VaultStandardQueryMsg<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for VaultStandardQueryMsg<T>

where T: JsonSchema + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for VaultStandardQueryMsg<T>

where T: JsonSchema + Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> JsonSchema for VaultStandardQueryMsg<T>

where T: JsonSchema + JsonSchema,

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<T> PartialEq for VaultStandardQueryMsg<T>

where T: JsonSchema + PartialEq,

fn eq(&self, other: &VaultStandardQueryMsg<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> QueryResponses for VaultStandardQueryMsg<T>

where T: JsonSchema + JsonSchema,

Available on non-WebAssembly only.

fn response_schemas_impl() -> BTreeMap<String, RootSchema>

fn response_schemas() -> Result<BTreeMap<String, RootSchema>, IntegrityError>

impl<T> Serialize for VaultStandardQueryMsg<T>

where T: JsonSchema + Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> StructuralPartialEq for VaultStandardQueryMsg<T>

where T: JsonSchema,