Turnpike/f1 fee distribution

app/app.go

@@ -401,18 +401,19 @@ func NewOsmosisApp(
 		),
 	)
 
-	app.LockupKeeper = *lockupKeeper.SetHooks(
-		lockuptypes.NewMultiLockupHooks(
-		// insert lockup hooks receivers here
-		),
-	)
-
 	app.IncentivesKeeper = *incentivesKeeper.SetHooks(
 		incentivestypes.NewMultiIncentiveHooks(
 		// insert incentive hooks receivers here
 		),
 	)
 
+	app.LockupKeeper = *lockupKeeper.SetHooks(
+		lockuptypes.NewMultiLockupHooks(
+			// insert lockup hooks receivers here
+			app.IncentivesKeeper.Hooks(),
+		),
+	)
+
 	app.MintKeeper = *mintKeeper.SetHooks(
 		minttypes.NewMultiMintHooks(
 			// insert mint hooks receivers here

proto/osmosis/incentives/gauge.proto

@@ -41,4 +41,42 @@ message LockableDurationsInfo {
     (gogoproto.stdduration) = true,
     (gogoproto.moretags) = "yaml:\"lockable_durations\""
   ];
-}
+}
+
+message HistoricalReward {
+  repeated cosmos.base.v1beta1.DecCoin cumulative_reward_ratio = 1 [
+    (gogoproto.nullable) = false,
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.DecCoins"
+  ];
+  uint64 period = 2;
+  uint64 last_eligible_epoch = 3;
+}
+
+message CurrentReward {
+  uint64 period = 1;
+  int64 last_processed_epoch = 2;
+  cosmos.base.v1beta1.Coin coin = 3 [
+    (gogoproto.nullable) = false,
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coin"
+  ];
+  repeated cosmos.base.v1beta1.Coin rewards = 4 [
+    (gogoproto.nullable) = false,
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"
+  ];
+  string denom = 5;
+  google.protobuf.Duration duration = 6 [
+    (gogoproto.stdduration) = true,
+    (gogoproto.nullable) = false,
+    (gogoproto.moretags) = "yaml:\"duration\""
+  ];
+}
+
+message PeriodLockReward {
+  option (gogoproto.stable_marshaler) = true;
+  uint64 ID = 1;
+  map<string, uint64> period = 2;
+  repeated cosmos.base.v1beta1.Coin rewards = 3 [
+    (gogoproto.nullable) = false,
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"
+  ];
+}

proto/osmosis/incentives/genesis.proto

@@ -18,4 +18,13 @@ message GenesisState {
     (gogoproto.stdduration) = true,
     (gogoproto.moretags) = "yaml:\"lockable_durations\""
   ];
+  repeated GenesisReward genesis_reward = 4 [ (gogoproto.nullable) = false ];
+  repeated PeriodLockReward period_lock_reward = 5
+      [ (gogoproto.nullable) = false ];
+}
+
+message GenesisReward {
+  CurrentReward current_reward = 1 [ (gogoproto.nullable) = false ];
+  repeated HistoricalReward historical_reward = 2
+      [ (gogoproto.nullable) = false ];
 }

proto/osmosis/incentives/query.proto

@@ -51,12 +51,35 @@ service Query {
     option (google.api.http).get =
         "/osmosis/incentives/v1beta1/rewards_est/{owner}";
   }
+  // returns current estimate of accumulated rewards
+  // from both current and historical rewards
+  rpc Rewards(RewardsRequest) returns (RewardsResponse) {
+    option (google.api.http).get =
+        "/osmosis/incentives/v1beta1/rewards/{owner}";
+  }
   // returns lockable durations that are valid to give incentives
   rpc LockableDurations(QueryLockableDurationsRequest)
       returns (QueryLockableDurationsResponse) {
     option (google.api.http).get =
         "/osmosis/incentives/v1beta1/lockable_durations";
   }
