Enum ArchwayMsg 

pub enum ArchwayMsg {
    UpdateContractMetadata {
        contract_address: Option<String>,
        owner_address: Option<String>,
        rewards_address: Option<String>,
    },
    SetFlatFee {
        contract_address: String,
        flat_fee_amount: Coin,
    },
    WithdrawRewards {
        records_limit: Option<u64>,
        record_ids: Vec<u64>,
    },
}

Custom messages to interact with the Archway Network bindings.

Those messages work in conjunction with the cosmwasm_std::CosmosMsg::Custom variant.

Examples

use cosmwasm_std::CosmosMsg;
use archway_bindings::ArchwayMsg;

let msg: CosmosMsg<ArchwayMsg> = CosmosMsg::Custom(
    ArchwayMsg::UpdateContractMetadata {
        contract_address: Some(String::from("contract_address")),
        owner_address: Some(String::from("owner")),
        rewards_address: Some(String::from("rewards")),
    }
);

Variants

UpdateContractMetadata

Updates a contract’s metadata. Either owner_address or rewards_address must be provided.

Fields

contract_address: Option<String>

If set to None, the metadata of the sender contract will be updated. In case the contract_address already has a metadata, the sender contract must be set as the owner_address to be able to update it.

owner_address: Option<String>

If set to None, the contract’s owner will not be updated.

rewards_address: Option<String>

If set to None, the contract’s rewards address will not be updated.

SetFlatFee

Sets a premium fee for a contract. This action should be executed from a contract only if it’s set as the owner_address in the metadata of contract_address. The tx will fail if the contract_address has no metadata.

Fields

contract_address: String

flat_fee_amount: Coin

WithdrawRewards

Withdraws rewards from the contract. This action should be executed from a contract only if it’s set as the rewards_address in a contract metadata. Only one of records_limit or record_ids should be set.

See also

• crate::types::rewards::WithdrawRewardsResponse

Fields

records_limit: Option<u64>

Withdraw rewards up to a specified limit. If set to None, all rewards will be withdrawn up to the limit of records specified by the governance parameter rewards.MaxWithdrawRecords.

record_ids: Vec<u64>

Withdraw rewards by a list of record IDs.

Implementations

impl ArchwayMsg

pub fn update_rewards_ownership(owner_address: impl Into<String>) -> Self

Creates an ArchwayMsg to update the current contract’s metadata ownership.

Arguments

• owner_address - The new owner address.

pub fn update_external_rewards_ownership( contract_address: impl Into<String>, owner_address: impl Into<String>, ) -> Self

Creates an ArchwayMsg to update the ownership of an external contract metadata.

Arguments

• contract_address - The other contract address.
• owner_address - The new owner address.

pub fn update_rewards_address(rewards_address: impl Into<String>) -> Self

Creates an ArchwayMsg to update the current contract’s rewards address.

Arguments

• rewards_address - The new rewards address.

pub fn update_external_rewards_address( contract_address: impl Into<String>, rewards_address: impl Into<String>, ) -> Self

Creates an ArchwayMsg to update the rewards address of an external contract metadata.

Arguments

• contract_address - The other contract address.
• rewards_address - The new rewards address.

pub fn set_flat_fee(contract_address: impl Into<String>, amount: Coin) -> Self

Creates an ArchwayMsg to set a flat fee for a contract.

This action should be executed from a contract only if it’s set as the owner_address in the metadata of contract_address. The tx will fail if the contract_address has no metadata.

Arguments

• contract_address - The contract address.
• amount - The flat fee amount.

pub fn withdraw_max_rewards() -> Self

Creates an ArchwayMsg to withdraw all rewards from the contract up to the maximum limit of records specified by the governance parameter rewards.MaxWithdrawRecords.

This action should be executed from a contract only if its set as the rewards_address in a contract metadata.

pub fn withdraw_rewards_by_limit(limit: u64) -> Self

Creates an ArchwayMsg to withdraw rewards from the contract.

This action should be executed from a contract only if its set as the rewards_address in a contract metadata.

Arguments

• limit - Withdraw rewards up to a specified limit.

pub fn withdraw_rewards_by_ids(record_ids: Vec<u64>) -> Self

Creates an ArchwayMsg to withdraw rewards from the contract by a list of record IDs.

This action should be executed from a contract only if its set as the rewards_address in a contract metadata.

Arguments

• record_ids - List of record IDs to withdraw rewards from the rewards pool.

Trait Implementations

impl Clone for ArchwayMsg

fn clone(&self) -> ArchwayMsg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArchwayMsg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ArchwayMsg

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ArchwayMsg> for CosmosMsg<ArchwayMsg>

fn from(msg: ArchwayMsg) -> Self

Converts to this type from the input type.

impl JsonSchema for ArchwayMsg

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 PartialEq for ArchwayMsg

fn eq(&self, other: &ArchwayMsg) -> 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 Serialize for ArchwayMsg

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl CustomMsg for ArchwayMsg

impl StructuralPartialEq for ArchwayMsg