feat: add feature to change btc/rbtc liquidity ratio

Author: AndresQuijano

docker-compose/docker-compose.yml

@@ -154,6 +154,7 @@ services:
       - COLD_WALLET_FORCE_TRANSFER_AFTER_SECONDS
       - HOT_WALLET_LOW_LIQUIDITY_WARNING
       - HOT_WALLET_LOW_LIQUIDITY_CRITICAL
+      - BTC_LIQUIDITY_TARGET_PERCENTAGE
     ports:
       - "8080:8080"
     volumes:

docker-compose/local/docker-compose.lps.yml

@@ -92,6 +92,7 @@ services:
       - COLD_WALLET_FORCE_TRANSFER_AFTER_SECONDS
       - HOT_WALLET_LOW_LIQUIDITY_WARNING
       - HOT_WALLET_LOW_LIQUIDITY_CRITICAL
+      - BTC_LIQUIDITY_TARGET_PERCENTAGE
     ports:
       - "8080:8080"
     volumes:

docker-compose/mainnet/docker-compose.yml

@@ -106,6 +106,7 @@ services:
       - COLD_WALLET_FORCE_TRANSFER_AFTER_SECONDS
       - HOT_WALLET_LOW_LIQUIDITY_WARNING
       - HOT_WALLET_LOW_LIQUIDITY_CRITICAL
+      - BTC_LIQUIDITY_TARGET_PERCENTAGE
     ports:
       - "8080:8080"
     volumes:

docs/Environment.md

