Merge branch 'restake-init' into master-feed

Author: colmazia

app/app.go

@@ -428,11 +428,9 @@ func NewBandApp(
 	app.RestakeKeeper = restakekeeper.NewKeeper(
 		appCodec,
 		keys[restaketypes.StoreKey],
-		authtypes.FeeCollectorName,
 		app.AccountKeeper,
 		app.BankKeeper,
 		app.StakingKeeper,
-		authtypes.NewModuleAddress(govtypes.ModuleName).String(),
 	)
 
 	// create IBC Keeper

proto/restake/v1beta1/genesis.proto

@@ -3,38 +3,14 @@ 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
-  ];
+  // Locks is a list of locks in the module.
+  repeated Lock locks = 2 [(gogoproto.nullable) = false];
 }

proto/restake/v1beta1/query.proto

@@ -15,19 +15,19 @@ service Query {
     option (google.api.http).get = "/restake/v1beta1/keys";
   }
 
-  // Key returns a key information
+  // 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";
+    option (google.api.http).get = "/restake/v1beta1/lockers/{locker_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";
+    option (google.api.http).get = "/restake/v1beta1/lockers/{locker_address}/locks";
   }
 }
 
@@ -59,16 +59,16 @@ message QueryKeyResponse {
 
 // QueryRewardsRequest represents the request type for the Query/Rewards RPC method.
 message QueryRewardsRequest {
-  // Address is the target address to query rewards.
-  string address = 1;
+  // LockerAddress is the target address to query rewards.
+  string locker_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.
+  // Rewards is a list of rewards for the locker.
   repeated Reward rewards = 1;
 
   // Pagination defines pagination parameters in the response.
@@ -77,17 +77,17 @@ message QueryRewardsResponse {
 
 // QueryLocksRequest represents the request type for the Query/Locks RPC method.
 message QueryLocksRequest {
-  // Address is the target address to query locks.
-  string address = 1;
+  // LockerAddres is the target address to query locks.
+  string locker_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;
+  // Locks is a list of locks of the locker.
+  repeated LockResponse locks = 1;
 
   // Pagination defines pagination parameters in the response.
   cosmos.base.query.v1beta1.PageResponse pagination = 2;

proto/restake/v1beta1/tx.proto

@@ -4,100 +4,26 @@ 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 definition for Msg which handles restake 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 (cosmos.msg.v1.signer) = "locker_address";
   option (amino.name)           = "restake/MsgClaimRewards";
 
-  // Address is the address that will claim the rewards.
-  string address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+  // LockerAddress is the address that will claim the rewards.
+  string locker_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 {}

proto/restake/v1beta1/types.proto

@@ -8,49 +8,51 @@ import "amino/amino.proto";
 import "cosmos_proto/cosmos.proto";
 import "cosmos/base/v1beta1/coin.proto";
 
-// Key message represents a key definition.
+// Key message is used for tracking the status and rewards of the keys.
 message Key {
   option (gogoproto.equal) = true;
 
   // Name is the name of the key.
   string name = 1;
 
-  // Address is the address that holds rewards for this key.
-  string address = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+  // PoolAddress is the address that holds rewards for this key.
+  string pool_address = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"];
 
   // IsActive is the status of the key
   bool is_active = 3;
 
-  // RewardPerShares is a list of reward_per_share of rewards.
-  repeated cosmos.base.v1beta1.DecCoin reward_per_shares = 4 [
+  // RewardPerPowers is a list of reward_per_power.
+  // new_reward_per_power = current_reward_per_power + (rewards / total_power)
+  repeated cosmos.base.v1beta1.DecCoin reward_per_powers = 4 [
     (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.DecCoins",
     (gogoproto.nullable)     = false,
     (amino.dont_omitempty)   = true
   ];
 
-  // TotalLock is the total locked power of the key.
-  string total_lock = 5 [
+  // TotalPower is the total locked power of the key.
+  string total_power = 5 [
     (cosmos_proto.scalar)  = "cosmos.Int",
     (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int",
     (gogoproto.nullable)   = false
   ];
 
   // Remainders is a list of the remainder amounts in the key.
+  // this field is used to track remainder amount from claimings in the key pool.
   repeated cosmos.base.v1beta1.DecCoin remainders = 6 [
     (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.DecCoins",
     (gogoproto.nullable)     = false,
     (amino.dont_omitempty)   = true
   ];
 }
 
-// Stake message represents a stake detail.
-message Stake {
+// Lock message is used to store lock information of each user on each key along with their reward information.
+message Lock {
   option (gogoproto.equal) = true;
 
-  // Address is the owner's address of the stake.
-  string address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+  // LockerAddress is the owner's address of the locker.
+  string locker_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
 
-  // Key is the key that this stake is locked to.
+  // Key is the key that this lock is locked to.
   string key = 2;
 
   // Amount is the locked power amount.
@@ -62,37 +64,38 @@ message Stake {
 
   // PosRewardDebts is a list of reward debt for each reward (only the positive side).
   // Note: Coin and DecCoin can't have negative amounts. so, we split it into two numbers.
-  repeated cosmos.base.v1beta1.Coin pos_reward_debts = 4 [
-    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins",
+  repeated cosmos.base.v1beta1.DecCoin pos_reward_debts = 4 [
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.DecCoins",
     (gogoproto.nullable)     = false,
     (amino.dont_omitempty)   = true
   ];
 
   // NegRewardDebts is a list of reward debt for each reward (only negative side).
-  repeated cosmos.base.v1beta1.Coin neg_reward_debts = 5 [
-    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins",
+  repeated cosmos.base.v1beta1.DecCoin neg_reward_debts = 5 [
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.DecCoins",
     (gogoproto.nullable)     = false,
     (amino.dont_omitempty)   = true
   ];
 }
 
-// Reward message represents a reward detail.
+// Reward message is used as response of the query to show final rewards of the key for the user.
 message Reward {
   option (gogoproto.equal) = true;
 
   // Key is the key that this reward belongs to.
   string key = 1;
 
-  // Rewards is a list of rewards.
+  // Rewards is a list of reward.
   repeated cosmos.base.v1beta1.DecCoin rewards = 2 [
     (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.DecCoins",
     (gogoproto.nullable)     = false,
     (amino.dont_omitempty)   = true
   ];
 }
 
-// Lock message represents a lock definition.
-message Lock {
+// LockResponse message is used as response of the query to show the power amount
+// that is locked by the key for the user.
+message LockResponse {
   option (gogoproto.equal) = true;
 
   // Key is the key that this lock belongs to.

x/restake/client/cli/query.go

@@ -21,6 +21,7 @@ func GetQueryCmd() *cobra.Command {
 	}
 
 	queryCmd.AddCommand(
+		GetQueryCmdKey(),
 		GetQueryCmdKeys(),
 		GetQueryCmdLocks(),
 		GetQueryCmdRewards(),
@@ -29,6 +30,34 @@ func GetQueryCmd() *cobra.Command {
 	return queryCmd
 }
 
+func GetQueryCmdKey() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "key [name]",
+		Short: "shows information of the key",
+		Args:  cobra.ExactArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			clientCtx := client.GetClientContextFromCmd(cmd)
+			queryClient := types.NewQueryClient(clientCtx)
+
+			res, err := queryClient.Key(
+				context.Background(),
+				&types.QueryKeyRequest{
+					Key: args[0],
+				},
+			)
+			if err != nil {
+				return err
+			}
+
+			return clientCtx.PrintProto(res)
+		},
+	}
+
+	flags.AddQueryFlagsToCmd(cmd)
+
+	return cmd
+}
+
 func GetQueryCmdKeys() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "keys",
@@ -68,7 +97,7 @@ func GetQueryCmdLocks() *cobra.Command {
 			queryClient := types.NewQueryClient(clientCtx)
 
 			res, err := queryClient.Locks(context.Background(), &types.QueryLocksRequest{
-				Address: args[0],
+				LockerAddress: args[0],
 			})
 			if err != nil {
 				return err
@@ -93,7 +122,7 @@ func GetQueryCmdRewards() *cobra.Command {
 			queryClient := types.NewQueryClient(clientCtx)
 
 			res, err := queryClient.Rewards(context.Background(), &types.QueryRewardsRequest{
-				Address: args[0],
+				LockerAddress: args[0],
 			})
 			if err != nil {
 				return err