feat: generate and store quote creation data

Author: Luisfc68

.mockery.yaml

@@ -1,5 +1,7 @@
 with-expecter: true
 dir: test/mocks
+resolve-type-alias: false
+issue-845-fix: true
 filename: "{{ .InterfaceName | snakecase }}_mock.go"
 mockname: "{{ .InterfaceName | firstUpper }}Mock"
 outpkg: mocks
@@ -55,4 +57,4 @@ packages:
       UseCaseRegistry:
   github.com/gorilla/sessions:
     interfaces:
-      Store:
+      Store:

OpenApi.yml

@@ -60,8 +60,8 @@ components:
           description: Available liquidity for PegIn operations in wei
           example: "5000000000000000000"
         pegoutLiquidityAmount:
-          description: Available liquidity for PegOut operations in satoshi
-          example: "500000000"
+          description: Available liquidity for PegOut operations in wei
+          example: "5000000000000000000"
       required:
       - peginLiquidityAmount
       - pegoutLiquidityAmount
@@ -198,10 +198,12 @@ components:
       type: object
     PeginConfigurationDTO:
       properties:
-        callFee:
-          type: string
         callTime:
           type: integer
+        feePercentage:
+          type: number
+        fixedFee:
+          type: string
         maxValue:
           type: string
         minValue:
@@ -217,6 +219,22 @@ components:
           $ref: '#/components/schemas/PeginConfigurationDTO'
           type: object
       type: object
+    PeginCreationDataDTO:
+      properties:
+        fixedFee:
+          description: The fixed fee used to compute the call fee
+          type: integer
+        gasPrice:
+          description: The gas price used to compute the gas fee
+          type: integer
+        percentageFee:
+          description: The percentage fee used to compute the call fee
+          type: number
+      required:
+      - gasPrice
+      - percentageFee
+      - fixedFee
+      type: object
     PeginQuoteDTO:
       properties:
         agreementTimestamp:
@@ -333,6 +351,10 @@ components:
       type: object
     PeginQuoteStatusDTO:
       properties:
+        creationData:
+          $ref: '#/components/schemas/PeginCreationDataDTO'
+          description: Values used to compute some fields of the quote
+          type: object
         detail:
           $ref: '#/components/schemas/PeginQuoteDTO'
           description: Agreed specification of the quote
@@ -344,17 +366,20 @@ components:
       required:
       - detail
       - status
+      - creationData
       type: object
     PegoutConfigurationDTO:
       properties:
         bridgeTransactionMin:
           type: string
-        callFee:
-          type: string
         expireBlocks:
           type: integer
         expireTime:
           type: integer
+        feePercentage:
+          type: number
+        fixedFee:
+          type: string
         maxValue:
           type: string
         minValue:
@@ -370,6 +395,26 @@ components:
           $ref: '#/components/schemas/PegoutConfigurationDTO'
           type: object
       type: object
+    PegoutCreationDataDTO:
+      properties:
+        feeRate:
+          description: The fee rate used to compute the gas fee
+          type: number
+        fixedFee:
+          description: The fixed fee used to compute the call fee
+          type: integer
+        gasPrice:
+          description: The gas price used to compute the gas fee
+          type: integer
+        percentageFee:
+          description: The percentage fee used to compute the call fee
+          type: number
+      required:
+      - gasPrice
+      - percentageFee
+      - fixedFee
+      - feeRate
+      type: object
     PegoutQuoteDTO:
       properties:
         agreementTimestamp:
@@ -455,6 +500,10 @@ components:
       type: object
     PegoutQuoteStatusDTO:
       properties:
+        creationData:
+          $ref: '#/components/schemas/PegoutCreationDataDTO'
+          description: Values used to compute some fields of the quote
+          type: object
         detail:
           $ref: '#/components/schemas/PegoutQuoteDTO'
           description: Agreed specification of the quote
@@ -466,10 +515,16 @@ components:
       required:
       - detail
       - status
+      - creationData
       type: object
     ProviderDetail:
       properties:
         fee:
+          deprecated: true
+          type: integer
+        feePercentage:
+          type: number
+        fixedFee:
           type: integer
         maxTransactionValue:
           type: integer
@@ -479,6 +534,8 @@ components:
           type: integer
       required:
       - fee
+      - fixedFee
+      - feePercentage
       - minTransactionValue
       - maxTransactionValue
       - requiredConfirmations

