Merge pull request #684 from rsksmart/QA-Test

QA-Test -> Stable-Test - v2.1.2

Author: Luisfc68

.github/CODEOWNERS

@@ -0,0 +1 @@
+*       @Luisfc68 @MaximStanciu8 @gsoares85 @Dominikkq @AndresQuijano

.github/workflows/ci.yml

@@ -56,4 +56,5 @@ jobs:
       - name: golangci-lint
         uses: golangci/golangci-lint-action@ec5d18412c0aeab7936cb16880d708ba2a64e1ae #v6.2.0
         with:
-          version: v1.55.2
+          version: v1.63.4
+          skip-pkg-cache: true

.github/workflows/codeql.yml

@@ -2,9 +2,8 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ "master", "Stable-Test", "QA-Test"]
+    branches: [ "master", "Stable-Test", "QA-Test", "flyover-*" ]
   pull_request:
-    branches: [ "master", "Stable-Test", "QA-Test"]
   schedule:
     - cron: "0 0 * * 1"
 

.github/workflows/e2e.yml

@@ -27,10 +27,11 @@ jobs:
         run: cd docker-compose/local/ && ./gh-action-env.sh $GITHUB_TOKEN
 
       - name: Building LPS environment...
-        run: cd docker-compose/local/ && LPS_STAGE=regtest sh lps-env.sh up
+        run: cd docker-compose/local/ && LPS_STAGE=regtest ./lps-env.sh up
+        shell: bash
 
       - name: Checking LPS health...
         run: curl -X GET http://localhost:8080/health
 
       - name: Shutting LPS environment down...
-        run: cd docker-compose/local/ && LPS_STAGE=regtest sh lps-env.sh down
+        run: cd docker-compose/local/ && LPS_STAGE=regtest ./lps-env.sh down

.gitignore

@@ -23,6 +23,7 @@ build/
 /utils/*
 /**/.env.regtest
 /**/gh_token.txt
+/**/geth_keystore/
 /**/local/cookie_jar.txt
 !sample-config.env
 /**/*.env

.golangci.yml

@@ -2,14 +2,30 @@ run:
   allow-parallel-runners: true
   timeout: 3m
   tests: true
-  skip-dirs:
+issues:
+  exclude-dirs:
     - internal/adapters/dataproviders/rootstock/bindings
+    - test/mocks
 linters:
   presets:
     - bugs
     - complexity
     - unused
     - performance
 linters-settings:
+  errcheck:
+   check-type-assertions: true
+   check-blank: true
+  govet:
+    enable:
+      - nilness
+      - defers
+      - lostcancel
+      - nilfunc
+      - shadow
+      - unusedwrite
   exhaustive:
-    default-signifies-exhaustive: true
+    default-signifies-exhaustive: true
+  gosec:
+    excludes:
+      - G115 # TODO update project to cast safely

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/golangci/golangci-lint
-    rev: v1.55.2
+    rev: v1.63.4
     hooks:
       - id: golangci-lint-full
   - repo: https://github.com/commitizen-tools/commitizen

Makefile

@@ -1,15 +1,22 @@
-.PHONY: test all clean
+.PHONY: test all clean utils
 
 COVER_FILE = coverage/cover.out
 TEMPORAL_COVER_FILE =$(shell pwd)/coverage/cover.out.temp
 
 filter_coverage_file = grep -v "internal/adapters/dataproviders/rootstock/bindings" $(1) > coverage/temp.txt && mv coverage/temp.txt $(1)
 
+define utils_build
+	CGO_ENABLED=0 go build -v -o ./utils/update_provider_url ./cmd/utils/update_provider_url/update_provider_url.go
+  	CGO_ENABLED=0 go build -v -o ./utils/register_pegin ./cmd/utils/register_pegin/register_pegin.go
+  	CGO_ENABLED=0 go build -v -o ./utils/refund_user_pegout ./cmd/utils/refund_user_pegout/refund_user_pegout.go
+  	CGO_ENABLED=0 go build -v -o ./utils/key_conversion ./cmd/utils/key_conversion/key_conversion.go
+endef
+
 tools: download
 	go install github.com/parvez3019/go-swagger3@fef3d30b0707883c389261bf26297eebd10d7216 #v1.0.3
 	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.55.2
