WIP on group module spec

x/group/spec/messages.md

@@ -0,0 +1,46 @@
+```go
+// Groups get their own GroupID
+type MsgCreateGroup struct {
+	Signer sdk.AccAddress `json:"signer"`
+	// The Owner of the group is allowed to change the group structure. A group account
+	// can own a group in order for the group to be able to manage its own members
+	Owner  sdk.AccAddress `json:"owner"`
+	// The members of the group and their associated weight
+	Members []Member `json:"members,omitempty"`
+	// TODO maybe make this something more specific to a domain name or a claim on identity? or Info leave it generic
+	Memo string `json:"memo,omitempty"`
+}
+
+// group accounts get their own sdk.AccAddress
+type MsgCreateGroupAccount struct {
+	Signer         sdk.AccAddress `json:"signer"`
+	// The Owner of a group account is allowed to change the DecisionPolicy. This can be left nil 
+	// in order for the group account to "own" itself
+	Owner          sdk.AccAddress `json:"owner"`
+	Group          GroupID        `json:"group"`
+	DecisionPolicy DecisionPolicy `json:"decision_policy"`
+	Memo           string         `json:"memo,omitempty"`
+}
+type MsgCreateProposal struct {
+	Proposer sdk.AccAddress `json:"proposer"`
+	GroupAccount    sdk.AccAddress `json:"group"`
+	Msgs     []sdk.Msg      `json:"msgs"`
+	// Exec can be set to true in order to attempt to execute the proposal immediately
+	// with no voting in a single transaction - this is useful for 1/N or 2/N multisig
+	// key groups. Every signer of the MsgCreateProposal transaction is considered a yes
+	// vote
+	Exec bool `json:"exec,omitempty"`
+}
+
+type MsgVote struct {
+	ProposalID ProposalID     `json:"proposal_id"`
+	// Voters must sign this transaction
+	Voters     []sdk.AccAddress `json:"voters"`
+	Vote       Vote           `json:"vote"`
+}
+
+type MsgTryExecuteProposal struct {
+	ProposalID ProposalID     `json:"proposal_id"`
+	Signer     sdk.AccAddress `json:"signer"`
+}
+```

x/group/spec/params.md

@@ -0,0 +1,8 @@
+# Parameters
+
+The group module contains the following parameters:
+
+| Key                    | Type            | Usage | Example |
+|------------------------|-----------------|---------|
+| MaxVotingPeriod        | string (time ns) | Proposals older than this time will be garbage-collected | "172800000000000"   |
+| MaxDescriptionCharacters      | string (uint64) | | "256"   |

x/group/spec/policies.md

@@ -0,0 +1,15 @@
+# Decision Policies
+
+```go
+type ThresholdDecisionPolicy struct {
+	// Specifies the number of votes that must be accumulated in order for a decision to be made by the group.
+	// A member gets as many votes as is indicated by their Weight field.
+	// A big integer is used here to avoid any potential vulnerabilities from overflow errors
+	// where large weight and threshold values are used.
+	DecisionThreshold sdk.Int `json:"decision_threshold"`
+}
+
+type PercentageDecisionPolicy struct {
+	Percent sdk.Dec `json:"percent"`
+}
+```

x/group/spec/state.md

