feat: return IsEligibleForTransition in delegation (#139)

* feat: return IsEligibleForTransition in delegation

docs/docs.go

@@ -196,7 +196,8 @@ const docTemplate = `{
                             "unbonding_requested",
                             "unbonding",
                             "unbonded",
-                            "withdrawn"
+                            "withdrawn",
+                            "transitioned"
                         ],
                         "type": "string",
                         "description": "Filter by state",
@@ -999,6 +1000,9 @@ const docTemplate = `{
                 "finality_provider_pk_hex": {
                     "type": "string"
                 },
+                "is_eligible_for_transition": {
+                    "type": "boolean"
+                },
                 "is_overflow": {
                     "type": "boolean"
                 },

docs/swagger.json

@@ -188,7 +188,8 @@
                             "unbonding_requested",
                             "unbonding",
                             "unbonded",
-                            "withdrawn"
+                            "withdrawn",
+                            "transitioned"
                         ],
                         "type": "string",
                         "description": "Filter by state",
@@ -991,6 +992,9 @@
                 "finality_provider_pk_hex": {
                     "type": "string"
                 },
+                "is_eligible_for_transition": {
+                    "type": "boolean"
+                },
                 "is_overflow": {
                     "type": "boolean"
                 },

docs/swagger.yaml

@@ -233,6 +233,8 @@ definitions:
     properties:
       finality_provider_pk_hex:
         type: string
+      is_eligible_for_transition:
+        type: boolean
       is_overflow:
         type: boolean
       staker_pk_hex:
@@ -612,6 +614,7 @@ paths:
         - unbonding
         - unbonded
         - withdrawn
+        - transitioned
         in: query
         name: state
         type: string

internal/indexer/db/client/interface.go

@@ -21,4 +21,10 @@ type IndexerDBClient interface {
 	// Staker Delegations
 	GetDelegation(ctx context.Context, stakingTxHashHex string) (*indexerdbmodel.IndexerDelegationDetails, error)
 	GetDelegations(ctx context.Context, stakerPKHex string, paginationToken string) (*db.DbResultMap[indexerdbmodel.IndexerDelegationDetails], error)
+	/**
+	 * GetLastProcessedBbnHeight retrieves the last processed BBN height.
+	 * @param ctx The context
+	 * @return The last processed height or an error
+	 */
+	GetLastProcessedBbnHeight(ctx context.Context) (uint64, error)
 }

internal/indexer/db/client/last_processed_height.go

@@ -0,0 +1,25 @@
+package indexerdbclient
+
+import (
+	"context"
+
+	indexerdbmodel "github.com/babylonlabs-io/staking-api-service/internal/indexer/db/model"
+	"go.mongodb.org/mongo-driver/bson"
+	"go.mongodb.org/mongo-driver/mongo"
+)
+
+func (db *IndexerDatabase) GetLastProcessedBbnHeight(ctx context.Context) (uint64, error) {
+	// If not in context, query from database
+	var result indexerdbmodel.LastProcessedHeight
+	err := db.Client.Database(db.DbName).Collection(
+		indexerdbmodel.LastProcessedHeightCollection,
+	).FindOne(ctx, bson.M{}).Decode(&result)
+	if err == mongo.ErrNoDocuments {
+		// If no document exists, return 0
+		return 0, nil
+	}
+	if err != nil {
+		return 0, err
+	}
+	return result.Height, nil
+}

internal/indexer/db/model/last_processed_height.go

@@ -0,0 +1,5 @@
+package indexerdbmodel
+
+type LastProcessedHeight struct {
+	Height uint64 `bson:"height"`
+}

internal/indexer/db/model/setup.go

@@ -5,4 +5,5 @@ const (
 	BTCDelegationDetailsCollection    = "btc_delegation_details"
 	TimeLockCollection                = "timelock"
 	GlobalParamsCollection            = "global_params"
+	LastProcessedHeightCollection     = "last_processed_height"
 )

internal/shared/config/config.go

@@ -10,12 +10,13 @@ import (
 )
 
 type Config struct {
-	Server    *ServerConfig      `mapstructure:"server"`
-	StakingDb *DbConfig          `mapstructure:"staking-db"`
-	IndexerDb *DbConfig          `mapstructure:"indexer-db"`
-	Queue     *queue.QueueConfig `mapstructure:"queue"`
-	Metrics   *MetricsConfig     `mapstructure:"metrics"`
-	Assets    *AssetsConfig      `mapstructure:"assets"`
+	Server               *ServerConfig               `mapstructure:"server"`
+	StakingDb            *DbConfig                   `mapstructure:"staking-db"`
+	IndexerDb            *DbConfig                   `mapstructure:"indexer-db"`
+	Queue                *queue.QueueConfig          `mapstructure:"queue"`
+	Metrics              *MetricsConfig              `mapstructure:"metrics"`
+	Assets               *AssetsConfig               `mapstructure:"assets"`
+	DelegationTransition *DelegationTransitionConfig `mapstructure:"delegation_transition"`
 }
 
 func (cfg *Config) Validate() error {
@@ -46,6 +47,13 @@ func (cfg *Config) Validate() error {
 		}
 	}
 
+	// The DelegationTransition is optional
+	if cfg.DelegationTransition != nil {
+		if err := cfg.DelegationTransition.Validate(); err != nil {
+			return err
+		}
+	}
+
 	return nil
 }
 

