Skip to content

feat(commondao): add support for grouping members #4287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

jeronimoalbi
Copy link
Member

PR changes members storage to support grouping of members.

Two new abstractions are introduced:

  • MemberGrouping: Collection of member groups
  • MemberGroup: Group of members with metadata

Grouping support is an optional feature.

Member groups can be used by DAOs that require grouping users by roles or by tiers for example.

@jeronimoalbi jeronimoalbi self-assigned this May 16, 2025
@github-actions github-actions bot added the 🧾 package/realm Tag used for new Realms or Packages. label May 16, 2025
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label May 16, 2025
@Gno2D2
Copy link
Collaborator

Gno2D2 commented May 16, 2025

🛠 PR Checks Summary

All Automated Checks passed. ✅

Manual Checks (for Reviewers):
  • IGNORE the bot requirements for this PR (force green CI check)
Read More

🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.

✅ Automated Checks (for Contributors):

🟢 Pending initial approval by a review team member, or review from tech-staff

☑️ Contributor Actions:
  1. Fix any issues flagged by automated checks.
  2. Follow the Contributor Checklist to ensure your PR is ready for review.
    • Add new tests, or document why they are unnecessary.
    • Provide clear examples/screenshots, if necessary.
    • Update documentation, if required.
    • Ensure no breaking changes, or include BREAKING CHANGE notes.
    • Link related issues/PRs, where applicable.
☑️ Reviewer Actions:
  1. Complete manual checks for the PR, including the guidelines and additional checks if applicable.
📚 Resources:
Debug
Automated Checks
Pending initial approval by a review team member, or review from tech-staff

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🟢 Requirement satisfied
└── 🟢 If
    ├── 🟢 Condition
    │   └── 🟢 Or
    │       ├── 🟢 At least 1 user(s) of the organization reviewed the pull request (with state "APPROVED")
    │       ├── 🟢 At least 1 user(s) of the team tech-staff reviewed pull request
    │       └── 🔴 This pull request is a draft
    └── 🟢 Then
        └── 🟢 And
            ├── 🟢 Not (🔴 This label is applied to pull request: review/triage-pending)
            └── 🟢 At least 1 user(s) of the team tech-staff reviewed pull request

Manual Checks
**IGNORE** the bot requirements for this PR (force green CI check)

If

🟢 Condition met
└── 🟢 On every pull request

Can be checked by

  • Any user with comment edit permission

Copy link

codecov bot commented May 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@jeronimoalbi
Copy link
Member Author

jeronimoalbi commented May 16, 2025

Group by role example:

storage := commondao.NewMemberStorageWithGrouping()

// Add a member that doesn't belong to any group
storage.Add("g1...a")

// Create a member group for owners
owners, err := storage.Grouping().Add("owners")
if err != nil {
  panic(err)
}

// Add a member to the owners group
owners.Members().Add("g1...b")

// Add voting power to owners group metadata
owners.SetMeta(3)

// Create a member group for moderators
moderators, err := storage.Grouping().Add("moderators")
if err != nil {
  panic(err)
}

// Add voting power to moderators group metadata
moderators.SetMeta(1)

// Add members to the moderators group
moderators.Members().Add("g1...c")
moderators.Members().Add("g1...d")

@Kouteki Kouteki moved this from Triage to In Review in 🧙‍♂️gno.land core team May 21, 2025
@Gno2D2 Gno2D2 removed the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label May 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧾 package/realm Tag used for new Realms or Packages.
Projects
Status: In Progress
Status: In Review
Development

Successfully merging this pull request may close these issues.

3 participants