refactor: replace"vested" terminology with "locked" (#205)

## Description

This PR updates the `x/liquidvesting` module to replace the "vested"
terminology with "locked" instead. This is to make it clearer that we
are representing *vesting* (i.e. not yet vested, still locked) tokens
rather than vested (i.e. which have completed the vesting period,
unlocked) tokens.

Depends-On: #204

<!-- Add a description of the changes that this PR introduces and the
files that
are the most critical to review. -->

---

### Author Checklist

*All items are required. Please add a note to the item if the item is
not applicable and
please add links to any relevant follow up issues.*

I have...

- [ ] included the correct [type
prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json)
in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR
Targeting](https://github.com/milkyway-labs/milkyway/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building
modules](https://docs.cosmos.network/v0.44/building-modules/intro.html)
- [ ] included the necessary unit and integration
[tests](https://github.com/milkyway-labs/milkyway/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go
code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable
and please add
your handle next to the items reviewed if you only reviewed selected
items.*

I have...

- [ ] confirmed the correct [type
prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json)
in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)

Author: RiccardoM

Diff for: proto/milkyway/liquidvesting/v1/messages.proto

@@ -14,15 +14,15 @@ option go_package = "github.com/milkyway-labs/milkyway/x/liquidvesting/types";
 service Msg {
   option (cosmos.msg.v1.service) = true;
 
-  // MintVestedRepresentation defines the operation to mint a user's staked
-  // vested tokens representation that can be used in the liquid vesting module.
-  rpc MintVestedRepresentation(MsgMintVestedRepresentation)
-      returns (MsgMintVestedRepresentationResponse);
+  // MintLockedRepresentation defines the operation to mint a user's staked
+  // locked tokens representation that can be used in the liquid vesting module.
+  rpc MintLockedRepresentation(MsgMintLockedRepresentation)
+      returns (MsgMintLockedRepresentationResponse);
 
-  // BurnVestedRepresentation defines the operation to burn a user's staked
-  // vested tokens representation.
-  rpc BurnVestedRepresentation(MsgBurnVestedRepresentation)
-      returns (MsgBurnVestedRepresentationResponse);
+  // BurnLockedRepresentation defines the operation to burn a user's staked
+  // locked tokens representation.
+  rpc BurnLockedRepresentation(MsgBurnLockedRepresentation)
+      returns (MsgBurnLockedRepresentationResponse);
 
   // WithdrawInsuranceFund defines the operation to withdraw an amount
   // of tokens from the user's insurance fund.
@@ -39,13 +39,13 @@ service Msg {
   rpc UpdateParams(MsgUpdateParams) returns (MsgUpdateParamsResponse);
 }
 
-// MsgMintVestedRepresentation defines the message structure for the
-// MintVestedRepresentation gRPC service method. It allows an authorized
-// account to mint a user's staked vested tokens representation that can be
+// MsgMintLockedRepresentation defines the message structure for the
+// MintLockedRepresentation gRPC service method. It allows an authorized
+// account to mint a user's staked locked tokens representation that can be
 // used in the liquid vesting module.
-message MsgMintVestedRepresentation {
+message MsgMintLockedRepresentation {
   option (cosmos.msg.v1.signer) = "sender";
-  option (amino.name) = "milkyway/MsgMintVestedRepresentation";
+  option (amino.name) = "milkyway/MsgMintLockedRepresentation";
 
   // User that want to trigger the tokens mint.
   string sender = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString" ];
@@ -61,16 +61,16 @@ message MsgMintVestedRepresentation {
   ];
 }
 
-// MsgMintVestedRepresentationResponse is the return value of
-// MsgMintVestedRepresentation.
-message MsgMintVestedRepresentationResponse {}
+// MsgMintLockedRepresentationResponse is the return value of
+// MsgMintLockedRepresentation.
+message MsgMintLockedRepresentationResponse {}
 
-// MsgBurnVestedRepresentation defines the message structure for the
-// BurnVestedRepresentation gRPC service method. It allows an authorized
-// account to burn a user's staked vested tokens representation.
-message MsgBurnVestedRepresentation {
+// MsgBurnLockedRepresentation defines the message structure for the
+// BurnLockedRepresentation gRPC service method. It allows an authorized
+// account to burn a user's staked locked tokens representation.
+message MsgBurnLockedRepresentation {
   option (cosmos.msg.v1.signer) = "sender";
-  option (amino.name) = "milkyway/MsgBurnVestedRepresentation";
+  option (amino.name) = "milkyway/MsgBurnLockedRepresentation";
 
   // User that want to trigger the tokens burn.
   string sender = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString" ];
@@ -86,9 +86,9 @@ message MsgBurnVestedRepresentation {
   ];
 }
 
-// MsgBurnVestedRepresentationResponse is the return value of
-// MsgBurnVestedRepresentation.
-message MsgBurnVestedRepresentationResponse {}
+// MsgBurnLockedRepresentationResponse is the return value of
+// MsgBurnLockedRepresentation.
+message MsgBurnLockedRepresentationResponse {}
 
 // MsgWithdrawInsuranceFund defines the message structure for the
 // WithdrawInsuranceFund gRPC service method.

Diff for: proto/milkyway/liquidvesting/v1/models.proto

@@ -19,7 +19,7 @@ message UserInsuranceFund {
 }
 
 // BurnCoins is a struct that contains the information about the coins to burn
-// once the unbonding period of the vested representation tokens ends.
+// once the unbonding period of the locked representation tokens ends.
 message BurnCoins {
   option (gogoproto.equal) = false;
   option (gogoproto.goproto_getters) = false;

Diff for: proto/milkyway/liquidvesting/v1/params.proto

@@ -9,22 +9,22 @@ option go_package = "github.com/milkyway-labs/milkyway/x/liquidvesting/types";
 // Params defines the parameters for the module.
 message Params {
   // This value represents the percentage that needs to be sent to the
-  // insurance fund in order to restake a certain amount of vested tokens.
+  // insurance fund in order to restake a certain amount of locked tokens.
   // For example, if this value is 2%, a user must send 2 tokens to
-  // the insurance fund to restake 100 vested tokens
+  // the insurance fund to restake 100 locked tokens
   string insurance_percentage = 1 [
     (cosmos_proto.scalar) = "cosmos.Dec",
     (gogoproto.customtype) = "cosmossdk.io/math.LegacyDec",
     (gogoproto.nullable) = false
   ];
 
   // This value represents the list of users who are authorized to execute the
-  // MsgBurnVestedRepresentation.
+  // MsgBurnLockedRepresentation.
   repeated string burners = 2
       [ (cosmos_proto.scalar) = "cosmos.AddressString" ];
 
   // This value represents the list of users who are authorized to execute the
-  // MsgMintVestedRepresentation.
+  // MsgMintLockedRepresentation.
   repeated string minters = 3
       [ (cosmos_proto.scalar) = "cosmos.AddressString" ];
 

Diff for: x/liquidvesting/autocli.go

@@ -57,21 +57,21 @@ func (a AppModule) AutoCLIOptions() *autocliv1.ModuleOptions {
 			Service: liquidvestingv1.Msg_ServiceDesc.ServiceName,
 			RpcCommandOptions: []*autocliv1.RpcCommandOptions{
 				{
-					RpcMethod: "MintVestedRepresentation",
-					Use:       "mint-vested-representation [sender] [receiver] [amount]",
-					Short:     "Mint an user's staked vested tokens representation",
-					Example:   fmt.Sprintf(`$ %s tx liquidvesting mint-vested-representation init1... init1... 1000umilk`, version.AppName),
+					RpcMethod: "MintLockedRepresentation",
+					Use:       "mint-locked-representation [sender] [receiver] [amount]",
+					Short:     "Mint an user's staked locked tokens representation",
+					Example:   fmt.Sprintf(`$ %s tx liquidvesting mint-locked-representation init1... init1... 1000umilk`, version.AppName),
 					PositionalArgs: []*autocliv1.PositionalArgDescriptor{
 						{ProtoField: "sender"},
 						{ProtoField: "receiver"},
 						{ProtoField: "amount"},
 					},
 				},
 				{
-					RpcMethod: "BurnVestedRepresentation",
-					Use:       "burn-vested-representation [sender] [user] [amount]",
-					Short:     "Burns an user's staked vested tokens representation",
-					Example:   fmt.Sprintf(`$ %s tx liquidvesting burn-vested-representation init1... init1... 1000vestd/umilk`, version.AppName),
+					RpcMethod: "BurnLockedRepresentation",
+					Use:       "burn-locked-representation [sender] [user] [amount]",
+					Short:     "Burns an user's staked locked tokens representation",
+					Example:   fmt.Sprintf(`$ %s tx liquidvesting burn-locked-representation init1... init1... 1000vestd/umilk`, version.AppName),
 					PositionalArgs: []*autocliv1.PositionalArgDescriptor{
 						{ProtoField: "sender"},
 						{ProtoField: "user"},

Diff for: x/liquidvesting/keeper/alias_functions.go

@@ -20,53 +20,53 @@ func (k *Keeper) GetAllUsersInsuranceFundsEntries(ctx sdk.Context) ([]types.User
 	return usersInsuranceFundState, err
 }
 
-// GetAllUserRestakedVestedRepresentations returns all restaked coins that are vested
+// GetAllUserRestakedLockedRepresentations returns all restaked coins that are locked
 // representation tokens for the provided user.
-func (k *Keeper) GetAllUserRestakedVestedRepresentations(ctx context.Context, userAddress string) (sdk.DecCoins, error) {
+func (k *Keeper) GetAllUserRestakedLockedRepresentations(ctx context.Context, userAddress string) (sdk.DecCoins, error) {
 	restakedCoins, err := k.restakingKeeper.GetAllUserRestakedCoins(ctx, userAddress)
 	if err != nil {
 		return nil, err
 	}
 
-	vestedRepresentations := sdk.NewDecCoins()
+	lockedRepresentations := sdk.NewDecCoins()
 	for _, coin := range restakedCoins {
-		if types.IsVestedRepresentationDenom(coin.Denom) {
-			vestedRepresentations = vestedRepresentations.Add(coin)
+		if types.IsLockedRepresentationDenom(coin.Denom) {
+			lockedRepresentations = lockedRepresentations.Add(coin)
 		}
 	}
 
-	return vestedRepresentations, nil
+	return lockedRepresentations, nil
 }
 
-// GetAllUserUnbondingVestedRepresentations returns all the vested representation
+// GetAllUserUnbondingLockedRepresentations returns all the locked representation
 // tokens that are currently unbonding for the provided user.
-func (k *Keeper) GetAllUserUnbondingVestedRepresentations(ctx context.Context, userAddress string) sdk.Coins {
-	vestedRepresentations := sdk.NewCoins()
+func (k *Keeper) GetAllUserUnbondingLockedRepresentations(ctx context.Context, userAddress string) sdk.Coins {
+	lockedRepresentations := sdk.NewCoins()
 
 	userUndelegations := k.restakingKeeper.GetAllUserUnbondingDelegations(ctx, userAddress)
 	for _, undelegation := range userUndelegations {
 		for _, entry := range undelegation.Entries {
 			for _, coin := range entry.Balance {
-				if types.IsVestedRepresentationDenom(coin.Denom) {
-					vestedRepresentations = vestedRepresentations.Add(coin)
+				if types.IsLockedRepresentationDenom(coin.Denom) {
+					lockedRepresentations = lockedRepresentations.Add(coin)
 				}
 			}
 		}
 	}
 
-	return vestedRepresentations
+	return lockedRepresentations
 }
 
-// GetAllUserActiveVestedRepresentations gets all the vested representation tokens
+// GetAllUserActiveLockedRepresentations gets all the locked representation tokens
 // that are restaked or are currently unbonding for the provided user.
-func (k *Keeper) GetAllUserActiveVestedRepresentations(ctx context.Context, userAddress string) (sdk.DecCoins, error) {
-	restakedCoins, err := k.GetAllUserRestakedVestedRepresentations(ctx, userAddress)
+func (k *Keeper) GetAllUserActiveLockedRepresentations(ctx context.Context, userAddress string) (sdk.DecCoins, error) {
+	restakedCoins, err := k.GetAllUserRestakedLockedRepresentations(ctx, userAddress)
 	if err != nil {
 		return nil, err
 	}
 
-	// Get the vested representation tokens that are currently unbonding
-	userUnbondingVestedRepresentations := k.GetAllUserUnbondingVestedRepresentations(ctx, userAddress)
+	// Get the locked representation tokens that are currently unbonding
+	userUnbondingLockedRepresentations := k.GetAllUserUnbondingLockedRepresentations(ctx, userAddress)
 
-	return restakedCoins.Add(sdk.NewDecCoinsFromCoins(userUnbondingVestedRepresentations...)...), nil
+	return restakedCoins.Add(sdk.NewDecCoinsFromCoins(userUnbondingLockedRepresentations...)...), nil
 }