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.

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

(TFM) Add transfer fees module #168

Merged
merged 4 commits into from
Oct 6, 2023
Merged

(TFM) Add transfer fees module #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d9f1b9a
(TFM) Add transfer fees module
aliarbak Sep 20, 2023
4b8b624
Remove describe.only from unit tests
aliarbak Sep 20, 2023
2928520
Update set fees function
aliarbak Oct 2, 2023
4555054
Add is plug and play function
aliarbak Oct 3, 2023
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
204 changes: 204 additions & 0 deletions contracts/compliance/modular/modules/TransferFeesModule.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,204 @@
// SPDX-License-Identifier: GPL-3.0
//
// :+#####%%%%%%%%%%%%%%+
// .-*@@@%+.:+%@@@@@%%#***%@@%=
// :=*%@@@#=. :#@@% *@@@%=
// .-+*%@%*-.:+%@@@@@@+. -*+: .=#. :%@@@%-
// :=*@@@@%%@@@@@@@@@%@@@- .=#@@@%@%= =@@@@#.
// -=+#%@@%#*=:. :%@@@@%. -*@@#*@@@@@@@#=:- *@@@@+
// =@@%=:. :=: *@@@@@%#- =%*%@@@@#+-. =+ :%@@@%-
// -@@%. .+@@@ =+=-. @@#- +@@@%- =@@@@%:
// :@@@. .+@@#%: : .=*=-::.-%@@@+*@@= +@@@@#.
// %@@: +@%%* =%@@@@@@@@@@@#. .*@%- +@@@@*.
// #@@= .+@@@@%:=*@@@@@- :%@%: .*@@@@+
// *@@* +@@@#-@@%-:%@@* +@@#. :%@@@@-
// -@@% .:-=++*##%%%@@@@@@@@@@@@*. :@+.@@@%: .#@@+ =@@@@#:
// .@@@*-+*#%%%@@@@@@@@@@@@@@@@%%#**@@%@@@. *@=*@@# :#@%= .#@@@@#-
// -%@@@@@@@@@@@@@@@*+==-:-@@@= *@# .#@*-=*@@@@%= -%@@@* =@@@@@%-
// -+%@@@#. %@%%= -@@:+@: -@@* *@@*-:: -%@@%=. .*@@@@@#
// *@@@* +@* *@@##@@- #@*@@+ -@@= . :+@@@#: .-+@@@%+-
// +@@@%*@@:..=@@@@* .@@@* .#@#. .=+- .=%@@@*. :+#@@@@*=:
// =@@@@%@@@@@@@@@@@@@@@@@@@@@@%- :+#*. :*@@@%=. .=#@@@@%+:
// .%@@= ..... .=#@@+. .#@@@*: -*%@@@@%+.
// +@@#+===---:::... .=%@@*- +@@@+. -*@@@@@%+.
// -@@@@@@@@@@@@@@@@@@@@@@%@@@@= -@@@+ -#@@@@@#=.
// ..:::---===+++***###%%%@@@#- .#@@+ -*@@@@@#=.
// @@@@@@+. +@@*. .+@@@@@%=.
// -@@@@@= =@@%: -#@@@@%+.
// +@@@@@. =@@@= .+@@@@@*:
// #@@@@#:%@@#. :*@@@@#-
// @@@@@%@@@= :#@@@@+.
// :@@@@@@@#.:#@@@%-
// +@@@@@@-.*@@@*:
// #@@@@#.=@@@+.
// @@@@+-%@%=
// :@@@#%@%=
// +@@@@%-
// :#%%=
//
/**
* NOTICE
*
* The T-REX software is licensed under a proprietary license or the GPL v.3.
* If you choose to receive it under the GPL v.3 license, the following applies:
* T-REX is a suite of smart contracts implementing the ERC-3643 standard and
* developed by Tokeny to manage and transfer financial assets on EVM blockchains
*
* Copyright (C) 2023, Tokeny sàrl.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

pragma solidity 0.8.17;

import "../IModularCompliance.sol";
import "../../../token/IToken.sol";
import "../../../roles/AgentRole.sol";
import "./AbstractModule.sol";

import "@openzeppelin/contracts/access/Ownable.sol";

contract TransferFeesModule is AbstractModule, Ownable {
/// Struct of fees
struct Fee {
uint256 rate; // min = 0, max = 10000, 0.01% = 1, 1% = 100, 100% = 10000
address collector;
}

/// Mapping for compliance fees
mapping(address => Fee) private _fees;

/**
* this event is emitted whenever a fee definition is updated for the given compliance address
* the event is emitted by 'setFee'.
* compliance is the compliance contract address
* _rate is the rate of the fee (0.01% = 1, 1% = 100, 100% = 10000)
* _collector is the collector wallet address
*/
event FeeUpdated(address indexed compliance, uint256 _rate, address _collector);

