fix: return the transitioned state for phase-1 delegation (#169)

docs/docs.go

@@ -960,9 +960,6 @@ const docTemplate = `{
                 "is_slashed": {
                     "type": "boolean"
                 },
-                "is_transitioned": {
-                    "type": "boolean"
-                },
                 "staker_pk_hex": {
                     "type": "string"
                 },

docs/swagger.json

@@ -952,9 +952,6 @@
                 "is_slashed": {
                     "type": "boolean"
                 },
-                "is_transitioned": {
-                    "type": "boolean"
-                },
                 "staker_pk_hex": {
                     "type": "string"
                 },

docs/swagger.yaml

@@ -214,8 +214,6 @@ definitions:
         type: boolean
       is_slashed:
         type: boolean
-      is_transitioned:
-        type: boolean
       staker_pk_hex:
         type: string
       staking_tx:

internal/shared/utils/state_transition.go

@@ -43,3 +43,8 @@ func QualifiedStatesToWithdraw() []types.DelegationState {
 func OutdatedStatesForWithdraw() []types.DelegationState {
 	return []types.DelegationState{types.Withdrawn}
 }
+
+// QualifiedStatesToTransitioned returns the qualified exisitng states to transition to "transitioned"
+func QualifiedStatesToTransitioned() []types.DelegationState {
+	return []types.DelegationState{types.Active, types.UnbondingRequested}
+}

internal/v1/db/client/delegation.go

@@ -12,6 +12,7 @@ import (
 	"github.com/babylonlabs-io/staking-api-service/internal/shared/db"
 	dbmodel "github.com/babylonlabs-io/staking-api-service/internal/shared/db/model"
 	"github.com/babylonlabs-io/staking-api-service/internal/shared/types"
+	"github.com/babylonlabs-io/staking-api-service/internal/shared/utils"
 	v1dbmodel "github.com/babylonlabs-io/staking-api-service/internal/v1/db/model"
 )
 
@@ -156,21 +157,14 @@ func (v1dbclient *V1Database) ScanDelegationsPaginated(
 	)
 }
 
-// MarkDelegationAsTransitioned marks an existing delegation as transitioned
-func (v1dbclient *V1Database) MarkDelegationAsTransitioned(ctx context.Context, stakingTxHashHex string) error {
-	client := v1dbclient.Client.Database(v1dbclient.DbName).Collection(dbmodel.V1DelegationCollection)
-	update := bson.M{"$set": bson.M{"is_transitioned": true}}
-	result, err := client.UpdateOne(ctx, bson.M{"_id": stakingTxHashHex}, update)
-	if err != nil {
-		return err
-	}
-	if result.MatchedCount == 0 {
-		return &db.NotFoundError{
-			Key:     stakingTxHashHex,
-			Message: "Delegation not found",
-		}
-	}
-	return nil
+// TransitionToTransitionedState marks an existing delegation as transitioned
+func (v1dbclient *V1Database) TransitionToTransitionedState(
+	ctx context.Context, stakingTxHashHex string,
+) error {
+	return v1dbclient.transitionState(
+		ctx, stakingTxHashHex, types.Transitioned.ToString(),
+		utils.QualifiedStatesToTransitioned(), nil,
+	)
 }
 
 // TransitionState updates the state of a staking transaction to a new state

internal/v1/db/client/interface.go

@@ -30,7 +30,7 @@ type V1DBClient interface {
 		ctx context.Context, stakingTxHashHex, unbondingTxHashHex, txHex, signatureHex string,
 	) error
 	FindDelegationByTxHashHex(ctx context.Context, txHashHex string) (*v1dbmodel.DelegationDocument, error)
-	MarkDelegationAsTransitioned(ctx context.Context, stakingTxHashHex string) error
+	TransitionToTransitionedState(ctx context.Context, stakingTxHashHex string) error
 	SaveTimeLockExpireCheck(ctx context.Context, stakingTxHashHex string, expireHeight uint64, txType string) error
 	TransitionToUnbondedState(
 		ctx context.Context, stakingTxHashHex string, eligiblePreviousState []types.DelegationState,

internal/v1/db/model/delegation.go

@@ -22,7 +22,6 @@ type DelegationDocument struct {
 	StakingTx             *TimelockTransaction  `bson:"staking_tx"` // Always exist
 	UnbondingTx           *TimelockTransaction  `bson:"unbonding_tx,omitempty"`
 	IsOverflow            bool                  `bson:"is_overflow"`
-	IsTransitioned        bool                  `bson:"is_transitioned"`
 }
 
 type DelegationByStakerPagination struct {

internal/v1/service/delegation.go

@@ -32,7 +32,6 @@ type DelegationPublic struct {
 	IsOverflow              bool               `json:"is_overflow"`
 	IsEligibleForTransition bool               `json:"is_eligible_for_transition"`
 	IsSlashed               bool               `json:"is_slashed"`
-	IsTransitioned          bool               `json:"is_transitioned"`
 }
 
 func (s *V1Service) DelegationsByStakerPk(
@@ -213,7 +212,6 @@ func (s *V1Service) FromDelegationDocument(
 		IsOverflow:              d.IsOverflow,
 		IsEligibleForTransition: isFpTransitioned && !isSlashed && s.isEligibleForTransition(d, bbnHeight),
 		IsSlashed:               isSlashed,
-		IsTransitioned:            d.IsTransitioned,
 	}
 
 	// Add unbonding transaction if it exists

internal/v2/db/client/interface.go

@@ -26,5 +26,4 @@ type V2DBClient interface {
 	SubtractStakerStats(
 		ctx context.Context, stakingTxHashHex, stakerPkHex string, amount uint64,
 	) error
-	MarkV1DelegationAsTransitioned(ctx context.Context, stakingTxHashHex string) error
 }

internal/v2/service/delegation.go

@@ -171,12 +171,18 @@ func (s *V2Service) SaveUnprocessableMessages(ctx context.Context, messageBody,
 	return nil
 }
 
-func (s *V2Service) MarkV1DelegationAsTransitioned(ctx context.Context, stakingTxHashHex string) *types.Error {
-	err := s.DbClients.V2DBClient.MarkV1DelegationAsTransitioned(ctx, stakingTxHashHex)
+// MarkV1DelegationAsTransitioned marks a v1 delegation as transitioned
+func (s *V2Service) MarkV1DelegationAsTransitioned(
+	ctx context.Context, stakingTxHashHex string,
+) *types.Error {
+	err := s.DbClients.V1DBClient.TransitionToTransitionedState(ctx, stakingTxHashHex)
 	if err != nil {
 		if db.IsNotFoundError(err) {
+			// If the delegation is not found, it means it has already been transitioned
+			// or not relevant to phase-1 at all.
 			return nil
 		}
+		log.Ctx(ctx).Error().Err(err).Msg("Failed to transition v1 delegation to transitioned state")
 		return types.NewInternalServiceError(err)
 	}
 	return nil

internal/v2/service/interface.go

@@ -24,6 +24,5 @@ type V2ServiceProvider interface {
 		finalityProviderBtcPksHex []string,
 		state types.DelegationState, amount uint64,
 	) *types.Error
-
 	SaveUnprocessableMessages(ctx context.Context, messageBody, receipt string) *types.Error
 }