These contracts define the compliance layer for permissioned network participants (KYC/AML, Sanctions, PEP screening), the offering rules and the transfer rules for tokens, which ensures transfers are conducted in line with the legal and regulatory guardrails of MiFID II.

The compliance modules are upgradeable and are tied to specific tokens.

Git Source

Inherits: IModularCompliance

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.

The IFrictionlessModularCompliance is responsible for the compliant transfer of the various Tokens in the Frictionless protocol.

Functions

init

Initializes the modular compliance, sets the maximum allowable modules per token and adds the modules provided

function init(address[] calldata modules_, uint256 maxModulesCount_) external;

Parameters

updateMaxModulesCount

Set the maximum number of allowable modules which can be bound.

function updateMaxModulesCount(uint256 newMaxModulesCount_) external;

Parameters

addModules

Adds modules based on the array of module addresses provided

function addModules(address[] calldata modulesToAdd_) external;

Parameters

removeModules

Removes modules based on the array of module addresses provided

function removeModules(address[] calldata modulesToRemove_) external;

Parameters

maxModulesCount

Returns the maximum number of allowable modules which can be bound.

function maxModulesCount() external view returns (uint256);

Returns

Events

MaxModulesCountUpdated

Emitted during updateMaxModulesCount to inform of new modules max count updates

event MaxModulesCountUpdated(uint256 newMaxModulesCount, uint256 oldMaxModulesCount);

ModulesAdded

Emitted during addModules to inform of new modules added

event ModulesAdded(address[] modules);

ModulesRemoved

Emitted during removeModules to inform of modules removed

event ModulesRemoved(address[] modules);

Errors

FrictionlessIsZeroAddress

thrown if specific address is zero.

error FrictionlessIsZeroAddress(string);

FrictionlessModularComplianceZeroMaxModulesCount

thrown if an attempt to set the maximum number of allowable modules to zero is made in updateMaxModulesCount

error FrictionlessModularComplianceZeroMaxModulesCount();

FrictionlessModularComplianceModuleIsAlreadyBound

thrown if an attempt to add an already existing module during addModules

error FrictionlessModularComplianceModuleIsAlreadyBound(address module);

FrictionlessModularComplianceModuleDoesNotExist

thrown if module for the given address is not already bound by the modifier onlyExistingModule

error FrictionlessModularComplianceModuleDoesNotExist(address module);

FrictionlessModularComplianceMaxModuleCountReached

thrown if an attempt to add more than the allowable modules during addModules

error FrictionlessModularComplianceMaxModuleCountReached();

FrictionlessModularComplianceCallerNotATokenOrOwner

thrown during bindToken or unBindToken if the caller is not the owner or the bound token address

error FrictionlessModularComplianceCallerNotATokenOrOwner(address caller);

FrictionlessModularComplianceCallerNotAToken

thrown if the the msg.sender is not the bound token address during modifier onlyToken

error FrictionlessModularComplianceCallerNotAToken(address caller);

Git Source

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

setPermissionsManager

Sets the instance of the IFrictionlessPermissionsManager to determine permissions for users.

function setPermissionsManager(address frictionlessPermissionsManager_) external override onlyOwner;

Parameters

setComplianceFactory

Sets the instance of the IFrictionlessComplianceFactory to determine the compliance module for the protocol.

function setComplianceFactory(address newComplianceFactory_) external override onlyOwner;

Parameters

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

Returns

isCustodian

Verifies if the specified wallet address is a PERMISSIONED_CUSTODIAN user.

function isCustodian(address userAddress_) public view override returns (bool);

Parameters

Returns

isInvestor

Verifies if the specified wallet address is a PERMISSIONED_INVESTOR user.

function isInvestor(address userAddress_) public view override returns (bool);

Parameters

Returns

isManager

Verifies if the specified wallet address is a PERMISSIONED_MANAGER user.

function isManager(address userAddress_) public view override returns (bool);

Parameters

Returns

isCalculatingAgent

Verifies if the specified wallet address is a PERMISSIONED_CALCULATING_AGENT user.

function isCalculatingAgent(address userAddress_) public view override returns (bool);

Parameters

Returns

isTransferAgent

Verifies if the specified wallet address is a PERMISSIONED_TRANSFER_AGENT user.

function isTransferAgent(address userAddress_) public view override returns (bool);

Parameters

Returns

isFundAccountant

Verifies if the specified wallet address is a PERMISSIONED_FUND_ACCOUNTANT user.

function isFundAccountant(address userAddress_) public view override returns (bool);

Parameters

