Astral Assembly

Overview

The Assembly contract allows xASTRO holders as well as Initial Astroport Builders to post and vote on new on-chain proposals that can execute arbitrary logic.

InstantiateMsg

Instantiate the contract with proposal parameter limitations and the xASTRO and builder unlock contract addresses.

json

assembly.rs

{
    "xastro_token_addr": "terra...", 
    "builder_unlock_addr": "terra...",
    "proposal_voting_period": 123,
    "proposal_effective_delay": 123,
    "proposal_expiration_period": 123,
    "proposal_required_deposit": "123",
    "proposal_required_quorum": "0.55",
    "proposal_required_threshold": "0.55",
    "whitelisted_links": [
        "https://some.link"
    ]
}

Params	Type	Description
`xastro_token_addr`	`String`	Address of xASTRO token
`builder_unlock_addr`	`String`	Address of the builder unlock contract
`proposal_voting_period`	`u64`	Proposal voting period
`proposal_effective_delay`	`u64`	Proposal effective delay
`proposal_expiration_period`	`u64`	Proposal expiration period
`proposal_required_deposit`	`Uint128`	Proposal required deposit
`proposal_required_quorum`	`String`	Proposal required quorum
`proposal_required_threshold`	`String`	Proposal required threshold
`whitelisted_links`	`Vec<String>`	Whitelisted links

ExecuteMsg

`receive`

Receive a new on-chain proposal.

json

assembly.rs

{
    "receive": {
        "sender": "...",
        "amount": "123", 
        "msg": "<base64_encoded_json_string>"
    }
}

Params	Type	Description
`receive`	`Cw20ReceiveMsg`	CW20 receive message

`cast_vote`

Casts a vote for an active proposal.

json

assembly.rs

{
    "cast_vote": {
        "proposal_id": 123, 
        "vote": "for"
    }
}

Params	Type	Description
`proposal_id`	`u64`	Proposal identifier
`vote`	`ProposalVoteOption`	Vote option

`ProposalVoteOption`

This structure describes a proposal vote.

assembly.rs

#[cw_serde]
pub enum ProposalVoteOption {
    For,
    Against,
}

Variants	Description
`For`	Vote for proposal
`Against`	Vote against proposal

`end_proposal`

Ends an expired proposal.

json

assembly.rs

{
    "end_proposal": {
        "proposal_id": 123
    }
}

Params	Type	Description
`proposal_id`	`u64`	Proposal identifier

`check_messages`

Check messages execution.

json

assembly.rs

{
    "check_messages": {
        "messages": [
            {
                "proposal_message": {
                    "order": "123", 
                    "msg": "<CosmosMsg>"
                }
            }
        ]
    }
}

Params	Type	Description
`messages`	`Vec<ProposalMessage>`	Messages

`ProposalMessage`

This structure describes a proposal message.

json

assembly.rs

{
    "proposal_message": {
        "order": "123", 
        "msg": "<CosmosMsg>"
    }
}

Params	Type	Description
`order`	`Uint64`	Order of execution of the message
`msg`	`CosmosMsg`	Execution message

`check_messages_passed`

The last endpoint which is executed only if all proposal messages have been passed.

json

assembly.rs

{
    "check_messages_passed": {}
}

`execute_proposal`

Executes a sucessful proposal.

json

assembly.rs

{
    "execute_proposal": {
        "proposal_id": 123
    }
}

`remove_completed_proposal`

Removes a completed proposal from the proposal list.

json

assembly.rs

{
    "remove_completed_proposal": {
        "proposal_id": 123
    }
}

`update_config`

Update contract parameters. Only the Assembly is allowed to update its own parameters.

json

assembly.rs

{
    "update_config": {
        "xastro_token_addr": "...", 
        "vxastro_token_addr": "...",
        "voting_escrow_delegator_addr": "...", 
        "builder_unlock_addr": "...",
        "proposal_voting_period": 123,
        "proposal_effective_delay": 123,
        "proposal_expiration_period": 123,
        "proposal_required_deposit": "123",
        "proposal_required_quorum": "0.55",
        "proposal_required_threshold": "0.55",
        "whitelist_remove": [
            "https://some.link"
        ], 
        "whitelist_add": [
            "https://some.link"
        ]
    }
}

`UpdateConfig`

This structure stores the params used when updating the main Assembly contract params.

json

assembly.rs

{
    "xastro_token_addr": "...", 
    "vxastro_token_addr": "...",
    "voting_escrow_delegator_addr": "...", 
    "builder_unlock_addr": "...",
    "proposal_voting_period": 123,
    "proposal_effective_delay": 123,
    "proposal_expiration_period": 123,
    "proposal_required_deposit": "123",
    "proposal_required_quorum": "0.55",
    "proposal_required_threshold": "0.55",
    "whitelist_remove": [
        "https://some.link"
    ], 
    "whitelist_add": [
        "https://some.link"
    ]
}

