fix: improve docs and tests

Author: AndresQuijano

internal/adapters/dataproviders/rootstock/pegin_contract.go

@@ -240,6 +240,8 @@ func (peginContract *peginContractImpl) RegisterPegin(params blockchain.Register
 	return transactionReceipt, nil
 }
 
+// Withdraw withdraws the specified amount from the LP's balance in the pegin contract.
+// It first performs a dry-run call to check for reverts before submitting the actual transaction.
 func (peginContract *peginContractImpl) Withdraw(amount *entities.Wei) error {
 	const functionName = "withdraw"
 	var res []any

internal/usecases/liquidity_provider/transfer_excess_to_cold_wallet.go

@@ -51,6 +51,11 @@ type TransferToColdWalletResult struct {
 	RskResult NetworkTransferResult
 }
 
+type currentLiquidityResult struct {
+	Btc  *entities.Wei
+	Rbtc *entities.Wei
+}
+
 func NewTransferToColdWalletResult(btcResult, rskResult NetworkTransferResult) *TransferToColdWalletResult {
 	return &TransferToColdWalletResult{
 		BtcResult: btcResult,
@@ -352,6 +357,7 @@ func (useCase *TransferExcessToColdWalletUseCase) publishRskTransferEvent(ctx co
 	}
 }
 
+// sendTransferAlert triggers the alertSender to send an alert with the transfer details.
 func (useCase *TransferExcessToColdWalletUseCase) sendTransferAlert(ctx context.Context, asset string, amount *entities.Wei, txHash string, fee *entities.Wei, isTimeForcing bool) error {
 	reason := "threshold"
 	if isTimeForcing {
@@ -369,22 +375,6 @@ func (useCase *TransferExcessToColdWalletUseCase) sendTransferAlert(ctx context.
 	return useCase.alertSender.SendAlert(ctx, alerts.AlertSubjectHotToColdTransfer, body, []string{useCase.alertRecipient})
 }
 
-func (useCase *TransferExcessToColdWalletUseCase) withdrawContractFunds() {
-	lpAddress := useCase.generalProvider.RskAddress()
-	contractBalance, err := useCase.peginContract.GetBalance(lpAddress)
-	if err != nil {
-		log.Errorf("TransferExcessToColdWallet: failed to get pegin contract balance: %v", err)
-		return
-	}
-	if contractBalance.Cmp(entities.NewWei(0)) <= 0 {
-		return
-	}
-	log.Infof("TransferExcessToColdWallet: withdrawing %s wei from pegin contract", contractBalance.String())
-	if err := useCase.peginContract.Withdraw(contractBalance); err != nil {
-		log.Errorf("TransferExcessToColdWallet: failed to withdraw from pegin contract: %v", err)
-	}
-}
-
 // handleRskTransfer orchestrates a single RBTC transfer: skips if no excess, executes the transfer,
 // checks if the amount is economical, and publishes the corresponding event on success.
 func (useCase *TransferExcessToColdWalletUseCase) handleRskTransfer(ctx context.Context, excess *entities.Wei, isTimeForcingTransfer bool) NetworkTransferResult {
@@ -425,9 +415,22 @@ func (useCase *TransferExcessToColdWalletUseCase) handleRskTransfer(ctx context.
 	}
 }
 
-type currentLiquidityResult struct {
-	Btc  *entities.Wei
-	Rbtc *entities.Wei
+// withdrawContractFunds retrieves the LP's balance from the pegin contract and withdraws it
+// back to the hot wallet, ensuring contract funds are prioritized before cold wallet transfers.
+func (useCase *TransferExcessToColdWalletUseCase) withdrawContractFunds() {
+	lpAddress := useCase.generalProvider.RskAddress()
+	contractBalance, err := useCase.peginContract.GetBalance(lpAddress)
+	if err != nil {
+		log.Errorf("TransferExcessToColdWallet: failed to get pegin contract balance: %v", err)
+		return
+	}
+	if contractBalance.Cmp(entities.NewWei(0)) <= 0 {
+		return
+	}
+	log.Infof("TransferExcessToColdWallet: withdrawing %s wei from pegin contract", contractBalance.String())
+	if err := useCase.peginContract.Withdraw(contractBalance); err != nil {
+		log.Errorf("TransferExcessToColdWallet: failed to withdraw from pegin contract: %v", err)
+	}
 }
 
 // validateColdWallet checks that both BTC and RSK cold wallet addresses are configured.

internal/usecases/liquidity_provider/transfer_excess_to_cold_wallet_test.go

@@ -399,10 +399,10 @@ func TestTransferExcessToColdWalletUseCase_Run_HappyPathRskExcessWithContractFun
 	generalProvider.On("GeneralConfiguration", ctx).Return(generalConfig)
 
 	stateConfig := lpEntity.StateConfiguration{
-		LastBtcToColdWalletTransfer:  &nowUnix,
-		LastRbtcToColdWalletTransfer: &nowUnix,
+		LastBtcToColdWalletTransfer:  nowUnix,
+		LastRbtcToColdWalletTransfer: nowUnix,
 	}
-	generalProvider.On("StateConfiguration", ctx).Return(stateConfig)
+	generalProvider.On("StateConfiguration", ctx).Return(stateConfig, nil)
 
 	pegoutProvider.On("AvailablePegoutLiquidity", ctx).Return(btcLiquidity, nil)
 	peginProvider.On("AvailablePeginLiquidity", ctx).Return(rbtcLiquidity, nil)
@@ -532,9 +532,9 @@ func TestTransferExcessToColdWalletUseCase_Run_RskExcess_GetContractBalanceFails
 		},
 	})
 	generalProvider.On("StateConfiguration", ctx).Return(lpEntity.StateConfiguration{
-		LastBtcToColdWalletTransfer:  &nowUnix,
-		LastRbtcToColdWalletTransfer: &nowUnix,
-	})
+		LastBtcToColdWalletTransfer:  nowUnix,
+		LastRbtcToColdWalletTransfer: nowUnix,
+	}, nil)
 	pegoutProvider.On("AvailablePegoutLiquidity", ctx).Return(btcLiquidity, nil)
 	peginProvider.On("AvailablePeginLiquidity", ctx).Return(rbtcLiquidity, nil)
 
@@ -626,9 +626,9 @@ func TestTransferExcessToColdWalletUseCase_Run_RskExcess_WithdrawContractFundsFa
 		},
 	})
 	generalProvider.On("StateConfiguration", ctx).Return(lpEntity.StateConfiguration{
-		LastBtcToColdWalletTransfer:  &nowUnix,
-		LastRbtcToColdWalletTransfer: &nowUnix,
-	})
+		LastBtcToColdWalletTransfer:  nowUnix,
+		LastRbtcToColdWalletTransfer: nowUnix,
+	}, nil)
 	pegoutProvider.On("AvailablePegoutLiquidity", ctx).Return(btcLiquidity, nil)
 	peginProvider.On("AvailablePeginLiquidity", ctx).Return(rbtcLiquidity, nil)