Struct InstantiateMsg 

pub struct InstantiateMsg {
    pub owner: Option<String>,
    pub recipient: String,
    pub title: String,
    pub description: Option<String>,
    pub total: Uint128,
    pub denom: UncheckedDenom,
    pub schedule: Schedule,
    pub start_time: Option<Timestamp>,
    pub vesting_duration_seconds: u64,
    pub unbonding_duration_seconds: u64,
}

Fields

owner: Option<String>

The optional owner address of the contract. If an owner is specified, the owner may cancel the vesting contract at any time and withdraw unvested funds.

recipient: String

The receiver address of the vesting tokens.

title: String

The a name or title for this payment.

description: Option<String>

A description for the payment to provide more context.

total: Uint128

The total amount of tokens to be vested.

denom: UncheckedDenom

The type and denom of token being vested.

schedule: Schedule

The vesting schedule, can be either SaturatingLinear vesting (which vests evenly over time), or PiecewiseLinear which can represent a more complicated vesting schedule.

start_time: Option<Timestamp>

The time to start vesting, or None to start vesting when the contract is instantiated. start_time may be in the past, though the contract checks that start_time + vesting_duration_seconds > now. Otherwise, this would amount to a regular fund transfer.

vesting_duration_seconds: u64

The length of the vesting schedule in seconds. Must be non-zero, though one second vesting durations are allowed. This may be combined with a start_time in the future to create an agreement that instantly vests at a time in the future, and allows the receiver to stake vesting tokens before the agreement completes.

See suite_tests/tests.rs test_almost_instavest_in_the_future for an example of this.

unbonding_duration_seconds: u64

The unbonding duration for the chain this contract is deployed on. Smart contracts do not have access to this data as stargate queries are disabled on most chains, and cosmwasm-std provides no way to query it.

This value being too high will cause this contract to hold funds for longer than needed, this value being too low will reduce the quality of error messages and require additional external calculations with correct values to withdraw avaliable funds from the contract.

Trait Implementations

impl Clone for InstantiateMsg

fn clone(&self) -> InstantiateMsg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstantiateMsg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InstantiateMsg

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for InstantiateMsg

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 InstantiateMsg

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for InstantiateMsg