This module provides the functionalities related to the foundation. The foundation can turn off these functionalities irreversibly, through the corresponding proposal. Therefore, the users can ensure that no one can bring back these foundation-specific functionalities.
x/foundation's authority is a module account associated with the foundation
and a decision policy. It is an "administrator" which has the ability to add,
remove and update members in the foundation.
x/foundation has several messages which cannot be triggered but by the
authority. It includes membership management messages, and other messages which
controls the assets of the foundation.
Note: The authority is a module account, which means no one has the private key of the authority. Hence, foundation members MUST propose, vote and execute the corresponding proposal.
A decision policy is the rules that dictate whether a proposal should pass or not based on its tally outcome.
All decision policies generally would have a mininum execution period and a maximum voting window. The minimum execution period is the minimum amount of time that must pass after submission in order for a proposal to potentially be executed, and it may be set to 0. The maximum voting window is the maximum time after submission that a proposal may be voted on before it is tallied.
The chain developer also defines an app-wide maximum execution period, which is the maximum amount of time after a proposal's voting period end where the members are allowed to execute a proposal.
The current foundation module comes shipped with two decision policies:
threshold and percentage. Any chain developer can extend upon these two, by
creating custom decision policies, as long as they adhere to the
DecisionPolicy interface:
A threshold decision policy defines a threshold of yes votes (based on a tally of voter weights) that must be achieved in order for a proposal to pass. For this decision policy, abstain and veto are simply treated as no's.
A percentage decision policy is similar to a threshold decision policy, except that the threshold is not defined as a constant weight, but as a percentage. It's more suited for a foundation where the membership can be updated, as the percentage threshold stays the same, and doesn't depend on how the number of members get updated.
A outsourcing decision policy is a policy set after x/foundation decides to
outsource its proposal relevant features to other modules (e.g. x/group).
It means one can expect that any states relevant to the feature must be removed
in the update to this policy.
Any foundation member(s) can submit a proposal for the foundation policy account to decide upon. A proposal consists of a set of messages that will be executed if the proposal passes as well as any metadata associated with the proposal.
There are four choices to choose while voting - yes, no, abstain and veto. Not all decision policies will take the four choices into account. Votes can contain some optional metadata.
In the current implementation, the voting window begins as soon as a proposal is submitted, and the end is defined by the decision policy.
Proposals can be withdrawn any time before the voting period end, either by the
module's authority or by one of the proposers. Once withdrawn, it is marked as
PROPOSAL_STATUS_WITHDRAWN, and no more voting or execution is allowed on it.
If the decision policy is updated during the voting period of the proposal,
then the proposal is marked as PROPOSAL_STATUS_ABORTED, and no more voting or
execution is allowed on it. This is because the decision policy defines the
rules of proposal voting and execution, so if those rules change during the
lifecycle of a proposal, then the proposal should be marked as stale.
Tallying is the counting of all votes on a proposal. It can be triggered by the following two factors:
- either someone tries to execute the proposal (see next section), which can
happen on a
Msg/Exectransaction, or aMsg/{SubmitProposal,Vote}transaction with theExecfield set. When a proposal execution is attempted, a tally is done first to make sure the proposal passes. - or on
EndBlockwhen the proposal's voting period end just passed.
If the tally result passes the decision policy's rules, then the proposal is
marked as PROPOSAL_STATUS_ACCEPTED, or else it is marked as
PROPOSAL_STATUS_REJECTED. In any case, no more voting is allowed anymore, and
the tally result is persisted to state in the proposal's FinalTallyResult.
Proposals are executed only when the tallying is done, and the decision policy
allows the proposal to pass based on the tally outcome. They are marked by the
status PROPOSAL_STATUS_ACCEPTED. Execution must happen before a duration of
MaxExecutionPeriod (set by the chain developer) after each proposal's voting
period end.
Proposals will not be automatically executed by the chain in this current
design, but rather a member must submit a Msg/Exec transaction to attempt to
execute the proposal based on the current votes and decision policy. Any member
can execute proposals that have been accepted, and execution fees are paid by
the proposal executor.
It's also possible to try to execute a proposal immediately on creation or on
new votes using the Exec field of Msg/SubmitProposal and Msg/Vote
requests. In the former case, proposers signatures are considered as yes votes.
In these cases, if the proposal can't be executed (i.e. it didn't pass the
decision policy's rules), it will still be opened for new votes and
could be tallied and executed later on.
A successful proposal execution will have its ExecutorResult marked as
PROPOSAL_EXECUTOR_RESULT_SUCCESS. The proposal will be automatically pruned
after execution. On the other hand, a failed proposal execution will be marked
as PROPOSAL_EXECUTOR_RESULT_FAILURE. Such a proposal can be re-executed
multiple times, until it expires after MaxExecutionPeriod after voting period
end.
Proposals and votes are automatically pruned to avoid state bloat.
Votes are pruned:
- either after a successful tally, i.e. a tally whose result passes the
decision policy's rules, which can be trigged by a
Msg/Execor aMsg/{SubmitProposal,Vote}with theExecfield set, - or on
EndBlockright after the proposal's voting period end. This applies to proposals with statusabortedorwithdrawntoo. - or after updating the membership or decision policy.
whichever happens first.
Proposals are pruned:
- on
EndBlockwhose proposal status iswithdrawnorabortedon proposal's voting period end before tallying, - and either after a successful proposal execution,
- or on
EndBlockright after the proposal'svoting_period_end+max_execution_period(defined as an app-wide configuration) is passed,
whichever happens first.
The foundation module defines interfaces of authorizations on messages to
enforce_censorship_ on its execution. The other modules may deny the execution
of the message based on the information in the foundation.
Authorization is an interface that must be implemented by a concrete
authorization logic to validate and execute grants. Authorizations are
extensible and can be defined for any Msg service method even outside of the
module where the Msg method is defined.
Note: The foundation module's Authorization is different from that of
x/authz, while the latter allows an account to perform actions on behalf of
another account.
ReceiveFromTreasuryAuthorization implements the Authorization interface for
the Msg/WithdrawFromTreasury.
Note: The subject which executes
lbm.foundation.v1.MsgWithdrawFromTreasury is the foundation.
CreateValidatorAuthorization implements the Authorization interface for the
Msg/CreateValidator.
An account must have this authorization prior to sending the message.
Note: You MUST provide the CreateValidatorAuthorizations into the genesis
if Msg/CreateValidator is being censored (CensoredMsgTypeUrls contains the
url of Msg/CreateValidator), or the chain cannot be started.
x/foundation intercepts the rewards prior to its distribution
(by x/distribution). The rate would be FoundationTax.
The foundation can withdraw coins from the treasury. The recipient must have
the corresponding authorization (ReceiveFromTreasuryAuthorization) prior to
sending the message Msg/WithdrawFromTreasury.
Note: After setting the tax rate to zero, you cannot set it to a non-zero value again (irreversible), which means you must set it to a non-zero value in the genesis to make it work.
When the chain is first started, it may be necessary to mint a large amount of coins at most once for initial validators or for specific purposes. Newly minted coins are transferred to the treasury pool.
- Params:
0x00 -> PropocolBuffer(Params).
The value of FoundationTax is the foundation tax rate.
The CensoredMsgTypeUrls contains the urls of the messages under the
censorship.
FoundationInfo contains the information relevant to the foundation.
- FoundationInfo:
0x01 -> ProtocolBuffer(FoundationInfo).
The Version is used to track changes to the foundation membership. Whenever
the membership is changed, this value is incremented, which will cause
proposals based on older versions to fail.
The TotalWeight is the number of the foundation members.
The DecisionPolicy is the decision policy of the foundation.
The Member is the foundation member.
- Member:
0x10 | []byte(member.Address) -> ProtocolBuffer(Member).
The value of the PreviousProposalID is the last used proposal ID. The chain
uses this value to issue the ID of the next new proposal.
- PreviousProposalID:
0x11 -> BigEndian(ProposalId).
- Proposal:
0x12 | BigEndian(ProposalId) -> ProtocolBuffer(Proposal).
ProposalByVotingPeriodEnd allows to retrieve proposals sorted by
chronological voting_period_end. This index is used when tallying the
proposal votes at the end of the voting period, and for pruning proposals at
VotingPeriodEnd + MaxExecutionPeriod.
- ProposalByVotingPeriodEnd:
0x13 | sdk.FormatTimeBytes(proposal.VotingPeriodEnd) | BigEndian(ProposalId) -> []byte().
- Vote:
0x40 | BigEndian(ProposalId) | []byte(voter.Address) -> ProtocolBuffer(Vote).
Grants are identified by combining grantee address and Authorization type
(its target message type URL). Hence we only allow one grant for the (grantee,
Authorization) tuple.
- Grant:
0x20 | len(grant.Grantee) (1 byte) | []byte(grant.Grantee) | []byte(grant.Authorization.MsgTypeURL()) -> ProtocolBuffer(Authorization)
The MsgUpdateParams can be used to update the parameters of foundation.
It's expected to fail if:
- the authority is not the module's authority.
- the parameters introduces any new foundation-specific features.
The MsgUpdateDecisionPolicy can be used to update the decision policy.
It's expected to fail if:
- the authority is not the module's authority.
- the new decision policy's
Validate()method doesn't pass.
Foundation members can be updated with the MsgUpdateMembers.
In the list of MemberUpdates, an existing member can be removed by setting
its remove flag to true.
It's expected to fail if:
- the authority is not the module's authority.
- if the decision policy's
Validate()method fails against the updated membership.
The MsgLeaveFoundation allows a foundation member to leave the foundation.
It's expected to fail if:
- the address is not of a foundation member.
- if the decision policy's
Validate()method fails against the updated membership.
A new proposal can be created with the MsgSubmitProposal, which has a list of
proposers addresses, a list of messages to execute if the proposal is accepted
and some optional metadata.
An optional Exec value can be provided to try to execute the proposal
immediately after proposal creation. Proposers signatures are considered as yes
votes in this case.
It's expected to fail if:
- metadata length is greater than
MaxMetadataLenconfig. - if any of the proposers is not a foundation member.
A proposal can be withdrawn using MsgWithdrawProposal which has an address
(can be either a proposer or the module's authority) and a proposal_id (which
has to be withdrawn).
It's expected to fail if:
- the address is neither the module's authority nor a proposer of the proposal.
- the proposal is already closed or aborted.
A new vote can be created with the MsgVote, given a proposal id, a voter
address, a choice (yes, no, veto or abstain) and some optional metadata.
An optional Exec value can be provided to try to execute the proposal
immediately after voting.
It's expected to fail if:
- metadata length is greater than
MaxMetadataLenconfig. - the proposal is not in voting period anymore.
A proposal can be executed with the MsgExec.
The messages that are part of this proposal won't be executed if:
- the proposal has not been accepted by the decision policy.
- the proposal has already been successfully executed.
An authorization grant is created using the MsgGrant message.
If there is already a grant for the (grantee, Authorization) tuple, then the
new grant overwrites the previous one. To update or extend an existing grant, a
new grant with the same (grantee, Authorization) tuple should be created.
The message handling should fail if:
- the authority is not the module's authority.
- provided
Authorizationis not implemented. Authorization.MsgTypeURL()is not defined in the router (there is no defined handler in the app router to handle that Msg types).
Note: Do NOT confuse with that of x/authz.
A grant can be removed with the MsgRevoke message.
The message handling should fail if:
- the authority is not the module's authority.
- provided
MsgTypeUrlis empty.
Anyone can fund treasury with MsgFundTreasury.
The foundation can withdraw coins from the treasury with
MsgWithdrawFromTreasury.
The message handling should fail if:
- the authority is not the module's authority.
- the address which receives the coins has no authorization of
ReceiveFromTreasuryAuthorization.
Massive minting is possible through 'MsgGovMint' up to 1 time after the chain is started.
The message handling should fail if:
- the authority is not the module's authority.
- The remaining left count is 0.
EventUpdateFoundationParams is an event emitted when the foundation
parameters have been updated.
| Attribute Key | Attribute Value |
|---|---|
| params | {params} |
EventUpdateDecisionPolicy is an event emitted when the decision policy have
been updated.
| Attribute Key | Attribute Value |
|---|---|
| decision_policy | {decisionPolicy} |
EventUpdateMembers is an event emitted when the foundation members have been
updated.
| Attribute Key | Attribute Value |
|---|---|
| member_updates | {members} |
EventLeaveFoundation is an event emitted when a foundation member leaves the
foundation.
| Attribute Key | Attribute Value |
|---|---|
| address | {memberAddress} |
EventSubmitProposal is an event emitted when a proposal is submitted.
| Attribute Key | Attribute Value |
|---|---|
| proposal | {proposal} |
EventWithdrawProposal is an event emitted when a proposal is withdrawn.
| Attribute Key | Attribute Value |
|---|---|
| proposal_id | {proposalId} |
EventVote is an event emitted when a voter votes on a proposal.
| Attribute Key | Attribute Value |
|---|---|
| vote | {vote} |
EventExec is an event emitted when a proposal is executed.
| Attribute Key | Attribute Value |
|---|---|
| proposal_id | {proposalId} |
| result | {result} |
EventGrant is an event emitted when an authorization is granted to a grantee.
| Attribute Key | Attribute Value |
|---|---|
| grantee | {granteeAddress} |
| authorization | {authorization} |
EventRevoke is an event emitted when an authorization is revoked from a
grantee.
| Attribute Key | Attribute Value |
|---|---|
| grantee | {granteeAddress} |
| msg_type_url | {msgTypeURL} |
EventFundTreasury is an event emitted when one funds the treasury.
| Attribute Key | Attribute Value |
|---|---|
| from | {fromAddress} |
| amount | {amount} |
EventWithdrawFromTreasury is an event emitted when coins are withdrawn from
the treasury.
| Attribute Key | Attribute Value |
|---|---|
| to | {toAddress} |
| amount | {amount} |
EventGovMint is an event emitted when coins are minted.
| Attribute Key | Attribute Value |
|---|---|
| amount | {amount} |
A user can query and interact with the foundation module using the CLI.
The query commands allow users to query foundation state.
simd query foundation --helpThe params command allows users to query for the parameters of foundation.
simd query foundation params [flags]Example:
simd query foundation paramsExample Output:
params:
censored_msg_type_urls:
- /cosmos.staking.v1beta1.MsgCreateValidator
- /lbm.foundation.v1.MsgWithdrawFromTreasury
foundation_tax: "0.200000000000000000"The foundation-info command allows users to query for the foundation info.
simd query foundation foundation-info [flags]Example:
simd query foundation foundation-infoExample Output:
info:
decision_policy:
'@type': /lbm.foundation.v1.ThresholdDecisionPolicy
threshold: "3.000000000000000000"
windows:
min_execution_period: 0s
voting_period: 86400s
total_weight: "3.000000000000000000"
version: "1"The member command allows users to query for a foundation member by address.
simd query foundation member [address] [flags]Example:
simd query foundation member link1...Example Output:
member:
added_at: "0001-01-01T00:00:00Z"
address: link1...
metadata: genesis memberThe members command allows users to query for the foundation members with
pagination flags.
simd query foundation members [flags]Example:
simd query foundation membersExample Output:
members:
- added_at: "0001-01-01T00:00:00Z"
address: link1...
metadata: genesis member
- added_at: "0001-01-01T00:00:00Z"
address: link1...
metadata: genesis member
- added_at: "0001-01-01T00:00:00Z"
address: link1...
metadata: genesis member
pagination:
next_key: null
total: "3"The proposal command allows users to query for proposal by id.
simd query foundation proposal [id] [flags]Example:
simd query foundation proposal 1Example Output:
proposal:
executor_result: PROPOSAL_EXECUTOR_RESULT_NOT_RUN
final_tally_result:
abstain_count: "0.000000000000000000"
no_count: "0.000000000000000000"
no_with_veto_count: "0.000000000000000000"
yes_count: "0.000000000000000000"
foundation_version: "1"
id: "1"
messages:
- '@type': /lbm.foundation.v1.MsgWithdrawFromTreasury
authority: link1...
amount:
- amount: "1000000000"
denom: stake
to: link1...
metadata: show-me-the-money
proposers:
- link1...
status: PROPOSAL_STATUS_SUBMITTED
submit_time: "2022-09-19T01:26:38.544943184Z"
voting_period_end: "2022-09-20T01:26:38.544943184Z"The proposals command allows users to query for proposals with pagination
flags.
simd query foundation proposals [flags]Example:
simd query foundation proposalsExample Output:
pagination:
next_key: null
total: "1"
proposals:
- executor_result: PROPOSAL_EXECUTOR_RESULT_NOT_RUN
final_tally_result:
abstain_count: "0.000000000000000000"
no_count: "0.000000000000000000"
no_with_veto_count: "0.000000000000000000"
yes_count: "0.000000000000000000"
foundation_version: "1"
id: "1"
messages:
- '@type': /lbm.foundation.v1.MsgWithdrawFromTreasury
authority: link1...
amount:
- amount: "1000000000"
denom: stake
to: link1...
metadata: show-me-the-money
proposers:
- link1...
status: PROPOSAL_STATUS_SUBMITTED
submit_time: "2022-09-19T01:26:38.544943184Z"
voting_period_end: "2022-09-20T01:26:38.544943184Z"The vote command allows users to query for vote by proposal id and voter
account address.
simd query foundation vote [proposal-id] [voter] [flags]Example:
simd query foundation vote 1 link1...Example Output:
vote:
metadata: nope
option: VOTE_OPTION_NO
proposal_id: "1"
submit_time: "2022-09-19T01:35:30.920689570Z"
voter: link1...The votes command allows users to query for votes by proposal id with
pagination flags.
simd query foundation votes [proposal-id] [flags]Example:
simd query foundation votes 1Example Output:
pagination:
next_key: null
total: "1"
votes:
- metadata: nope
option: VOTE_OPTION_NO
proposal_id: "1"
submit_time: "2022-09-19T01:35:30.920689570Z"
voter: link1...The tally command allows users to query for the tally in progress by its
proposal id.
simd query foundation tally [proposal-id] [flags]Example:
simd query foundation tally 1Example Output:
tally:
abstain_count: "0.000000000000000000"
no_count: "1.000000000000000000"
no_with_veto_count: "0.000000000000000000"
yes_count: "0.000000000000000000"The grants command allows users to query grants for a grantee. If the message
type URL is set, it selects grants only for that message type.
simd query foundation grants [grantee] [msg-type-url]? [flags]Example:
simd query foundation grants link1... /lbm.foundation.v1.MsgWithdrawFromTreasuryExample Output:
authorizations:
- '@type': /lbm.foundation.v1.ReceiveFromTreasuryAuthorization
pagination: nullThe treasury command allows users to query for the foundation treasury.
simd query foundation treasury [flags]Example:
simd query foundation treasuryExample Output:
amount:
- amount: "1000000000000.000000000000000000"
denom: stakeThe tx commands allow users to interact with the foundation module.
simd tx foundation --helpNote: Some commands must be signed by the module's authority, which means you cannot broadcast the message directly. The use of those commands is to make it easier to generate the messages by end users.
The update-params command allows users to update the foundation's parameters.
simd tx foundation update-params [authority] [params-json] [flags]Example:
simd tx foundation update-params link1... \
'{
"foundation_tax": "0.1",
"censored_msg_type_urls": [
"/cosmos.staking.v1beta1.MsgCreateValidator",
"/lbm.foundation.v1.MsgWithdrawFromTreasury"
]
}'Note: The signer is the module's authority.
The update-members command allows users to update the foundation's members.
simd tx foundation update-members [authority] [members-json] [flags]Example:
simd tx foundation update-members link1... \
'[
{
"address": "link1...",
"metadata": "some new metadata"
},
{
"address": "link1...",
"remove": true,
}
]'Note: The signer is the module's authority.
The update-decision-policy command allows users to update the foundation's
decision policy.
simd tx foundation update-decision-policy [authority] [decision-policy-json] [flags]Example:
simd tx foundation update-decision-policy link1... \
'{
"@type": "/lbm.foundation.v1.ThresholdDecisionPolicy",
"threshold": "4",
"windows": {
"voting_period": "1h",
"min_execution_period": "0s"
}
}'Note: The signer is the module's authority.
The submit-proposal command allows users to submit a new proposal.
simd tx foundation submit-proposal [metadata] [proposers-json] [messages-json] [flags]Example:
simd tx foundation submit-proposal show-me-the-money \
'[
"link1...",
"link1..."
]' \
'[
{
"@type": "/lbm.foundation.v1.MsgWithdrawFromTreasury",
"authority": "link1...",
"to": "link1...",
"amount": [
{
"denom": "stake",
"amount": "10000000000"
}
]
}
]'The withdraw-proposal command allows users to withdraw a proposal.
simd tx foundation withdraw-proposal [proposal-id] [authority-or-proposer] [flags]Example:
simd tx foundation withdraw-proposal 1 link1...The vote command allows users to vote on a proposal.
simd tx foundation vote [proposal-id] [voter] [option] [metadata] [flags]Example:
simd tx foundation vote 1 link1... VOTE_OPTION_NO nopeThe exec command allows users to execute a proposal.
simd tx foundation exec [proposal-id] [flags]Example:
simd tx foundation exec 1The leave-foundation command allows foundation member to leave the
foundation.
simd tx foundation leave-foundation [address] [flags]Example:
simd tx foundation leave-foundation link1...The grant command allows users to grant an authorization to a grantee.
simd tx foundation grant [authority] [grantee] [authorization-json] [flags]Example:
simd tx foundation grant link1.. link1... \
'{
"@type": "/lbm.foundation.v1.ReceiveFromTreasuryAuthorization",
}'Note: The signer is the module's authority.
The revoke command allows users to revoke an authorization from a grantee.
simd tx foundation revoke [authority] [grantee] [msg-type-url] [flags]Example:
simd tx foundation revoke link1.. link1... /lbm.foundation.v1.MsgWithdrawFromTreasuryNote: The signer is the module's authority.
The fund-treasury command allows users to fund the foundation treasury.
simd tx foundation fund-treasury [from] [amount] [flags]Example:
simd tx foundation fund-treasury link1.. 1000stakeThe withdraw-from-treasury command allows users to withdraw coins from the
foundation treasury.
simd tx foundation withdraw-from-treasury [authority] [to] [amount] [flags]Example:
simd tx foundation withdraw-from-treasury link1.. link1... 1000stakeNote: The signer is the module's authority.
A user can query the foundation module using gRPC endpoints.
grpcurl -plaintext \
localhost:9090 list lbm.foundation.v1.QueryThe Params endpoint allows users to query for the parameters of foundation.
lbm.foundation.v1.Query/ParamsExample:
grpcurl -plaintext \
localhost:9090 lbm.foundation.v1.Query/ParamsExample Output:
{
"params": {
"foundationTax": "200000000000000000"
"censoredMsgTypeUrls": [
"/cosmos.staking.v1beta1.MsgCreateValidator",
"/lbm.foundation.v1.MsgWithdrawFromTreasury"
]
}
}The FoundationInfo endpoint allows users to query for the foundation info.
lbm.foundation.v1.Query/FoundationInfoExample:
grpcurl -plaintext \
localhost:9090 lbm.foundation.v1.Query/FoundationInfoExample Output:
{
"info": {
"version": "1",
"totalWeight": "3000000000000000000",
"decisionPolicy": {"@type":"/lbm.foundation.v1.ThresholdDecisionPolicy","threshold":"3000000000000000000","windows":{"votingPeriod":"86400s","minExecutionPeriod":"0s"}}
}
}The Member endpoint allows users to query for a foundation member by address.
lbm.foundation.v1.Query/MemberExample:
grpcurl -plaintext \
-d '{"address": "link1..."}'
localhost:9090 lbm.foundation.v1.Query/MemberExample Output:
{
"member": {
"address": "link1...",
"metadata": "genesis member",
"addedAt": "0001-01-01T00:00:00Z"
}
}The Members endpoint allows users to query for the foundation members with
pagination flags.
lbm.foundation.v1.Query/MembersExample:
grpcurl -plaintext \
localhost:9090 lbm.foundation.v1.Query/MembersExample Output:
{
"members": [
{
"address": "link1...",
"metadata": "genesis member",
"addedAt": "0001-01-01T00:00:00Z"
},
{
"address": "link1...",
"metadata": "genesis member",
"addedAt": "0001-01-01T00:00:00Z"
},
{
"address": "link1...",
"metadata": "genesis member",
"addedAt": "0001-01-01T00:00:00Z"
}
],
"pagination": {
"total": "3"
}
}The Proposal endpoint allows users to query for proposal by id.
lbm.foundation.v1.Query/ProposalExample:
grpcurl -plaintext \
-d '{"proposal_id": "1"}' \
localhost:9090 lbm.foundation.v1.Query/ProposalExample Output:
{
"proposal": {
"id": "1",
"metadata": "show-me-the-money",
"proposers": [
"link1..."
],
"submitTime": "2022-09-19T01:26:38.544943184Z",
"foundationVersion": "1",
"status": "PROPOSAL_STATUS_SUBMITTED",
"finalTallyResult": {
"yesCount": "0",
"abstainCount": "0",
"noCount": "0",
"noWithVetoCount": "0"
},
"votingPeriodEnd": "2022-09-20T01:26:38.544943184Z",
"executorResult": "PROPOSAL_EXECUTOR_RESULT_NOT_RUN",
"messages": [
{"@type":"/lbm.foundation.v1.MsgWithdrawFromTreasury","authority":"link1...","amount":[{"denom":"stake","amount":"1000000000"}],"to":"link1..."}
]
}
}The Proposals endpoint allows users to query for proposals with pagination
flags.
lbm.foundation.v1.Query/ProposalsExample:
grpcurl -plaintext \
localhost:9090 lbm.foundation.v1.Query/ProposalsExample Output:
{
"proposals": [
{
"id": "1",
"metadata": "show-me-the-money",
"proposers": [
"link1..."
],
"submitTime": "2022-09-19T01:26:38.544943184Z",
"foundationVersion": "1",
"status": "PROPOSAL_STATUS_SUBMITTED",
"finalTallyResult": {
"yesCount": "0",
"abstainCount": "0",
"noCount": "0",
"noWithVetoCount": "0"
},
"votingPeriodEnd": "2022-09-20T01:26:38.544943184Z",
"executorResult": "PROPOSAL_EXECUTOR_RESULT_NOT_RUN",
"messages": [
{"@type":"/lbm.foundation.v1.MsgWithdrawFromTreasury","authority":"link1...","amount":[{"denom":"stake","amount":"1000000000"}],"to":"link1..."}
]
}
],
"pagination": {
"total": "1"
}
}The Vote endpoint allows users to query for vote by proposal id and voter account address.
lbm.foundation.v1.Query/VoteExample:
grpcurl -plaintext \
-d '{"proposal_id": "1", "voter": "link1..."}' \
localhost:9090 lbm.foundation.v1.Query/VoteExample Output:
{
"vote": {
"proposalId": "1",
"voter": "link1...",
"option": "VOTE_OPTION_NO",
"metadata": "nope",
"submitTime": "2022-09-19T01:35:30.920689570Z"
}
}The Votes endpoint allows users to query for votes by proposal id with
pagination flags.
lbm.foundation.v1.Query/VotesExample:
grpcurl -plaintext \
-d '{"proposal_id": "1"}' \
localhost:9090 lbm.foundation.v1.Query/VotesExample Output:
{
"votes": [
{
"proposalId": "1",
"voter": "link1...",
"option": "VOTE_OPTION_NO",
"metadata": "nope",
"submitTime": "2022-09-19T01:35:30.920689570Z"
}
],
"pagination": {
"total": "1"
}
}The TallyResult endpoint allows users to query for the tally in progress by
its proposal id.
lbm.foundation.v1.Query/VoteExample:
grpcurl -plaintext \
-d '{"proposal_id": "1"}' \
localhost:9090 lbm.foundation.v1.Query/TallyResultExample Output:
{
"tally": {
"yesCount": "0",
"abstainCount": "0",
"noCount": "1000000000000000000",
"noWithVetoCount": "0"
}
}The Grants endpoint allows users to query grants for a grantee. If the
message type URL is set, it selects grants only for that message type.
lbm.foundation.v1.Query/GrantsExample:
grpcurl -plaintext \
-d '{"grantee": "link1...", "msg_type_url": "/lbm.foundation.v1.MsgWithdrawFromTreasury"}' \
localhost:9090 lbm.foundation.v1.Query/GrantsExample Output:
{
"authorizations": [
{"@type":"/lbm.foundation.v1.ReceiveFromTreasuryAuthorization"}
]
}The Treasury endpoint allows users to query for the foundation treasury.
lbm.foundation.v1.Query/TreasuryExample:
grpcurl -plaintext \
localhost:9090 lbm.foundation.v1.Query/TreasuryExample Output:
{
"amount": [
{
"denom": "stake",
"amount": "1000000000000000000000000000000"
}
]
}