+
+  // returns CurrentReward in this epoch
+  rpc CurrentReward(CurrentRewardRequest) returns (CurrentRewardResponse) {
+    option (google.api.http).get = "/osmosis/incentives/v1beta1/current_reward";
+  }
+  // returns HistoricalReward with given period
+  rpc HistoricalReward(HistoricalRewardRequest)
+      returns (HistoricalRewardResponse) {
+    option (google.api.http).get =
+        "/osmosis/incentives/v1beta1/historical_reward";
+  }
+  // returns PeriodLockReward with given lockID
+  rpc PeriodLockReward(PeriodLockRewardRequest)
+      returns (PeriodLockRewardResponse) {
+    option (google.api.http).get =
+        "/osmosis/incentives/v1beta1/period_lock_reward";
+  }
 }
 
 message ModuleToDistributeCoinsRequest {}
@@ -120,11 +143,69 @@ message RewardsEstResponse {
   ];
 }
 
+message RewardsRequest {
+  string owner = 1 [ (gogoproto.moretags) = "yaml:\"owner\"" ];
+  repeated uint64 lock_ids = 2;
+}
+message RewardsResponse {
+  repeated cosmos.base.v1beta1.Coin coins = 1 [
+    (gogoproto.nullable) = false,
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"
+  ];
+}
+
 message QueryLockableDurationsRequest {}
 message QueryLockableDurationsResponse {
   repeated google.protobuf.Duration lockable_durations = 1 [
     (gogoproto.nullable) = false,
     (gogoproto.stdduration) = true,
     (gogoproto.moretags) = "yaml:\"lockable_durations\""
   ];
-}
+}
+
+message CurrentRewardRequest {
+  string denom = 1;
+  google.protobuf.Duration lockable_durations = 2 [
+    (gogoproto.nullable) = false,
+    (gogoproto.stdduration) = true,
+    (gogoproto.moretags) = "yaml:\"lockable_durations\""
+  ];
+}
+message CurrentRewardResponse {
+  uint64 period = 1;
+  int64 last_processed_epoch = 2;
+  cosmos.base.v1beta1.Coin coin = 3 [ (gogoproto.nullable) = false ];
+  repeated cosmos.base.v1beta1.Coin reward = 4 [
+    (gogoproto.nullable) = false,
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"
+  ];
+}
+
+message HistoricalRewardRequest {
+  string denom = 1;
+  google.protobuf.Duration lockable_durations = 2 [
+    (gogoproto.nullable) = false,
+    (gogoproto.stdduration) = true,
+    (gogoproto.moretags) = "yaml:\"lockable_durations\""
+  ];
+  int64 period = 3;
+}
+message HistoricalRewardResponse {
+  repeated cosmos.base.v1beta1.DecCoin cumulative_reward_ratio = 1 [
+    (gogoproto.nullable) = false,
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.DecCoins"
+  ];
+  uint64 period = 2;
+  uint64 last_eligible_epoch = 3;
+}
+
+message PeriodLockRewardRequest { uint64 id = 1; }
+message PeriodLockRewardResponse {
+  option (gogoproto.stable_marshaler) = true;
+  uint64 ID = 1;
+  map<string, uint64> period = 2;
+  repeated cosmos.base.v1beta1.Coin rewards = 3 [
+    (gogoproto.nullable) = false,
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"
+  ];
+}

proto/osmosis/incentives/tx.proto

@@ -12,6 +12,9 @@ option go_package = "github.com/osmosis-labs/osmosis/x/incentives/types";
 service Msg {
   rpc CreateGauge(MsgCreateGauge) returns (MsgCreateGaugeResponse);
   rpc AddToGauge(MsgAddToGauge) returns (MsgAddToGaugeResponse);
+  rpc ClaimLockReward(MsgClaimLockReward) returns (MsgClaimLockRewardResponse);
+  rpc ClaimLockRewardAll(MsgClaimLockRewardAll)
+      returns (MsgClaimLockRewardResponseAll);
 }
 
 message MsgCreateGauge {
@@ -44,3 +47,14 @@ message MsgAddToGauge {
   ];
 }
 message MsgAddToGaugeResponse {}
