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

Parameters

updateMaxModulesCount

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

Parameters

addModules

Adds modules based on the array of module addresses provided

Parameters

removeModules

Removes modules based on the array of module addresses provided

Parameters

maxModulesCount

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

Returns

Events

MaxModulesCountUpdated

Emitted during updateMaxModulesCount to inform of new modules max count updates

ModulesAdded

Emitted during addModules to inform of new modules added

ModulesRemoved

Emitted during removeModules to inform of modules removed

Errors

FrictionlessIsZeroAddress

thrown if specific address is zero.

FrictionlessModularComplianceZeroMaxModulesCount

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

FrictionlessModularComplianceModuleIsAlreadyBound

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

FrictionlessModularComplianceModuleDoesNotExist

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

FrictionlessModularComplianceMaxModuleCountReached

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

FrictionlessModularComplianceCallerNotATokenOrOwner

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

FrictionlessModularComplianceCallerNotAToken

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

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.

Parameters

updateModularComplianceImpl

Updates and upgrades the modular compliance implementation

Parameters

updateSupportedComplianceData

Updates the set of supported modular compliance modules.

Parameters

updateModularComplianceData

Updates the modular compliance data.

Parameters

deployCompliance

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

Parameters

Returns

treasuryManager

returns the address of the treasuryManager

Returns

modularComplianceBeacon

returns the ProxyBeacon of the ModularCompliance

Returns

getModularComplianceImpl

returns the address of the ModularCompliance

Returns

getModularComplianceTokenType

returns the FrictionlessTokenTypes which is bound by the ModularCompliance

Parameters

Returns

getSupportedComplianceModulesCount

returns the amount of supported compliances ModularCompliance for the specified tokenType_

Parameters

Returns

getSupportedComplianceModules

returns the array of supported compliances ModularCompliance for the specified tokenType_

Parameters

Returns

getSupportedComplianceInfo

isSupportedComplianceModule

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

Parameters

Returns

isModularCompliance

Returns true if the address provided is a ModularCompliance contract

Parameters

Returns

Events

FrictionlessComplianceDeployed

Event emitted upon successful deployment of a compliance contract.

Errors

FrictionlessComplianceFactoryZeroAddr

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

FrictionlessComplianceFactoryNotATreasuryManager

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

FrictionlessComplianceFactoryNotAModularCompliance

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

FrictionlessComplianceFactoryInvalidTokenType

error thrown if an invalid tokenType is specified during deployCompliance

FrictionlessComplianceFactoryInvalidModularComplianceData

error thrown if an invalid module is specified during updateModularCompliancesModules

Structs

SupportedComplianceData

ModularComplianceInfo

UpdateModularComplianceData

Structure to represent the update of modular compliance data.

UpdateSupportedComplianceData

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

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.

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.

complianceFactory

The IFrictionlessComplianceFactory for the protocol.

_complianceBound

the mapping of compliance modules bound.

Functions

onlyApprovedCompliance

modifier used to very that only approved compliance modules can be used.

onlyBoundCompliance

modifier used to very that only modules that are bound, can be used.

__AbstractFrictionlessComplianceModule_init

Initiatizes the compliance module

Parameters

setPermissionsManager

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

Parameters

setComplianceFactory

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

Parameters

bindCompliance

unbindCompliance

moduleTransferAction

moduleMintAction

moduleBurnAction

moduleCheck

isComplianceBound

isTreasury

Verifies if the specified wallet address is a PROTOCOL_TREASURY user.

Parameters

Returns

isCustodian

Verifies if the specified wallet address is a PERMISSIONED_CUSTODIAN user.

Parameters

Returns

isInvestor

Verifies if the specified wallet address is a PERMISSIONED_INVESTOR user.

Parameters

Returns

isManager

Verifies if the specified wallet address is a PERMISSIONED_MANAGER user.

Parameters

Returns

isCalculatingAgent

Verifies if the specified wallet address is a PERMISSIONED_CALCULATING_AGENT user.

Parameters

Returns

isTransferAgent

Verifies if the specified wallet address is a PERMISSIONED_TRANSFER_AGENT user.

Parameters

Returns

isFundAccountant

Verifies if the specified wallet address is a PERMISSIONED_FUND_ACCOUNTANT user.

Parameters

Returns

isUser

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

Parameters

Returns

hasClaim

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

Parameters

Returns

_setPermissionsManager

Impl of the setting of the permissions manager

_setComplianceFactory

Impl of the setting of the compliance factory

_checkZeroAddr

Verifies if an address is a zero address

_onlyBoundCompliance

Verifies if the compliance_ address supplied is bound as per the mapping

_onlyValidCompliance

Verifies if the compliance_ address supplied is valid

_onlyApprovedCompliance

Verifies if the msg.sender is a valid modular compliance

_getTokenBound

Returns the address of the IToken bound by this compliance

_hasClaim

Determine if a claim is present for a given userAddress and userType

Parameters