Struct osmosis_std::types::osmosis::lockup::PeriodLock

pub struct PeriodLock {
    pub id: u64,
    pub owner: String,
    pub duration: Option<Duration>,
    pub end_time: Option<Timestamp>,
    pub coins: Vec<Coin>,
    pub reward_receiver_address: String,
}

PeriodLock is a single lock unit by period defined by the x/lockup module. It’s a record of a locked coin at a specific time. It stores owner, duration, unlock time and the number of coins locked. A state of a period lock is created upon lock creation, and deleted once the lock has been matured after the duration has passed since unbonding started.

Fields

id: u64

ID is the unique id of the lock. The ID of the lock is decided upon lock creation, incrementing by 1 for every lock.

owner: String

Owner is the account address of the lock owner. Only the owner can modify the state of the lock.

duration: Option<Duration>

Duration is the time needed for a lock to mature after unlocking has started.

end_time: Option<Timestamp>

EndTime refers to the time at which the lock would mature and get deleted. This value is first initialized when an unlock has started for the lock, end time being block time + duration.

coins: Vec<Coin>

Coins are the tokens locked within the lock, kept in the module account.

reward_receiver_address: String

Reward Receiver Address is the address that would be receiving rewards for the incentives for the lock. This is set to owner by default and can be changed via separate msg.

Implementations

impl PeriodLock

pub const TYPE_URL: &'static str = "/osmosis.lockup.PeriodLock"

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

pub fn to_any(&self) -> Any

Trait Implementations

impl Clone for PeriodLock

fn clone(&self) -> PeriodLock

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PeriodLock

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

Formats the value using the given formatter.

impl Default for PeriodLock

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PeriodLock

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PeriodLock> for Binary

fn from(msg: PeriodLock) -> Self

Converts to this type from the input type.

impl<T> From<PeriodLock> for CosmosMsg<T>

fn from(msg: PeriodLock) -> Self

Converts to this type from the input type.

impl JsonSchema for PeriodLock

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 PeriodLock

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 PeriodLock

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

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 PeriodLock

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 PeriodLock

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 PeriodLock

impl StructuralEq for PeriodLock

impl StructuralPartialEq for PeriodLock