+	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell go env GOPATH)/bin v1.63.4
 	brew install mockery && brew upgrade mockery 	# installation with brew is because mockery team doesnt recommend to install with go install, if you don't have brew feel free to comment this line and install mockery with other method
 
 download:
@@ -23,12 +30,17 @@ validation: lint
 	go mod verify
 	govulncheck ./... # should fail on non informational vulnerabilities
 
+COMMIT_TAG ?= $(shell git describe --exact-match --tags)
 COMMIT_HASH ?= $(shell git rev-parse HEAD)
 SOURCE_VERSION := $(COMMIT_HASH)
+SOURCE_TAG := $(COMMIT_TAG)
+
 build: download
 	mkdir -p build && cd build
-	@echo "Building liquidity-provider-server $(SOURCE_VERSION)"
-	CGO_ENABLED=0 go build -v -installsuffix 'static' -ldflags="-s -X 'main.BuildVersion=$(SOURCE_VERSION)' -X 'main.BuildTime=$(shell date)'" -o ./build/liquidity-provider-server ./cmd/application/main.go
+	@echo "Building liquidity-provider-server $(SOURCE_TAG) ($(SOURCE_VERSION))"
+	CGO_ENABLED=0 go build -v -installsuffix 'static' \
+	-ldflags="-s -X 'main.BuildVersion=$(SOURCE_VERSION)' -X 'main.BuildTime=$(shell date)' -X 'github.com/rsksmart/liquidity-provider-server/internal/usecases/liquidity_provider.BuildVersion=$(SOURCE_TAG)' -X 'github.com/rsksmart/liquidity-provider-server/internal/usecases/liquidity_provider.BuildRevision=$(SOURCE_VERSION)'" \
+	-o ./build/liquidity-provider-server ./cmd/application/main.go
 
 api:
 	go-swagger3 --module-path . \
@@ -38,26 +50,40 @@ api:
 
 coverage: clean
 	mkdir -p coverage
-	go test -v -race -covermode=atomic -coverpkg=./pkg/...,./internal/...,./cmd/... -coverprofile=$(TEMPORAL_COVER_FILE) ./pkg/... ./internal/... ./cmd/...
+	go test -timeout 30m -v -race -covermode=atomic -coverpkg=./pkg/...,./internal/...,./cmd/... -coverprofile=$(TEMPORAL_COVER_FILE) ./pkg/... ./internal/... ./cmd/...
 	$(call filter_coverage_file, $(TEMPORAL_COVER_FILE))
 	go tool cover -func "$(TEMPORAL_COVER_FILE)" && go tool cover -html="$(TEMPORAL_COVER_FILE)"
 	rm $(TEMPORAL_COVER_FILE)
 
 coverage-report: clean
 	mkdir -p coverage
-	go test -v -race -covermode=atomic -coverpkg=./pkg/...,./internal/...,./cmd/... -coverprofile=$(COVER_FILE) ./pkg/... ./internal/... ./cmd/...
+	go test -timeout 30m -v -race -covermode=atomic -coverpkg=./pkg/...,./internal/...,./cmd/... -coverprofile=$(COVER_FILE) ./pkg/... ./internal/... ./cmd/...
 	$(call filter_coverage_file, $(COVER_FILE))
 
 test: clean
 	mkdir -p coverage
-	go test -v -race -covermode=atomic -coverpkg=./pkg/...,./internal/...,./cmd/... -coverprofile=$(TEMPORAL_COVER_FILE)  ./pkg/... ./internal/... ./cmd/...
+	go test -timeout 30m -v -race -covermode=atomic -coverpkg=./pkg/...,./internal/...,./cmd/... -coverprofile=$(TEMPORAL_COVER_FILE)  ./pkg/... ./internal/... ./cmd/...
 	$(call filter_coverage_file, $(TEMPORAL_COVER_FILE))
 	go tool cover -func $(TEMPORAL_COVER_FILE)
 	rm $(TEMPORAL_COVER_FILE)
 
 clean:
 	rm -rf build $(TEMPORAL_COVER_FILE)
 
