Skip to content
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.

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

feat: adding the splitter contract at marketplace contracts #61

Merged
merged 22 commits into from
Sep 20, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
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
145 changes: 145 additions & 0 deletions contracts/ERC20Splitter.sol
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
// SPDX-License-Identifier: CC0-1.0
pragma solidity 0.8.9;

import '@openzeppelin/contracts/token/ERC20/IERC20.sol';
import '@openzeppelin/contracts/security/ReentrancyGuard.sol';

contract ERC20Splitter is ReentrancyGuard {
// tokenAddress => userAddress => balance
mapping(address => mapping(address => uint256)) public balances;
// userAddress => tokenAddress[]
mapping(address => address[]) private userTokens;
// tokenAddress => boolean
mapping(address => mapping(address => bool)) private hasToken;
EduardoMelo00 marked this conversation as resolved.
Show resolved Hide resolved

/** Events **/

event Deposit(
address indexed depositor,
address[] tokenAddresses,
uint256[] amounts,
uint16[][] shares,
address[][] recipients
);
event Withdraw(address indexed user, address[] tokenAddresses, uint256[] amounts);
EduardoMelo00 marked this conversation as resolved.
Show resolved Hide resolved

uint16 public constant MAX_SHARES = 10000;

/** External Functions **/

/// @notice Deposits ERC20 or native tokens and splits between recipients based on shares.
/// @param tokenAddresses Array of token addresses (use address(0) for native tokens).
/// @param amounts Array of amounts for each token.
/// @param shares Array of share percentages (out of 10000) for each recipient.
/// @param recipients Array of recipients for each token.
function deposit(
address[] calldata tokenAddresses,
uint256[] calldata amounts,
uint16[][] calldata shares,
address[][] calldata recipients
) external payable nonReentrant {
require(tokenAddresses.length == amounts.length, 'ERC20Splitter: Invalid input lengths');
require(
tokenAddresses.length == shares.length && tokenAddresses.length == recipients.length,
'ERC20Splitter: Mismatched input sizes'
);

uint256 totalEthAmount = 0;

for (uint256 i = 0; i < tokenAddresses.length; i++) {
if (tokenAddresses[i] == address(0)) {
totalEthAmount += amounts[i];
}
_splitTokens(tokenAddresses[i], amounts[i], shares[i], recipients[i]);
}

require(msg.value == totalEthAmount, 'ERC20Splitter: Incorrect native token amount sent');

emit Deposit(msg.sender, tokenAddresses, amounts, shares, recipients);
}

/// @notice Withdraw all tokens that the caller is entitled to.
/// Tokens are automatically determined based on previous deposits.
EduardoMelo00 marked this conversation as resolved.
Show resolved Hide resolved
EduardoMelo00 marked this conversation as resolved.
Show resolved Hide resolved
function withdraw() external nonReentrant {
address payable to = payable(msg.sender);
EduardoMelo00 marked this conversation as resolved.
Show resolved Hide resolved
address[] storage senderTokens = userTokens[msg.sender];

if (senderTokens.length == 0) {
return;
}

uint256[] memory withdrawnAmounts = new uint256[](senderTokens.length);

for (uint256 i = 0; i < senderTokens.length; i++) {
address tokenAddress = senderTokens[i];
uint256 amount = balances[tokenAddress][to];

balances[tokenAddress][to] = 0;

if (tokenAddress == address(0)) {
to.transfer(amount);
} else {
require(
IERC20(tokenAddress).transferFrom(address(this), to, amount),
'ERC20Splitter: TransferFrom failed'
);
}

withdrawnAmounts[i] = amount;

delete hasToken[to][tokenAddress];
}
emit Withdraw(to, userTokens[msg.sender], withdrawnAmounts);

delete userTokens[to];
}

/** Internal Functions **/

/// @notice Internal function to split the tokens among recipients.
/// @param tokenAddress The address of the token being split (use address(0) for native tokens).
/// @param amount The amount of tokens to be split.
/// @param shares Array of share percentages (out of 10000) for each recipient.
/// @param recipients Array of recipients for the token.
function _splitTokens(
address tokenAddress,
uint256 amount,
uint16[] calldata shares,
address[] calldata recipients
) internal {
require(shares.length == recipients.length, 'ERC20Splitter: Shares and recipients length mismatch');
require(amount > 0, 'ERC20Splitter: Amount must be greater than zero');
EduardoMelo00 marked this conversation as resolved.
Show resolved Hide resolved

uint256 totalSharePercentage = 0;

for (uint256 i = 0; i < shares.length; i++) {
totalSharePercentage += shares[i];
}

require(totalSharePercentage == MAX_SHARES, 'ERC20Splitter: Shares must sum to 100%');

if (tokenAddress != address(0)) {
require(
IERC20(tokenAddress).transferFrom(msg.sender, address(this), amount),
'ERC20Splitter: Transfer failed'
);
}

for (uint256 i = 0; i < recipients.length; i++) {
uint256 recipientAmount = (amount * shares[i]) / MAX_SHARES;
balances[tokenAddress][recipients[i]] += recipientAmount;

_addTokenForUser(recipients[i], tokenAddress);
}
}

/// @notice Adds a token to the list of tokens a user has received (for automatic withdrawals).
/// @param recipient The recipient of the token.
/// @param tokenAddress The address of the token.
function _addTokenForUser(address recipient, address tokenAddress) internal {
if (!hasToken[recipient][tokenAddress]) {
userTokens[recipient].push(tokenAddress);
hasToken[recipient][tokenAddress] = true;
}
}
}
22 changes: 22 additions & 0 deletions contracts/mocks/MaliciousERC20.sol
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// SPDX-License-Identifier: CC0-1.0

pragma solidity ^0.8.9;

import "@openzeppelin/contracts/token/ERC20/ERC20.sol";

contract MaliciousERC20 is ERC20 {
constructor() ERC20("MaliciousToken", "MTK") {}

function transferFrom(
address sender,
address recipient,
uint256 amount
) public override returns (bool) {
return false;
}

// Mint function for testing purposes
function mint(address to, uint256 amount) external {
_mint(to, amount);
}
}
15 changes: 15 additions & 0 deletions contracts/mocks/MaliciousRecipient.sol
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// SPDX-License-Identifier: CC0-1.0


pragma solidity ^0.8.9;

contract MaliciousRecipient {
// Fallback function that reverts when receiving Ether
fallback() external payable {
revert("MaliciousRecipient: Reverting on receive");
}

receive() external payable {
revert("MaliciousRecipient: Reverting on receive");
}
}
1 change: 1 addition & 0 deletions hardhat.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ const BASE_CONFIG = {
forking: {
url: POLYGON_PROVIDER_URL,
blockNumber: 55899875,
timeout: 9999900,
EduardoMelo00 marked this conversation as resolved.
Show resolved Hide resolved
},
},
},
Expand Down
Loading
Loading