@@ -74,6 +74,7 @@ These are the environment variables required by the liquidity provider server (L
 | `COLD_WALLET_FORCE_TRANSFER_AFTER_SECONDS` | Number of seconds after which excess liquidity will be transferred to cold wallet even if below threshold | `1209600` (2 weeks) | No |
 | `HOT_WALLET_LOW_LIQUIDITY_WARNING` | Hot wallet liquidity threshold in whole coins (BTC/RBTC) below which a warning alert is emitted every check cycle | `3` | No |
 | `HOT_WALLET_LOW_LIQUIDITY_CRITICAL` | Hot wallet liquidity threshold in whole coins (BTC/RBTC) below which a critical alert is emitted every check cycle. Must be less than `HOT_WALLET_LOW_LIQUIDITY_WARNING` | `1` | No |
+| `BTC_LIQUIDITY_TARGET_PERCENTAGE` | Percentage of MaxLiquidity allocated to BTC in the hot wallet (RBTC gets the remainder). Must be between 10 and 90 | `50` | No |
 
 ## AWS variables
 You may notice that in [`sample-config.env`](https://github.com/rsksmart/liquidity-provider-server/blob/master/sample-config.env) there are some environment variables that are related to AWS. These variables are required to use AWS services, however, they are not listed in the table as the AWS SDK has the functionality to load them from multiple sources. For that reason, they are not accessed directly from the code and are not listed in the table above.

internal/adapters/entrypoints/watcher/liquidity_check_test.go

@@ -9,6 +9,7 @@ import (
 	"github.com/rsksmart/liquidity-provider-server/internal/adapters/entrypoints/watcher"
 	"github.com/rsksmart/liquidity-provider-server/internal/entities"
 	"github.com/rsksmart/liquidity-provider-server/internal/entities/blockchain"
+	lpEntity "github.com/rsksmart/liquidity-provider-server/internal/entities/liquidity_provider"
 	"github.com/rsksmart/liquidity-provider-server/internal/entities/utils"
 	"github.com/rsksmart/liquidity-provider-server/internal/usecases/liquidity_provider"
 	"github.com/rsksmart/liquidity-provider-server/test"
@@ -28,7 +29,7 @@ func TestNewLiquidityCheckWatcher(t *testing.T) {
 	ticker := &mocks.TickerMock{}
 	providerMock := &mocks.ProviderMock{}
 	checkLiquidityUseCase := liquidity_provider.NewCheckLiquidityUseCase(providerMock, providerMock, blockchain.RskContracts{}, &mocks.AlertSenderMock{}, test.AnyString)
-	lowLiquidityUseCase := liquidity_provider.NewLowLiquidityAlertUseCase(providerMock, providerMock, &mocks.AlertSenderMock{}, test.AnyString, 3, 1)
+	lowLiquidityUseCase := liquidity_provider.NewLowLiquidityAlertUseCase(providerMock, providerMock, providerMock, &mocks.AlertSenderMock{}, test.AnyString, 3, 1)
 	test.AssertNonZeroValues(t, watcher.NewLiquidityCheckWatcher(checkLiquidityUseCase, lowLiquidityUseCase, ticker, time.Duration(1)))
 }
 
@@ -46,8 +47,9 @@ func TestLiquidityCheckWatcher_Start(t *testing.T) {
 	bridgeMock.On("GetMinimumLockTxValue").Return(entities.NewWei(5), nil)
 	alertSenderMock := &mocks.AlertSenderMock{}
 	alertSenderMock.On("SendAlert", mock.Anything, mock.Anything, mock.Anything, mock.Anything).Return(nil)
+	providerMock.On("StateConfiguration", mock.Anything).Return(lpEntity.StateConfiguration{}, nil)
 	checkLiquidityUseCase := liquidity_provider.NewCheckLiquidityUseCase(providerMock, providerMock, blockchain.RskContracts{Bridge: bridgeMock}, alertSenderMock, test.AnyString)
-	lowLiquidityUseCase := liquidity_provider.NewLowLiquidityAlertUseCase(providerMock, providerMock, alertSenderMock, test.AnyString, 3, 1)
+	lowLiquidityUseCase := liquidity_provider.NewLowLiquidityAlertUseCase(providerMock, providerMock, providerMock, alertSenderMock, test.AnyString, 3, 1)
 	w := watcher.NewLiquidityCheckWatcher(checkLiquidityUseCase, lowLiquidityUseCase, ticker, time.Duration(1))
 	wg := sync.WaitGroup{}
 	wg.Add(2)
@@ -81,8 +83,9 @@ func TestLiquidityCheckWatcher_Start_ErrorHandling(t *testing.T) {
 	bridgeMock.On("GetMinimumLockTxValue").Return(nil, assert.AnError)
 	alertSenderMock := &mocks.AlertSenderMock{}
 	alertSenderMock.On("SendAlert", mock.Anything, mock.Anything, mock.Anything, mock.Anything).Return(nil)
+	providerMock.On("StateConfiguration", mock.Anything).Return(lpEntity.StateConfiguration{}, nil)
 	checkLiquidityUseCase := liquidity_provider.NewCheckLiquidityUseCase(providerMock, providerMock, blockchain.RskContracts{Bridge: bridgeMock}, alertSenderMock, test.AnyString)
-	lowLiquidityUseCase := liquidity_provider.NewLowLiquidityAlertUseCase(providerMock, providerMock, alertSenderMock, test.AnyString, 3, 1)
+	lowLiquidityUseCase := liquidity_provider.NewLowLiquidityAlertUseCase(providerMock, providerMock, providerMock, alertSenderMock, test.AnyString, 3, 1)
 	w := watcher.NewLiquidityCheckWatcher(checkLiquidityUseCase, lowLiquidityUseCase, ticker, time.Duration(1))
 	wg := sync.WaitGroup{}
 	wg.Add(2)

internal/configuration/environment/environment.go

@@ -195,6 +195,7 @@ type ColdWalletEnv struct {
 	ForceTransferAfterSeconds     uint64 `env:"COLD_WALLET_FORCE_TRANSFER_AFTER_SECONDS"`
 	HotWalletLowLiquidityWarning  uint64 `env:"HOT_WALLET_LOW_LIQUIDITY_WARNING"`
 	HotWalletLowLiquidityCritical uint64 `env:"HOT_WALLET_LOW_LIQUIDITY_CRITICAL"`
+	BtcLiquidityTargetPercentage  uint64 `env:"BTC_LIQUIDITY_TARGET_PERCENTAGE"`
 }
 
 func (env *ColdWalletEnv) FillWithDefaults() *ColdWalletEnv {
@@ -204,15 +205,20 @@ func (env *ColdWalletEnv) FillWithDefaults() *ColdWalletEnv {
 		ForceTransferAfterSeconds:     1209600, // 2 weeks (14 days * 24 hours * 60 minutes * 60 seconds)
 		HotWalletLowLiquidityWarning:  3,
 		HotWalletLowLiquidityCritical: 1,
+		BtcLiquidityTargetPercentage:  50,
 	}
 	env.BtcMinTransferFeeMultiplier = utils.FirstNonZero(env.BtcMinTransferFeeMultiplier, defaults.BtcMinTransferFeeMultiplier)
 	env.RbtcMinTransferFeeMultiplier = utils.FirstNonZero(env.RbtcMinTransferFeeMultiplier, defaults.RbtcMinTransferFeeMultiplier)
 	env.ForceTransferAfterSeconds = utils.FirstNonZero(env.ForceTransferAfterSeconds, defaults.ForceTransferAfterSeconds)
 	env.HotWalletLowLiquidityWarning = utils.FirstNonZero(env.HotWalletLowLiquidityWarning, defaults.HotWalletLowLiquidityWarning)
 	env.HotWalletLowLiquidityCritical = utils.FirstNonZero(env.HotWalletLowLiquidityCritical, defaults.HotWalletLowLiquidityCritical)
+	env.BtcLiquidityTargetPercentage = utils.FirstNonZero(env.BtcLiquidityTargetPercentage, defaults.BtcLiquidityTargetPercentage)
 	if env.HotWalletLowLiquidityCritical >= env.HotWalletLowLiquidityWarning {
 		log.Fatal("HOT_WALLET_LOW_LIQUIDITY_CRITICAL must be less than HOT_WALLET_LOW_LIQUIDITY_WARNING")
 	}
+	if env.BtcLiquidityTargetPercentage < 10 || env.BtcLiquidityTargetPercentage > 90 {
+		log.Fatal("BTC_LIQUIDITY_TARGET_PERCENTAGE must be between 10 and 90")
+	}
 	return env
 }
 

internal/configuration/registry/usecase.go

@@ -262,6 +262,7 @@ func NewUseCaseRegistry(
 			lpRegistry.ColdWallet,
 			rskRegistry.Wallet,
 			signingHashFunction,
+			env.ColdWallet.BtcLiquidityTargetPercentage,
 		),
 		getManagementUiDataUseCase: liquidity_provider.NewGetManagementUiDataUseCase(
 			databaseRegistry.LiquidityProviderRepository,
@@ -393,6 +394,7 @@ func NewUseCaseRegistry(
 			env.Provider.AlertRecipientEmail,
 		),
 		lowLiquidityAlertUseCase: liquidity_provider.NewLowLiquidityAlertUseCase(
+			lpRegistry.LiquidityProvider,
 			lpRegistry.LiquidityProvider,
 			lpRegistry.LiquidityProvider,
 			messaging.AlertSender,

internal/entities/liquidity_provider/configuration.go

@@ -110,6 +110,8 @@ type StateConfiguration struct {
 	LastRbtcToColdWalletTransfer int64  `json:"lastRbtcToColdWalletTransfer" bson:"last_rbtc_to_cold_wallet_transfer"`
 	BtcColdWalletAddressHash     string `json:"btcColdWalletAddressHash" bson:"btc_cold_wallet_address_hash"`
 	RskColdWalletAddressHash     string `json:"rskColdWalletAddressHash" bson:"rsk_cold_wallet_address_hash"`
+	BtcLiquidityTargetPercentage uint64 `json:"btcLiquidityTargetPercentage" bson:"btc_liquidity_target_percentage"`
+	RatioCooldownEndTimestamp    int64  `json:"ratioCooldownEndTimestamp" bson:"ratio_cooldown_end_timestamp"`
 }
 
 type ConfigurationType interface {

internal/usecases/liquidity_provider/initialize_state_configuration.go

@@ -13,12 +13,15 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
+const CoolDownAfterRatioChange int64 = 10800 // 3 hours
+
 type InitializeStateConfigurationUseCase struct {
-	provider     liquidity_provider.LiquidityProvider
-	lpRepository liquidity_provider.LiquidityProviderRepository
-	coldWallet   cold_wallet.ColdWallet
-	signer       entities.Signer
-	hashFunc     entities.HashFunction
+	provider                     liquidity_provider.LiquidityProvider
+	lpRepository                 liquidity_provider.LiquidityProviderRepository
+	coldWallet                   cold_wallet.ColdWallet
+	signer                       entities.Signer
+	hashFunc                     entities.HashFunction
+	btcLiquidityTargetPercentage uint64
 }
 
 func NewInitializeStateConfigurationUseCase(
@@ -27,13 +30,15 @@ func NewInitializeStateConfigurationUseCase(
 	coldWallet cold_wallet.ColdWallet,
 	signer entities.Signer,
 	hashFunc entities.HashFunction,
+	btcLiquidityTargetPercentage uint64,
 ) *InitializeStateConfigurationUseCase {
 	return &InitializeStateConfigurationUseCase{
-		provider:     provider,
-		lpRepository: lpRepository,
-		coldWallet:   coldWallet,
-		signer:       signer,
-		hashFunc:     hashFunc,
+		provider:                     provider,
+		lpRepository:                 lpRepository,
+		coldWallet:                   coldWallet,
+		signer:                       signer,
+		hashFunc:                     hashFunc,
+		btcLiquidityTargetPercentage: btcLiquidityTargetPercentage,
 	}
 }
 
@@ -80,6 +85,11 @@ func (useCase *InitializeStateConfigurationUseCase) Run(ctx context.Context) err
 		modified = true
 	}
 
+	stateConfig, ratioUpdated := useCase.applyRatioUpdate(stateConfig, now)
+	if ratioUpdated {
+		modified = true
+	}
+
 	if !modified {
 		log.Debug("State configuration already fully initialized")
 		return nil
@@ -88,6 +98,22 @@ func (useCase *InitializeStateConfigurationUseCase) Run(ctx context.Context) err
 	return useCase.signAndPersist(ctx, stateConfig)
 }
 
+func (useCase *InitializeStateConfigurationUseCase) applyRatioUpdate(stateConfig liquidity_provider.StateConfiguration, now int64) (liquidity_provider.StateConfiguration, bool) {
+	if stateConfig.BtcLiquidityTargetPercentage == 0 {
+		log.Infof("Initializing BtcLiquidityTargetPercentage to %d", useCase.btcLiquidityTargetPercentage)
+		stateConfig.BtcLiquidityTargetPercentage = useCase.btcLiquidityTargetPercentage
+		return stateConfig, true
+	}
+	if stateConfig.BtcLiquidityTargetPercentage != useCase.btcLiquidityTargetPercentage {
+		log.Infof("BtcLiquidityTargetPercentage changed from %d to %d, activating cooldown",
+			stateConfig.BtcLiquidityTargetPercentage, useCase.btcLiquidityTargetPercentage)
+		stateConfig.BtcLiquidityTargetPercentage = useCase.btcLiquidityTargetPercentage
+		stateConfig.RatioCooldownEndTimestamp = now + CoolDownAfterRatioChange
+		return stateConfig, true
+	}
+	return stateConfig, false
+}
+
 func (useCase *InitializeStateConfigurationUseCase) validateColdWalletAddresses() (coldWalletAddresses, error) {
 	btcAddr := useCase.coldWallet.GetBtcAddress()
 	rskAddr := useCase.coldWallet.GetRskAddress()