Returns

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

Returns

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

Returns

_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

Git Source

Inherits: IModule

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.

The IFrictionlessCompliance is responsible for the compliant transfer of the various Tokens in the Frictionless protocol.

Functions

setPermissionsManager

Sets the instance of the IFrictionlessPermissionsManager to determine permissions for users.

function setPermissionsManager(address frictionlessPermissionsManager_) external;

Parameters

setComplianceFactory

Sets the instance of the IFrictionlessComplianceFactory to determine the compliance module for the protocol.

function setComplianceFactory(address newComplianceFactory_) external;

Parameters

permissionsManager

Gets the instance of the IFrictionlessPermissionsManager to determine permissions for users.

function permissionsManager() external view returns (IFrictionlessPermissionsManager);

Returns

complianceFactory

Gets the instance of the IFrictionlessComplianceFactory to determine the compliance module for the protocol.

function complianceFactory() external view returns (IFrictionlessComplianceFactory);

Returns

isTreasury

Verifies if the specified wallet address is a PROTOCOL_TREASURY user.

function isTreasury(address walletAddress_) external view returns (bool);

Parameters

Returns

isCustodian

Verifies if the specified wallet address is a PERMISSIONED_CUSTODIAN user.

function isCustodian(address walletAddress_) external view returns (bool);

Parameters

Returns

isInvestor

Verifies if the specified wallet address is a PERMISSIONED_INVESTOR user.

function isInvestor(address walletAddress_) external view returns (bool);

Parameters

Returns

isManager

Verifies if the specified wallet address is a PERMISSIONED_MANAGER user.

function isManager(address walletAddress_) external view returns (bool);

Parameters

Returns

isCalculatingAgent

Verifies if the specified wallet address is a PERMISSIONED_CALCULATING_AGENT user.

function isCalculatingAgent(address walletAddress_) external view returns (bool);

Parameters

Returns

isTransferAgent

Verifies if the specified wallet address is a PERMISSIONED_TRANSFER_AGENT user.

function isTransferAgent(address walletAddress_) external view returns (bool);

Parameters

Returns

isFundAccountant

Verifies if the specified wallet address is a PERMISSIONED_FUND_ACCOUNTANT user.

function isFundAccountant(address walletAddress_) external view returns (bool);

Parameters

Returns

isUser

Verifies if the specified wallet address is a permissioned user in the Frictionless protocol.

function isUser(address walletAddress_) external view returns (bool);

Parameters

Returns

hasClaim

verify if the userAddress is permissioned in the Frictionless protocol and has a valid claim

function hasClaim(address userAddress_, IFrictionlessPermissionsManager.FrictionlessPermissionedUser userType_)
    external
    view
    returns (bool);

Parameters

Returns

Events

FrictionlessTokenTransferred

Event emitted during compliance module transfers

event FrictionlessTokenTransferred(
    IBasicFrictionlessToken.FrictionlessTokenTypes tokenType,
    address tokenAddr,
    address from,
    address to,
    uint256 amount
);

Errors

FrictionlessIsZeroAddress

throws if specific address is zero.

error FrictionlessIsZeroAddress(string);

FrictionlessComplianceModuleInvalidCompliance

thrown if the compliance module address is invalid during bindCompliance and unBindCompliance

error FrictionlessComplianceModuleInvalidCompliance(address compliance);

FrictionlessComplianceModuleNotAnApprovedCompliance

thrown if the compliance module address is not approved during bindCompliance

error FrictionlessComplianceModuleNotAnApprovedCompliance(address compliance);

FrictionlessComplianceModuleComplianceIsAlreadyBound

thrown if the compliance module address is already bound, thrown by bindCompliance

error FrictionlessComplianceModuleComplianceIsAlreadyBound(address compliance);

FrictionlessComplianceModuleNotABoundCompliance

thrown if the compliance module address is not already bound during unBindCompliance

error FrictionlessComplianceModuleNotABoundCompliance(address compliance);

Git Source

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.

Interface defining the upgradeable compliance factory for all tokens in the Frictionless protocol.

Functions

setTreasuryManager

Sets the Treasury Manager to be the specified address.

function setTreasuryManager(address newTreasuryManager_) external;

Parameters

updateModularComplianceImpl

Updates and upgrades the modular compliance implementation

function updateModularComplianceImpl(address newModularComplianceImpl_) external;

Parameters

updateSupportedComplianceData

Updates the set of supported modular compliance modules.

function updateSupportedComplianceData(UpdateSupportedComplianceData[] calldata updateSupportedComplianceDataArr_)
    external;

