Gov
The Gov Contract contains logic for holding governance polls and handling Anchor Token (ANC) staking, and allows Anchor Protocol to be governed by its users in a decentralized manner. After the initial bootstrapping of Anchor Protocol's contracts, the Gov Contract is assigned to be the owner of all contracts in Anchor Protocol.
New proposals for change are submitted as polls, and are voted on by ANC stakers through the voting procedure. Polls can contain messages that can be executed directly without changing the Anchor Protocol code.
The Gov Contract keeps a balance of ANC tokens, which it uses to reward stakers with funds it receives from trading fees sent by the Anchor Collector and user deposits from creating new governance polls. This balance is separate from the Community Pool, which is held by the Community contract (owned by the Gov contract).
Key | Type | Description |
owner | CanonicalAddr | Address of contract owner |
anchor_token | CanonicalAddr | Contract address of Anchor Token (ANC) |
quorum | Decimal | Minimum percentage of participation required for a poll to pass |
threshold | Decimal | Minimum percentage of yes votes required for a poll to pass |
voting_period | u64 | Number of blocks during which votes can be cast [blocks] |
timelock_period | u64 | Number of blocks required after a poll pass before executing changes [blocks] |
expiration_period | u64 | Number of blocks after a poll's voting period during which the poll can be executed [blocks] |
proposal_deposit | Uint128 | Minimum ANC deposit required for submitting a new poll |
snapshot_period | u64 | Window of time (number of blocks) allowed for poll snapshot before a poll's end [blocks] |
Rust
JSON
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
pub struct InstantiateMsg {
pub quorum: Decimal,
pub threshold: Decimal,
pub voting_period: u64,
pub timelock_period: u64,
pub expiration_period: u64,
pub proposal_deposit: Uint128,
pub snapshot_period: u64,
}
{
"quorum": "0.1",
"threshold": "0.5",
"voting_period": 123456,
"timelock_period": 123456,
"expiration_period": 123456,
"proposal_deposit": "100000000",
"snapshot_period": 123456
}
Key | Type | Description |
quorum | Decimal | Minimum percentage of participation required for a poll to pass |
threshold | Decimal | Minimum percentage of yes votes required for a poll to pass |
voting_period | u64 | Number of blocks during which votes can be cast [blocks] |
timelock_period | u64 | Number of blocks required after a poll pass before executing changes [blocks] |
expiration_period | u64 | Number of blocks after a poll's voting period during which the poll can be executed [blocks] |
proposal_deposit | Uint128 | Minimum ANC deposit required for submitting a new poll |
snapshot_period | u64 | Window of time (number of blocks) allowed for poll snapshot before a poll's end [blocks] |
Can be called during a CW20 token transfer when the Gov contract is the recipient. Allows the token transfer to execute a Receive Hook as a subsequent action within the same transaction.
Rust
JSON
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExecuteMsg {
Receive {
sender: String,
amount: Uint128,
msg: Binary,
}
}
{
"receive": {
"amount": "10000000",
"sender": "terra1...",
"msg": "eyAiZXhlY3V0ZV9tc2ciOiAiYmluYXJ5IiB9"
}
}
Key | Type | Description |
sender | String | Sender of token transfer |
amount | Uint128 | Amount of tokens received |
msg | Binary |
Executes messages in a passed poll. Can only by issued by
Gov.Rust
JSON
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExecuteMsg {
ExecutePollMsgs {
poll_id: u64,
}
}
{
"execute_poll_msgs": {
"poll_id": 8
}
}
Key | Type | Description |
poll_id | u64 | Poll ID |
Registers the contract addresses (i.e. Anchor Token, ANC) to Gov.
Rust
JSON
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExecuteMsg {
RegisterContracts {
anchor_token: String,
}
}
{
"register_contracts": {
"anchor_token": "terra1...",
}
}
Key | Type | Description |
anchor_token | String | Contract address of Anchor Token (ANC) |
Updates the configuration of the Gov contract.
Rust
JSON
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExecuteMsg {
UpdateConfig {
owner: Option<String>,
quorum: Option<Decimal>,
threshold: Option<Decimal>,
voting_period: Option<u64>,
timelock_period: Option<u64>,
expiration_period: Option<u64>,
proposal_deposit: Option<Uint128>,
snapshot_period: Option<u64>,
}
}
{
"update_config": {
"owner": "terra1...",
"quorum": "0.1",
"threshold": "0.1",
"voting_period": 123456,
"timelock_period": 123456,
"expiration_period": 123456,
"proposal_deposit": "100000000",
"snapshot_period": 123456
}
}
Key | Type | Description |
owner* | String | New address of contract owner |
quorum* | Decimal | New percentage of participation (of total staked ANC) required for a poll to pass |
threshold* | Decimal | New percentage of yes votes required for a poll to pass |
voting_period* | u64 | New number of blocks during which votes for a poll can be cast after it has finished its deposit [blocks] |
timelock_period* | u64 | New number of blocks required after a poll pass before executing changes [blocks] |
expiration_period* | u64 | New number of blocks after a poll's voting period during which the poll can be executed [blocks] |
proposal_deposit* | Uint128 | New minimum ANC deposit required for a poll to enter voting |
snapshot_period* | u64 | New window of time (number of blocks) allowed for poll snapshot before a poll's end [blocks] |
* = optional
Submits a user's vote for an active poll. Once a user has voted, they cannot change their vote with subsequent messages (increasing voting power, changing vote option, cancelling vote, etc.)
Rust
JSON
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExecuteMsg {
CastVote {
poll_id: u64,
vote: VoteOption,
amount: Uint128,
}
}
​
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum VoteOption {
Yes,
No,
}
{
"cast_vote": {
"poll_id": 8,
"vote": "yes",
"amount": "10000000"
}
}
Key | Type | Description |
poll_id | u64 | Poll ID |
vote | VoteOption | Can be yes or no |
amount | Uint128 | Amount of voting power (staked ANC) to allocate |
Removes specified amount of staked ANC tokens from a staking position and returns them to a user's balance. Withdraws all staked ANC tokens if
amount is not specified.Rust
JSON
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExecuteMsg {
WithdrawVotingTokens {
amount: Option<Uint128>,
}
}
{
"withdraw_voting_tokens": {
"amount": "100000000"
}
}
Key | Type | Description |
amount* | Uint128 | Amount of ANC tokens to withdraw |
* = optional
Can be issued by anyone to end the voting for an active poll. Triggers tally the results to determine whether the poll has passed. The current block height must exceed the end height of voting phase.
Rust
JSON
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExecuteMsg {
EndPoll {
poll_id: u64,
}
}
{
"end_poll": {
"poll_id": 8
}
}
Key | Type | Description |
poll_id | u64 | Poll ID |
Can be issued by anyone to implement into action the contents of a passed poll. The current block height must exceed the end height of the poll's effective delay.
Rust
JSON
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExecuteMsg {
ExecutePoll {
poll_id: u64,
}
}
{
"execute_poll": {
"poll_id": 8
}
}
Key | Type | Description |
poll_id | u64 | Poll ID |
Snapshots the total amount of staked ANC and stores the number to the specified poll. This staked ANC amount is used to determine the degree of participation for this poll, calculated by dividing the total amount of ANC voted to the poll with the total staked ANC supply at the time of EndPoll. Can only be issued within a window of
snapshot_period blocks before the poll's end_height.Rust
JSON
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ExecuteMsg {
SnapshotPoll {
poll_id: u64,
}
}
{
"snapshot_poll": {
"poll_id": 8
}
}
Key | Type | Description |
poll_id | u64 | Poll ID |
WARNING
Sending ANC tokens to the Gov contract without issuing this hook will lead to PERMANENT LOSS OF FUNDS and will be irrevocably donated to the reward pool for stakers.
Issued when sending ANC tokens to the Gov contract to add them to their ANC staking position.
Rust
JSON
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum Cw20HookMsg {
StakeVotingTokens {}
}
{
"stake_voting_tokens": {}
}
Key | Type | Description |
​ | ​ | ​ |
Issued when sending ANC tokens to the Gov contract to create a new poll. Will only succeed if the amount of tokens sent meets the configured
proposal_deposit amount. Can contain a list of generic messages to be issued by the Gov contract if it passes (can invoke messages in other contracts it owns).Rust
JSON
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum Cw20HookMsg {
CreatePoll {
title: String,
description: String,
link: Option<String>,
execute_msgs: Option<Vec<PollExecuteMsg>>,
}
}
​
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub struct PollExecuteMsg {
pub order: u64,
pub contract: String,
pub msg: Binary,
}
{
"create_poll": {
"title": "...",
"description": "...",
"link": "https://...",
"execute_msgs": [
{
"order": 1,
"contract": "terra1...",
"msg": "eyAiZXhlY3V0ZV9tc2ciOiAiYmluYXJ5IiB9"
},
{
"order": 2,
"contract": "terra1...",
"msg": "eyAiZXhlY3V0ZV9tc2ciOiAiYmluYXJ5IiB9"
}
]
}
}
Key | Type | Description |
title | String | Poll title |
description | String | Poll description |
link* | String | URL to external post about poll (forum, PDF, etc.) |
execute_msgs* | Vec<PollExecuteMsg> | List of governance messages to be issued by Gov contract upon poll execution |
Key | Type | Description |
order | u64 | Order sequence of message |
contract | String | Contract address of governance message recipient |
msg | Binary | Base64-encoded JSON of governance message |
* = optional
Gets the configuration for the Gov contract.
Rust
JSON
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum QueryMsg {
Config {}
}
{
"config": {}
}
Key | Type | Description |
​ | ​ | ​ |
Rust
JSON
#[derive(Serialize, Deserialize, Clone, PartialEq, JsonSchema)]
pub struct ConfigResponse {
pub owner: String,
pub anchor_token: String,
pub quorum: Decimal,
pub threshold: Decimal,
pub voting_period: u64,
pub timelock_period: u64,
pub expiration_period: u64,
pub proposal_deposit: Uint128,
pub snapshot_period: u64,
}
{
"owner": "terra1...",
"anchor_token": "terra1...",
"quorum": "0.1",
"threshold": "0.5",
"voting_period": 123456,
"timelock_period": 123456,
"expiration_period": 123456,
"proposal_deposit": "100000000",
"snapshot_period": 123456
}
Key | Type | Description |
owner | String | Address of contract owner |
anchor_token | String | Contract address of Anchor Token (ANC) |
quorum | Decimal | Minimum percentage of participation required for a poll to pass |
threshold | Decimal | Minimum percentage of yes votes required for a poll to pass |
voting_period | u64 | Number of blocks during which votes can be cast [blocks] |
timelock_period | u64 | Number of blocks required after a poll pass before executing changes [blocks] |
expiration_period | u64 | Number of blocks after a poll's voting period during which the poll can be executed [blocks] |
proposal_deposit | Uint128 | Minimum ANC deposit required for submitting a new poll |
snapshot_period | u64 | Window of time (number of blocks) allowed for poll snapshot before a poll's end [blocks] |
Gets state information for the Gov contract.
Rust
JSON
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum QueryMsg {
State {}
}
{
"state": {}
}
Key | Type | Description |
​ | ​ | ​ |
Rust
JSON
#[derive(Serialize, Deserialize, Clone, PartialEq, JsonSchema)]
pub struct StateResponse {
pub poll_count: u64,
pub total_share: Uint128,
pub total_deposit: Uint128,
}
{
"poll_count": 8,
"total_share": "100000000",
"total_deposit": "100000000"
}
Key | Type | Description |
poll_count | u64 | Total number of created polls |
total_share | Uint128 | Current total number of voting shares |
total_deposit | Uint128 | Total amount of ANC currently deposited for poll creation |
Gets information for the specified ANC staker.
Rust
JSON
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum QueryMsg {
Staker {
address: String,
}
}
{
"staker": {
"address": "terra1..."
}
}
Key | Type | Description |
address | String | Address of staker |
Rust
JSON
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, JsonSchema)]
pub struct StakerResponse {
pub balance: Uint128,
pub share: Uint128,
pub locked_balance: Vec<(u64, VoterInfo)>, // (Voted Poll's ID, VoterInfo)
}
​
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
pub struct VoterInfo {
pub vote: VoteOption,
pub balance: Uint128,
}
​
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum VoteOption {
Yes,
No,
}
{
"balance": "100000000",
"share": "100000000",
"locked_balance": [
[
7,
{
"vote": "yes",
"balance": "100000000"
}
],
[
8,
{
"vote": "no",
"balance": "100000000"
}
]
]
}
Key | Type | Description |
balance | Uint128 | Amount of ANC staked by staker |
share | Uint128 | Total voting shares owned by staker |
locked_balance | Vec<(u64, VoterInfo)> | List of (voted poll's ID, voter's vote information) |
Name | Type | Description |
vote | VoteOption | Vote type made by staker |
balance | Uint128 | Amount of staked ANC locked to vote this poll |
Name | Description |
yes | Staker has voted for the proposal |
no | Staker has voted against the proposal |
Gets information for the specified poll.