feat: r/gov/dao v2 + r/sys/vars

examples/gno.land/p/demo/dao/dao.gno

@@ -0,0 +1,32 @@
+package dao
+
+const (
+ ProposalAddedEvent = "ProposalAdded" // emitted when a new proposal has been added
+ ProposalAcceptedEvent = "ProposalAccepted" // emitted when a proposal has been accepted
+ ProposalNotAcceptedEvent = "ProposalNotAccepted" // emitted when a proposal has not been accepted
+ ProposalExecutedEvent = "ProposalExecuted" // emitted when a proposal has been executed
+
+ ProposalEventIDKey = "proposal-id"
+ ProposalEventExecutionKey = "exec-status"
+)
+
+// ProposalRequest is a single govdao proposal request
+// that contains the necessary information to
+// log and generate a valid proposal
+type ProposalRequest struct {
+ Description string // the description associated with the proposal
+ Executor Executor // the proposal executor
+}
+
+// DAO defines the DAO abstraction
+type DAO interface {
+ // PropStore is the DAO proposal storage
+ PropStore
+
+ // Propose adds a new proposal to the executor-based GOVDAO.
+ // Returns the generated proposal ID
+ Propose(request ProposalRequest) (uint64, error)
+
+ // ExecuteProposal executes the proposal with the given ID
+ ExecuteProposal(id uint64) error
+}

examples/gno.land/p/demo/dao/executor.gno

@@ -0,0 +1,13 @@
+package dao
+
+// Executor represents a minimal closure-oriented proposal design.
+// It is intended to be used by a govdao governance proposal (v1, v2, etc)
+type Executor interface {
+ // Execute executes the given proposal, and returns any error encountered
+ // during the execution
+ Execute() error
+
+ // IsExpired returns a flag indicating
+ // if the executor is expired
+ IsExpired() bool
+}

examples/gno.land/p/demo/dao/gno.mod

@@ -0,0 +1 @@
+module gno.land/p/demo/dao

examples/gno.land/p/demo/dao/proposals.gno

@@ -0,0 +1,54 @@
+package dao
+
+import "std"
+
+type ProposalStatus string
+
+// ACTIVE -> ACCEPTED -> EXECUTION(SUCCEEDED/FAILED)
+// ACTIVE -> NOT ACCEPTED
+var (
+ Active ProposalStatus = "active" // proposal is still active
+ Accepted ProposalStatus = "accepted" // proposal gathered quorum
+ NotAccepted ProposalStatus = "not accepted" // proposal failed to gather quorum
+ ExecutionSuccessful ProposalStatus = "execution successful" // proposal is executed successfully
+ ExecutionFailed ProposalStatus = "execution failed" // proposal is failed during execution
+)
+
+func (s ProposalStatus) String() string {
+ return string(s)
+}
+
+// PropStore defines the proposal storage abstraction
+type PropStore interface {
+ // Proposals returns the given paginated proposals
+ Proposals(offset, count uint64) []Proposal
+
+ // ProposalByID returns the proposal associated with
+ // the given ID, if any
+ ProposalByID(id uint64) (Proposal, error)
+
+ // Size returns the number of proposals in
+ // the proposal store
+ Size() int
+}
+
+// Proposal is the single proposal abstraction
+type Proposal interface {
+ // Author returns the author of the proposal
+ Author() std.Address
+
+ // Description returns the description of the proposal
+ Description() string
+
+ // Status returns the status of the proposal
+ Status() ProposalStatus
+
+ // Executor returns the proposal executor
+ Executor() Executor
+
+ // Stats returns the voting stats of the proposal
+ Stats() Stats
+
+ // Render renders the proposal in a readable format
+ Render() string
+}

examples/gno.land/p/demo/dao/vote.gno

@@ -0,0 +1,70 @@
+package dao
+
+import (
+ "std"
+)
+
+const (
+ VoteAddedEvent = "VoteAdded" // emitted when a vote was cast for a proposal
+
+ VoteAddedIDKey = "proposal-id"
+ VoteAddedAuthorKey = "author"
+ VoteAddedOptionKey = "option"
+)
+
+type VoteOption string
+
+const (
+ YesVote VoteOption = "YES"
+ NoVote VoteOption = "NO"
+ AbstainVote VoteOption = "ABSTAIN"
+)
+
+func (v VoteOption) String() string {
+ return string(v)
+}
+
+// Vote encompasses a single GOVDAO vote
+type Vote struct {
+ Address std.Address // the address of the voter
+ Option VoteOption // the voting option
+}
+
+// Stats encompasses the proposal voting stats
+type Stats struct {
+ YayVotes uint64
+ NayVotes uint64
+ AbstainVotes uint64
+
+ TotalVotingPower uint64
+}
+
+// YayPercent returns the percentage (0-100) of the yay votes
+// in relation to the total voting power
+func (v Stats) YayPercent() uint64 {
+ return (v.YayVotes / v.TotalVotingPower) * 100
+}
+
+// NayPercent returns the percentage (0-100) of the nay votes
+// in relation to the total voting power
+func (v Stats) NayPercent() uint64 {
+ return (v.NayVotes / v.TotalVotingPower) * 100
+}
+
+// AbstainPercent returns the percentage (0-100) of the abstain votes
+// in relation to the total voting power
+func (v Stats) AbstainPercent() uint64 {
+ return (v.AbstainVotes / v.TotalVotingPower) * 100
+}
+
+// MissingVotes returns the summed voting power that has not
+// participated in proposal voting yet
+func (v Stats) MissingVotes() uint64 {
+ return v.TotalVotingPower - (v.YayVotes + v.NayVotes + v.AbstainVotes)
+}
+
+// MissingVotesPercent returns the percentage (0-100) of the missing votes
+// in relation to the total voting power
+func (v Stats) MissingVotesPercent() uint64 {
+ return (v.MissingVotes() / v.TotalVotingPower) * 100
+}

examples/gno.land/r/gov/dao/gno.mod → examples/gno.land/p/demo/membstore/gno.mod

@@ -1,8 +1,9 @@
-module gno.land/r/gov/dao
+module gno.land/p/demo/membstore
 
 require (
+ gno.land/p/demo/avl v0.0.0-latest
  gno.land/p/demo/testutils v0.0.0-latest
+ gno.land/p/demo/uassert v0.0.0-latest
  gno.land/p/demo/ufmt v0.0.0-latest
  gno.land/p/demo/urequire v0.0.0-latest
- gno.land/p/gov/proposal v0.0.0-latest
 )

examples/gno.land/p/demo/membstore/members.gno

@@ -0,0 +1,38 @@
+package membstore
+
+import (
+ "std"
+)
+
+// MemberStore defines the member storage abstraction
+type MemberStore interface {
+ // Members returns all members in the store
+ Members(offset, count uint64) []Member
+
+ // Size returns the current size of the store
+ Size() int
+
+ // IsMember returns a flag indicating if the given address
+ // belongs to a member
+ IsMember(address std.Address) bool
+
+ // TotalPower returns the total voting power of the member store
+ TotalPower() uint64
+
+ // Member returns the requested member
+ Member(address std.Address) (Member, error)
+
+ // AddMember adds a member to the store
+ AddMember(member Member) error
+
+ // UpdateMember updates the member in the store.
+ // If updating a member's voting power to 0,
+ // the member will be removed
+ UpdateMember(address std.Address, member Member) error
+}
+
+// Member holds the relevant member information
+type Member struct {
+ Address std.Address // bech32 gno address of the member (unique)
+ VotingPower uint64 // the voting power of the member
+}