internal/adapters/dataproviders/bitcoin/derivative_wallet.go

@@ -110,14 +110,14 @@ func (wallet *DerivativeWallet) importPublicKey() error {
 	return errors.New("public key imported, rescan started, please wait for the rescan process to finish before initializing the server again")
 }
 
-func (wallet *DerivativeWallet) EstimateTxFees(toAddress string, value *entities.Wei) (*entities.Wei, error) {
+func (wallet *DerivativeWallet) EstimateTxFees(toAddress string, value *entities.Wei) (blockchain.BtcFeeEstimation, error) {
 	const quoteHashLength = 32
 
 	if _, err := btcutil.DecodeAddress(toAddress, wallet.conn.NetworkParams); err != nil {
-		return nil, err
+		return blockchain.BtcFeeEstimation{}, err
 	}
 	if err := EnsureLoadedBtcWallet(wallet.conn); err != nil {
-		return nil, err
+		return blockchain.BtcFeeEstimation{}, err
 	}
 
 	amountInSatoshi, _ := value.ToSatoshi().Int64()
@@ -128,11 +128,11 @@ func (wallet *DerivativeWallet) EstimateTxFees(toAddress string, value *entities
 
 	feeRate, err := wallet.estimateFeeRate()
 	if err != nil {
-		return nil, err
+		return blockchain.BtcFeeEstimation{}, err
 	}
 	changeAddress, err := wallet.rskAccount.BtcAddress()
 	if err != nil {
-		return nil, err
+		return blockchain.BtcFeeEstimation{}, err
 	}
 
 	opts := btcjson.WalletCreateFundedPsbtOpts{
@@ -144,14 +144,17 @@ func (wallet *DerivativeWallet) EstimateTxFees(toAddress string, value *entities
 
 	simulatedTx, err := wallet.conn.client.WalletCreateFundedPsbt(nil, output, nil, &opts, nil)
 	if err != nil {
-		return nil, err
+		return blockchain.BtcFeeEstimation{}, err
 	}
 	btcFee, err := btcutil.NewAmount(simulatedTx.Fee)
 	if err != nil {
-		return nil, err
+		return blockchain.BtcFeeEstimation{}, err
 	}
 	satoshiFee := btcFee.ToUnit(btcutil.AmountSatoshi)
-	return entities.SatoshiToWei(uint64(satoshiFee)), nil
+	return blockchain.BtcFeeEstimation{
+		Value:   entities.SatoshiToWei(uint64(satoshiFee)),
+		FeeRate: utils.NewBigFloat64(*feeRate),
+	}, nil
 }
 
 func (wallet *DerivativeWallet) GetBalance() (*entities.Wei, error) {

internal/adapters/dataproviders/bitcoin/derivative_wallet_test.go

@@ -14,6 +14,7 @@ import (
 	"github.com/rsksmart/liquidity-provider-server/internal/adapters/dataproviders/rootstock/account"
 	"github.com/rsksmart/liquidity-provider-server/internal/entities"
 	"github.com/rsksmart/liquidity-provider-server/internal/entities/blockchain"
+	"github.com/rsksmart/liquidity-provider-server/internal/entities/utils"
 	"github.com/rsksmart/liquidity-provider-server/test"
 	"github.com/rsksmart/liquidity-provider-server/test/mocks"
 	"github.com/stretchr/testify/assert"
@@ -415,7 +416,8 @@ func testEstimateFees(t *testing.T, rskAccount *account.RskAccount, addressInfo
 	require.NoError(t, err)
 	fee, err := wallet.EstimateTxFees(testnetAddress, amount)
 	require.NoError(t, err)
-	assert.Equal(t, entities.NewWei(600000000000000), fee)
+	assert.Equal(t, entities.NewWei(600000000000000), fee.Value)
+	assert.Equal(t, utils.NewBigFloat64(feeRate), fee.FeeRate)
 	client.AssertExpectations(t)
 }
 
@@ -441,7 +443,8 @@ func testEstimateFeesExtra(t *testing.T, rskAccount *account.RskAccount, address
 	require.NoError(t, err)
 	fee, err := wallet.EstimateTxFees(testnetAddress, amount)
 	require.NoError(t, err)
-	assert.Equal(t, entities.NewWei(600000000000000), fee)
+	assert.Equal(t, entities.NewWei(600000000000000), fee.Value)
+	assert.Equal(t, utils.NewBigFloat64(0.00011), fee.FeeRate)
 	client.AssertExpectations(t)
 }
 

internal/adapters/dataproviders/bitcoin/watchonly_wallet.go

@@ -53,8 +53,8 @@ func (wallet *WatchOnlyWallet) createWallet() (*btcjson.GetWalletInfoResult, err
 	return wallet.conn.client.GetWalletInfo()
 }
 
-func (wallet *WatchOnlyWallet) EstimateTxFees(toAddress string, value *entities.Wei) (*entities.Wei, error) {
-	return nil, errors.New("cannot estimate from a watch-only wallet")
+func (wallet *WatchOnlyWallet) EstimateTxFees(toAddress string, value *entities.Wei) (blockchain.BtcFeeEstimation, error) {
+	return blockchain.BtcFeeEstimation{}, errors.New("cannot estimate from a watch-only wallet")
 }
 
 func (wallet *WatchOnlyWallet) GetBalance() (*entities.Wei, error) {

internal/adapters/dataproviders/bitcoin/watchonly_wallet_test.go

@@ -166,7 +166,7 @@ func TestWatchOnlyWallet_EstimateTxFees(t *testing.T) {
 	require.NoError(t, err)
 	result, err := wallet.EstimateTxFees("address", nil)
 	require.ErrorContains(t, err, "cannot estimate from a watch-only wallet")
-	require.Nil(t, result)
+	require.Empty(t, result)
 }
 
 // TestWatchOnlyWallet_GetTransactions This test are reused from the bitcoind wallet tests suite since they share behavior

internal/adapters/dataproviders/database/mongo/common_test.go

@@ -106,3 +106,10 @@ func getClientAndCollectionMocks(collectionName string) (*mocks.DbClientBindingM
 	db.On("Collection", collectionName).Return(collection)
 	return client, collection
 }
+
+func getClientAndDatabaseMocks() (*mocks.DbClientBindingMock, *mocks.DbBindingMock) {
+	client := &mocks.DbClientBindingMock{}
+	db := &mocks.DbBindingMock{}
+	client.On("Database", mongo.DbName).Return(db)
+	return client, db
+}

internal/adapters/dataproviders/database/mongo/liquidity_provider_test.go

@@ -5,6 +5,7 @@ import (
 	"github.com/rsksmart/liquidity-provider-server/internal/adapters/dataproviders/database/mongo"
 	"github.com/rsksmart/liquidity-provider-server/internal/entities"
 	"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/test"
 	log "github.com/sirupsen/logrus"
 	"github.com/stretchr/testify/assert"
@@ -23,7 +24,8 @@ var peginTestConfig = &entities.Signed[liquidity_provider.PeginConfiguration]{
 		TimeForDeposit: 1,
 		CallTime:       2,
 		PenaltyFee:     entities.NewWei(3),
-		CallFee:        entities.NewWei(4),
+		FixedFee:       entities.NewWei(4),
+		FeePercentage:  utils.NewBigFloat64(4.5),
 		MaxValue:       entities.NewWei(5),
 		MinValue:       entities.NewWei(6),
 	},
@@ -36,7 +38,8 @@ var pegoutTestConfig = &entities.Signed[liquidity_provider.PegoutConfiguration]{
 		TimeForDeposit:       1,
 		ExpireTime:           2,
 		PenaltyFee:           entities.NewWei(3),
-		CallFee:              entities.NewWei(4),
+		FixedFee:             entities.NewWei(4),
+		FeePercentage:        utils.NewBigFloat64(4.5),
 		MaxValue:             entities.NewWei(5),
 		MinValue:             entities.NewWei(6),
 		ExpireBlocks:         7,
@@ -76,7 +79,7 @@ func TestLpMongoRepository_GetPeginConfiguration(t *testing.T) {
 	filter := bson.D{primitive.E{Key: "name", Value: mongo.ConfigurationName("pegin")}}
 	log.SetLevel(log.DebugLevel)
 	t.Run("pegin configuration read successfully", func(t *testing.T) {
-		const expectedLog = "READ interaction with db: {Value:{TimeForDeposit:1 CallTime:2 PenaltyFee:3 CallFee:4 MaxValue:5 MinValue:6} Signature:pegin signature Hash:pegin hash}"
+		const expectedLog = "READ interaction with db: {Value:{TimeForDeposit:1 CallTime:2 PenaltyFee:3 FixedFee:4 FeePercentage:4.5 MaxValue:5 MinValue:6} Signature:pegin signature Hash:pegin hash}"
 		client, collection := getClientAndCollectionMocks(mongo.LiquidityProviderCollection)
 		repo := mongo.NewLiquidityProviderRepository(mongo.NewConnection(client, time.Duration(1)))
 		collection.On("FindOne", mock.Anything, filter).
@@ -111,7 +114,7 @@ func TestLpMongoRepository_GetPegoutConfiguration(t *testing.T) {
 	filter := bson.D{primitive.E{Key: "name", Value: mongo.ConfigurationName("pegout")}}
 	log.SetLevel(log.DebugLevel)
 	t.Run("pegout configuration read successfully", func(t *testing.T) {
-		const expectedLog = "READ interaction with db: {Value:{TimeForDeposit:1 ExpireTime:2 PenaltyFee:3 CallFee:4 MaxValue:5 MinValue:6 ExpireBlocks:7 BridgeTransactionMin:8} Signature:pegout signature Hash:pegout hash}"
+		const expectedLog = "READ interaction with db: {Value:{TimeForDeposit:1 ExpireTime:2 PenaltyFee:3 FixedFee:4 FeePercentage:4.5 MaxValue:5 MinValue:6 ExpireBlocks:7 BridgeTransactionMin:8} Signature:pegout signature Hash:pegout hash}"
 		client, collection := getClientAndCollectionMocks(mongo.LiquidityProviderCollection)
 		repo := mongo.NewLiquidityProviderRepository(mongo.NewConnection(client, time.Duration(1)))
 		collection.On("FindOne", mock.Anything, filter).
@@ -216,7 +219,7 @@ func TestLpMongoRepository_UpsertPeginConfiguration(t *testing.T) {
 	configName := mongo.ConfigurationName("pegin")
 	filter := bson.D{primitive.E{Key: "name", Value: configName}}
 	t.Run("pegin configuration upserted successfully", func(t *testing.T) {
-		const expectedLog = "INSERT interaction with db: {Signed:{Value:{TimeForDeposit:1 CallTime:2 PenaltyFee:3 CallFee:4 MaxValue:5 MinValue:6} Signature:pegin signature Hash:pegin hash} Name:pegin}"
+		const expectedLog = "INSERT interaction with db: {Signed:{Value:{TimeForDeposit:1 CallTime:2 PenaltyFee:3 FixedFee:4 FeePercentage:4.5 MaxValue:5 MinValue:6} Signature:pegin signature Hash:pegin hash} Name:pegin}"
 		client, collection := getClientAndCollectionMocks(mongo.LiquidityProviderCollection)
 		repo := mongo.NewLiquidityProviderRepository(mongo.NewConnection(client, time.Duration(1)))
 		collection.On("ReplaceOne", mock.Anything, filter, mongo.StoredConfiguration[liquidity_provider.PeginConfiguration]{
@@ -243,7 +246,7 @@ func TestLpMongoRepository_UpsertPegoutConfiguration(t *testing.T) {
 	configName := mongo.ConfigurationName("pegout")
 	filter := bson.D{primitive.E{Key: "name", Value: configName}}
 	t.Run("pegout configuration upserted successfully", func(t *testing.T) {
-		const expectedLog = "INSERT interaction with db: {Signed:{Value:{TimeForDeposit:1 ExpireTime:2 PenaltyFee:3 CallFee:4 MaxValue:5 MinValue:6 ExpireBlocks:7 BridgeTransactionMin:8} Signature:pegout signature Hash:pegout hash} Name:pegout}"
+		const expectedLog = "INSERT interaction with db: {Signed:{Value:{TimeForDeposit:1 ExpireTime:2 PenaltyFee:3 FixedFee:4 FeePercentage:4.5 MaxValue:5 MinValue:6 ExpireBlocks:7 BridgeTransactionMin:8} Signature:pegout signature Hash:pegout hash} Name:pegout}"
 		client, collection := getClientAndCollectionMocks(mongo.LiquidityProviderCollection)
 		repo := mongo.NewLiquidityProviderRepository(mongo.NewConnection(client, time.Duration(1)))
 		collection.On("ReplaceOne", mock.Anything, filter, mongo.StoredConfiguration[liquidity_provider.PegoutConfiguration]{