Params	Type	Description
`xastro_token_addr`	`Option<String>`	xASTRO token address
`vxastro_token_addr`	`Option<String>`	vxASTRO token address
`voting_escrow_delegator_addr`	`Option<String>`	Voting Escrow delegator address
`builder_unlock_addr`	`Option<String>`	Builder unlock contract address
`proposal_voting_period`	`Option<u64>`	Proposal voting period
`proposal_effective_delay`	`Option<u64>`	Proposal effective delay
`proposal_expiration_period`	`Option<u64>`	Proposal expiration period
`proposal_required_deposit`	`Option<u128>`	Proposal required deposit
`proposal_required_quorum`	`Option<String>`	Proposal required quorum
`proposal_required_threshold`	`Option<String>`	Proposal required threshold
`whitelist_remove`	`Option<String>`	Links to remove from whitelist
`whitelist_add`	`Option<String>`	Links to add to whitelist

Cw20HookMsg

`submit_proposal`

Submit a new proposal in the Assembly.

NOTE

You should execute this message inside the xASTRO token contract.

json

{
    "send": {
        "contract": "AssemblyContractAddress", 
        "amount": "999", 
        "msg": "base64-encodedStringOfWithdrawMsg"
    }
}

Params	Type	Description
`send`	`Cw20ExecuteMsg`	CW20 receive message

In send.msg, you may encode this JSON string into base64 encoding.

json

assembly.rs

{
    "submit_proposal": {
        "title": "Example proposal",
        "description": "Example proposal",
        "link": "https://forum.astroport.fi/",
        "messages":
            [
                {
                    "wasm": {
                        "execute": {
                            "contract_addr": "terra..",
                            "msg": "<base64_encoded_json_string>",
                            "funds": []
                        }
                    }
                }
            ],
        "ibc_channel": "channel..."
    }
}

Params	Type	Description
`title`	`String`	Proposal title
`description`	`String`	Description for proposal
`link`	`Option<String>`	Link for proposal
`messages`	`Option<Vec<ProposalMessage>>`	Proposal messages
`ibc_channel`	`Option<String>`	If the proposal should be executed on a remote chain, this field should specify the governance channel

QueryMsg

`config`

Queries Astral Assembly parameters.

json

assembly.rs

{
    "config": {}
}

`Config` (response)

json

assembly.rs

{
    "xastro_token_addr": "...", 
    "vxastro_token_addr": "...",
    "voting_escrow_delegator_addr": "...", 
    "builder_unlock_addr": "...",
    "proposal_voting_period": 123,
    "proposal_effective_delay": 123,
    "proposal_expiration_period": 123,
    "proposal_required_deposit": "123",
    "proposal_required_quorum": "0.55",
    "proposal_required_threshold": "0.55",
    "whitelisted_links": [
        "https://some.link"
    ]
}

Params	Type	Description
`xastro_token_addr`	`Addr`	xASTRO token address
`vxastro_token_addr`	`Option<Addr>`	vxASTRO token address
`voting_escrow_delegator_addr`	`Option<Addr>`	Voting Escrow delegator address
`builder_unlock_addr`	`Addr`	Builder unlock contract address
`proposal_voting_period`	`u64`	Proposal voting period
`proposal_effective_delay`	`u64`	Proposal effective delay
`proposal_expiration_period`	`u64`	Proposal expiration period
`proposal_required_deposit`	`Uint128`	Proposal required deposit
`proposal_required_quorum`	`Decimal`	Proposal required quorum
`proposal_required_threshold`	`Decimal`	Proposal required threshold
`whitelisted_links`	`Vec<String>`	Whitelisted links

`proposals`

Queries the current proposal list.

json

assembly.rs

{
    "proposals": {
        "start": 5, 
        "limit": 5
    }
}

Params	Type	Description
`start`	`Option<u64>`	Id from which to start querying
`limit`	`Option<u32>`	The amount of proposals to return

`ProposalListResponse`

This structure describes a proposal list response.

json

assembly.rs

{
    "proposal_count": "10", 
    "proposal_list": [
        {
            "proposal_id": "123", 
            "submitter": "...", 
            "status": "active", 
            "for_power": "100000", 
            "against_power": "100000", 
            "start_block": 123, 
            "start_time": 123, 
            "end_block": 123, 
            "delayed_end_block": 123, 
            "expiration_block": 123, 
            "title": "...", 
            "description": "...", 
            "link": "https://some.link", 
            "messages": [
                {
                    "order": "1", 
                    "msg": "<CosmosMsg>"
                }, 
                {
                    "order": "2", 
                    "msg": "<CosmosMsg>"
                }, 
                ...etc
            ], 
            "deposit_amount": "100000"
        },
        etc...
    ]
}

Params	Type	Description
`proposal_count`	`Uint64`	The amount of proposals returned
`proposal_list`	`Vec<ProposalResponse>`	The list of proposals that are returned

`ProposalResponse`

This structure describes a proposal response.

json

assembly.rs

