[Feeds] integrate restake module (#182)

* first draft of restake module

* add restake module into app

* add keys and locks

* first version for distribution logic

* finish logic's first version

* fix lint and test

* refactor and optimize

* add genesis

* add events

* fix

* fix module account

* fix from spec

* key format

* adjust comment

* separate module account to key account for keeping rewards

* add pagination for query path

* fix claim reward

* fix precision

* fix reward debt sign

* add gomock

* fix double set hooks

* implement restake module in feeds module

* fix from comments

---------

Co-authored-by: Kitipong Sirirueangsakul <[email protected]>

Author: colmazia

app/app.go

@@ -129,6 +129,9 @@ import (
 	"github.com/bandprotocol/chain/v2/x/oracle"
 	oraclekeeper "github.com/bandprotocol/chain/v2/x/oracle/keeper"
 	oracletypes "github.com/bandprotocol/chain/v2/x/oracle/types"
+	"github.com/bandprotocol/chain/v2/x/restake"
+	restakekeeper "github.com/bandprotocol/chain/v2/x/restake/keeper"
+	restaketypes "github.com/bandprotocol/chain/v2/x/restake/types"
 )
 
 const (
@@ -178,6 +181,7 @@ var (
 		oracle.AppModuleBasic{},
 		feeds.AppModuleBasic{},
 		globalfee.AppModule{},
+		restake.AppModuleBasic{},
 	)
 	// module account permissions
 	maccPerms = map[string][]string{
@@ -189,6 +193,7 @@ var (
 		stakingtypes.NotBondedPoolName: {authtypes.Burner, authtypes.Staking},
 		govtypes.ModuleName:            {authtypes.Burner},
 		ibctransfertypes.ModuleName:    {authtypes.Minter, authtypes.Burner},
+		restaketypes.ModuleName:        nil,
 	}
 
 	Upgrades = []upgrades.Upgrade{v2_6.Upgrade}
@@ -291,6 +296,7 @@ func NewBandApp(
 		oracletypes.StoreKey,
 		feedstypes.StoreKey,
 		globalfeetypes.StoreKey,
+		restaketypes.StoreKey,
 	)
 	tkeys := sdk.NewTransientStoreKeys(paramstypes.TStoreKey)
 	memKeys := sdk.NewMemoryStoreKeys(capabilitytypes.MemStoreKey)
@@ -419,6 +425,16 @@ func NewBandApp(
 		authtypes.NewModuleAddress(govtypes.ModuleName).String(),
 	)
 
+	app.RestakeKeeper = restakekeeper.NewKeeper(
+		appCodec,
+		keys[restaketypes.StoreKey],
+		authtypes.FeeCollectorName,
+		app.AccountKeeper,
+		app.BankKeeper,
+		app.StakingKeeper,
+		authtypes.NewModuleAddress(govtypes.ModuleName).String(),
+	)
+
 	// create IBC Keeper
 	app.IBCKeeper = ibckeeper.NewKeeper(
 		appCodec,
@@ -531,6 +547,7 @@ func NewBandApp(
 		keys[feedstypes.StoreKey],
 		app.OracleKeeper,
 		app.StakingKeeper,
+		app.RestakeKeeper,
 		app.AuthzKeeper,
 		authtypes.NewModuleAddress(govtypes.ModuleName).String(),
 	)
@@ -539,7 +556,7 @@ func NewBandApp(
 		stakingtypes.NewMultiStakingHooks(
 			app.DistrKeeper.Hooks(),
 			app.SlashingKeeper.Hooks(),
-			app.FeedsKeeper.Hooks(),
+			app.RestakeKeeper.Hooks(),
 		),
 	)
 
@@ -634,6 +651,7 @@ func NewBandApp(
 		oracleModule,
 		feeds.NewAppModule(appCodec, app.FeedsKeeper),
 		globalfee.NewAppModule(app.GlobalfeeKeeper),
+		restake.NewAppModule(appCodec, &app.RestakeKeeper),
 	)
 
 	// NOTE: Oracle module must occur before distr as it takes some fee to distribute to active oracle validators.
@@ -646,6 +664,7 @@ func NewBandApp(
 		minttypes.ModuleName,
 		oracletypes.ModuleName,
 		feedstypes.ModuleName,
+		restaketypes.ModuleName,
 		distrtypes.ModuleName,
 		slashingtypes.ModuleName,
 		evidencetypes.ModuleName,
@@ -673,6 +692,7 @@ func NewBandApp(
 		stakingtypes.ModuleName,
 		oracletypes.ModuleName,
 		feedstypes.ModuleName,
+		restaketypes.ModuleName,
 		ibctransfertypes.ModuleName,
 		ibcexported.ModuleName,
 		icatypes.ModuleName,
@@ -725,6 +745,7 @@ func NewBandApp(
 		oracletypes.ModuleName,
 		feedstypes.ModuleName,
 		globalfeetypes.ModuleName,
+		restaketypes.ModuleName,
 	)
 
 	app.mm.RegisterInvariants(app.CrisisKeeper)

app/genesis.go

@@ -43,6 +43,8 @@ import (
 	globalfeetypes "github.com/bandprotocol/chain/v2/x/globalfee/types"
 	"github.com/bandprotocol/chain/v2/x/oracle"
 	oracletypes "github.com/bandprotocol/chain/v2/x/oracle/types"
+	"github.com/bandprotocol/chain/v2/x/restake"
+	restaketypes "github.com/bandprotocol/chain/v2/x/restake/types"
 )
 
 // GenesisState defines a type alias for the Band genesis application state.
@@ -110,5 +112,6 @@ func NewDefaultGenesisState() GenesisState {
 		oracletypes.ModuleName:       oracle.AppModuleBasic{}.DefaultGenesis(cdc),
 		feedstypes.ModuleName:        feeds.AppModuleBasic{}.DefaultGenesis(cdc),
 		globalfeetypes.ModuleName:    cdc.MustMarshalJSON(globalfeeGenesis),
+		restaketypes.ModuleName:      restake.AppModuleBasic{}.DefaultGenesis(cdc),
 	}
 }

app/keepers/keepers.go

@@ -24,6 +24,7 @@ import (
 	feedskeeper "github.com/bandprotocol/chain/v2/x/feeds/keeper"
 	globalfeekeeper "github.com/bandprotocol/chain/v2/x/globalfee/keeper"
 	oraclekeeper "github.com/bandprotocol/chain/v2/x/oracle/keeper"
+	restakekeeper "github.com/bandprotocol/chain/v2/x/restake/keeper"
 )
 
 type AppKeepers struct {
@@ -51,6 +52,7 @@ type AppKeepers struct {
 	FeedsKeeper           feedskeeper.Keeper
 	ConsensusParamsKeeper consensusparamkeeper.Keeper
 	GlobalfeeKeeper       globalfeekeeper.Keeper
+	RestakeKeeper         restakekeeper.Keeper
 
 	// make scoped keepers public for test purposes
 	ScopedIBCKeeper      capabilitykeeper.ScopedKeeper

go.mod

@@ -4,6 +4,7 @@ go 1.22.3
 
 require (
 	cosmossdk.io/api v0.3.1
+	cosmossdk.io/core v0.5.1
 	cosmossdk.io/errors v1.0.1
 	cosmossdk.io/math v1.3.0
 	github.com/bandprotocol/bothan/bothan-api/client/go-client v0.0.1-alpha.1
@@ -46,7 +47,6 @@ require (
 	cloud.google.com/go/compute/metadata v0.2.3 // indirect
 	cloud.google.com/go/iam v1.1.6 // indirect
 	cloud.google.com/go/storage v1.36.0 // indirect
-	cosmossdk.io/core v0.5.1 // indirect
 	cosmossdk.io/depinject v1.0.0-alpha.4 // indirect
 	cosmossdk.io/log v1.3.1 // indirect
 	cosmossdk.io/tools/rosetta v0.2.1 // indirect

proto/restake/v1beta1/genesis.proto

@@ -0,0 +1,40 @@
+syntax = "proto3";
+package restake.v1beta1;
+
+option go_package = "github.com/bandprotocol/chain/v2/x/restake/types";
+
+import "amino/amino.proto";
+import "gogoproto/gogo.proto";
+import "cosmos_proto/cosmos.proto";
+import "cosmos/base/v1beta1/coin.proto";
+import "restake/v1beta1/types.proto";
+
+// GenesisState represents the initial state of the blockchain.
+message GenesisState {
+  // Keys is a list of keys in the module.
+  repeated Key keys = 1 [(gogoproto.nullable) = false];
+
+  // Stake is a list of stakes in the module.
+  repeated Stake stakes = 2 [(gogoproto.nullable) = false];
+
+  // Rewards is a list of rewards in the module.
+  repeated RewardGenesis rewards = 3 [(gogoproto.nullable) = false];
+}
+
+// RewardGenesis message represents reward details for genesis state.
+message RewardGenesis {
+  option (gogoproto.equal) = true;
+
+  // Address is the owner address of this reward.
+  string address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+
+  // Key is the key that this rewards belongs to.
+  string key = 2;
+
+  // Amounts is a list of reward amounts for this address and key.
+  repeated cosmos.base.v1beta1.DecCoin amounts = 3 [
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.DecCoins",
+    (gogoproto.nullable)     = false,
+    (amino.dont_omitempty)   = true
+  ];
+}

proto/restake/v1beta1/query.proto

@@ -0,0 +1,94 @@
+syntax = "proto3";
+package restake.v1beta1;
+
+option go_package = "github.com/bandprotocol/chain/v2/x/restake/types";
+
+import "gogoproto/gogo.proto";
+import "google/api/annotations.proto";
+import "cosmos/base/query/v1beta1/pagination.proto";
+import "restake/v1beta1/types.proto";
+
+// Query service defines the gRPC querier service for restake.
+service Query {
+  // Keys returns a list of keys.
+  rpc Keys(QueryKeysRequest) returns (QueryKeysResponse) {
+    option (google.api.http).get = "/restake/v1beta1/keys";
+  }
+
+  // Key returns a key information
+  rpc Key(QueryKeyRequest) returns (QueryKeyResponse) {
+    option (google.api.http).get = "/restake/v1beta1/keys/{key}";
+  }
+
+  // Rewards returns rewards for a specific address.
+  rpc Rewards(QueryRewardsRequest) returns (QueryRewardsResponse) {
+    option (google.api.http).get = "/restake/v1beta1/addresses/{address}/rewards";
+  }
+
+  // Locks returns all lock information for a specific address.
+  rpc Locks(QueryLocksRequest) returns (QueryLocksResponse) {
+    option (google.api.http).get = "/restake/v1beta1/addresses/{address}/locks";
+  }
+}
+
+// QueryKeysRequest represents the request type for the Query/Keys RPC method.
+message QueryKeysRequest {
+  // Pagination defines optional pagination parameters.
+  cosmos.base.query.v1beta1.PageRequest pagination = 1;
+}
+
+// QueryKeysResponse represents the response type for the Query/Keys RPC method.
+message QueryKeysResponse {
+  // Keys is a list of keys.
+  repeated Key keys = 1;
+
+  // Pagination defines pagination parameters in the response.
+  cosmos.base.query.v1beta1.PageResponse pagination = 2;
+}
+
+// QueryKeyRequest represents the request type for the Query/Key RPC method.
+message QueryKeyRequest {
+  string key = 1;
+}
+
+// QueryKeyResponse represents the response type for the Query/Key RPC method.
+message QueryKeyResponse {
+  // Key is a key information.
+  Key key = 1 [(gogoproto.nullable) = false];
+}
+
+// QueryRewardsRequest represents the request type for the Query/Rewards RPC method.
+message QueryRewardsRequest {
+  // Address is the target address to query rewards.
+  string address = 1;
+
+  // Pagination defines optional pagination parameters.
+  cosmos.base.query.v1beta1.PageRequest pagination = 2;
+}
+
+// QueryRewardsResponse represents the response type for the Query/Rewards RPC method.
+message QueryRewardsResponse {
+  // Rewards is a list of rewards for the address.
+  repeated Reward rewards = 1;
+
+  // Pagination defines pagination parameters in the response.
+  cosmos.base.query.v1beta1.PageResponse pagination = 2;
+}
+
+// QueryLocksRequest represents the request type for the Query/Locks RPC method.
+message QueryLocksRequest {
+  // Address is the target address to query locks.
+  string address = 1;
+
+  // Pagination defines optional pagination parameters.
+  cosmos.base.query.v1beta1.PageRequest pagination = 2;
+}
+
+// QueryLocksResponse represents the response type for the Query/Locks RPC method.
+message QueryLocksResponse {
+  // Locks is a list of locks of the address.
+  repeated Lock locks = 1;
+
+  // Pagination defines pagination parameters in the response.
+  cosmos.base.query.v1beta1.PageResponse pagination = 2;
+}

proto/restake/v1beta1/tx.proto

@@ -0,0 +1,103 @@
+syntax = "proto3";
+package restake.v1beta1;
+
+option go_package = "github.com/bandprotocol/chain/v2/x/restake/types";
+
+import "amino/amino.proto";
+import "cosmos/base/v1beta1/coin.proto";
+import "cosmos/msg/v1/msg.proto";
+import "cosmos_proto/cosmos.proto";
+import "gogoproto/gogo.proto";
+
+// Service definition for Msg which handles oracle related messages.
+service Msg {
+  // RPC method for claiming rewards.
+  rpc ClaimRewards(MsgClaimRewards) returns (MsgClaimRewardsResponse);
+
+  //////////////////////////////////////////
+  // Methods below are for testing only.
+  //////////////////////////////////////////
+
+  // RPC method for locking powers.
+  rpc LockPower(MsgLockPower) returns (MsgLockPowerResponse);
+
+  // RPC method for adding rewards.
+  rpc AddRewards(MsgAddRewards) returns (MsgAddRewardsResponse);
+
+  // RPC method for deactivating a key.
+  rpc DeactivateKey(MsgDeactivateKey) returns (MsgDeactivateKeyResponse);
+}
+
+// MsgClaimRewards is the request message type for claiming rewards.
+message MsgClaimRewards {
+  option (cosmos.msg.v1.signer) = "address";
+  option (amino.name)           = "restake/MsgClaimRewards";
+
+  // Address is the address that will claim the rewards.
+  string address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+
+  // Key is the key that want to claim rewards from.
+  string key = 2;
+}
+
+// MsgClaimRewardsResponse is the response message type for claiming rewards.
+message MsgClaimRewardsResponse {}
+
+// MsgLockPower is the request message type for locking tokens.
+message MsgLockPower {
+  option (cosmos.msg.v1.signer) = "address";
+  option (amino.name)           = "restake/MsgLockPower";
+
+  // Address is the address will be locked power.
+  string address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+
+  // Key is the key of the lock.
+  string key = 2;
+
+  // Amount is the locked amount.
+  string amount = 3 [
+    (cosmos_proto.scalar)  = "cosmos.Int",
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int",
+    (gogoproto.nullable)   = false
+  ];
+}
+
+// MsgLockPowerResponse is the response message type for locking power.
+message MsgLockPowerResponse {}
+
+// MsgAddRewards is the request message type for adding rewards.
+message MsgAddRewards {
+  option (cosmos.msg.v1.signer) = "sender";
+  option (amino.name)           = "restake/MsgAddRewards";
+
+  // Sender is the address that want to send rewards.
+  string sender = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+
+  // Key is the key of pool that reward will be sent to.
+  string key = 2;
+
+  // Rewards is a list of rewards that will send to module.
+  repeated cosmos.base.v1beta1.Coin rewards = 3 [
+    (gogoproto.nullable)     = false,
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins",
+    (gogoproto.jsontag)      = "min_deposit,omitempty"
+  ];
+}
+
+// MsgAddRewardsResponse is the response message type for adding rewards.
+message MsgAddRewardsResponse {}
+
+// MsgDeactivateKey is the request message type for deactivating a key.
+message MsgDeactivateKey {
+  option (cosmos.msg.v1.signer) = "sender";
+  option (amino.name)           = "restake/MsgDeactivateKey";
+
+  // Sender is the sender of the message.
+  string sender = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+
+  // Key is the key that will be deactivated.
+  string key = 2;
+}
+
+// MsgDeactivateKeyResponse is the response message type for deactivating a key.
+message MsgDeactivateKeyResponse {}