-utils:
-	mkdir -p utils && cd utils
-	CGO_ENABLED=0 go build -v -o ./utils/update_provider_url ./cmd/utils/update_provider_url.go
+utils: download
+	rm -rf utils
+	mkdir -p utils
+	$(utils_build)
+
+utils-docker:
+	rm -rf utils
+	mkdir -p utils
+	docker build -f docker-compose/utils/Dockerfile --output=utils .
+
+MONITOR_PORT ?= 8090
+monitoring:
+	docker build -f docker-compose/monitoring/Dockerfile -t monitoring .
+	docker run \
+		-p $(MONITOR_PORT):$(MONITOR_PORT) \
+		-e MONITOR_PORT=$(MONITOR_PORT) \
+		monitoring

OpenApi.yml

@@ -604,6 +604,20 @@ components:
       - refundPegoutTxHash
       - bridgeRefundTxHash
       type: object
+    ServerInfoDTO:
+      properties:
+        revision:
+          description: Version commit hash
+          example: b7bf393a2b1cedde8ee15b00780f44e6e5d2ba9d
+          type: string
+        version:
+          description: Server version tag
+          example: v1.0.0
+          type: string
+      required:
+      - version
+      - revision
+      type: object
     Services:
       properties:
         btc:
@@ -983,6 +997,17 @@ paths:
                 $ref: '#/components/schemas/DepositEventDTO'
           description: Successfully retrieved the user quotes
       summary: GetUserQuotes
+  /version:
+    get:
+      description: ' Returns the server version and revision'
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ServerInfoDTO'
+          description: ""
+      summary: Get server version
 servers:
 - description: ' Testnet'
   url: https://lps.testnet.flyover.rif.technology

README.md

@@ -56,6 +56,35 @@ mentioned before are the minimal dependencies, but in order to run a fully funct
 The [cmd/utils](cmd/utils) directory contains scripts with different utilities for the liquidity providers. You can either run them directly
 with `go run` or build them with `make utils`. You can run the scripts with the `--help` flag to see the available options. The current utilities are:
 - **update_provider_url**: updates the URL of a liquidity provider provided when the discovery function of the Liquidity Bridge Contract is executed.
+- **register_pegin**: register a PegIn transaction within the Liquidity Bridge Contract. Most times, this script is only required to execute refunds
+on special cases. This script requires an input file whose structure can be found [the input-example.json](cmd/utils/register_pegin/input-example.json) file.
+- **refund_user_pegout**: executes a refund for a user's peg-out operation through the Liquidity Bridge Contract. This is used when a peg-out operation needs to be refunded back to the user's RSK address. The script requires the quote hash of the operation to refund.
+- **key_conversion**: shows the corresponding BTC and RSK address for a given private key and encrypts it into a keystore, accepts the key either in WIF or hex format. The key can be provided through the terminal, a file or an existing keystore.
+
+### Monitoring Service
+The project includes a Bitcoin balance monitoring service that tracks specified BTC addresses and exposes metrics at `http://<host>:8080/metrics` using Prometheus `https://prometheus.io/`.
+
+To run the monitoring service with the default port (8090):
+```bash
+make monitoring
+```
+
+To run the monitoring service with a custom port (e.g., 8091):
+```bash
+make monitoring MONITOR_PORT=8091
+```
+
+The service is configured in `docker-compose/monitoring/src/config.ts` and supports both testnet and mainnet monitoring:
+
+- MONITORED_ADDRESSES: The set of addresses to be monitored. Each address should have an alias that will be used in the metrics.
+- MONITOR_CONFIG: The configuration for the monitoring service.
+  - pollingIntervalSeconds: How often the service will check the bitcoin balance of the monitored addresses in seconds.
+  - monitorName: The name of the monitoring service.
+  - network: The network to monitor (mainnet or testnet).
+  - port: The port where the service will be exposed.
+
+The service can be configured to monitor other addresses by modifying the `MONITORED_ADDRESSES` array in `docker-compose/monitoring/src/config.ts`.
+
 
 ### More information
 If you're looking forward to integrate with Flyover Protocol then you can check the [Flyover SDK repository](https://github.com/rsksmart/unified-bridges-sdk/tree/main/packages/flyover-sdk).