Create Community Pools

[decentralauren]

Note to contributors

There is a draft PR up.
A few things have already been taken care of, the PR was in review.
The task is to finish the PR: #296

1. Clone our repository if you have not already done so
2. add git remote add <some label for remote> https://github.com/pbkompasz/GoodCollective.git
3. git fetch <some label for remote>
4. git checkout feat-community-pools.
5. follow up on the review, and what has been done and apply the requested changes.
6. create a new PR and request a review
7. include demo video where you create a new ubi pool.

Business Description

An interface/flow to allow anyone to create a GoodCollective UBIPool smart contract without interacting with an explorer.

User Flow:

1. Select pool type (only Community pools will be selectable for now; see design flow below)
2. Define the GoodCollective pool details
3. Define the contract parameters
4. Review and Create the contract
5. View the GoodCollective in the GoodCollective dApp

---

Detailed Description of Functionality

The following parameters can be configured by an admin of a new GoodCollective. These should be organized in an easy-to-use manner following the UX design.

Pool Type Selection (Required)

About Various Pools page
Each pool type should have a description pulled from GoodCollective HIW.

• Results-Based Financing (NFT-Triggered)
• Segmented Aid
• Community Pool (only this option should be selectable for now)

---

GoodCollective Pool Details

(design reference
Get Started / Project Details

Fields (Saved to IPFS)

Reference: IPFS Save Logic

• Image* - jpg, gif, png; max file size 20MB, (1400x256px)
• Logo* - jpg, gif, png; max file size 1MB, (500x500px)
• Pool Name* - 100 character max
• Pool Description* - 500 character max
• Reward Description - 250 character max
• Socials* (At least one required)
  • Instagram
  • X
  • Website
  • Threads
  • Facebook

Admin Configuration

• Admin Wallet Address* - The only wallet that can make contract upgrades or disable the contract. Defaults to the connected wallet.

---

Contract Parameters (Configurable in UI)

General Pool Contract Parameters

(design reference)
(Pool Configuration)

• Admin Wallet Address (shown for display only, configured in the previous step)
• Max # of people per pool (first come, first served)

Community Pool-Specific Parameters

• Pool Recipients - Optional Wallet address(es) of all recipients
• OnlyMembers: if no list provided, always false. if list provided, user can configure this setting)
• Admin/Manager Fee - Optional fee for administration (default: 0%)
• Claim Frequency* - Every X days (default: daily)
  • Based on the GoodDollar UBI clock (resets at 12 UTC)
• Max Claim Amount* - In G$
• Max Members - Uses value from 'expected members' ([todo: add link])

---

Default Contract Parameters (Not configurable in UI)

These will be set with default values and configurable later via the PoolAdmin UI.

UbiPoolSettings (Contracts should be based on Env)

• MembersValidator: AddressZero
• UniquenessValidator: 0xC361A6E67822a0EDc17D899227dd9FC50BD62F42
• RewardToken: 0x62B8B11039FcfE5aB0C56E502b1C372A3d2a9c7A

UbiSettings

• Cycle Length Days:
  • If <claimFrequency> ≤ 7: 7
  • If <claimFrequency> > 7: <claimFrequency>
• ClaimForEnabled: false

Extended Settings

• Max Period Claimers: 0
• Min Claim Amount: <maxClaimAmount>
• Manager Fee Bps: 0 (or user-configured value)

---

Design Reference

• See the GoodCollective Figma for expected flow and UI.

---

Technical Implementation

• Use createPool.ts as a reference for createUbiPoolWithAttributes from @gooddollar/goodcollective-sdk
• when using createUbiPoolWithAttributes, isBeacon should always be false
• [Example usage of dev/prod contracts](

  GoodCollective/packages/app/src/models/constants.ts

  Line 20 in 4adbead

  export const GDDevToken: Token = new Token(

  )
  • We only use development-celo or production-celo
• Through the 'review and create' page, someone can choose to edit the configured values. the flow will be to send a user back to the specific page/section they want to edit. Make sure the values configured are cached properly.

---

TBD

• Vetting process for displaying Pools on goodcollective (TBD)
  -- For now after creating a pool, a user will be navigated to the explorer page of the contract created
• Some copy in the design shown as lorem ipsum, the actual copy will be provided in time

---

Acceptance Criteria

Specify criteria for determining if the feature meets requirements and functions correctly.

• Should follow contribution guidelines
• Should match design provided in Figma
• Is responsive to desktop design (included in figma)
• Should verify if existing components can be re-used
• Anything in the TBD at time of putting up your pull-request is not a requirement for it get merged

[decentralauren]

@sirpy - put a couple of questions for you above. Mind answering?

Also, am I missing any contract or UI parameters that a user could set when creating a new GC?

[sirpy]

@decentralauren

1. we just have protocol fee, no admin fees
2. the claim frequency can be set, but the "claim time" is always 12UTC
3. We dont have min amount yet. we can add it. lets discuss this and other ubi settings
4. We dont have generic support for segmented ubi based on identity.
5. ubi pool settings

• manager: can change pool settings and add members
• cycleLengthDays: number of days of each UBI pool cycle (preserve enough tokens to be distributed over cycle. DailyPool = TotalInPool/cycleLengthDays)
• claimPeriodDays: how often can someone claim their UBI
• minActiveUsers: minimum amount of users to divide the pool for (maxDailyUBI = DailyPool/minActiveUsers)
• claimForEnabled: can you trigger claim for someone else
• maxClaimAmount: dailyUBI = min(maxDailyUBI, maxClaimAmount)
• maxClaimers: maximum number of members in the pool, first come first served.
• onlyMembers: only pre-approved wallets (by manager) can claim, otherwise anyone that claims becomes a member

6. NFT pool settings

• manager: can change pool settings and mint NFTs
• rewardsPerEvent: how much reward is paid per event in the NFT (contributer reward = eventReward*Quantity/event contributers)
  Safety limits:
• maxTotalPerMonth: maximum total rewards per month that can flow out of the pool
• maxMemberPerMonth: maximum rewards a contributer can earn per month
• maxMemberPerDay: maximum rewards a contributer can earn par day

[sirpy]

@decentralauren while pools can already support other tokens, I don't want to support it in the UI.

1. We already have the mechanism that automatically swaps to G$
2. Other tokens are not supertokens or they require "wrapping" which is almost no difference then swapping to G$, ie you need a special extra TX.
3. using G$ is double impact. you support the pool but also global UBI

[Micholn]

I was told by @L03TJ3 that this is now defined and included with a UI and I could start working on it. Already working on it, will provide feedback soonest.

[L03TJ3]

@Micholn hi, yes, I just assigned you.

Some minor things need to be updated in the flow/design in the next day or so, but that should not prevent you from starting on this issue!