Merge pull request #921 from rsksmart/feat_hot_to_cold_tranfer_alert

Feat/Fly2227/ Add alert for hot to cold wallet transfer

Author: AndresQuijano

internal/configuration/registry/usecase.go

@@ -389,6 +389,8 @@ func NewUseCaseRegistry(
 			messaging.EventBus,
 			rskRegistry.Wallet,
 			signingHashFunction,
+			messaging.AlertSender,
+			env.Provider.AlertRecipientEmail,
 		),
 		checkColdWalletAddressChangeUseCase: liquidity_provider.NewCheckColdWalletAddressChangeUseCase(
 			databaseRegistry.LiquidityProviderRepository,

internal/entities/alerts/alerts.go

@@ -11,6 +11,7 @@ const (
 	AlertSubjectPegoutOutOfLiquidity = "PegOut: Out of liquidity"
 	AlertSubjectEclipseAttack        = "Node Eclipse Detected"
 	AlertSubjectColdWalletChange     = "Cold wallet address changed"
+	AlertSubjectHotToColdTransfer   = "Hot to cold wallet transfer executed"
 )
 
 type AlertSender interface {

internal/usecases/liquidity_provider/transfer_excess_to_cold_wallet.go

@@ -3,10 +3,12 @@ package liquidity_provider
 import (
 	"context"
 	"errors"
+	"fmt"
 	"sync"
 	"time"
 
 	"github.com/rsksmart/liquidity-provider-server/internal/entities"
+	"github.com/rsksmart/liquidity-provider-server/internal/entities/alerts"
 	"github.com/rsksmart/liquidity-provider-server/internal/entities/blockchain"
 	"github.com/rsksmart/liquidity-provider-server/internal/entities/cold_wallet"
 	"github.com/rsksmart/liquidity-provider-server/internal/entities/liquidity_provider"
@@ -86,6 +88,8 @@ type TransferExcessToColdWalletUseCase struct {
 	eventBus                     entities.EventBus
 	signer                       entities.Signer
 	hashFunc                     entities.HashFunction
+	alertSender                  alerts.AlertSender
+	alertRecipient               string
 }
 
 // NewTransferExcessToColdWalletUseCase creates a new use case for transferring excess liquidity to the cold wallet.
@@ -106,6 +110,8 @@ func NewTransferExcessToColdWalletUseCase(
 	eventBus entities.EventBus,
 	signer entities.Signer,
 	hashFunc entities.HashFunction,
+	alertSender alerts.AlertSender,
+	alertRecipient string,
 ) *TransferExcessToColdWalletUseCase {
 	return &TransferExcessToColdWalletUseCase{
 		peginProvider:                peginProvider,
@@ -124,6 +130,8 @@ func NewTransferExcessToColdWalletUseCase(
 		eventBus:                     eventBus,
 		signer:                       signer,
 		hashFunc:                     hashFunc,
+		alertSender:                  alertSender,
+		alertRecipient:               alertRecipient,
 	}
 }
 
@@ -155,7 +163,7 @@ func (useCase *TransferExcessToColdWalletUseCase) Run(ctx context.Context) (*Tra
 		return nil, usecases.WrapUseCaseError(usecases.TransferExcessToColdWalletId, err)
 	}
 
-	btcResult := useCase.handleBtcTransfer(excessResult.BtcExcess, excessResult.BtcIsTimeForced)
+	btcResult := useCase.handleBtcTransfer(ctx, excessResult.BtcExcess, excessResult.BtcIsTimeForced)
 	if btcResult.Status == TransferStatusFailed {
 		result := NewTransferToColdWalletResult(btcResult, NetworkTransferResult{})
 		return result, usecases.WrapUseCaseError(usecases.TransferExcessToColdWalletId, btcResult.Error)
@@ -260,7 +268,7 @@ func (useCase *TransferExcessToColdWalletUseCase) calculateExcessForBothNetworks
 
 // publishBtcTransferEvent emits a BTC cold wallet transfer event to the event bus, distinguishing
 // between threshold-triggered and time-forced transfers.
-func (useCase *TransferExcessToColdWalletUseCase) publishBtcTransferEvent(txResult internalTxResult, isTimeForcingTransfer bool) {
+func (useCase *TransferExcessToColdWalletUseCase) publishBtcTransferEvent(ctx context.Context, txResult internalTxResult, isTimeForcingTransfer bool) {
 	if isTimeForcingTransfer {
 		useCase.eventBus.Publish(cold_wallet.BtcTransferredDueToTimeForcingEvent{
 			Event:  entities.NewBaseEvent(cold_wallet.BtcTransferredDueToTimeForcingEventId),
@@ -276,11 +284,14 @@ func (useCase *TransferExcessToColdWalletUseCase) publishBtcTransferEvent(txResu
 			Fee:    txResult.Fee,
 		})
 	}
+	if err := useCase.sendTransferAlert(ctx, "BTC", txResult.Amount, txResult.TxHash, txResult.Fee, isTimeForcingTransfer); err != nil {
+		log.Error("Error sending hot to cold transfer alert: ", err)
+	}
 }
 
 // handleBtcTransfer orchestrates a single BTC transfer: skips if no excess, executes the transfer,
 // checks if the amount is economical, and publishes the corresponding event on success.
-func (useCase *TransferExcessToColdWalletUseCase) handleBtcTransfer(excess *entities.Wei, isTimeForcingTransfer bool) NetworkTransferResult {
+func (useCase *TransferExcessToColdWalletUseCase) handleBtcTransfer(ctx context.Context, excess *entities.Wei, isTimeForcingTransfer bool) NetworkTransferResult {
 	if excess.Cmp(entities.NewWei(0)) <= 0 {
 		return NetworkTransferResult{
 			Status:  TransferStatusSkippedNoExcess,
@@ -290,7 +301,7 @@ func (useCase *TransferExcessToColdWalletUseCase) handleBtcTransfer(excess *enti
 
 	txResult, err := useCase.executeBtcTransfer(excess)
 	if err == nil {
-		useCase.publishBtcTransferEvent(txResult, isTimeForcingTransfer)
+		useCase.publishBtcTransferEvent(ctx, txResult, isTimeForcingTransfer)
 
 		return NetworkTransferResult{
 			Status:  TransferStatusSuccess,
@@ -317,7 +328,7 @@ func (useCase *TransferExcessToColdWalletUseCase) handleBtcTransfer(excess *enti
 
 // publishRskTransferEvent emits an RBTC cold wallet transfer event to the event bus, distinguishing
 // between threshold-triggered and time-forced transfers.
-func (useCase *TransferExcessToColdWalletUseCase) publishRskTransferEvent(txResult internalTxResult, isTimeForcingTransfer bool) {
+func (useCase *TransferExcessToColdWalletUseCase) publishRskTransferEvent(ctx context.Context, txResult internalTxResult, isTimeForcingTransfer bool) {
 	if isTimeForcingTransfer {
 		useCase.eventBus.Publish(cold_wallet.RbtcTransferredDueToTimeForcingEvent{
 			Event:  entities.NewBaseEvent(cold_wallet.RbtcTransferredDueToTimeForcingEventId),
@@ -333,6 +344,26 @@ func (useCase *TransferExcessToColdWalletUseCase) publishRskTransferEvent(txResu
 			Fee:    txResult.Fee,
 		})
 	}
+	if err := useCase.sendTransferAlert(ctx, "RBTC", txResult.Amount, txResult.TxHash, txResult.Fee, isTimeForcingTransfer); err != nil {
+		log.Error("Error sending hot to cold transfer alert: ", err)
+	}
+}
+
+func (useCase *TransferExcessToColdWalletUseCase) sendTransferAlert(ctx context.Context, asset string, amount *entities.Wei, txHash string, fee *entities.Wei, isTimeForcing bool) error {
+	reason := "threshold"
+	if isTimeForcing {
+		reason = "time forcing"
+	}
+	amountStr := "0"
+	if amount != nil {
+		amountStr = amount.ToRbtc().String()
+	}
+	feeStr := "0"
+	if fee != nil {
+		feeStr = fee.ToRbtc().String()
+	}
+	body := fmt.Sprintf("| Asset: %s | Amount: %s | TxHash: %s | Fee: %s | Reason: %s", asset, amountStr, txHash, feeStr, reason)
+	return useCase.alertSender.SendAlert(ctx, alerts.AlertSubjectHotToColdTransfer, body, []string{useCase.alertRecipient})
 }
 
 // handleRskTransfer orchestrates a single RBTC transfer: skips if no excess, executes the transfer,
@@ -347,7 +378,7 @@ func (useCase *TransferExcessToColdWalletUseCase) handleRskTransfer(ctx context.
 
 	txResult, err := useCase.executeRskTransfer(ctx, excess)
 	if err == nil {
-		useCase.publishRskTransferEvent(txResult, isTimeForcingTransfer)
+		useCase.publishRskTransferEvent(ctx, txResult, isTimeForcingTransfer)
 
 		return NetworkTransferResult{
 			Status:  TransferStatusSuccess,