Parameters

updateModularComplianceData

Updates the modular compliance data.

function updateModularComplianceData(UpdateModularComplianceData[] calldata updateModularComplianceDataArr_) external;

Parameters

deployCompliance

Deploys the compliance contract using the ProxyBeacon with the associated FrictionlessPermissionsManager contract

function deployCompliance(IBasicFrictionlessToken.FrictionlessTokenTypes tokenType_) external returns (address);

Parameters

Returns

treasuryManager

returns the address of the treasuryManager

function treasuryManager() external view returns (address);

Returns

modularComplianceBeacon

returns the ProxyBeacon of the ModularCompliance

function modularComplianceBeacon() external view returns (ProxyBeacon);

Returns

getModularComplianceImpl

returns the address of the ModularCompliance

function getModularComplianceImpl() external view returns (address);

Returns

getModularComplianceTokenType

returns the FrictionlessTokenTypes which is bound by the ModularCompliance

function getModularComplianceTokenType(address modularComplianceAddr_)
    external
    view
    returns (IBasicFrictionlessToken.FrictionlessTokenTypes);

Parameters

Returns

getSupportedComplianceModulesCount

returns the amount of supported compliances ModularCompliance for the specified tokenType_

function getSupportedComplianceModulesCount(IBasicFrictionlessToken.FrictionlessTokenTypes tokenType_)
    external
    view
    returns (uint256);

Parameters

Returns

getSupportedComplianceModules

returns the array of supported compliances ModularCompliance for the specified tokenType_

function getSupportedComplianceModules(IBasicFrictionlessToken.FrictionlessTokenTypes tokenType_)
    external
    view
    returns (address[] memory);

Parameters

Returns

getSupportedComplianceInfo

function getSupportedComplianceInfo(IBasicFrictionlessToken.FrictionlessTokenTypes tokenType_)
    external
    view
    returns (ModularComplianceInfo memory);

isSupportedComplianceModule

returns true if the compliance module supports the Frictionless token type, otherwise false

function isSupportedComplianceModule(IBasicFrictionlessToken.FrictionlessTokenTypes tokenType_, address moduleToCheck_)
    external
    view
    returns (bool);

Parameters

Returns

isModularCompliance

Returns true if the address provided is a ModularCompliance contract

function isModularCompliance(address modularComplianceAddr_) external view returns (bool);

Parameters

Returns

Events

FrictionlessComplianceDeployed

Event emitted upon successful deployment of a compliance contract.

event FrictionlessComplianceDeployed(
    IBasicFrictionlessToken.FrictionlessTokenTypes indexed tokenType, address newComplianceContract
);

Errors

FrictionlessComplianceFactoryZeroAddr

error thrown if the specified contract address is a zero address, during init, setTreasuryManager, and updateModularComplianceImpl

error FrictionlessComplianceFactoryZeroAddr(string);

FrictionlessComplianceFactoryNotATreasuryManager

error thrown if the msg.sender is not the treasury manager during the function deployCompliance

error FrictionlessComplianceFactoryNotATreasuryManager(address);

FrictionlessComplianceFactoryNotAModularCompliance

error thrown if the modular compliance is invlaid for hte token type during the function updateModularCompliancesModules

error FrictionlessComplianceFactoryNotAModularCompliance(address);

FrictionlessComplianceFactoryInvalidTokenType

error thrown if an invalid tokenType is specified during deployCompliance

error FrictionlessComplianceFactoryInvalidTokenType();

FrictionlessComplianceFactoryInvalidModularComplianceData

error thrown if an invalid module is specified during updateModularCompliancesModules

error FrictionlessComplianceFactoryInvalidModularComplianceData(UpdateModularComplianceData modularComplianceData);

Structs

SupportedComplianceData

struct SupportedComplianceData {
    uint256 maxModulesCount;
    EnumerableSet.AddressSet modules;
    bytes32[48] _gap;
}

ModularComplianceInfo

struct ModularComplianceInfo {
    uint256 maxModulesCount;
    address[] modules;
}

UpdateModularComplianceData

Structure to represent the update of modular compliance data.

struct UpdateModularComplianceData {
    address modularCompliance;
    ModularComplianceInfo complianceInfo;
    bool isAdding;
}

UpdateSupportedComplianceData

Structure to represent the update of modular compliance data for a given token type

struct UpdateSupportedComplianceData {
    IBasicFrictionlessToken.FrictionlessTokenTypes tokenType;
    ModularComplianceInfo complianceInfo;
    bool isAdding;
}