Managing a Pool
Guide for creators on funding a pool
Once a Pool is deployed, there are no ways for a project to adjust the configuration. The core actions the Pool owner can take is to fund the Pool with more rewards, set metadata, withdraw any $GYSR spent on that Pool, and to clean up expired funding schedules.
Funding
Funding a Pool requires a balance of the ERC-20 token the owner would like to distribute. The parameters are:
Amount- how much of the reward token to be distributedPeriod- what duration these rewards should be released overStart Date- what date the rewards will begin to be releasedToken- the reward token address (only for the Waterfall)
There can be up to 16 funding schedules on a single Pool (per token). If there are 16 funding schedules, once one of them ends, it will be deleted and another schedule can be added on.
If a Pool is funded with a future start date, there will be a "boiling period" before rewards start distributing. During this time, users can still stake and (in the case of a Fountain) begin their vesting period or (in the case of a Geyser) get a jump start on earning a time multiplier and share seconds.
Metadata
Pool owners can now define project metadata to be listed on their Pool's staking page. Currently the possible values include:
Name- a custom name for this specific PoolWebsite- the URL of the project or organization behind this PoolDescription- a description of the Pool and project behind it
Withdrawing
As users spend $GYSR on a Pool, earned funds will become available for the Pool owner to withdraw. There is a “Withdraw” capability under a Pool’s management page. Confirm the transaction and all of the $GYSR in the pool will be sent to the owner.
Cleaning
Once funding schedules have expired, the Pool owner can optionally run the "Clean" action from the management page. The clean method removes all "stale" fundings (with no remaining rewards) in order to save on storage space, reduce gas costs, and make room for more funding schedules.
Last updated