DNM: incentive module proto #1514

toteki · 2022-10-23T18:29:29Z

Marking as DO NOT MERGE so I can break it up into smaller PRs

This PR contains the first step in the incentive module

Progress:

Proto files
Proto gen
Implement Msg interfaces

Design of gov proposals:

I have created two options for funding incentive programs:

one that uses a community fund or known address to fund a program the moment it passes governance
another that creates the program and sets its total rewards via governance, but requires a basic account to fund it after passing or it won't start.

Two step process (basic account)

If doing external incentives, we may want to let the source of the funding use a basic account. In that case, MsgGovCreateProgram (and governance vote) is used to set the program's max_rewards but NOT fund it.

Then, a MsgSponsorProgram can be used by the basic account, which must fund the exact amount specified in max_rewards or the program will not start / activate.

One step process (community fund)

For ordinary programs that use the community fund, or instances where external incentives are already waiting at a known address, a MsgCreateAndSponsorProgram is used to do it all in one step.

Author Checklist

toteki · 2022-10-27T18:21:34Z

Marking this R4R - since adding the proto files without hooking up module to the app does not mess with the build in main / release branch, it should be safe to merge.

proto/umee/incentive/v1/tx.proto

x/incentive/types/tx.go

…adam/incentive-a

proto/umee/incentive/v1/genesis.proto

robert-zaremba

please follow the 0.46 module organization: types should be generated directly into the root package of the module, together with codec, errors and keys.
don't use yaml tags - they are deprecated
don't use paramtypes.ParamSet - new gov mechanism should be used instead when possible.
tx.go with sdk.Msg implementations should be renamed to msg.go

proto/umee/incentive/v1/genesis.proto

proto/umee/incentive/v1/incentive.proto

x/incentive/types/tx.go

codecov-commenter · 2022-11-16T12:14:28Z

Codecov Report

Merging #1514 (6e8e0fd) into main (bcd3e5a) will increase coverage by 0.15%.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##             main    #1514      +/-   ##
==========================================
+ Coverage   55.47%   55.63%   +0.15%     
==========================================
  Files          68       68              
  Lines        6725     6706      -19     
==========================================
  Hits         3731     3731              
+ Misses       2717     2698      -19     
  Partials      277      277

Impacted Files	Coverage Δ
x/leverage/types/msgs.go	`6.52% <0.00%> (+1.90%)`	⬆️

toteki · 2022-11-20T19:05:53Z

Switched all block height (unbondings, durations, program ends) to unix time.

Also split up where the incentive programs are stored in state and queried, so it's easier to validate them (different values should be zero/nonzero at different points in the program's lifecycle (upcoming, ongoing, completed).

Additionally, only the completed programs query has pagination - that's where programs will accumulate (the upcoming and ongoing sets will always have a limited amount of programs in them)

proto/umee/oracle/v1/genesis.proto

robert-zaremba

Usually, the best is to keep the first PR only proto oriented + generated files. This way we firstly deal with proto, without messing with validation etc... But the validation is already here, so we can go with that. So let's make the review in mulitple stage, here I firstly review the proto.

Let's don't use params - it's officially deprecated. See my comment how to move forward with that.
Let's add a create_program_fee param to avoid a spam (maybe we can discuss it in notion). This will be paid in Umee.
Please create a notion page to specify functionality (not a design doc). Specifically:
- how the programs will work with uTokens?
- Can there be multiple programs for the same uToken with overlapping period?
- Do we support auto compounding (now, or v2?)?
- Can programs be extended or resumed?
- Can we partially fund a program?
- Maybe we should support a scenario when community fund will only partially sponsor a program? In that case we would need to add ratio parameter to MsgGovCreateAndSponsorProgram

proto/umee/incentive/v1/genesis.proto

x/leverage/types/msgs.go

x/incentive/params.go

x/incentive/msgs.go

robert-zaremba · 2022-11-21T14:19:00Z

