Skip to content

Pr/feesharingcollector v2 SIP-0088 #574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bribri-wci wants to merge 3 commits into
base: development
Choose a base branch
from
Open

Pr/feesharingcollector v2 SIP-0088 #574

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
222ef5a
SIP-88: Revert FeeSharingCollector - add V2 deploy script and config …
bribri-wci Mar 2, 2026
bb62baa
Add FeeSharingCollectorV2 deploy script
bribri-wci Mar 3, 2026
e42ecdb
Revert FeeSharingCollector to pre-5429b56 version
bribri-wci Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
258 changes: 80 additions & 178 deletions contracts/governance/FeeSharingCollector/FeeSharingCollector.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,63 @@ contract FeeSharingCollector is
address public constant RBTC_DUMMY_ADDRESS_FOR_CHECKPOINT =
address(uint160(uint256(keccak256("RBTC_DUMMY_ADDRESS_FOR_CHECKPOINT"))));

/* Events */

/// @notice Deprecated event after the unification between wrbtc & rbtc
// event FeeWithdrawn(address indexed sender, address indexed token, uint256 amount);
event FeeWithdrawnInRBTC(address indexed sender, uint256 amount);

/// @notice An event emitted when tokens transferred.
event TokensTransferred(address indexed sender, address indexed token, uint256 amount);

/// @notice An event emitted when checkpoint added.
event CheckpointAdded(address indexed sender, address indexed token, uint256 amount);

/// @notice An event emitted when user fee get withdrawn.
event UserFeeWithdrawn(
address indexed sender,
address indexed receiver,
address indexed token,
uint256 amount
);

/// @notice An event emitted when user fee get withdrawn.
event UserFeeProcessedNoWithdraw(
address indexed sender,
address indexed token,
uint256 prevProcessedCheckpoints,
uint256 newProcessedCheckpoints
);

/**
* @notice An event emitted when fee from AMM get withdrawn.
*
* @param sender sender who initiate the withdrawn amm fees.
* @param converter the converter address.
* @param amount total amount of fee (Already converted to WRBTC).
*/
event FeeAMMWithdrawn(address indexed sender, address indexed converter, uint256 amount);

/// @notice An event emitted when converter address has been registered to be whitelisted.
event WhitelistedConverter(address indexed sender, address converter);

/// @notice An event emitted when converter address has been removed from whitelist.
event UnwhitelistedConverter(address indexed sender, address converter);

event RBTCWithdrawn(address indexed sender, address indexed receiver, uint256 amount);

event SetWrbtcToken(
address indexed sender,
address indexed oldWrbtcToken,
address indexed newWrbtcToken
);

event SetLoanTokenWrbtc(
address indexed sender,
address indexed oldLoanTokenWrbtc,
address indexed newLoanTokenWrbtc
);

/* Modifier */
modifier oneTimeExecution(bytes4 _funcSig) {
require(
Expand Down Expand Up @@ -150,7 +207,7 @@ contract FeeSharingCollector is
"FeeSharingCollector::withdrawFees: wrbtc token amount exceeds 96 bits"
);

_processFee(RBTC_DUMMY_ADDRESS_FOR_CHECKPOINT, amount96);
_addCheckpoint(RBTC_DUMMY_ADDRESS_FOR_CHECKPOINT, amount96);
}

// note deprecated event since we unify the wrbtc & rbtc
Expand Down Expand Up @@ -200,7 +257,7 @@ contract FeeSharingCollector is
}

if (totalPoolTokenAmount > 0) {
_processFee(RBTC_DUMMY_ADDRESS_FOR_CHECKPOINT, totalPoolTokenAmount);
_addCheckpoint(RBTC_DUMMY_ADDRESS_FOR_CHECKPOINT, totalPoolTokenAmount);
}
}

Expand All @@ -226,7 +283,7 @@ contract FeeSharingCollector is
_token = RBTC_DUMMY_ADDRESS_FOR_CHECKPOINT;
}

_processFee(_token, _amount);
_addCheckpoint(_token, _amount);

emit TokensTransferred(msg.sender, _token, _amount);
}
Expand All @@ -240,44 +297,35 @@ contract FeeSharingCollector is
uint96 _amount = uint96(msg.value);
require(_amount > 0, "FeeSharingCollector::transferRBTC: invalid value");

_processFee(RBTC_DUMMY_ADDRESS_FOR_CHECKPOINT, _amount);
_addCheckpoint(RBTC_DUMMY_ADDRESS_FOR_CHECKPOINT, _amount);

