Merge pull request #869 from rsksmart/Stable-Test

v2.4.0 -> master

Author: Luisfc68

.github/dependabot.yml

@@ -1,22 +1,128 @@
 version: 2
+
 updates:
-  - package-ecosystem: 'gomod'
+  # Go modules - Minor and Patch updates
+  - package-ecosystem: "gomod"
     directory: "/"
+    target-branch: QA-Test
+    schedule:
+      interval: "weekly"
+    # Wait at least 10 days after a new version is released before opening a PR
+    cooldown:
+      default-days: 10
+    labels:
+      - "dependencies"
+      - "go"
+    # one PR per week that groups BOTH minor + patch updates
+    groups:
+      go-updates:
+        applies-to: version-updates
+        patterns:
+          - "*"
+        update-types:
+          - minor
+          - patch
+
+  # Go modules - Security updates
+  - package-ecosystem: "gomod"
+    directory: "/"
+    target-branch: master
     schedule:
       interval: "daily"
+    # Wait at least 1 day after a security update is released before opening a PR
+    cooldown:
+      default-days: 1
+    labels:
+      - "dependencies"
+      - "go"
+      - "security"
+    # one PR that groups security updates
+    groups:
+      security:
+        applies-to: security-updates
+        patterns:
+          - "*"
+
+  # GitHub Actions - Minor and Patch updates
+  - package-ecosystem: "github-actions"
+    directory: "/"
     target-branch: QA-Test
-  - package-ecosystem: github-actions
+    schedule:
+      interval: "weekly"
+    # Wait at least 10 days after a new version is released before opening a PR
+    cooldown:
+      default-days: 10
+    labels:
+      - "dependencies"
+      - "github_actions"
+    # one PR per week that groups BOTH minor + patch updates
+    groups:
+      actions-updates:
+        applies-to: version-updates
+        patterns:
+          - "*"
+        update-types:
+          - minor
+          - patch
+
+  # GitHub Actions - Security updates
+  - package-ecosystem: "github-actions"
     directory: "/"
+    target-branch: master
     schedule:
       interval: "daily"
+    # Wait at least 1 day after a security update is released before opening a PR
+    cooldown:
+      default-days: 1
+    labels:
+      - "dependencies"
+      - "github_actions"
+      - "security"
+    # one PR that groups security updates
+    groups:
+      security:
+        applies-to: security-updates
+        patterns:
+          - "*"
+
+  # Docker - Minor and Patch updates
+  - package-ecosystem: "docker"
+    directory: "/"
     target-branch: QA-Test
+    schedule:
+      interval: "weekly"
+    # Wait at least 10 days after a new version is released before opening a PR
+    cooldown:
+      default-days: 10
+    labels:
+      - "dependencies"
+      - "docker"
+    # one PR per week that groups BOTH minor + patch updates
     groups:
-      dependencies:
-        dependency-type: production
-      dev-dependencies:
-        dependency-type: development
-  - package-ecosystem: docker
+      docker-updates:
+        applies-to: version-updates
+        patterns:
+          - "*"
+        update-types:
+          - minor
+          - patch
+
+  # Docker - Security updates
+  - package-ecosystem: "docker"
     directory: "/"
+    target-branch: master
     schedule:
       interval: "daily"
-    target-branch: QA-Test
+    # Wait at least 1 day after a security update is released before opening a PR
+    cooldown:
+      default-days: 1
+    labels:
+      - "dependencies"
+      - "docker"
+      - "security"
+    # one PR that groups security updates
+    groups:
+      security:
+        applies-to: security-updates
+        patterns:
+          - "*"

.gitignore

@@ -27,4 +27,7 @@ build/
 !sample-config.env
 /**/*.env
 /**/.env*
-.cursorrules
+
+/coverage/
+
+/.cursor/

.mockery.yaml

@@ -44,6 +44,10 @@ packages:
       SetGeneralConfigUseCase:
       GetPegoutReportUseCase:
       GetPeginReportUseCase:
+      RecommendedPegoutUseCase:
+      RecommendedPeginUseCase:
+      GetRevenueReportUseCase:
+      GetSummariesReportUseCase:
   github.com/rsksmart/liquidity-provider-server/internal/entities/liquidity_provider:
     interfaces:
       LiquidityProviderRepository:
@@ -60,6 +64,7 @@ packages:
     interfaces:
       BitcoinWallet:
       RootstockRpcServer:
+      LiquidityBridgeContract:
   github.com/rsksmart/liquidity-provider-server/internal/entities/rootstock:
     interfaces:
       BatchPegOutRepository:

Makefile

@@ -17,7 +17,7 @@ tools: download
 	go install golang.org/x/vuln/cmd/govulncheck@latest
 	pip3 install pre-commit && pre-commit install
 	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell go env GOPATH)/bin v1.63.4
-	go install github.com/vektra/mockery/v2@v2.53.1  	# ensures mockery version 2.53.1 is installed
+	go install github.com/vektra/mockery/v2@v2.53.0  	# ensures mockery version 2.53.0 is installed
 
 download:
 	go mod download

OpenApi.yml

@@ -159,11 +159,11 @@ components:
     GetTransactionsItem:
       properties:
         amount:
-          $ref: '#/components/schemas/Wei'
+          $ref: '#/components/schemas/'
         callFee:
-          $ref: '#/components/schemas/Wei'
+          $ref: '#/components/schemas/'
         gasFee:
-          $ref: '#/components/schemas/Wei'
+          $ref: '#/components/schemas/'
         quoteHash:
           type: string
         status:
@@ -175,11 +175,11 @@ components:
           items:
             properties:
               amount:
-                $ref: '#/components/schemas/Wei'
+                $ref: '#/components/schemas/'
               callFee:
-                $ref: '#/components/schemas/Wei'
+                $ref: '#/components/schemas/'
               gasFee:
-                $ref: '#/components/schemas/Wei'
+                $ref: '#/components/schemas/'
               quoteHash:
                 type: string
               status:
@@ -574,8 +574,8 @@ components:
     ProviderDetail:
       properties:
         fee:
-          $ref: '#/components/schemas/'
           deprecated: true
+          $ref: '#/components/schemas/'
         feePercentage:
           type: number
         fixedFee:
@@ -612,6 +612,29 @@ components:
       - pegin
       - pegout
       type: object
+    RecommendedOperationDTO:
+      properties:
+        estimatedCallFee:
+          description: Estimated call fee if a quote is created with the recommended
+            amount
+          example: "100000"
+        estimatedGasFee:
+          description: Estimated gas fee if a quote is created with the recommended
+            amount
+          example: "100000"
+        estimatedProductFee:
+          description: Estimated product fee if a quote is created with the recommended
+            amount
+          example: "100000"
+        recommendedQuoteValue:
+          description: Recommended quote value for the input amount
+          example: "100000"
+      required:
+      - recommendedQuoteValue
+      - estimatedCallFee
+      - estimatedGasFee
+      - estimatedProductFee
+      type: object
     RetainedPeginQuoteDTO:
       properties:
         callForUserTxHash:
@@ -779,8 +802,6 @@ components:
         rbtcLockingCap:
           $ref: '#/components/schemas/'
       type: object
-    Wei: {}
-    entities.Wei: {}
     pkg.AcceptAuthenticatedQuoteRequest:
       properties:
         quoteHash:
@@ -853,6 +874,29 @@ components:
       required:
       - collateral
       type: object
+    pkg.RecommendedOperationDTO:
+      properties:
+        estimatedCallFee:
+          description: Estimated call fee if a quote is created with the recommended
+            amount
+          example: "100000"
+        estimatedGasFee:
+          description: Estimated gas fee if a quote is created with the recommended
+            amount
+          example: "100000"
+        estimatedProductFee:
+          description: Estimated product fee if a quote is created with the recommended
+            amount
+          example: "100000"
+        recommendedQuoteValue:
+          description: Recommended quote value for the input amount
+          example: "100000"
+      required:
+      - recommendedQuoteValue
+      - estimatedCallFee
+      - estimatedGasFee
+      - estimatedProductFee
+      type: object
     pkg.TrustedAccountRequest:
       properties:
         address:
@@ -1079,6 +1123,45 @@ paths:
                 $ref: '#/components/schemas/GetPeginQuoteResponse'
           description: ""
       summary: Pegin GetQuote
+  /pegin/recommended:
+    get:
+      description: ' Returns the recommended quote value to create a quote whose total
+        payment is the input amount'
+      parameters:
+      - description: Amount in wei expected to use as total payment for the quote
+        in: query
+        name: amount
+        required: true
+        schema:
+          description: Amount in wei expected to use as total payment for the quote
+          format: string
+          type: string
+      - description: Destination address for the pegin. Is optional, but if provided,
+          it will increase the estimation accuracy.
+        in: query
+        name: destination_address
+        schema:
+          description: Destination address for the pegin. Is optional, but if provided,
+            it will increase the estimation accuracy.
+          format: string
+          type: string
+      - description: Hex-encoded data payload to include in the pegin transaction.
+          Is optional, but if provided, it will increase the estimation accuracy.
+        in: query
+        name: data
+        schema:
+          description: Hex-encoded data payload to include in the pegin transaction.
+            Is optional, but if provided, it will increase the estimation accuracy.
+          format: string
+          type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/RecommendedOperationDTO'
+          description: Recommended operation object
+      summary: Recommended pegin
   /pegin/status:
     get:
       description: ' Returns the status of an accepted pegin quote'
@@ -1192,6 +1275,38 @@ paths:
                 $ref: '#/components/schemas/GetPegoutQuoteResponse'
           description: ""
       summary: Pegout GetQuote
+  /pegout/recommended:
+    get:
+      description: ' Returns the recommended quote value to create a quote whose total
+        payment is the input amount'
+      parameters:
+      - description: Amount in wei expected to use as total payment for the quote
+        in: query
+        name: amount
+        required: true
+        schema:
+          description: Amount in wei expected to use as total payment for the quote
+          format: string
+          type: string
+      - description: 'Destination address type for the pegout. Is optional, but if
+          provided, it will  increase the estimation accuracy. Must be one of: p2pkh,
+          p2sh, p2wpkh, p2wsh, p2tr'
+        in: query
+        name: destination_type
+        schema:
+          description: 'Destination address type for the pegout. Is optional, but
+            if provided, it will  increase the estimation accuracy. Must be one of:
+            p2pkh, p2sh, p2wpkh, p2wsh, p2tr'
+          format: string
+          type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/RecommendedOperationDTO'
+          description: Recommended operation object
+      summary: Recommended pegout
   /pegout/status:
     get:
       description: ' Returns the status of an accepted pegout quote'

cmd/utils/refund_user_pegout/refund_user_pegout_test.go

@@ -92,7 +92,7 @@ func TestParseRefundUserPegOutScriptInput(t *testing.T) {
 
 func TestRefundUserPegOut(t *testing.T) {
 	t.Run("should execute refund user peg out successfully", func(t *testing.T) {
-		lbc := &mocks.LbcMock{}
+		lbc := &mocks.LiquidityBridgeContractMock{}
 		expectedTxHash := test.AnyHash
 
 		// Setup mock expectations