add comment to all function

Author: RogerKSI

x/restake/client/cli/query.go

@@ -32,6 +32,7 @@ func GetQueryCmd() *cobra.Command {
 	return queryCmd
 }
 
+// GetQueryCmdKey implements the key query command.
 func GetQueryCmdKey() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "key [name]",
@@ -60,6 +61,7 @@ func GetQueryCmdKey() *cobra.Command {
 	return cmd
 }
 
+// GetQueryCmdKeys implements the keys query command.
 func GetQueryCmdKeys() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "keys",
@@ -89,6 +91,7 @@ func GetQueryCmdKeys() *cobra.Command {
 	return cmd
 }
 
+// GetQueryCmdRewards implements the rewards query command.
 func GetQueryCmdRewards() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "rewards [locker_address]",
@@ -115,6 +118,7 @@ func GetQueryCmdRewards() *cobra.Command {
 	return cmd
 }
 
+// GetQueryCmdReward implements the reward query command.
 func GetQueryCmdReward() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "reward [locker_address] [key_name]",
@@ -141,6 +145,7 @@ func GetQueryCmdReward() *cobra.Command {
 	return cmd
 }
 
+// GetQueryCmdLocks implements the locks query command.
 func GetQueryCmdLocks() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "locks [locker_address]",
@@ -167,6 +172,7 @@ func GetQueryCmdLocks() *cobra.Command {
 	return cmd
 }
 
+// GetQueryCmdLock implements the lock query command.
 func GetQueryCmdLock() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "lock [locker_address] [key_name]",

x/restake/keeper/grpc_query.go

@@ -12,13 +12,14 @@ import (
 	"github.com/bandprotocol/chain/v2/x/restake/types"
 )
 
-// Querier is used as Keeper will have duplicate methods if used directly, and gRPC names take precedence over keeper
+// Querier is used as Keeper will have duplicate methods if used directly, and gRPC names take precedence over keeper.
 type Querier struct {
 	*Keeper
 }
 
 var _ types.QueryServer = Querier{}
 