emit TokensTransferred(msg.sender, ZERO_ADDRESS, _amount);
}

/**
* @notice Add checkpoint with accumulated amount by function invocation.
* @dev If token is in protocol withhold list, accumulates fees for protocol (no checkpoint for stakers).
* @dev If token is not in withhold list, creates checkpoint for stakers (100% distribution).
* @param _token Address of the token.
* @param _amount Amount of tokens to process.
* */
function _processFee(address _token, uint96 _amount) internal {
/// @notice Check if token is in protocol withhold list
if (protocolWithheldTokensList.contains(_token)) {
/// @notice Token is withheld by protocol - directly add to withheld fees (no unprocessedAmount accumulation)
protocolWithheldFees[_token] = protocolWithheldFees[_token].add(_amount);
emit ProtocolRevenueAccumulated(_token, _amount);
function _addCheckpoint(address _token, uint96 _amount) internal {
if (block.timestamp - lastFeeWithdrawalTime[_token] >= FEE_WITHDRAWAL_INTERVAL) {
lastFeeWithdrawalTime[_token] = block.timestamp;
uint96 amount = add96(
unprocessedAmount[_token],
_amount,
"FeeSharingCollector::_addCheckpoint: amount exceeds 96 bits"
);

/// @notice Reset unprocessed amount of tokens to zero.
unprocessedAmount[_token] = 0;

/// @notice Write a regular checkpoint.
_writeTokenCheckpoint(_token, amount);
} else {
/// @notice Token is distributed to stakers - use unprocessedAmount and interval logic
if (block.timestamp - lastFeeWithdrawalTime[_token] >= FEE_WITHDRAWAL_INTERVAL) {
lastFeeWithdrawalTime[_token] = block.timestamp;
uint96 amount = add96(
unprocessedAmount[_token],
_amount,
"FeeSharingCollector::_processFee: amount exceeds 96 bits"
);
/// @notice Reset unprocessed amount of tokens to zero.
unprocessedAmount[_token] = 0;
/// @notice Create checkpoint for stakers
_writeTokenCheckpoint(_token, amount);
} else {
unprocessedAmount[_token] = add96(
unprocessedAmount[_token],
_amount,
"FeeSharingCollector::_processFee: unprocessedAmount exceeds 96 bits"
);
}
unprocessedAmount[_token] = add96(
unprocessedAmount[_token],
_amount,
"FeeSharingCollector::_addCheckpoint: unprocessedAmount exceeds 96 bits"
);
}
}

Expand Down Expand Up @@ -1047,152 +1095,6 @@ contract FeeSharingCollector is
wrbtcToken.safeTransfer(receiver, wrbtcAmount);
}

/**
* @notice Add a token to the protocol withhold list.
* @dev Only callable by owner.
* @dev Fees from tokens in this list are withheld 100% by protocol (no staker distribution).
* @dev If there are unprocessed fees accumulated before adding to list, they are moved to protocolWithheldFees.
* @dev Resets lastFeeWithdrawalTime to avoid stale interval behavior if token is later removed from list.
* @param token The token address to add.
*/
function addProtocolWithholdToken(address token) external onlyOwner {
require(token != ZERO_ADDRESS, "addProtocolWithholdToken: invalid token");
require(
!protocolWithheldTokensList.contains(token),
"addProtocolWithholdToken: token already in list"
);

/// @notice Move any existing unprocessed amount to protocol withheld fees
if (unprocessedAmount[token] > 0) {
protocolWithheldFees[token] = protocolWithheldFees[token].add(
unprocessedAmount[token]
);
emit ProtocolRevenueAccumulated(token, unprocessedAmount[token]);
unprocessedAmount[token] = 0;
}

/// @notice Reset withdrawal interval baseline while token is in withhold mode.
lastFeeWithdrawalTime[token] = 0;

protocolWithheldTokensList.add(token);
emit TokenAddedToProtocolWithholdList(msg.sender, token);
}

/**
* @notice Remove a token from the protocol withhold list. Accumulated protocol fees can still be withdrawn by owner, but new fees will be distributed to stakers.
* @dev Only callable by owner.
* @dev Fees from tokens removed from this list will be distributed to stakers.
* @param token The token address to remove.
*/
function removeProtocolWithholdToken(address token) external onlyOwner {
require(
protocolWithheldTokensList.contains(token),
"removeProtocolWithholdToken: token not in list"
);

protocolWithheldTokensList.remove(token);
emit TokenRemovedFromProtocolWithholdList(msg.sender, token);
}

/**
* @notice Check if a token is in the protocol withhold list.
* @param token The token address to check.
* @return True if token fees are withheld by protocol, false otherwise.
*/
function isTokenInProtocolWithholdList(address token) external view returns (bool) {
return protocolWithheldTokensList.contains(token);
}

/**
* @notice Get all tokens in the protocol withhold list.
* @return Array of token addresses that are withheld by protocol.
*/
function getProtocolWithholdTokensList() external view returns (address[] memory) {
uint256 length = protocolWithheldTokensList.length();
address[] memory tokens = new address[](length);
for (uint256 i = 0; i < length; i++) {
tokens[i] = protocolWithheldTokensList.get(i);
}
return tokens;
}

/**
* @notice Withdraw all accumulated protocol withheld fees for a token.
* @dev Only callable by owner. Withdraws the full balance.
* @param _token The token address to withdraw.
* Use RBTC_DUMMY_ADDRESS_FOR_CHECKPOINT for RBTC.
* @param _receiver The address to receive the withheld fees.
*/
function withdrawProtocolWithheldFees(
address _token,
address _receiver
) external onlyOwner nonReentrant {
require(_receiver != ZERO_ADDRESS, "withdrawProtocolWithheldFees: invalid receiver");

uint256 amount = protocolWithheldFees[_token];
require(amount > 0, "withdrawProtocolWithheldFees: no fees to withdraw");

protocolWithheldFees[_token] = 0;

// Handle RBTC vs ERC20 token withdrawal
if (_token == RBTC_DUMMY_ADDRESS_FOR_CHECKPOINT) {
// Transfer RBTC
(bool success, ) = _receiver.call.value(amount)("");
require(success, "withdrawProtocolWithheldFees: RBTC transfer failed");
} else {
// Transfer ERC20 token
IERC20(_token).safeTransfer(_receiver, amount);
}

emit ProtocolWithheldFeesWithdrawn(msg.sender, _receiver, _token, amount);
}

/**
* @notice Withdraw all accumulated protocol withheld fees for multiple tokens in batch.
* @dev Only callable by owner. Withdraws full balance for each token to the same receiver.
* @param _tokens Array of token addresses to withdraw.
* @param _receiver The address to receive all withheld fees.
*/
function withdrawProtocolWithheldFeesBatch(
address[] calldata _tokens,
address _receiver
) external onlyOwner nonReentrant {
require(_receiver != ZERO_ADDRESS, "withdrawProtocolWithheldFeesBatch: invalid receiver");
require(_tokens.length > 0, "withdrawProtocolWithheldFeesBatch: empty array");

for (uint256 i = 0; i < _tokens.length; i++) {
address token = _tokens[i];
uint256 amount = protocolWithheldFees[token];

if (amount == 0) {
continue; // Skip tokens with no fees
}

protocolWithheldFees[token] = 0;

// Handle RBTC vs ERC20 token withdrawal
if (token == RBTC_DUMMY_ADDRESS_FOR_CHECKPOINT) {
// Transfer RBTC
(bool success, ) = _receiver.call.value(amount)("");
require(success, "withdrawProtocolWithheldFeesBatch: RBTC transfer failed");
} else {
// Transfer ERC20 token
IERC20(token).safeTransfer(_receiver, amount);
}

emit ProtocolWithheldFeesWithdrawn(msg.sender, _receiver, token, amount);
}
}

/**
* @notice Get the accumulated protocol withheld fees for a specific token.
* @param token The token address to query.
* @return The accumulated withheld fees amount.
*/
function getProtocolWithheldFees(address token) external view returns (uint256) {
return protocolWithheldFees[token];
}

/**
* @dev This function is dedicated to recover the wrong fee allocation for the 4 year vesting contracts.
* This function can only be called once
Expand Down
12 changes: 0 additions & 12 deletions contracts/governance/FeeSharingCollector/FeeSharingCollectorStorage.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,18 +86,6 @@ contract FeeSharingCollectorStorage is Ownable {
*/
address public loanTokenWrbtcAddress;

/**
* @dev Enumerable set of tokens for which protocol withholds 100% of fees
* @notice These tokens will NOT create checkpoints for stakers
*/
EnumerableAddressSet.AddressSet internal protocolWithheldTokensList;

/**
* @dev Accumulated protocol fees per token (for tokens in protocolWithheldTokensList)
* @notice token => accumulated amount
*/
mapping(address => uint256) public protocolWithheldFees;

/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* If you mark a function `nonReentrant`, you should also
Expand Down
Loading