Include a RewardDistribution Contract

[mikeki]

🧐 Motivation

Many new projects in crypto are distributing tokens or creating their business models on top of a reward distribution contract, as initially done by synthetix. There's currently no 'official' contract that could be used for that, and I think it would be a great addition to the open zeppelin library

📝 Details

[Amxx]

We already have a PaymentSplitter contract, that is designed to do that for ETH (native token). We could just as well have an equivalent contract that deals with ERC20 tokens.

Would that meet your requirements? If so, we could definitely consider adding it.

[frangio]

Thanks for the suggestion @mikeki. Can you share the contract that is used by Synthetix, or a similar one?

I think the requirements are slightly different to PaymentSplitter.

[mikeki]

I will take a look at PaymentSplitter, but they are probably different requirements, since the ones used widely on DeFi right now is also a Staking pool which distributes rewards according to the share of staked tokens in the pool.

This is the current Synthetix code, which at this point is very unique to their product, but might be a good place to get inspiration, since they've been working on it for quite a while now.

There's also the Yam Finance code, which is the pool that most DeFi projects started cloning. IMO it's very RAW, it could be a bit better organized.

I also ran into this other codebase which looks pretty well organized, although it seems like it was created with a different purpose in mind, but perhaps it could be adapted (Or perhaps it could be modularized to satisfy different needs)

[frangio]

Thank you for all the links @mikeki. For licensing reasons we will probably prefer that any contracts for OpenZeppelin Contracts be written from scratch, but taking inspiration from these other protocols is fine.

We're interested in this feature but we will want to carefully design the solution. I think a good place to start is for someone to propose what contract we should add (possibly an ERC20 extension?), and a minimal interface for this contract.

[hanselb]

I already did this guys. I combined the ERC721 + PaymentSplitter for my first drop. I just forked and working on a PR to the ERC721 extensions folder since I feel like it is more that that a new Payment contract. I feel like simply calling it ERC721PaymentSplitter will be good enough for SEO.

[frangio]

@hanselb It sounds unrelated to this issue. Before opening a PR please propose your contract in a new issue.

[hanselb]

@frangio just to make sure I understood the scope: We are trying to find an official way to distribute rewards among token holders in a transparent way. I am certain we can accomplish this with ERC721 + ERC721Enumerable + PaymentSplitter

In my implementation I extend ERC721Enumerable and use most of the functions of PaymentSplitter but remove payees[] and make _totalShares a function that returns the ERC721Enumerable's totalSupply.

This allows me to have two methods release(tokenId) and release(account) to distribute payment using ownerOf and tokenOfOwnerByIndex() internally. I also handle releasing any _pendingPayment(tokenId) on transfer or leaving it for future claim based on_releaseOnTranser prop which can be set in the constructor for ERC721PaymentSplitter

Please let me know if this is not in scope for this issue. I can definitely create a new issue for this. I think this extremely needed in the space for creators who wish to give back to their communities and I see a lot of external systems created to do this.

[frangio]

I believe what you're describing is about "discrete" rewards where you want one payment (or a series of separate payments) to get split among token holders.

This issue is slightly different, it's about a reward pool that continuously drips rewards to the token holders.

[hanselb]

Anything you deposit onto the ERC721PaymentSplitter contract get's split among the holders equally and the balance is kept on the contract itself. I don't fully understand "continuously drips" does this mean that if they want to distribute 100 ETH total, they will slowly release that into the reward pool or is it more on an individual holder level? ERC721PaymentSplitter makes the rewards owed to holder available the moment it is deposited into the contract. I am using it to distribute Music Royalties and also give back a % of minting and resale to the holders right at the moment it happens.

[frangio]

What I mean is you could deposit 100 ETH in a contract and configure the reward pool so they are distributed slowly over the course of 6 months, for example.

[hanselb]

I see, I have created a new issue for ERC721PaymentSplitter you can find it below.
#3201

Maybe for this issue we could use some of the PullPayment patterns inside the ERC721 to do the slow leak of the ETH https://docs.openzeppelin.com/contracts/4.x/api/security#PullPayment

[PrimeDominus]

I'm very interested in an official implementation along the lines of what @frangio has described.

[frangio]

@PrimeDominus Have you looked at other implementations of this concept across DeFi projects? Did you consider reusing them? Is there something in particular that an OpenZeppelin implementation should aim for?