Merge pull request #435 from rsksmart/v2.5.0-fixes

V2.5.0 fixes

Author: Luisfc68

.github/workflows/ci.yml

@@ -7,6 +7,7 @@ on: [push, pull_request, workflow_dispatch]
 
 permissions:
   contents: read
+  packages: read
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:

.github/workflows/fuzz.yml

@@ -0,0 +1,56 @@
+name: Fuzz test smart contracts
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - QA-Test
+      - Stable-Test
+      - master
+      - "v*.*.*"
+  pull_request:
+    branches:
+      - QA-Test
+      - Stable-Test
+      - master
+      - "v*.*.*"
+
+permissions:
+  contents: read
+  packages: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Use Node.js 20.15.1
+        uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
+        with:
+          node-version: "20.15.1"
+
+      - name: NPM Login
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npm config set //npm.pkg.github.com/:_authToken $GITHUB_TOKEN
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: "Install Foundry"
+        uses: "foundry-rs/foundry-toolchain@50d5a8956f2e319df19e6b57539d7e2acb9f8c1e" # v1.5.0
+        with:
+          version: stable
+
+      - name: Lint contracts
+        run: npm run lint:sol
+
+      - name: Compile contracts
+        run: npm run compile
+
+      - name: Fuzz test smart contracts
+        run: npm run test:fuzz
+
+      - name: Invariant test smart contracts
+        run: npm run test:invariant

Makefile

@@ -6,7 +6,7 @@ NETWORK ?= testnet
 FORK_BLOCK ?= latest
 VERIFY ?= false
 BROADCAST ?= true
-GAS_LIMIT ?= 10000000
+GAS_LIMIT ?= 100000000
 GAS_PRICE ?= 0
 PRIORITY_GAS_PRICE ?= 0
 
@@ -1071,6 +1071,12 @@ safe-change-owner: validate-deploy change-owner-fork
 docs:
 	@echo "Documentation is available in docs/FOUNDRY_MAKEFILE_GUIDE.md"
 
+# Invariant tests
+.PHONY: test-invariant
+test-invariant:
+	@echo "Running invariant tests..."
+	forge test --match-path "test/invariant/**/*.t.sol" -vv
+
 # Catch-all target for hash-quote arguments (pegin/pegout, network names, file paths)
 # This prevents make from complaining about unknown targets when using: make hash-quote pegin testnet
 ifneq (,$(findstring hash-quote,$(MAKECMDGOALS)))

README.md

@@ -48,7 +48,6 @@ PegIn Quotes consist of:
         uint callTime;                          // the time (in seconds) that the LP has to perform the call on behalf of the user after the deposit achieves the number of confirmations
         uint depositConfirmations;              // the number of confirmations that the LP requires before making the call
         bool callOnRegister:                    // a boolean value indicating whether the callForUser can be called on registerPegIn.
-        uint256 productFeeAmount;               // the fee payed to the network DAO
         uint256 gasFee;                         // the fee payed to the LP to cover the gas of the RSK transaction
     }
 
@@ -72,7 +71,6 @@ PegOut Quotes consist of:
         uint transferTime;                      // the time (in seconds) that the LP has to transfer on behalf of the user after the deposit achieves the number of confirmations
         uint expireDate;                        // the timestamp to consider the quote expired
         uint expireBlock;                       // the block number to consider the quote expired
-        uint256 productFeeAmount;               // the fee payed to the network DAO
         uint256 gasFee;                         // the fee payed to the LP to cover the fee of the BTC transaction
     }
 
@@ -242,6 +240,17 @@ Validates that the LP made the deposit of the service and applies the correspond
     * partialMerkleTree: PMT to validate transaction
     * merkleBranchHashes: merkleBranchHashes used by the bridge to validate transaction
 
+#### Peg-out BTC transaction structure (required)
+
+For `refundPegOut`, the contract expects a Bitcoin transaction with two specific outputs used to prove the LP delivered the service:
+
+1. **Payment output** at index `0`: pays the user destination (`quote.depositAddress`) with the peg-out amount.
+2. **Quote-hash output** at index `1`: an `OP_RETURN` output containing the peg-out quote hash.
+
+The structure is intentionally enforced by contract validation for peg-out refunding. Bitcoin consensus does not enforce output ordering, but `refundPegOut` currently validates these outputs using fixed positions. If the required outputs are present but swapped, validation fails and the LP cannot be refunded through this function.
+
+`btcTx` must be the raw Bitcoin transaction serialization without witness data.
+
 ### **refundUserPegOut**
 
     function refundUserPegOut(
@@ -399,8 +408,10 @@ This project uses **Foundry** for smart contract development and deployment. We
 
 ```bash
 # Setup environment
+# Optional: create and activate a Python virtualenv before installing
 cp example.env .env
 make install
+npm ci
 make build
 
 # Test deployment (simulation)

addresses.json

@@ -148,35 +148,39 @@
   },
   "rskDevelopment": {
     "SignatureValidator": {
-      "address": "0x4008Db45ff34dD9839e3bd69B371e393A8fd2257",
+      "address": "0xb5698C36773aE6eAE9F8D399beF24B33C3519454",
       "deployed": true
     },
     "Quotes": {
-      "address": "0x0762F13Fd699f2a9B7611D91c89C2Ebc041DFcEC",
+      "address": "0xC2Fac578B41e092543db8Dda0C990F64Bb18b6F5",
       "deployed": true
     },
     "BtcUtils": {
-      "address": "0x229ff422d64d3a3c9a4e77c155e24e89aa2c5958",
+      "address": "0xddFb077cD156095e31ADE2e53F5153d53b770054",
       "deployed": true
     },
     "FlyoverDiscovery": {
-      "address": "0x9850388C612adAcb1F7DB1EBb2Ca88573b3De4aA",
+      "address": "0xe16b04a1a87aC65a4aF8D46a8b797D0d46572408",
       "deployed": true
     },
     "PegOutContract": {
-      "address": "0xEe3254eE028a2C7971B6774210FdCc05B3267Ca4",
+      "address": "0x15c240d9Fb91224c0d3Ca9b04Ff63844aA3dF040",
       "deployed": true
     },
     "PegInContract": {
-      "address": "0xC023B0dF3794cc8a104A6c367796C1f7FACE6300",
+      "address": "0xcf871fB1D934301dD161A3AD5eB50379527B1CDc",
       "deployed": true
     },
     "CollateralManagementContract": {
-      "address": "0x22f14668D476b0067fF96dD5b4B2d3C881991317",
+      "address": "0x4036AC5c4C24C4Ae11BD29D709Dd5d057ca8F39d",
       "deployed": true
     },
     "ProxyAdmin": {
-      "address": "0xB29D7e452054de57189Ea8dC645293C38F6D20Dd",
+      "address": "0x46b2Ff811543FA43f5c3378972571e239624E69B",
+      "deployed": true
+    },
+    "PauseRegistry": {
+      "address": "0x2FDe2c000AB628D6F4B72f671eA8C2f4Be7A451f",
       "deployed": true
     }
   }