+// Keys queries all keys with pagination.
 func (k Querier) Keys(
 	c context.Context,
 	req *types.QueryKeysRequest,
@@ -43,6 +44,7 @@ func (k Querier) Keys(
 	return &types.QueryKeysResponse{Keys: filteredKeys, Pagination: pageRes}, nil
 }
 
+// Key queries info about a key.
 func (k Querier) Key(
 	c context.Context,
 	req *types.QueryKeyRequest,
@@ -57,6 +59,7 @@ func (k Querier) Key(
 	return &types.QueryKeyResponse{Key: key}, nil
 }
 
+// Rewards queries all rewards with pagination.
 func (k Querier) Rewards(
 	c context.Context,
 	req *types.QueryRewardsRequest,
@@ -87,6 +90,7 @@ func (k Querier) Rewards(
 	return &types.QueryRewardsResponse{Rewards: filteredRewards, Pagination: pageRes}, nil
 }
 
+// Reward queries info about a reward by using address and key
 func (k Querier) Reward(
 	c context.Context,
 	req *types.QueryRewardRequest,
@@ -108,6 +112,7 @@ func (k Querier) Reward(
 	}, nil
 }
 
+// Locks queries all locks with pagination.
 func (k Querier) Locks(
 	c context.Context,
 	req *types.QueryLocksRequest,
@@ -144,6 +149,7 @@ func (k Querier) Locks(
 	return &types.QueryLocksResponse{Locks: filteredLocks, Pagination: pageRes}, nil
 }
 
+// Lock queries info about a lock by using address and key
 func (k Querier) Lock(
 	c context.Context,
 	req *types.QueryLockRequest,

x/restake/keeper/hooks.go

@@ -46,6 +46,7 @@ func (h Hooks) BeforeDelegationSharesModified(_ sdk.Context, _ sdk.AccAddress, _
 	return nil
 }
 
+// check if after delegation is removed, the locked power is still less than total delegation
 func (h Hooks) BeforeDelegationRemoved(ctx sdk.Context, delAddr sdk.AccAddress, valAddr sdk.ValAddress) error {
 	delegated := h.k.stakingKeeper.GetDelegatorBonded(ctx, delAddr)
 
@@ -68,6 +69,7 @@ func (h Hooks) BeforeDelegationRemoved(ctx sdk.Context, delAddr sdk.AccAddress,
 	return h.isAbleToUnbond(ctx, delAddr, delegated)
 }
 
+// check if after delegation is modified, the locked power is still less than total delegation
 func (h Hooks) AfterDelegationModified(ctx sdk.Context, delAddr sdk.AccAddress, _ sdk.ValAddress) error {
 	// get total delegation
 	delegated := h.k.stakingKeeper.GetDelegatorBonded(ctx, delAddr)
@@ -84,6 +86,7 @@ func (h Hooks) AfterUnbondingInitiated(_ sdk.Context, _ uint64) error {
 	return nil
 }
 
+// isAbleToUnbond checks if the new total delegation is still more than locked power in the module.
 func (h Hooks) isAbleToUnbond(ctx sdk.Context, addr sdk.AccAddress, delegated sdkmath.Int) error {
 	iterator := sdk.KVStoreReversePrefixIterator(ctx.KVStore(h.k.storeKey), types.LocksByAmountIndexKey(addr))
 	defer iterator.Close()

x/restake/keeper/keeper_key.go

@@ -8,6 +8,7 @@ import (
 	"github.com/bandprotocol/chain/v2/x/restake/types"
 )
 
+// GetOrCreateKey get the key object by using key name. If the key doesn't exist, it will initialize the new key.
 func (k Keeper) GetOrCreateKey(ctx sdk.Context, keyName string) (types.Key, error) {
 	key, err := k.GetKey(ctx, keyName)
 	if err != nil {
@@ -74,6 +75,7 @@ func (k Keeper) AddRewards(ctx sdk.Context, sender sdk.AccAddress, keyName strin
 	return nil
 }
 
+// IsActiveKey checks whether the key is active or not.
 func (k Keeper) IsActiveKey(ctx sdk.Context, keyName string) bool {
 	key, err := k.GetKey(ctx, keyName)
 	if err != nil {
@@ -83,6 +85,7 @@ func (k Keeper) IsActiveKey(ctx sdk.Context, keyName string) bool {
 	return key.IsActive
 }
 
+// DeactivateKey deactivates the key.
 func (k Keeper) DeactivateKey(ctx sdk.Context, keyName string) error {
 	key, err := k.GetKey(ctx, keyName)
 	if err != nil {
@@ -106,6 +109,7 @@ func (k Keeper) DeactivateKey(ctx sdk.Context, keyName string) error {
 	return nil
 }
 
+// createKeyAccount creates a key account by using name and block hash.
 func (k Keeper) createKeyAccount(ctx sdk.Context, key string) (sdk.AccAddress, error) {
 	header := ctx.BlockHeader()
 
@@ -143,10 +147,12 @@ func (k Keeper) createKeyAccount(ctx sdk.Context, key string) (sdk.AccAddress, e
 // store part
 // -------------------------------
 
+// GetKeysIterator gets iterator of key store.
 func (k Keeper) GetKeysIterator(ctx sdk.Context) sdk.Iterator {
 	return sdk.KVStorePrefixIterator(ctx.KVStore(k.storeKey), types.KeyStoreKeyPrefix)
 }
 
+// GetKeys gets all keys in the store.
 func (k Keeper) GetKeys(ctx sdk.Context) (keys []types.Key) {
 	iterator := k.GetKeysIterator(ctx)
 	defer iterator.Close()
@@ -160,10 +166,13 @@ func (k Keeper) GetKeys(ctx sdk.Context) (keys []types.Key) {
 	return keys
 }
 
+// HasKey checks if key exists in the store.
 func (k Keeper) HasKey(ctx sdk.Context, keyName string) bool {
 	return ctx.KVStore(k.storeKey).Has(types.KeyStoreKey(keyName))
 }
 
+// MustGetKey gets a key from store by name.
+// Panics if can't get the key.
 func (k Keeper) MustGetKey(ctx sdk.Context, keyName string) types.Key {
 	key, err := k.GetKey(ctx, keyName)
 	if err != nil {
@@ -173,6 +182,7 @@ func (k Keeper) MustGetKey(ctx sdk.Context, keyName string) types.Key {
 	return key
 }
 
+// GetKey gets a key from store by name.
 func (k Keeper) GetKey(ctx sdk.Context, keyName string) (types.Key, error) {
 	bz := ctx.KVStore(k.storeKey).Get(types.KeyStoreKey(keyName))
 	if bz == nil {
@@ -185,6 +195,7 @@ func (k Keeper) GetKey(ctx sdk.Context, keyName string) (types.Key, error) {
 	return key, nil
 }
 
+// SetKey sets a key to the store.
 func (k Keeper) SetKey(ctx sdk.Context, key types.Key) {
 	ctx.KVStore(k.storeKey).Set(types.KeyStoreKey(key.Name), k.cdc.MustMarshal(&key))
 }

x/restake/keeper/keeper_lock.go

@@ -86,12 +86,14 @@ func (k Keeper) GetLockedPower(ctx sdk.Context, lockerAddr sdk.AccAddress, keyNa
 	return lock.Amount, nil
 }
 
+// getAccumulatedRewards gets the accumulatedRewards of a lock if they lock since beginning.
 func (k Keeper) getAccumulatedRewards(ctx sdk.Context, lock types.Lock) sdk.DecCoins {
 	key := k.MustGetKey(ctx, lock.Key)
 
 	return key.RewardPerPowers.MulDecTruncate(sdkmath.LegacyNewDecFromInt(lock.Amount))
 }
 
+// getReward gets the reward of a lock by using accumulated rewards and reward debts.
 func (k Keeper) getReward(ctx sdk.Context, lock types.Lock) types.Reward {
 	totalRewards := k.getAccumulatedRewards(ctx, lock)
 
@@ -105,14 +107,17 @@ func (k Keeper) getReward(ctx sdk.Context, lock types.Lock) types.Reward {
 // store part
 // -------------------------------
 
+// GetLocksIterator gets iterator of lock store.
 func (k Keeper) GetLocksIterator(ctx sdk.Context) sdk.Iterator {
 	return sdk.KVStorePrefixIterator(ctx.KVStore(k.storeKey), types.LockStoreKeyPrefix)
 }
 
+// GetLocksByAddressIterator gets iterator of locks of the speicfic address.
 func (k Keeper) GetLocksByAddressIterator(ctx sdk.Context, addr sdk.AccAddress) sdk.Iterator {
 	return sdk.KVStorePrefixIterator(ctx.KVStore(k.storeKey), types.LocksStoreKey(addr))
 }
 
+// GetLocksByAddress gets all locks of the address.
 func (k Keeper) GetLocksByAddress(ctx sdk.Context, addr sdk.AccAddress) (locks []types.Lock) {
 	iterator := k.GetLocksByAddressIterator(ctx, addr)
 	defer iterator.Close()
@@ -126,6 +131,7 @@ func (k Keeper) GetLocksByAddress(ctx sdk.Context, addr sdk.AccAddress) (locks [
 	return locks
 }
 
+// GetLocks gets all locks in the store.
 func (k Keeper) GetLocks(ctx sdk.Context) (locks []types.Lock) {
 	iterator := k.GetLocksIterator(ctx)
 	defer iterator.Close()
@@ -139,10 +145,12 @@ func (k Keeper) GetLocks(ctx sdk.Context) (locks []types.Lock) {
 	return locks
 }
 
+// HasLock checks if lock exists in the store.
 func (k Keeper) HasLock(ctx sdk.Context, addr sdk.AccAddress, keyName string) bool {
 	return ctx.KVStore(k.storeKey).Has(types.LockStoreKey(addr, keyName))
 }
 
+// GetLock gets a lock from store by address and key name.
 func (k Keeper) GetLock(ctx sdk.Context, addr sdk.AccAddress, keyName string) (types.Lock, error) {
 	bz := ctx.KVStore(k.storeKey).Get(types.LockStoreKey(addr, keyName))
 	if bz == nil {
@@ -159,6 +167,7 @@ func (k Keeper) GetLock(ctx sdk.Context, addr sdk.AccAddress, keyName string) (t
 	return lock, nil
 }
 
+// SetLock sets a lock to the store.
 func (k Keeper) SetLock(ctx sdk.Context, lock types.Lock) {
 	addr := sdk.MustAccAddressFromBech32(lock.LockerAddress)
 	k.DeleteLock(ctx, addr, lock.Key)
@@ -167,6 +176,7 @@ func (k Keeper) SetLock(ctx sdk.Context, lock types.Lock) {
 	k.setLockByAmount(ctx, lock)
 }
 
+// DeleteLock deletes a lock from the store.
 func (k Keeper) DeleteLock(ctx sdk.Context, addr sdk.AccAddress, keyName string) {
 	lock, err := k.GetLock(ctx, addr, keyName)
 	if err != nil {
@@ -176,10 +186,12 @@ func (k Keeper) DeleteLock(ctx sdk.Context, addr sdk.AccAddress, keyName string)
 	k.deleteLockByAmount(ctx, lock)
 }
 
+// setLockByAmount sets a lock by amount to the store.
 func (k Keeper) setLockByAmount(ctx sdk.Context, lock types.Lock) {
 	ctx.KVStore(k.storeKey).Set(types.LockByAmountIndexKey(lock), []byte(lock.Key))
 }
 
+// deleteLockByAmount deletes a lock by amount from the store.
 func (k Keeper) deleteLockByAmount(ctx sdk.Context, lock types.Lock) {
 	ctx.KVStore(k.storeKey).Delete(types.LockByAmountIndexKey(lock))
 }

x/restake/types/keys.go

@@ -33,22 +33,27 @@ var (
 	LocksByAmountIndexKeyPrefix = []byte{0x10}
 )
 
+// KeyStoreKey returns the key to retrieve a specific key from the store.
 func KeyStoreKey(keyName string) []byte {
 	return append(KeyStoreKeyPrefix, []byte(keyName)...)
 }
 
+// LocksStoreKey returns the key to retrieve all locks of an address from the store.
 func LocksStoreKey(addr sdk.AccAddress) []byte {
 	return append(LockStoreKeyPrefix, address.MustLengthPrefix(addr)...)
 }
 
+// LockStoreKey returns the key to retrieve a lock of an address and the key from the store.
 func LockStoreKey(addr sdk.AccAddress, keyName string) []byte {
 	return append(LocksStoreKey(addr), []byte(keyName)...)
 }
 
+// LocksByAmountIndexKey returns the key to retrieve all locks of an address ordering by locked amount from the store.
 func LocksByAmountIndexKey(addr sdk.AccAddress) []byte {
 	return append(LocksByAmountIndexKeyPrefix, address.MustLengthPrefix(addr)...)
 }
 
+// LockByAmountIndexKey returns the key to retrieve a lock by amount from the store.
 func LockByAmountIndexKey(lock Lock) []byte {
 	address := sdk.MustAccAddressFromBech32(lock.LockerAddress)