ExecuteMsg

Enum ExecuteMsg 

Source
pub enum ExecuteMsg {
    Receive(Cw20ReceiveMsg),
    Distribute {
        amount: Option<Uint128>,
    },
    Cancel {},
    Delegate {
        validator: String,
        amount: Uint128,
    },
    Redelegate {
        src_validator: String,
        dst_validator: String,
        amount: Uint128,
    },
    Undelegate {
        validator: String,
        amount: Uint128,
    },
    SetWithdrawAddress {
        address: String,
    },
    WithdrawDelegatorReward {
        validator: String,
    },
    WithdrawCanceledPayment {
        amount: Option<Uint128>,
    },
    RegisterSlash {
        validator: String,
        time: Timestamp,
        amount: Uint128,
        during_unbonding: bool,
    },
    UpdateOwnership(Action),
}

Variants§

§

Receive(Cw20ReceiveMsg)

Fund the contract with a cw20 token. The msg field must have the shape {"fund":{}}, and the amount sent must be the same as the amount to be vested (as set during instantiation). Anyone may call this method so long as the contract has not yet been funded.

§

Distribute

Distribute vested tokens to the vest receiver. Anyone may call this method.

Fields

§amount: Option<Uint128>

The amount of tokens to distribute. If none are specified all claimable tokens will be distributed.

§

Cancel

Cancels the vesting payment. The current amount vested becomes the total amount that will ever vest, and all pending and future staking rewards from tokens staked by this contract will be sent to the owner. Tote that canceling does not impact already vested tokens.

Upon canceling, the contract will use any liquid tokens in the contract to settle pending payments to the vestee, and then returns the rest to the owner. Staked tokens are then split between the owner and the vestee according to the number of tokens that the vestee is entitled to.

The vestee will no longer receive staking rewards after cancelation, and may unbond and distribute (vested - claimed) tokens at their leisure. the owner will receive staking rewards and may unbond and withdraw (staked - (vested - claimed)) tokens at their leisure.

§

Delegate

This is translated to a MsgDelegate. delegator_address is automatically filled with the current contract’s address. Note: this only works with the native staking denom of a Cosmos chain. Only callable by Vesting Payment Recipient.

Fields

§validator: String

The validator to delegate to.

§amount: Uint128

The amount to delegate.

§

Redelegate

This is translated to a MsgBeginRedelegate. delegator_address is automatically filled with the current contract’s address. Only callable by Vesting Payment Recipient.

Fields

§src_validator: String
§dst_validator: String
§amount: Uint128
§

Undelegate

This is translated to a MsgUndelegate. delegator_address is automatically filled with the current contract’s address. Only callable by Vesting Payment Recipient.

Fields

§validator: String

The validator to undelegate from

§amount: Uint128

The amount to delegate

§

SetWithdrawAddress

This is translated to a MsgSetWithdrawAddress. delegator_address is automatically filled with the current contract’s address. Only callable by Vesting Payment Recipient.

Fields

§address: String
§

WithdrawDelegatorReward

This is translated to a MsgWithdrawDelegatorReward. delegator_address is automatically filled with the current contract’s address.

Fields

§validator: String

The validator to claim rewards for.

§

WithdrawCanceledPayment

If the owner cancels a payment and there are not enough liquid tokens to settle the owner may become entitled to some number of staked tokens. They may then unbond those tokens and then call this method to return them.

Fields

§amount: Option<Uint128>

The amount to withdraw.

§

RegisterSlash

Registers a slash event bonded or unbonding tokens with the contract. Only callable by the owner as the contract is unable to verify that the slash actually occured. The owner is assumed to be honest.

A future version of this contract may be able to permissionlessly take slashing evidence: https://github.com/CosmWasm/mesh-security/issues/35

Fields

§validator: String

The validator the slash occured for.

§time: Timestamp

The time the slash event occured. Note that this is not validated beyond validating that it is < now. This means that if two slash events occur for a single validator, and then this method is called, a dishonest sender could register those two slashes as a single larger one at the time of the first slash.

The result of this is that the staked balances tracked in this contract can not be relied on for accurate values in the past. Staked balances will be correct at time=now.

§amount: Uint128

The number of tokens that THIS CONTRACT lost as a result of the slash. Note that this differs from the total amount slashed from the validator.

§during_unbonding: bool

If the slash happened during unbonding. Set to false in the common case where the slash impacted bonding tokens.

§

UpdateOwnership(Action)

Update the contract’s ownership. The action to be provided can be either to propose transferring ownership to an account, accept a pending ownership transfer, or renounce the ownership permanently.

Trait Implementations§

Source§

impl Clone for ExecuteMsg

Source§

fn clone(&self) -> ExecuteMsg

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ExecuteMsg

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ExecuteMsg

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for ExecuteMsg

Source§

fn schema_name() -> String

The name of the generated JSON Schema. Read more
Source§

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

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

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

Generates a JSON Schema for this type. Read more
Source§

fn is_referenceable() -> bool

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

impl PartialEq for ExecuteMsg

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for ExecuteMsg

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ExecuteMsg

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<U> As for U

Source§

fn as_<T>(self) -> T
where T: CastFrom<U>,

Casts self to type T. The semantics of numeric casting with the as operator are followed, so <T as As>::as_::<U> can be used in the same way as T as U for numeric conversions. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,