chore: add TODOs & update comments

pokt-network · Oct 1, 2024 · c14ad46 · c14ad46
1 parent 090ca9a
commit c14ad46
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 9 deletions.
diff --git a/tests/integration/application/min_stake_test.go b/tests/integration/application/min_stake_test.go
@@ -181,7 +181,7 @@ func (s *applicationMinStakeTestSuite) stakeApp() {
 
 // stakeSupplier stakes a supplier for service 1.
 func (s *applicationMinStakeTestSuite) stakeSupplier() {
-	// TODO_NEXT(@bryanchriswhite, #612): Replace supplierStake with suppleirtypes.DefaultMinStake.
+	// TODO_UPNEXT(@bryanchriswhite, #612): Replace supplierStake with suppleirtypes.DefaultMinStake.
 	supplierStake := cosmostypes.NewInt64Coin(volatile.DenomuPOKT, 1000000) // 1 POKT.
 	s.keepers.SupplierKeeper.SetSupplier(s.ctx, sharedtypes.Supplier{
 		OwnerAddress:    s.supplierBech32,
@@ -236,7 +236,7 @@ func (s *applicationMinStakeTestSuite) getClaim(
 	}
 }
 
-// TODO_IN_THIS_COMMIT: godoc...
+// getAppBalance returns the bank module balance for the application.
 func (s *applicationMinStakeTestSuite) getAppBalance() *cosmostypes.Coin {
 	appBalRes, err := s.keepers.BankKeeper.Balance(s.ctx, &banktypes.QueryBalanceRequest{
 		Address: s.appBech32, Denom: volatile.DenomuPOKT,

diff --git a/x/application/keeper/msg_server_stake_application.go b/x/application/keeper/msg_server_stake_application.go
@@ -51,7 +51,7 @@ func (k msgServer) StakeApplication(ctx context.Context, msg *types.MsgStakeAppl
 		logger.Info(fmt.Sprintf("Application is going to escrow an additional %+v coins", coinsToEscrow))
 
 		// If the application has initiated an unstake action, cancel it since it is staking again.
-		// TODO_NEXT:(@bryanchriswhite): assert on EventApplicationUnbondingCanceled
+		// TODO_UPNEXT:(@bryanchriswhite): assert that an EventApplicationUnbondingCanceled event was emitted.
 		foundApp.UnstakeSessionEndHeight = types.ApplicationNotUnstaking
 	}
 

diff --git a/x/application/keeper/msg_server_unstake_application.go b/x/application/keeper/msg_server_unstake_application.go
@@ -51,7 +51,7 @@ func (k msgServer) UnstakeApplication(
 	foundApp.UnstakeSessionEndHeight = uint64(shared.GetSessionEndHeight(&sharedParams, currentHeight))
 	k.SetApplication(ctx, foundApp)
 
-	// TODO_NEXT:(@bryanchriswhite): emit a new EventApplicationUnbondingBegin
+	// TODO_UPNEXT:(@bryanchriswhite): emit a new EventApplicationUnbondingBegin event.
 
 	isSuccessful = true
 	return &types.MsgUnstakeApplicationResponse{}, nil

diff --git a/x/application/keeper/msg_server_unstake_application_test.go b/x/application/keeper/msg_server_unstake_application_test.go
@@ -57,7 +57,7 @@ func TestMsgServer_UnstakeApplication_Success(t *testing.T) {
 	_, err = srv.UnstakeApplication(ctx, unstakeMsg)
 	require.NoError(t, err)
 
-	// TODO_NEXT:(@bryanchriswhite): assert on EventApplicationUnbondingBegin
+	// TODO_UPNEXT:(@bryanchriswhite): assert that an EventApplicationUnbondingBegin event was emitted.
 
 	// Make sure the application entered the unbonding period
 	foundApp, isAppFound = applicationModuleKeepers.GetApplication(ctx, unstakingAppAddr)
@@ -72,7 +72,7 @@ func TestMsgServer_UnstakeApplication_Success(t *testing.T) {
 	err = applicationModuleKeepers.EndBlockerUnbondApplications(ctx)
 	require.NoError(t, err)
 
-	// TODO_NEXT:(@bryanchriswhite): assert on EventApplicationUnbondingEnd
+	// TODO_UPNEXT:(@bryanchriswhite): assert that an EventApplicationUnbondingEnd event was emitted.
 
 	// Make sure the unstaking application is removed from the applications list when
 	// the unbonding period is over.
@@ -109,7 +109,7 @@ func TestMsgServer_UnstakeApplication_CancelUnbondingIfRestaked(t *testing.T) {
 	_, err = srv.UnstakeApplication(ctx, unstakeMsg)
 	require.NoError(t, err)
 
-	// TODO_NEXT:(@bryanchriswhite): assert on EventApplicationUnbondingBegin
+	// TODO_UPNEXT:(@bryanchriswhite): assert that an EventApplicationUnbondingBegin event was emitted.
 
 	// Make sure the application entered the unbonding period
 	foundApp, isAppFound = applicationModuleKeepers.GetApplication(ctx, appAddr)
@@ -123,7 +123,7 @@ func TestMsgServer_UnstakeApplication_CancelUnbondingIfRestaked(t *testing.T) {
 	_, err = srv.StakeApplication(ctx, stakeMsg)
 	require.NoError(t, err)
 
-	// TODO_NEXT:(@bryanchriswhite): assert on EventApplicationUnbondingCancelled
+	// TODO_UPNEXT:(@bryanchriswhite): assert that an EventApplicationUnbondingCanceled event was emitted.
 
 	// Make sure the application is no longer in the unbonding period
 	foundApp, isAppFound = applicationModuleKeepers.GetApplication(ctx, appAddr)

diff --git a/x/application/keeper/unbond_applications.go b/x/application/keeper/unbond_applications.go
@@ -42,7 +42,7 @@ func (k Keeper) EndBlockerUnbondApplications(ctx context.Context) error {
 			return err
 		}
 
-		// TODO_NEXT(@bryanchriswhite): emit a new EventApplicationUnbondingEnd.
+		// TODO_UPNEXT(@bryanchriswhite): emit a new EventApplicationUnbondingEnd event.
 	}
 
 	return nil

diff --git a/x/tokenomics/keeper/token_logic_modules.go b/x/tokenomics/keeper/token_logic_modules.go
@@ -286,6 +286,8 @@ func (k Keeper) ProcessTokenLogicModules(
 		if err := k.applicationKeeper.UnbondApplication(ctx, &application); err != nil {
 			return err
 		}
+
+		// TODO_UPNEXT:(@bryanchriswhite): emit a new EventApplicationUnbondedBelowMinStake event.
 	} else {
 		// State mutation: update the application's on-chain record.
 		k.applicationKeeper.SetApplication(ctx, application)