+
+message MsgClaimLockReward {
+  string owner = 1 [ (gogoproto.moretags) = "yaml:\"owner\"" ];
+  uint64 ID = 2;
+}
+message MsgClaimLockRewardResponse {}
+
+message MsgClaimLockRewardAll {
+  string owner = 1 [ (gogoproto.moretags) = "yaml:\"owner\"" ];
+}
+message MsgClaimLockRewardResponseAll {}

proto/osmosis/lockup/tx.proto

@@ -17,6 +17,10 @@ service Msg {
       returns (MsgBeginUnlockingAllResponse);
   // MsgBeginUnlocking begins unlocking tokens by lock ID
   rpc BeginUnlocking(MsgBeginUnlocking) returns (MsgBeginUnlockingResponse);
+  // MsgBeginPartialUnlocking begins unlocking  partial amount of tokens by lock
+  // ID
+  rpc BeginPartialUnlocking(MsgBeginPartialUnlocking)
+      returns (MsgBeginPartialUnlockingResponse);
 }
 
 message MsgLockTokens {
@@ -44,3 +48,13 @@ message MsgBeginUnlocking {
   uint64 ID = 2;
 }
 message MsgBeginUnlockingResponse { bool success = 1; }
+
+message MsgBeginPartialUnlocking {
+  string owner = 1 [ (gogoproto.moretags) = "yaml:\"owner\"" ];
+  uint64 ID = 2;
+  repeated cosmos.base.v1beta1.Coin coins = 3 [
+    (gogoproto.nullable) = false,
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"
+  ];
+}
+message MsgBeginPartialUnlockingResponse { bool success = 1; }

x/incentives/README.md

@@ -72,3 +72,26 @@ MsgAddToGauge:
 ```bash
 osmosisd tx incentives add-to-gauge $GAUGE_ID 500MyToken
 ```
+
+
+## Estimating and Claiming Rewards
+
+The accumulated rewards can be estimated and claimed.
+
+### Examples
+
+```bash
+# estimate rewards for validator with a list of lock IDs
+osmosisd query incentives rewards $(osmosisd keys show -a validator --keyring-backend=test) \
+  --lock-ids [lock ids]
+
+# estimate rewards for validator (automatically finds all lock IDs associated with validator)
+osmosisd query incentives rewards $(osmosisd keys show -a validator --keyring-backend=test) \
+
+# claim rewards for a specific lock
+osmosisd tx incentives claim-lock-reward [lock_id] --from=validator --keyring-backend=test 
+
+# claim rewards for all locks
+osmosisd tx incentives claim-lock-reward-all --from=validator --keyring-backend=test 
+
+```

x/incentives/abci_test.go

@@ -64,6 +64,15 @@ func TestNonPerpetualGaugeExpireAfterDistribution(t *testing.T) {
 	_, err = app.IncentivesKeeper.CreateGauge(ctx, false, addr, coins, distrTo, time.Now(), 1)
 	require.NoError(t, err)
 
+	// lock with balance
+	addr1 := sdk.AccAddress([]byte("addr1---------------"))
+	coins = sdk.Coins{sdk.NewInt64Coin(distrTo.Denom, 10)}
+	lock := lockuptypes.NewPeriodLock(1, addr1, time.Second, time.Time{}, coins)
+	err = app.BankKeeper.SetBalances(ctx, addr, coins)
+	require.NoError(t, err)
+	err = app.LockupKeeper.Lock(ctx, lock)
+	require.NoError(t, err)
+
 	params := app.IncentivesKeeper.GetParams(ctx)
 	futureCtx := ctx.WithBlockTime(time.Now().Add(time.Minute))
 	app.EpochsKeeper.BeforeEpochStart(futureCtx, params.DistrEpochIdentifier, 1)