Feature/GBI-2808 - PegOut Contract implementation by Luisfc68 · Pull Request #349 · rsksmart/liquidity-bridge-contract

Luisfc68 · 2025-08-04T20:13:02Z

What

Add PegOutContract implementation
Add unit tests for the PegOut contract
Add OwnableDaoContributorUpgradeable to standardise the way the new contracts contribute to the DAO
Add natspec documentation for the new contracts
Run test in every PR

Task

https://rsklabs.atlassian.net/browse/GBI-2808

contracts/DaoContributor.sol

+    function claimContribution() external onlyOwner nonReentrant {
+        DaoContributorStorage storage $ = _getContributorStorage();
+        uint256 amount = $.currentContribution;
+        $.currentContribution = 0;
+        address feeCollector = $.feeCollector;
+        if (amount == 0) revert NoFees();
+        if (feeCollector == address(0)) revert FeeCollectorUnset();
+        if (amount > address(this).balance) revert Flyover.NoBalance(amount, address(this).balance);
+        emit DaoFeesClaimed(msg.sender, feeCollector, amount);
+        (bool sent, bytes memory reason) = feeCollector.call{value: amount}("");
+        if (!sent) revert Flyover.PaymentFailed(feeCollector, amount, reason);
+    }


contracts/DaoContributor.sol

+    function __OwnableDaoContributor_init(
+        address owner,
+        uint256 feePercentage,
+        address payable feeCollector
+    ) internal onlyInitializing {
+        __ReentrancyGuard_init_unchained();
+        __Ownable_init_unchained(owner);
+        DaoContributorStorage storage $ = _getContributorStorage();
+        $.feePercentage = feePercentage;
+        $.feeCollector = feeCollector;
+    }


contracts/DaoContributor.sol

+    function _getContributorStorage() private pure returns (DaoContributorStorage storage $) {
+        assembly {
+            $.slot := _CONTRIBUTOR_STORAGE_LOCATION
+        }
+    }


contracts/PegOutContract.sol

+    function depositPegOut(
+        Quotes.PegOutQuote calldata quote,
+        bytes calldata signature
+    ) external payable nonReentrant override {
+        if(!_collateralManagement.isRegistered(_PEG_TYPE, quote.lpRskAddress)) {
+            revert Flyover.ProviderNotRegistered(quote.lpRskAddress);
+        }
+        uint256 requiredAmount = quote.value + quote.callFee + quote.productFeeAmount + quote.gasFee;
+        if (msg.value < requiredAmount) {
+            revert InsufficientAmount(msg.value, requiredAmount);
+        }
+        if (quote.depositDateLimit < block.timestamp || quote.expireDate < block.timestamp) {
+            revert QuoteExpiredByTime(quote.depositDateLimit, quote.expireDate);
+        }
+        if (quote.expireBlock < block.number) {
+            revert QuoteExpiredByBlocks(quote.expireBlock);
+        }
+
+        bytes32 quoteHash = _hashPegOutQuote(quote);
+        if (!SignatureValidator.verify(quote.lpRskAddress, quoteHash, signature)) {
+            revert SignatureValidator.IncorrectSignature(quote.lpRskAddress, quoteHash, signature);
+        }
+
+        Quotes.PegOutQuote storage registeredQuote = _pegOutQuotes[quoteHash];
+
+        if (_isQuoteCompleted(quoteHash)) {
+            revert QuoteAlreadyCompleted(quoteHash);
+        }
+        if (registeredQuote.lbcAddress != address(0)) {
+            revert QuoteAlreadyRegistered(quoteHash);
+        }
+
+        _pegOutQuotes[quoteHash] = quote;
+        _pegOutRegistry[quoteHash].depositTimestamp = block.timestamp;
+
+        emit PegOutDeposit(quoteHash, msg.sender, msg.value, block.timestamp);
+
+        if (dustThreshold > msg.value - requiredAmount) {
+            return;
+        }
+
+        uint256 change = msg.value - requiredAmount;
+        emit PegOutChangePaid(quoteHash, quote.rskRefundAddress, change);
+        (bool sent, bytes memory reason) = quote.rskRefundAddress.call{value: change}("");
+        if (!sent) {
+            revert Flyover.PaymentFailed(quote.rskRefundAddress, change, reason);
+        }
+    }


contracts/PegOutContract.sol

