AbstractFrictionlessComplianceModule
Inherits: IFrictionlessComplianceModule, OwnableUpgradeable
Author: DEFYCA Labs S.à.r.l
Copyright © 2023 DEFYCA Labs S.à.r.l Permission is hereby granted, free of charge, to any person obtaining a copy of the Frictionless protocol smart contracts (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL DEFYCA LABS S.à.r.l BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
See {IFrictionlessComplianceModule}
State Variables
permissionsManager
The IFrictionlessPermissionsManager for the protocol.
IFrictionlessPermissionsManager public override permissionsManager;
complianceFactory
The IFrictionlessComplianceFactory for the protocol.
IFrictionlessComplianceFactory public override complianceFactory;
_complianceBound
the mapping of compliance modules bound.
mapping(address => bool) private _complianceBound;
Functions
onlyApprovedCompliance
modifier used to very that only approved compliance modules can be used.
modifier onlyApprovedCompliance();
onlyBoundCompliance
modifier used to very that only modules that are bound, can be used.
modifier onlyBoundCompliance();
__AbstractFrictionlessComplianceModule_init
Initiatizes the compliance module
function __AbstractFrictionlessComplianceModule_init(
address frictionlessPermissionsManager_,
address complianceFactory_
) internal onlyInitializing;
Parameters
frictionlessPermissionsManager_
address
the address of the frictionless permissions manager
complianceFactory_
address
the address of the compliance dfactory
setPermissionsManager
Sets the instance of the IFrictionlessPermissionsManager
to determine permissions for users.
function setPermissionsManager(address frictionlessPermissionsManager_) external override onlyOwner;
Parameters
frictionlessPermissionsManager_
address
the address of the IFrictionlessPermissionsManager
contract
setComplianceFactory
Sets the instance of the IFrictionlessComplianceFactory
to determine the compliance module for the protocol.
function setComplianceFactory(address newComplianceFactory_) external override onlyOwner;
Parameters
newComplianceFactory_
address
the address of the IFrictionlessComplianceFactory
contract
bindCompliance
function bindCompliance(address compliance_) external override onlyApprovedCompliance;
unbindCompliance
function unbindCompliance(address compliance_) external override;
moduleTransferAction
function moduleTransferAction(address from_, address to_, uint256 value_)
external
virtual
override
onlyBoundCompliance;
moduleMintAction
function moduleMintAction(address to_, uint256 value_) external virtual override onlyBoundCompliance;
moduleBurnAction
function moduleBurnAction(address from_, uint256 value_) external virtual override onlyBoundCompliance;
moduleCheck
function moduleCheck(address, address, uint256, address) public view virtual override returns (bool);
isComplianceBound
function isComplianceBound(address compliance_) public view override returns (bool);
isTreasury
Verifies if the specified wallet address is a PROTOCOL_TREASURY user.
function isTreasury(address userAddress_) public view override returns (bool);
Parameters
userAddress_
address
Returns
<none>
bool
true if the specified wallet address is a PROTOCOL_TREASURY user, otherwise false
isCustodian
Verifies if the specified wallet address is a PERMISSIONED_CUSTODIAN user.
function isCustodian(address userAddress_) public view override returns (bool);
Parameters
userAddress_
address
Returns
<none>
bool
true if the specified wallet address is a PERMISSIONED_CUSTODIAN user, otherwise false
isInvestor
Verifies if the specified wallet address is a PERMISSIONED_INVESTOR user.
function isInvestor(address userAddress_) public view override returns (bool);
Parameters
userAddress_
address
Returns
<none>
bool
true if the specified wallet address is a PERMISSIONED_INVESTOR user, otherwise false
isManager
Verifies if the specified wallet address is a PERMISSIONED_MANAGER user.
function isManager(address userAddress_) public view override returns (bool);
Parameters
userAddress_
address
Returns
<none>
bool
true if the specified wallet address is a PERMISSIONED_MANAGER user, otherwise false
isCalculatingAgent
Verifies if the specified wallet address is a PERMISSIONED_CALCULATING_AGENT user.
function isCalculatingAgent(address userAddress_) public view override returns (bool);
Parameters
userAddress_
address
Returns
<none>
bool
true if the specified wallet address is a PERMISSIONED_CALCULATING_AGENT user, otherwise false
isTransferAgent
Verifies if the specified wallet address is a PERMISSIONED_TRANSFER_AGENT user.
function isTransferAgent(address userAddress_) public view override returns (bool);
Parameters
userAddress_
address
Returns
<none>
bool
true if the specified wallet address is a PERMISSIONED_TRANSFER_AGENT user, otherwise false
isFundAccountant
Verifies if the specified wallet address is a PERMISSIONED_FUND_ACCOUNTANT user.
function isFundAccountant(address userAddress_) public view override returns (bool);
Parameters
userAddress_
address
Returns
<none>
bool
true if the specified wallet address is a PERMISSIONED_FUND_ACCOUNTANT user, otherwise false
isUser
Verifies if the specified wallet address is a permissioned user in the Frictionless protocol.
function isUser(address userAddress_) public view override returns (bool);
Parameters
userAddress_
address
Returns
<none>
bool
true if the specified wallet address is a permissioned user in the Frictionless protocol, otherwise false
hasClaim
verify if the userAddress is permissioned in the Frictionless protocol and has a valid claim
function hasClaim(address userAddress_, IFrictionlessPermissionsManager.FrictionlessPermissionedUser userType_)
public
view
override
returns (bool);
Parameters
userAddress_
address
the address of the user's wallet to verify
userType_
IFrictionlessPermissionsManager.FrictionlessPermissionedUser
the type of the user as per the enum
Returns
<none>
bool
true if a valid permissioned user and has a valid claim, otherwise false.
_setPermissionsManager
Impl of the setting of the permissions manager
function _setPermissionsManager(address newFrictionlessPermissionsManager_) internal;
_setComplianceFactory
Impl of the setting of the compliance factory
function _setComplianceFactory(address newComplianceFactory_) internal;
_checkZeroAddr
Verifies if an address is a zero address
function _checkZeroAddr(address addrToCheck_, string memory addrName_) internal pure;
_onlyBoundCompliance
Verifies if the compliance_ address supplied is bound as per the mapping
function _onlyBoundCompliance(address compliance_) internal view virtual;
_onlyValidCompliance
Verifies if the compliance_ address supplied is valid
function _onlyValidCompliance(address compliance_) internal view;
_onlyApprovedCompliance
Verifies if the msg.sender
is a valid modular compliance
function _onlyApprovedCompliance() internal view;
_getTokenBound
Returns the address of the IToken bound by this compliance
function _getTokenBound(address compliance_) internal view returns (address);
_hasClaim
Determine if a claim is present for a given userAddress and userType
function _hasClaim(address userAddress_, IFrictionlessPermissionsManager.FrictionlessPermissionedUser userType_)
internal
view
virtual
returns (bool);
Parameters
userAddress_
address
the address if the users wallet
userType_
IFrictionlessPermissionsManager.FrictionlessPermissionedUser
the type of the user as defined by the enumeration IFrictionlessPermissionsManager.FrictionlessPermissionedUser
Last updated