internal/shared/config/delegation_transition.go

@@ -0,0 +1,26 @@
+package config
+
+import "errors"
+
+// DelegationTransitionConfig represents the transition cutoff height for
+// the phase-1 delegation to phase-2.
+// A delegation can transition to phase-2 if either:
+// 1. The delegation's BTC staking height is less than EligibleBeforeBtcHeight, or
+// 2. The current BBN height is greater than AllowListExpirationHeight
+// (allowing all delegations to transition)
+type DelegationTransitionConfig struct {
+	EligibleBeforeBtcHeight   uint64 `mapstructure:"eligible_before_btc_height"`
+	AllowListExpirationHeight uint64 `mapstructure:"allow_list_expiration_height"`
+}
+
+func (cfg *DelegationTransitionConfig) Validate() error {
+	if cfg.EligibleBeforeBtcHeight == 0 {
+		return errors.New("before_btc_height cannot be 0")
+	}
+
+	if cfg.AllowListExpirationHeight == 0 {
+		return errors.New("allow_list_expiration_height cannot be 0")
+	}
+
+	return nil
+}

internal/shared/types/delegation.go

@@ -10,6 +10,7 @@ const (
 	Unbonding          DelegationState = "unbonding"
 	Unbonded           DelegationState = "unbonded"
 	Withdrawn          DelegationState = "withdrawn"
+	Transitioned       DelegationState = "transitioned"
 )
 
 func (s DelegationState) ToString() string {
@@ -28,6 +29,8 @@ func FromStringToDelegationState(s string) (DelegationState, error) {
 		return Unbonded, nil
 	case "withdrawn":
 		return Withdrawn, nil
+	case "transitioned":
+		return Transitioned, nil
 	default:
 		return "", fmt.Errorf("invalid delegation state: %s", s)
 	}

internal/v1/api/handlers/delegation.go

@@ -5,7 +5,6 @@ import (
 
 	"github.com/babylonlabs-io/staking-api-service/internal/shared/api/handlers/handler"
 	"github.com/babylonlabs-io/staking-api-service/internal/shared/types"
-	v1service "github.com/babylonlabs-io/staking-api-service/internal/v1/service"
 )
 
 // GetDelegationByTxHash @Summary Get a delegation
@@ -26,5 +25,5 @@ func (h *V1Handler) GetDelegationByTxHash(request *http.Request) (*handler.Resul
 		return nil, err
 	}
 
-	return handler.NewResult(v1service.FromDelegationDocument(delegation)), nil
+	return handler.NewResult(delegation), nil
 }

internal/v1/db/model/delegation.go

@@ -1,8 +1,8 @@
 package v1dbmodel
 
 import (
-	"github.com/babylonlabs-io/staking-api-service/internal/shared/types"
 	dbmodel "github.com/babylonlabs-io/staking-api-service/internal/shared/db/model"
+	"github.com/babylonlabs-io/staking-api-service/internal/shared/types"
 )
 
 type TimelockTransaction struct {

internal/v1/queue/handler/expired_staking.go

@@ -26,7 +26,8 @@ func (h *V1QueueHandler) ExpiredStakingHandler(ctx context.Context, messageBody
 	if delErr != nil {
 		return delErr
 	}
-	if utils.Contains[types.DelegationState](utils.OutdatedStatesForUnbonded(), del.State) {
+	state := types.DelegationState(del.State)
+	if utils.Contains(utils.OutdatedStatesForUnbonded(), state) {
 		// Ignore the message as the delegation state already passed the unbonded state. This is an outdated duplication
 		log.Ctx(ctx).Debug().Str("StakingTxHashHex", expiredStakingEvent.StakingTxHashHex).
 			Msg("delegation state is outdated for unbonded event")

internal/v1/queue/handler/unbonding.go

@@ -25,7 +25,7 @@ func (h *V1QueueHandler) UnbondingStakingHandler(ctx context.Context, messageBod
 	if delErr != nil {
 		return delErr
 	}
-	state := del.State
+	state := types.DelegationState(del.State)
 	if utils.Contains(utils.OutdatedStatesForUnbonding(), state) {
 		// Ignore the message as the delegation state already passed the unbonding state. This is an outdated duplication
 		log.Ctx(ctx).Debug().Str("StakingTxHashHex", unbondingStakingEvent.StakingTxHashHex).

internal/v1/queue/handler/withdraw.go

@@ -25,7 +25,7 @@ func (h *V1QueueHandler) WithdrawStakingHandler(ctx context.Context, messageBody
 	if delErr != nil {
 		return delErr
 	}
-	state := del.State
+	state := types.DelegationState(del.State)
 
 	stakingTxHashHex := withdrawnStakingEvent.GetStakingTxHashHex()