+    function depositPegOut(
+        Quotes.PegOutQuote calldata quote,
+        bytes calldata signature
+    ) external payable nonReentrant override {
+        if(!_collateralManagement.isRegistered(_PEG_TYPE, quote.lpRskAddress)) {
+            revert Flyover.ProviderNotRegistered(quote.lpRskAddress);
+        }
+        uint256 requiredAmount = quote.value + quote.callFee + quote.productFeeAmount + quote.gasFee;
+        if (msg.value < requiredAmount) {
+            revert InsufficientAmount(msg.value, requiredAmount);
+        }
+        if (quote.depositDateLimit < block.timestamp || quote.expireDate < block.timestamp) {
+            revert QuoteExpiredByTime(quote.depositDateLimit, quote.expireDate);
+        }
+        if (quote.expireBlock < block.number) {
+            revert QuoteExpiredByBlocks(quote.expireBlock);
+        }
+
+        bytes32 quoteHash = _hashPegOutQuote(quote);
+        if (!SignatureValidator.verify(quote.lpRskAddress, quoteHash, signature)) {
+            revert SignatureValidator.IncorrectSignature(quote.lpRskAddress, quoteHash, signature);
+        }
+
+        Quotes.PegOutQuote storage registeredQuote = _pegOutQuotes[quoteHash];
+
+        if (_isQuoteCompleted(quoteHash)) {
+            revert QuoteAlreadyCompleted(quoteHash);
+        }
+        if (registeredQuote.lbcAddress != address(0)) {
+            revert QuoteAlreadyRegistered(quoteHash);
+        }
+
+        _pegOutQuotes[quoteHash] = quote;
+        _pegOutRegistry[quoteHash].depositTimestamp = block.timestamp;
+
+        emit PegOutDeposit(quoteHash, msg.sender, msg.value, block.timestamp);
+
+        if (dustThreshold > msg.value - requiredAmount) {
+            return;
+        }
+
+        uint256 change = msg.value - requiredAmount;
+        emit PegOutChangePaid(quoteHash, quote.rskRefundAddress, change);
+        (bool sent, bytes memory reason) = quote.rskRefundAddress.call{value: change}("");
+        if (!sent) {
+            revert Flyover.PaymentFailed(quote.rskRefundAddress, change, reason);
+        }
+    }


contracts/PegOutContract.sol

+    function refundUserPegOut(bytes32 quoteHash) external nonReentrant override {
+        Quotes.PegOutQuote memory quote = _pegOutQuotes[quoteHash];
+
+        if (quote.lbcAddress == address(0)) revert Flyover.QuoteNotFound(quoteHash);
+        // solhint-disable-next-line gas-strict-inequalities
+        if (quote.expireDate >= block.timestamp || quote.expireBlock >= block.number) revert QuoteNotExpired(quoteHash);
+
+        uint256 valueToTransfer = quote.value + quote.callFee + quote.productFeeAmount + quote.gasFee;
+        address addressToTransfer = quote.rskRefundAddress;
+
+        delete _pegOutQuotes[quoteHash];
+        _pegOutRegistry[quoteHash].completed = true;
+
+        emit PegOutUserRefunded(quoteHash, addressToTransfer, valueToTransfer);
+        _collateralManagement.slashPegOutCollateral(quote, quoteHash);
+
+        (bool sent, bytes memory reason) = addressToTransfer.call{value: valueToTransfer}("");
+        if (!sent) {
+            revert Flyover.PaymentFailed(addressToTransfer, valueToTransfer, reason);
+        }
+    }


contracts/PegOutContract.sol

+    function refundUserPegOut(bytes32 quoteHash) external nonReentrant override {
+        Quotes.PegOutQuote memory quote = _pegOutQuotes[quoteHash];
+
+        if (quote.lbcAddress == address(0)) revert Flyover.QuoteNotFound(quoteHash);
+        // solhint-disable-next-line gas-strict-inequalities
+        if (quote.expireDate >= block.timestamp || quote.expireBlock >= block.number) revert QuoteNotExpired(quoteHash);
+
+        uint256 valueToTransfer = quote.value + quote.callFee + quote.productFeeAmount + quote.gasFee;
+        address addressToTransfer = quote.rskRefundAddress;
+
+        delete _pegOutQuotes[quoteHash];
+        _pegOutRegistry[quoteHash].completed = true;
+
+        emit PegOutUserRefunded(quoteHash, addressToTransfer, valueToTransfer);
+        _collateralManagement.slashPegOutCollateral(quote, quoteHash);
+
+        (bool sent, bytes memory reason) = addressToTransfer.call{value: valueToTransfer}("");
+        if (!sent) {
+            revert Flyover.PaymentFailed(addressToTransfer, valueToTransfer, reason);
+        }
+    }


contracts/PegOutContract.sol

+    function _shouldPenalize(
+        Quotes.PegOutQuote memory quote,
+        bytes32 quoteHash,
+        bytes32 blockHash
+    ) private view returns (bool) {
+        bytes memory firstConfirmationHeader = _bridge.getBtcBlockchainBlockHeaderByHash(blockHash);
+        if(firstConfirmationHeader.length < 1) revert Flyover.EmptyBlockHeader(blockHash);
+
+        uint256 firstConfirmationTimestamp = BtcUtils.getBtcBlockTimestamp(firstConfirmationHeader);
+        uint256 expectedConfirmationTime = _pegOutRegistry[quoteHash].depositTimestamp +
+            quote.transferTime +
+            btcBlockTime;
+
+        // penalize if the transfer was not made on time
+        if (firstConfirmationTimestamp > expectedConfirmationTime) {
+            return true;
+        }
+
+        // penalize if LP is refunding after expiration
+        if (block.timestamp > quote.expireDate || block.number > quote.expireBlock) {
+            return true;
+        }
+
+        return false;
+    }