@@ -0,0 +1,117 @@
+# State & Types
+
+## Groups
+
+Groups are simply aggregations of members.
+
+### Key Value Store Layout
+
+| Key                 | Description              | Type              |
+|---------------------|--------------------|--------------------------|
+| `g/<group>/desc`  | Group description    | `string`  |
+| `g/<group>/<member>`  | Member's voting power    | `sdk.Int`  |
+| `g/<group>/<member>/desc`  | Member description    | `string`  |
+| `g/<group>/owner`  | Group owner    | `sdk.AccAdress`  |
+| `g/<group>/totalPower`  | Group's computed total power    | `sdk.Int`  |
+| `mg/<member>/<group>`  |  Member -> group reverse index  | empty |
+| `og/<owner>/<group>`  |  Owner -> group reverse index  | empty |
+
+### Key Types
+
+| Key                 | Type             |
+|---------------------|------------------|
+| `<group>`  | `GroupID`  |
+| `<owner>`  | `sdk.AccAddress`  |
+| `<member>`  | `sdk.AccAddress`  |
+
+### Custom Types
+
+```go
+type GroupID []byte
+```
+
+`GroupID` is generated from an auto-incrementing `uint64` preprended with the
+prefix `0`. This prefix allows other group composition mechanisms in the future,
+specifically via token ownership rather than group membership.
+
+## Group Accounts
+
+Group accounts associate a group with a decision policy.
+
+### Key-Value Store Layout
+
+| Key                 | Description              | Type              |
+|---------------------|--------------------|--------------------------|
+| `a/<group-account>/description`  | Group account description    | `string`  |
+| `a/<group-account>/group`  | Group account's underlying group    | `GroupID`  |
+| `a/<group-account>/decisionPolicy`  | Group account's decision policy    | `DecisionPolicy`  |
+| `a/<group-account>/owner`  | Group account's owner | `sdk.AccAddress`  |
+| `ga/<group>/<group-account>`  | Group -> group account reverse index  | empty |
+| `oa/<owner>/<group-account>`  | Owner -> group account reverse index  | empty |
+
+### Key Types
+
+| Key                 | Type             | Description |
+|---------------------|------------------| ------------|
+| `<group-account>`  | `GroupID`  | Generated from an auto-incremented `uint64` |
+| `<group>`  | `GroupID`  | | 
+| `<owner>`  | `sdk.AccAddress`  | |
+
+*TODO:* How to encode group account addresses?
+
+### Custom Types
+
+```go
+type Tally struct {
+	YesCount sdk.Int
+	NoCount sdk.Int
+	AbstainCount sdk.Int
+	VetoCount sdk.Int
+}
+__
+// DecisionPolicy allows for flexibility in decision policy based both on
+// powers (the tally of yes, no, abstain, and veto votes) and time since voting
+// started
+type DecisionPolicy interface {
+	Allow(tally Tally, totalPower sdk.Int, timeSinceVotingStart time.Duration)
+}
+```
+
+## Proposals
+
+### Key Value Store Layout
+
+| Key                 | Description              | Type              |
+|---------------------|--------------------|--------------------------|
+| `p/<proposal>/desc`  | Proposal description    | `string`  |
+| `p/<proposal>/ga`  | Proposal's group account    | `sdk.AccAddress`  |
+| `p/<proposal>/msgs`  | Messages that will be run if the proposal succeeds    | `[]sdk.Msg`  |
+| `p/<proposal>/proposer`  | Account that proposed the proposal    | `sdk.AccAddress`  |
+| `p/<proposal>/votingStart`  | When voting started    | `time.Time`  |
+| `p/<proposal>/<voter>/vote`  | A voter's vote on the proposal    | `Vote`  |
+| `p/<proposal>/<voter>/comment`  | A voter's comment on their vote | `string`  |
+| `vp/<voter>/<proposal>`  | Voter -> proposal reverse look-up | empty  |
+| `ap/<group-account>/<proposal>`  | Group account -> proposal reverse look-up | empty  |
+| `pp/<proposer>/<proposal>`  | Proposer -> proposal reverse look-up | empty  |
+
+### Key Type
+
+| Key                 | Type             |------|
+|---------------------|------------------|------|
+| `<proposal>`  | `ProposalID`  | auto-incremented `uint64`
+| `<voter>`  | `sdk.AccAddress`  |
+| `<proposer>`  | `sdk.AccAddress`  |
+| `<group-account>`  | `sdk.AccAddress`  |
+
+### Custom Types
+
+```go
+type Vote int
+
+const (
+	No Vote = 0
+	Yes = 1
+	Abstain = 2
+	Veto = 3
+)
+```

x/group/spec/ucr.md

@@ -0,0 +1,36 @@
+# Use Cases and Requirements
+
+## Use Cases
+
+### UC1: Multi-factor authentication (MFA) and key rotation
+
+A single user may want to have an account that requires at least two out of
+three key to sign for instance.
+
+
+That use may also want to have an account that isn't tied to a single permanent
+key but rather where they can add and remove keys as their needs evolve. The
+member keys could be tied to a single device or hardware wallet, or potentially
+tied to a custodial service that users other mechanisms to support MFA 
+
+### UC2: Organizational Accounts
+
+### UC3: DAO's
+
+## Requirements
+
+### R1: Groups aren't tied to any permanent key
+
+### R2: Groups are themselves an account
+
+### R3: Keys can be added and removed from a group
+
+### R4: Groups can submit and execute a transaction within a single transaction
+
+### R5: Different keys can be assigned different weights
+
+### R6: Different voting strategies and thresholds can be chosen
+
+### R7: The same group can use different voting stategies for different accounts
+
+### R8: Garbage proposals eventually get cleaned up