vesting

The Vesting contract is responsible for distributing the MARS token to Mars contributors.

InstantiateMsg

Instantiates the Vesting contract. Takes in a contract owner and an unlock_schedule for token unlocking. Schedule is the same for all users.

json

msg.rs

{
    "owner": "...",
    "unlock_schedule": {
        "start_time": 123, 
        "cliff": 123, 
        "duration": 123
    }
}

Params	Type	Description
`owner`	`String`	The contract's owner
`unlock_schedule`	`Schedule`	Schedule for token unlocking; this schedule is the same for all users

`Schedule`

json

msg.rs

{
    "start_time": 123,
    "cliff": 123, 
    "duration": 123
}

Params	Type	Description
`start_time`	`u64`	Time when vesting/unlocking starts
`cliff`	`u64`	Time before with no token is to be vested/unlocked
`duration`	`u64`	Duration of the vesting/unlocking process. At time `start_time + duration`, the tokens are vested/unlocked in full

ExecuteMsg

`create_position`

Creates a new vesting position for a user.

json

msg.rs

{
    "create_position": {
        "user" "mars...", 
        "vest_schedule": {
            "start_time": 123,
            "cliff": 123, 
            "duration": 123
        }
    }
}

Params	Type	Description
`user`	`String`	User address receiving vested tokens
`vest_schedule`	`Schedule`	Schedule for token unlocking; this schedule is the same for all users

`terminate_position`

Terminates a vesting position, and collects all unvested tokens.

json

msg.rs

{
    "terminate_position": {
        "user": "..."
    }
}

Params	Type	Description
`user`	`String`	User address being terminated

`withdraw`

Withdraws vested and unlocked MARS tokens.

json

msg.rs

{
    "withdraw": {}
}

`transfer_ownership`

Transfers the contract's ownership to another account.

json

msg.rs

{
    "transfer_ownership": {}
}

QueryMsg

`config`

Returns the contract's configuration parameters.

json

msg.rs

{
    "config": {}
}

`ConfigResponse`

json

msg.rs

{
    "owner": "...",
    "unlock_schedule": {
        "start_time": 123, 
        "cliff": 123, 
        "duration": 123
    }
}

Params	Type	Description
`owner`	`String`	The contract's owner
`unlock_schedule`	`Schedule`	Schedule for token unlocking; this schedule is the same for all users

`voting_power`

Returns the amount of MARS tokens of a vesting recipient currently locked in the contract.

json

msg.rs

{
    "voting_power": {
        "user": "mars..."
    }
}

Params	Type	Description
`user`	`String`	Address of the user

`VotingPowerResponse`

json

msg.rs

{
    "user": "mars...",
    "voting_power": 123
}

Params	Type	Description
`user`	`String`	Address of the user
`voting_power`	`Uint128`	The user's current voting power, i.e. the amount of MARS tokens locked in vesting contract

`voting_powers`

Enumerates all vesting recipients and returns their current voting power.

json

msg.rs

{
    "voting_powers": {
        "start_after": "mars...",
        "limit": 123
    }
}

Params	Type	Description
`start_after`	`Option<String>`	A Mars account address to start after
`limit`	`Option<u32>`	The amount of addresses to list

`Vec<VotingPowerResponse>`

voting_powers returns a vector of the VotingPowerResponse struct defined above.

`position`

Returns details of a recipient's vesting position. Note: This query depends on block time, therefore it may not work with time travel queries. In such cases, use WASM raw query instead.

json

msg.rs

{
    "position": {
        "user": "mars..."
    }
}

Params	Type	Description
`user`	`String`	Address of the user

`PositionResponse`

json

msg.rs

{
    "user": "mars...",
    "total": 123, 
    "vested": 123, 
    "unlocked": 123, 
    "withdrawn": 123, 
    "withdrawable": 123, 
    "vest_schedule": {
        "start_time": 123, 
        "cliff": 123,
        "duration": 123
    }
}

Params	Type	Description
`user`	`String`	Address of the user
`total`	`Uint128`	Total amount of MARS tokens allocated to this recipient
`vested`	`Uint128`	Amount of tokens that have been vested, according to the vesting schedule
`unlocked`	`Uint128`	Amount of tokens that have been unlocked, according to the unlocking schedule
`withdrawn`	`Uint128`	Amount of tokens that have already been withdrawn
`withdrawable`	`Uint128`	Amount of tokens that can be withdrawn now, defined as the smaller of vested and unlocked amounts, minus the amount already withdrawn
`vest_schedule`	`Schedule`	The vesting position's vesting schedule

`positions`

Enumerates all vesting positions. Note: This query depends on block time, therefore it may not work with time travel queries. In such cases, use WASM raw query instead.

json

msg.rs

{
    "positions": {
        "start_after": "mars...",
        "limit": 123,
    }
}

Params	Type	Description
`start_after`	`Option<String>`	A Mars account address to start after
`limit`	`Option<u32>`	The amount of addresses to list

`Vec<PositionResponse>`

positions returns a vector of the PositionResponse struct defined above.

vesting

Links​

InstantiateMsg​

Schedule​

ExecuteMsg​

create_position​

terminate_position​

withdraw​

transfer_ownership​

QueryMsg​

config​

ConfigResponse​

voting_power​

VotingPowerResponse​

voting_powers​

Vec<VotingPowerResponse>​

position​

PositionResponse​

positions​

Vec<PositionResponse>​

Links

InstantiateMsg

`Schedule`

ExecuteMsg

`create_position`

`terminate_position`

`withdraw`

`transfer_ownership`

QueryMsg

`config`

`ConfigResponse`

`voting_power`

`VotingPowerResponse`

`voting_powers`

`Vec<VotingPowerResponse>`

`position`

`PositionResponse`

`positions`

`Vec<PositionResponse>`