contracts/test-contracts/PegOutChangeReceiver.sol

github-actions · 2025-08-04T20:13:14Z

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

Package	Version	Score	Details

Scanned Files

Copilot

Pull Request Overview

This PR implements the PegOutContract functionality for the Flyover protocol, adding comprehensive peg-out capabilities with proper testing and documentation. The implementation includes new contract structures, comprehensive test coverage, and standardized DAO contribution mechanisms.

Adds PegOutContract implementation with deposit, refund, and user refund functionality
Implements OwnableDaoContributorUpgradeable for standardized DAO fee collection
Adds comprehensive test suite covering all contract functions and edge cases

Reviewed Changes

Copilot reviewed 25 out of 25 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
contracts/PegOutContract.sol	Main contract implementing peg-out functionality with Bitcoin transaction validation
contracts/DaoContributor.sol	Base contract for standardized DAO fee collection and contribution management
contracts/interfaces/PegOut.sol	Interface definition for peg-out operations with comprehensive error handling
test/pegout/*.test.ts	Comprehensive test suite covering deposit, refund, configuration, and hashing functionality
test/utils/*.ts	Enhanced utility functions supporting both legacy and new contract testing
contracts/test-contracts/*.sol	Mock contracts for testing payment failures and reentrancy scenarios

test/utils/quotes.ts

test/utils/btc.ts

contracts/PegOutContract.sol

test/pegout/user-refund.test.ts

contracts/PegOutContract.sol

test/pegout/lp-refund.test.ts

contracts/PegOutContract.sol

+    function _validateBtcTxNullData(BtcUtils.TxRawOutput[] memory outputs, bytes32 quoteHash) private pure {
+        bytes memory scriptContent = BtcUtils.parseNullDataScript(outputs[_QUOTE_HASH_OUTPUT].pkScript);
+        uint256 scriptLength = scriptContent.length;
+
+        if (scriptLength != _QUOTE_HASH_SIZE + 1 || uint8(scriptContent[0]) != _QUOTE_HASH_SIZE) {
+            revert MalformedTransaction(scriptContent);
+        }
+
+        bytes32 txQuoteHash;
+        assembly {
+            txQuoteHash := mload(add(scriptContent, 33)) // 32 bytes after the first byte
+        }
+        if (quoteHash != txQuoteHash) revert InvalidQuoteHash(quoteHash, txQuoteHash);
+    }


Hakob23

LGTM

Luisfc68 added 10 commits July 29, 2025 17:13

feat: add PegOutContract initial version

e5a248c

ci: update slither config

af6dbe0

fix: slither feedback

dd3154a

test: add pegout configuration tests

7b92dee

ci: run test in each push and PR

2b81680

test: add pegout deposit tests

cf13c68

test: add pegout user refund tests

3ae98a9

test: add pegout refund tests

cb11447

test: add pegout hashing tests

e115665

docs: add natspec to dao contributor and pegout contract

22d817a

Luisfc68 requested review from AndresQuijano, Dominikkq and alexjavabraz August 4, 2025 20:13

github-advanced-security bot found potential problems Aug 4, 2025

View reviewed changes

alexjavabraz requested a review from Copilot August 5, 2025 14:51

alexjavabraz assigned Luisfc68 Aug 5, 2025

Copilot AI reviewed Aug 5, 2025

View reviewed changes

Base automatically changed from split-preparations to lbc-split August 5, 2025 18:45

Luisfc68 added 3 commits August 5, 2025 15:46

Merge branch 'split-preparations' into feature/GBI-2808

7688459

refactor: rename pegout interface file

7f6d8ee

fix: copilot suggestions

f1fd36f

github-advanced-security bot found potential problems Aug 5, 2025

View reviewed changes

Luisfc68 marked this pull request as ready for review August 5, 2025 19:10

Hakob23 approved these changes Aug 13, 2025

View reviewed changes

AndresQuijano approved these changes Aug 13, 2025

View reviewed changes

Luisfc68 merged commit 8212fb2 into lbc-split Aug 13, 2025
5 checks passed

Luisfc68 deleted the feature/GBI-2808 branch August 13, 2025 17:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/GBI-2808 - PegOut Contract implementation#349

Feature/GBI-2808 - PegOut Contract implementation#349
Luisfc68 merged 13 commits intolbc-splitfrom
feature/GBI-2808

Luisfc68 commented Aug 4, 2025

Uh oh!

Check warning

Check warning

Check warning

Check notice

Check warning

Check notice

Check warning

Check notice

Uh oh!

Uh oh!

github-actions bot commented Aug 4, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Check warning

Hakob23 left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

Luisfc68 commented Aug 4, 2025

What

Task

Uh oh!

Check warning

Check warning

Check warning

Check notice

Check warning

Check notice

Check warning

Check notice

Uh oh!

Uh oh!

github-actions bot commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Dependency Review

OpenSSF Scorecard

Scanned Files

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Check warning

Hakob23 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

github-actions bot commented Aug 4, 2025 •

edited

Loading