proto/umee/incentive/v1/genesis.proto

+// BondAmount tracks the amount of coins of one uToken denomination bonded to a
+// given reward tier by a single account.


Suggested change

// BondAmount tracks the amount of coins of one uToken denomination bonded to a

// given reward tier by a single account.

// Bond tracks the user rewards per tire and uToken coin.

I think we can simplify the name, otherwise we would need to call it UserTireBond or UserTireCoinBond

robert-zaremba · 2022-11-21T14:36:38Z

proto/umee/incentive/v1/query.proto

+  rpc UpcomingIncentivePrograms(QueryUpcomingIncentivePrograms)
+      returns (QueryUpcomingIncentiveProgramsResponse) {
+    option (google.api.http).get = "/umee/incentive/v1/incentive_programs/upcoming";
+  }


I think UI will usually need all programs, or both ongoing and upcoming. So, instead of having 3 queries, we can have either:

2 queries: past and ongoing+future (with a flag future [default = false]

1 query: pas + ongoing + future (with flag past [default = false])

Frontend will probably just need current, and it's easier to have them stored separately in state since it reduces iterations when looking for just one type.

So you are moving the program between storage prefixes?

My question was more related to the query, why having 3 queries if we can only have 1 or 2? That would reduce and simplify the code.

Let's verify with the frontend. My gut feeling is that they will like to show both present and future.

proto/umee/incentive/v1/genesis.proto

robert-zaremba · 2022-11-21T14:44:32Z

proto/umee/incentive/v1/tx.proto

+  rpc BeginUnbonding(MsgBeginUnbonding) returns (MsgBeginUnbondingResponse);
+
+  // Sponsor defines a permissionless method for sponsoring an upcoming, not yet funded incentive program.
+  rpc Sponsor(MsgSponsor) returns (MsgSponsorResponse);


I think w should enable partial sponsoring, when 2 separate sponsors will like to sponsor a program. Or do it in v2.

Partial sponsoring creates an edge case, where if a program is not fully sponsored by the time it starts, the module needs to either

remember the address of any sponsor and refund the tokens

start the program with actual rewards != governance agreed rewards

Currently, a program is either not funded, or fully funded, so such scenarios are prevented

Yes, but maybe we need to support a scenario when, for example we have 2 sponsors?

Something that could be useful in the future, but probably not near-term. Possible use case would be ecosystems with multiple tokens like Comdex. Maybe they want to incentivize borrowing their CMST stablecoin with CMDX, HARBOR, etc.

yes, I was thinking about similar scenario. Other would be if there are two independent accounts which would sponsor only if the proposal passes (Eg: Umee DAO and Osmosis DAO).

robert-zaremba · 2022-11-21T14:45:53Z

proto/umee/incentive/v1/tx.proto

+  // GovCreateProgram is used by governance proposals to create (but not fund) an incentive program.
+  rpc GovCreateProgram(MsgGovCreateProgram) returns (MsgGovCreateProgramResponse);
+
+  // GovCreateAndSponsorProgram is used by governance proposals to create and fund an incentive program.


Suggested change

// GovCreateAndSponsorProgram is used by governance proposals to create and fund an incentive program.

// GovCreateAndSponsorProgram is used by governance proposals to create an incentive program

// and sponsor it from the Community Fund.

robert-zaremba · 2022-11-21T14:48:41Z

proto/umee/incentive/v1/tx.proto

+// MsgGovCreateAndSponsorProgram is used by governance to create an incentive program
+// and fund it in the same transaction. The sponsor address should be the community
+// fund or an agreed upon account - program reward funds will be taken from that address
+// when the incentive program passes governance.


there is no sponsor parameter in this message. Let's just write that "when passed, the program is fully sponsored by the Community Fund".

If so, I'll need to hardcode (or add to Params) a community fund address.

Note: sponsor parameter is currently below the highlighted comment - it is the last field

You check the Community Fund address during the execution. It's not a param, because it doesn't change.

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

toteki · 2022-11-21T20:55:16Z

Please create a notion page to [...]

Most of there questions are already answered in the design document. I'll copypaste the answers here but I think they'll eventually end up in a spec

how the programs will work with uTokens?

Users lock and unlock `uTokens` they have enabled as collateral in `x/leverage` by sumbitting `x/incentive` message types.

Locked uTokens remain in the `x/leverage` module account.

Locking of funds is independent of active incentive programs, and can even be done in their absence.

and

Locked funds must be collateral-enabled uTokens. Locked funds will not leave their original place in the leverage module account. Locking will prevent withdrawal and collateral-disabling (but not liquidation) of the locked uTokens until they are successfully unlocked.

Can there be multiple programs for the same uToken with overlapping period?

Incentive programs are created by governance. No message types to alter or halt incentive programs once voted on are planned, and any number of incentive programs should be capable of being active simultaneously regardless of parameters, including overlapping dates and denominations.

Do we support auto compounding (now, or v2?)?

no - not mentioned in any design

Can programs be extended or resumed?

Incentive programs are created by governance. No message types to alter or halt incentive programs once voted on are planned, and any number of incentive programs should be capable of being active simultaneously regardless of parameters, including overlapping dates and denominations.

Can we partially fund a program?

currently we're requiring full funding to prevent partial -> refund edge cases.

Maybe we should support a scenario when community fund will only partially sponsor a program? In that case we would need to add ratio parameter to MsgGovCreateAndSponsorProgram

Not planned

stale · 2022-12-31T23:55:03Z

This PR has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

toteki added 7 commits October 23, 2022 00:50

gitignore++

b1d35cb

proto

1f08788

make proto-all

807a1b2

amount -> asset

4c9147b

++

5acd5b7

++

4d162fd

implement Msg interfaces

0b14b41

toteki added the C:x/incentive label Oct 23, 2022

toteki added 2 commits October 23, 2022 12:29

Merge branch 'main' into adam/incentive-a

561b558

add MsgCreateAnfdSponsorProgram

9876a38

toteki mentioned this pull request Oct 26, 2022

DNM: incentive module framework #1526

Closed

10 tasks

toteki changed the title ~~DNM - Incentive module step 1~~ feat: incentive module proto Oct 27, 2022

Merge branch 'main' into adam/incentive-a

9788676

toteki marked this pull request as ready for review October 27, 2022 18:13

toteki requested a review from a team as a code owner October 27, 2022 18:13

toteki commented Oct 27, 2022

View reviewed changes

proto/umee/incentive/v1/tx.proto Outdated Show resolved Hide resolved

toteki added 3 commits October 29, 2022 08:48

Merge branch 'main' into adam/incentive-a

f33ec03

go get github.com/mgechev/revive/revivelib@v1.2.4

c3a3b40

make go-mod-tidy

53d59b1

toteki commented Oct 30, 2022

View reviewed changes

x/incentive/types/tx.go Outdated Show resolved Hide resolved

lint++

270d131

toteki commented Oct 30, 2022

View reviewed changes

x/incentive/types/tx.go Outdated Show resolved Hide resolved

toteki added 4 commits October 30, 2022 07:35

lint++

f85a7d9

Merge branch 'adam/incentive-a' of github.com:umee-network/umee into …

b07ce4a

…adam/incentive-a

Merge branch 'main' into adam/incentive-a

1f43a59

Merge branch 'main' into adam/incentive-a

76fae42

robert-zaremba reviewed Oct 31, 2022

View reviewed changes

proto/umee/incentive/v1/genesis.proto Show resolved Hide resolved

robert-zaremba reviewed Nov 1, 2022

View reviewed changes

x/incentive/types/tx.go Outdated Show resolved Hide resolved

Merge branch 'main' into adam/incentive-a

9387d07

toteki added 9 commits November 16, 2022 04:36

proposal checkers function

63326b8

proposal checkers function

67ff0fc

proto comments

124c66d

proto comments

7cbe1bd

Merge branch 'main' into adam/incentive-a

d290931

module reorganization

f86e455

++

9cb6a55

additional proto fields and query refactor

828ccc6

++

6e8e0fd

toteki requested a review from robert-zaremba November 20, 2022 19:03

Merge branch 'main' into adam/incentive-a

185aba8

toteki commented Nov 21, 2022

View reviewed changes

proto/umee/oracle/v1/genesis.proto Show resolved Hide resolved

robert-zaremba reviewed Nov 21, 2022

View reviewed changes

toteki and others added 6 commits November 21, 2022 07:53

Update proto/umee/incentive/v1/incentive.proto

7115c8f

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

Update proto/umee/incentive/v1/incentive.proto

1217035

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

Update proto/umee/incentive/v1/incentive.proto

f9a664a

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

Update proto/umee/incentive/v1/incentive.proto

8cae016

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

use leverage HasUTokenPrefix

3638ec4

Merge branch 'main' into adam/incentive-a

c105897

toteki changed the title ~~feat: incentive module proto~~ DNM: incentive module proto Nov 30, 2022

toteki mentioned this pull request Nov 30, 2022

feat: incentive module proto #1630

Merged

17 tasks

toteki marked this pull request as draft December 1, 2022 18:59

stale bot added the S:Stale label Dec 31, 2022

stale bot closed this Jan 8, 2023

toteki deleted the adam/incentive-a branch April 27, 2023 14:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DNM: incentive module proto #1514

DNM: incentive module proto #1514

toteki commented Oct 23, 2022 •

edited

Loading

toteki commented Oct 27, 2022

robert-zaremba left a comment •

edited by toteki

Loading

codecov-commenter commented Nov 16, 2022 •

edited

Loading

toteki commented Nov 20, 2022 •

edited

Loading

robert-zaremba left a comment

robert-zaremba Nov 21, 2022

robert-zaremba Nov 21, 2022

robert-zaremba Nov 21, 2022

toteki Nov 21, 2022

robert-zaremba Nov 22, 2022

robert-zaremba Nov 21, 2022

toteki Nov 21, 2022

robert-zaremba Nov 22, 2022

jordanbearfort Nov 22, 2022

robert-zaremba Nov 22, 2022

robert-zaremba Nov 21, 2022

robert-zaremba Nov 21, 2022

toteki Nov 21, 2022

toteki Nov 22, 2022

robert-zaremba Nov 22, 2022

toteki commented Nov 21, 2022

stale bot commented Dec 31, 2022

		// BondAmount tracks the amount of coins of one uToken denomination bonded to a
		// given reward tier by a single account.

	// BondAmount tracks the amount of coins of one uToken denomination bonded to a
	// given reward tier by a single account.
	// Bond tracks the user rewards per tire and uToken coin.

	// GovCreateAndSponsorProgram is used by governance proposals to create and fund an incentive program.
	// GovCreateAndSponsorProgram is used by governance proposals to create an incentive program
	// and sponsor it from the Community Fund.

DNM: incentive module proto #1514

DNM: incentive module proto #1514

Conversation

toteki commented Oct 23, 2022 • edited Loading

Two step process (basic account)

One step process (community fund)

Author Checklist

toteki commented Oct 27, 2022

robert-zaremba left a comment • edited by toteki Loading

Choose a reason for hiding this comment

codecov-commenter commented Nov 16, 2022 • edited Loading

Codecov Report

toteki commented Nov 20, 2022 • edited Loading

robert-zaremba left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

toteki commented Nov 21, 2022

stale bot commented Dec 31, 2022

toteki commented Oct 23, 2022 •

edited

Loading

robert-zaremba left a comment •

edited by toteki

Loading

codecov-commenter commented Nov 16, 2022 •

edited

Loading

toteki commented Nov 20, 2022 •

edited

Loading