Struct osmosis_std::types::osmosis::incentives::MsgCreateGauge

pub struct MsgCreateGauge {
    pub is_perpetual: bool,
    pub owner: String,
    pub distribute_to: Option<QueryCondition>,
    pub coins: Vec<Coin>,
    pub start_time: Option<Timestamp>,
    pub num_epochs_paid_over: u64,
    pub pool_id: u64,
}

MsgCreateGauge creates a gague to distribute rewards to users

Fields

is_perpetual: bool

is_perpetual shows if it’s a perpetual or non-perpetual gauge Non-perpetual gauges distribute their tokens equally per epoch while the gauge is in the active period. Perpetual gauges distribute all their tokens at a single time and only distribute their tokens again once the gauge is refilled

owner: String

owner is the address of gauge creator

distribute_to: Option<QueryCondition>

distribute_to show which lock the gauge should distribute to by time duration or by timestamp

coins: Vec<Coin>

coins are coin(s) to be distributed by the gauge

start_time: Option<Timestamp>

start_time is the distribution start time

num_epochs_paid_over: u64

num_epochs_paid_over is the number of epochs distribution will be completed over

pool_id: u64

pool_id is the ID of the pool that the gauge is meant to be associated with. if pool_id is set, then the “QueryCondition.LockQueryType” must be “NoLock” with all other fields of the “QueryCondition.LockQueryType” struct unset, including “QueryCondition.Denom”. However, note that, internally, the empty string in “QueryCondition.Denom” ends up being overwritten with incentivestypes.NoLockExternalGaugeDenom() so that the gauges associated with a pool can be queried by this prefix if needed.

Implementations

impl MsgCreateGauge

pub const TYPE_URL: &'static str = "/osmosis.incentives.MsgCreateGauge"

pub fn to_proto_bytes(&self) -> Vec<u8>

pub fn to_any(&self) -> Any

Trait Implementations

impl Clone for MsgCreateGauge

fn clone(&self) -> MsgCreateGauge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MsgCreateGauge

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

Formats the value using the given formatter.

impl Default for MsgCreateGauge

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MsgCreateGauge

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<MsgCreateGauge> for Binary

fn from(msg: MsgCreateGauge) -> Self

Converts to this type from the input type.

impl<T> From<MsgCreateGauge> for CosmosMsg<T>

fn from(msg: MsgCreateGauge) -> Self

Converts to this type from the input type.

impl JsonSchema for MsgCreateGauge

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(gen: &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 Message for MsgCreateGauge

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for MsgCreateGauge

fn eq(&self, other: &MsgCreateGauge) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for MsgCreateGauge

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Binary> for MsgCreateGauge

type Error = StdError

The type returned in the event of a conversion error.

fn try_from(binary: Binary) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<SubMsgResult> for MsgCreateGauge

type Error = StdError

The type returned in the event of a conversion error.

fn try_from(result: SubMsgResult) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for MsgCreateGauge

impl StructuralEq for MsgCreateGauge

impl StructuralPartialEq for MsgCreateGauge