{
    "proposal_id": "123", 
    "submitter": "...", 
    "status": "active", 
    "for_power": "100000", 
    "against_power": "100000", 
    "start_block": 123, 
    "start_time": 123, 
    "end_block": 123, 
    "delayed_end_block": 123, 
    "expiration_block": 123, 
    "title": "...", 
    "description": "...", 
    "link": "https://some.link", 
    "messages": [
        {
            "order": "1", 
            "msg": "<CosmosMsg>"
        }, 
        {
            "order": "2", 
            "msg": "<CosmosMsg>"
        }, 
        ...etc
    ], 
    "deposit_amount": "100000"
}

Params	Type	Description
`proposal_id`	`Uint64`	Unique proposal ID
`submitter`	`Addr`	The address of the proposal submitter
`status`	`ProposalStatus`	Status of the proposal
`for_power`	`Uint128`	`For` power of proposal
`against_power`	`Uint128`	`Against` power of proposal
`start_block`	`u64`	Start block of proposal
`start_time`	`u64`	Start time of proposal
`end_block`	`u64`	End block of proposal
`delayed_end_block`	`u64`	Delayed end block of proposal
`expiration_block`	`u64`	Expiration block of proposal
`title`	`String`	Proposal title
`description`	`String`	Proposal description
`link`	`Option<String>`	Proposal link
`messages`	`Option<Vec<ProposalMessage>>`	Proposal messages
`deposit_amount`	`Uint128`	Amount of xASTRO deposited in order to post the proposal

`ProposalStatus`

This enum describes available statuses/states for a Proposal.

assembly.rs

#[cw_serde]
pub enum ProposalStatus {
    Active,
    Passed,
    Rejected,
    Executed,
    Expired,
}

Variants	Description
`Active`	Proposal is currently active
`Passed`	Proposal passed
`Rejected`	Proposal rejected
`Executed`	Proposal executed
`Expired`	Proposal expired

`proposal`

Queries information about a specific proposal.

json

assembly.rs

{
    "proposal": {
        "proposal_id": 123
    }
}

Params	Type	Description
`proposal_id`	`Option<u64>`	Id from which to start querying

Returns ProposalResponse

`proposal_voters`

Queries list of voters of specified proposal.

json

assembly.rs

{
    "proposal_voters": {
        "proposal_id": 123, 
        "vote_option": "for", 
        "start": 5, 
        "limit": 5
    }
}

Params	Type	Description
`proposal_id`	`u64`	Proposal unique id
`vote_option`	`ProposalVoteOption`	Proposal vote option
`start`	`Option<u64>`	Id from which to start querying
`limit`	`Option<u32>`	The amount of proposals to return

Returns a vector that contains objects of type Addr

`proposal_votes`

Queries information about the votes cast on a proposal.

json

assembly.rs

{
    "proposal_votes": {
        "proposal_id": 123
    }
}

Params	Type	Description
`proposal_id`	`u64`	Proposal unique id

`ProposalVotesResponse`

This structure describes a proposal vote response.

json

assembly.rs

{
    "proposal_id": 123, 
    "for_power": "1000000", 
    "against_power": "1000000"
}

Params	Type	Description
`proposal_id`	`u64`	Proposal identifier
`for_power`	`Uint128`	Total amount of `for` votes for a proposal
`against_power`	`Uint128`	Total amount of `against` votes for a proposal

`user_voting_power`

Queries user voting power for a specific proposal.

json

assembly.rs

{
    "user_voting_power": {
        "user": "...", 
        "proposal_id": 123
    }
}

Params	Type	Description
`user`	`String`	User address
`proposal_id`	`u64`	Proposal unique id

Returns Uint128

`total_voting_power`

Queries total voting power for a specific proposal.

json

assembly.rs

{
    "total_voting_power": {
        "proposal_id": 123
    }
}

Params	Type	Description
`proposal_id`	`u64`	Proposal unique id

Returns Uint128

Astral Assembly

Overview​

Links​

InstantiateMsg​

ExecuteMsg​

receive​

cast_vote​

ProposalVoteOption​

end_proposal​

check_messages​

ProposalMessage​

check_messages_passed​

execute_proposal​

remove_completed_proposal​

update_config​

UpdateConfig​

Cw20HookMsg​

submit_proposal​

QueryMsg​

config​

Config (response)​

proposals​

ProposalListResponse​

ProposalResponse​

ProposalStatus​

proposal​

proposal_voters​

proposal_votes​

ProposalVotesResponse​

user_voting_power​

total_voting_power​

Overview

Links

InstantiateMsg

ExecuteMsg

`receive`

`cast_vote`

`ProposalVoteOption`

`end_proposal`

`check_messages`

`ProposalMessage`

`check_messages_passed`

`execute_proposal`

`remove_completed_proposal`

`update_config`

`UpdateConfig`

Cw20HookMsg

`submit_proposal`

QueryMsg

`config`

`Config` (response)

`proposals`

`ProposalListResponse`

`ProposalResponse`

`ProposalStatus`

`proposal`

`proposal_voters`

`proposal_votes`

`ProposalVotesResponse`

`user_voting_power`

`total_voting_power`