error FeeRateIsOutOfRange(address compliance, uint256 rate);

error CollectorAddressIsNotVerified(address compliance, address collector);

/**
* @dev Sets the fee rate and collector of the given compliance
* @param _rate is the rate of the fee (0.01% = 1, 1% = 100, 100% = 10000)
* @param _collector is the collector wallet address
* Only the owner of the Compliance smart contract can call this function
* Collector wallet address must be verified
*/
function setFee(uint256 _rate, address _collector) external onlyComplianceCall {
address tokenAddress = IModularCompliance(msg.sender).getTokenBound();
if (_rate > 10000) {
revert FeeRateIsOutOfRange(msg.sender, _rate);
}

IIdentityRegistry identityRegistry = IToken(tokenAddress).identityRegistry();
if (!identityRegistry.isVerified(_collector)) {
revert CollectorAddressIsNotVerified(msg.sender, _collector);
}

_fees[msg.sender].rate = _rate;
_fees[msg.sender].collector = _collector;
emit FeeUpdated(msg.sender, _rate, _collector);
}

/**
* @dev See {IModule-moduleTransferAction}.
*/
function moduleTransferAction(address _from, address _to, uint256 _value) external override onlyComplianceCall {
address senderIdentity = _getIdentity(msg.sender, _from);
address receiverIdentity = _getIdentity(msg.sender, _to);

if (senderIdentity == receiverIdentity) {
return;
}

Fee memory fee = _fees[msg.sender];
if (fee.rate == 0 || _from == fee.collector || _to == fee.collector) {
return;
}

uint256 feeAmount = (_value * fee.rate) / 10000;
if (feeAmount == 0) {
return;
}

IToken token = IToken(IModularCompliance(msg.sender).getTokenBound());
bool sent = token.forcedTransfer(_to, fee.collector, feeAmount);
require(sent, "transfer fee collection failed");
}

/**
* @dev See {IModule-moduleMintAction}.
*/
// solhint-disable-next-line no-empty-blocks
function moduleMintAction(address _to, uint256 _value) external override onlyComplianceCall {}

/**
* @dev See {IModule-moduleBurnAction}.
*/
// solhint-disable-next-line no-empty-blocks
function moduleBurnAction(address _from, uint256 _value) external override onlyComplianceCall {}

/**
* @dev See {IModule-moduleCheck}.
*/
// solhint-disable-next-line no-unused-vars
function moduleCheck(address _from, address _to, uint256 _value, address _compliance) external view override returns (bool) {
return true;
}

/**
* @dev getter for `_fees` variable
* @param _compliance the Compliance smart contract to be checked
* returns the Fee
*/
function getFee(address _compliance) external view returns (Fee memory) {
return _fees[_compliance];
}

/**
* @dev See {IModule-canComplianceBind}.
*/
function canComplianceBind(address _compliance) external view returns (bool) {
address tokenAddress = IModularCompliance(_compliance).getTokenBound();
return AgentRole(tokenAddress).isAgent(address(this));
}

/**
* @dev See {IModule-isPlugAndPlay}.
*/
function isPlugAndPlay() external pure returns (bool) {
return false;
}

/**
* @dev See {IModule-name}.
*/
function name() public pure returns (string memory _name) {
return "TransferFeesModule";
}

/**
* @dev Returns the ONCHAINID (Identity) of the _userAddress
* @param _userAddress Address of the wallet
* internal function, can be called only from the functions of the Compliance smart contract
*/
function _getIdentity(address _compliance, address _userAddress) internal view returns (address) {
return address(IToken(IModularCompliance(_compliance).getTokenBound()).identityRegistry().identity
(_userAddress));
}
}
2 changes: 2 additions & 0 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ const ExchangeMonthlyLimitsModule = require('./artifacts/contracts/compliance/mo
const TimeExchangeLimitsModule = require('./artifacts/contracts/compliance/modular/modules/TimeExchangeLimitsModule.sol/TimeExchangeLimitsModule.json');
const TimeTransfersLimitsModule = require('./artifacts/contracts/compliance/modular/modules/TimeTransfersLimitsModule.sol/TimeTransfersLimitsModule.json');
const SupplyLimitModule = require('./artifacts/contracts/compliance/modular/modules/SupplyLimitModule.sol/SupplyLimitModule.json');
const TransferFeesModule = require('./artifacts/contracts/compliance/modular/modules/TransferFeesModule.sol/TransferFeesModule.json');

module.exports = {
contracts: {
Expand Down Expand Up @@ -117,6 +118,7 @@ module.exports = {
TimeExchangeLimitsModule,
TimeTransfersLimitsModule,
SupplyLimitModule,
TransferFeesModule,
},
interfaces: {
IToken,
Expand Down
Loading
Loading