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 token 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

deployFundDepositToken

Deploys the FrictionlessFundDepositToken contract as a proxy

function deployFundDepositToken(
    address tokenOwner_,
    BaseTokenInitParams calldata baseTokenInitParams_,
    IFrictionlessFundDepositToken.FFDImmutableData calldata initData_
) external returns (address tokenProxyAddr_);

Parameters

Returns

deployDigitalSecurityToken

Deploys the FrictionlessDigitalSecurityToken contract as a proxy

function deployDigitalSecurityToken(
    address tokenOwner_,
    BaseTokenInitParams calldata baseTokenInitParams_,
    IFrictionlessDigitalSecurityToken.FDSImmutableData calldata initData_,
    IFrictionlessDigitalSecurityToken.FDSMutableData calldata updateData_
) external returns (address tokenProxyAddr_);

Parameters

Returns

deployOnChainAssetToken

Deploys the FrictionlessOnChainAssetToken contract as a proxy

function deployOnChainAssetToken(
    address tokenOwner_,
    BaseTokenInitParams calldata baseTokenInitParams_,
    IFrictionlessOnChainAssetToken.FOCASpecData calldata specData_,
    IFrictionlessOnChainAssetToken.FOCAIssuanceData calldata issuanceData_,
    IFrictionlessOnChainAssetToken.FOCAUpdateData calldata updateData_
) external returns (address tokenProxyAddr_);

Parameters

Returns

treasuryManager

returns the address of the treasuryManager

function treasuryManager() external view returns (address);

Returns

existingFrictionlessTokens

Checks whether a given token address is an existing frictionless token

function existingFrictionlessTokens(address tokenAddr_) external view returns (bool);

Parameters

Returns

Events

FrictionlessTokenDeployed

Event emitted upon successful deployment of a compliance contract.

event FrictionlessTokenDeployed(
    IBasicFrictionlessToken.FrictionlessTokenTypes indexed tokenType, address newTokenContract
);

Errors

FrictionlessTokensFactoryZeroAddress

error thrown if an attempt to set a zero address contract during function setTreasuryManager

error FrictionlessTokensFactoryZeroAddress();

FrictionlessTokensFactoryNotATreasuryManager

error thrown if the msg.sender is not the treasury manager during the functions deployFundDepositToken, deployDigitalSecurityToken, or deployOnChainAssetToken

error FrictionlessTokensFactoryNotATreasuryManager(address);

Structs

BaseTokenInitParams

Struct to represent the base contract data to deploy a Frictionless token contract.

struct BaseTokenInitParams {
    address implementationAuthority;
    address identityRegistry;
    address compliance;
    address onChainId;
    string tokenName;
    string tokenSymbol;
}

Git Source

Inherits: IBasicFrictionlessToken

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.

Implementation of the storage of the underlying OnChain Asset and it's data.

Functions

setSpecificationData

Sets the specData data for the FrictionlessOnChainAssetToken. throws FrictionlessOnChainAssetTokenUnableToUpdateData This data is immutable, an attempt to modify will generate the error FrictionlessOnChainAssetTokenUnableToUpdateData

function setSpecificationData(FOCASpecData calldata specData) external;

Parameters

setIssuanceData

Sets the issuanceData data for the FrictionlessOnChainAssetToken throws FrictionlessOnChainAssetTokenUnableToUpdateData This data is immutable, an attempt to modify will generate the error FrictionlessOnChainAssetTokenUnableToUpdateData

function setIssuanceData(FOCAIssuanceData calldata issuanceData) external;

Parameters

setUpdateData

Sets the updatable data for the FrictionlessOnChainAssetToken

function setUpdateData(FOCAUpdateData calldata updateData) external;

Parameters

getSpecificationData

Get the specData data for the FrictionlessOnChainAssetToken.

function getSpecificationData() external view returns (FOCASpecData memory);

Returns

getIssuanceData

Get the issuanceData data for the FrictionlessOnChainAssetToken.

function getIssuanceData() external view returns (FOCAIssuanceData memory);

Returns

getUpdateData

Get the updateData data for the FrictionlessOnChainAssetToken.

function getUpdateData() external view returns (FOCAUpdateData memory);

Returns

getCurrency

Get the currency the FrictionlessOnChainAssetToken is issued in.

function getCurrency() external view returns (string memory);

Returns

Errors

FrictionlessOnChainAssetTokenUnableToUpdateData

error throw if there is an attempt to modify the immutable data.

error FrictionlessOnChainAssetTokenUnableToUpdateData();

Structs

FOCASpecData

The specification data for the FrictionlessOnChainAssetToken, this is an immutable data struct.

struct FOCASpecData {
    uint256 issuedOn;
    uint256 maturityDays;
    FrictionlessOnChainAssetSchedule schedule;
    FrictionlessOnChainAssetPaymentFrequency paymentFrequency;
    FrictionlessOnChainAssetYieldType yieldType;
    string baseCurrency;
    uint256 stripTotal;
    string name;
    string symbol;
}

FOCAIssuanceData

The issuance data for the FrictionlessOnChainAssetToken, this is an immutable data struct.

struct FOCAIssuanceData {
    uint256 auctionedOn;
    FrictionlessOnChainAssetPriceStatus priceQuoteStatus;
    string onChainAssetUUID;
    string issuerUUID;
    string isin;
    string issuanceDocs;
    string assetClass;
}

FOCAUpdateData

The uopdatable data for the FrictionlessOnChainAssetToken.

struct FOCAUpdateData {
    uint256 maturesOn;
    uint256 total;
    FrictionlessOnChainAssetStatus status;
    uint256 yield;
    FrictionlessOnChainAssetRiskGrade riskGrade;
    uint256 pullToParValue;
    address custodianAddress;
}

Enums

FrictionlessOnChainAssetSchedule

Enum for the schedule of the payments by the Manager, either pro_rat or coupon/bullet style.

enum FrictionlessOnChainAssetSchedule {
    SCHEDULE_COUPON_ONLY,
    SCHEDULE_PRO_RATA
}

FrictionlessOnChainAssetPaymentFrequency

Enum for the periodicity of payments by the Manager

enum FrictionlessOnChainAssetPaymentFrequency {
    PAYMENT_FREQUENCY_DAILY,
    PAYMENT_FREQUENCY_WEEKLY,
    PAYMENT_FREQUENCY_MONTHLY,
    PAYMENT_FREQUENCY_QUARTERLY,
    PAYMENT_FREQUENCY_SEMI_ANNUALLY,
    PAYMENT_FREQUENCY_ANNUALLY,
    PAYMENT_FREQUENCY_SINGLE
}

FrictionlessOnChainAssetYieldType

Enum for the yield for this FrictionlessOnChainAssetToken is a fixed/floating rate

enum FrictionlessOnChainAssetYieldType {
    YIELD_FIXED,
    YIELD_FLOATING
}

FrictionlessOnChainAssetPriceStatus

Enum for the price quote status obtained at auction

enum FrictionlessOnChainAssetPriceStatus {
    PRICE_QUOTE_STATUS_UNDER_SUBSCRIBED,
    PRICE_QUOTE_STATUS_PRICED_AT_PAR,
    PRICE_QUOTE_STATUS_PRICED_AT_DISCOUNT,
    PRICE_QUOTE_STATUS_PRICED_AT_PREMIUM
}

FrictionlessOnChainAssetStatus

Enum for the current status of the FrictionlessOnChainAssetToken. Updated over time by the Treasury

enum FrictionlessOnChainAssetStatus {
    STATUS_MINTED,
    STATUS_PURCHASED,
    STATUS_MATURED,
    STATUS_IMPAIRED,
    STATUS_REDEEMED
}

FrictionlessOnChainAssetRiskGrade

Enum for the current S&P style riskGrade of the FrictionlessOnChainAssetToken. Updated over time by the Manager/Treasury/Risk Oracle.

enum FrictionlessOnChainAssetRiskGrade {
    BER_AAA,
    BER_AA,
    BER_A,
    BER_BBB,
    BER_BB,
    BER_B,
    BER_CCC,
    BER_CC,
    BER_C,
    BER_D,
    BER_UNRATED
}

The Frictionless Tokens describe the tokens which are emitted by the Frictionless protocol to represent Asset, Securities and Deposits. These tokens are based on the ERC-3643 specification of IToken.

The following diagram describes the high-level interaction and composition of a Frictionless token.

Git Source

Inherits: IBasicFrictionlessToken

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.

A Fund Deposit Token represents a permissioned Investors FIAT contribution to a specific fund IBAN in a denominated FIAT currency. The Fund Deposit Token is used as a means of payment and settlement. The Fund Deposit Token can only be transferred between permissioned Investors in the fund. A daily attestation of the fund IBAN serves to prove the 1:1 backing with FIAT. Exclusively under Frictionless Markets S.à.r.l issuance terms Investors holding a FrictionlessFundDepositToken have the legal right to the FIAT value held in the fund IBAN account.

Functions

setInitData

Sets the immutable data for the FrictionlessFundDepositToken

function setInitData(FFDImmutableData calldata initData) external;

Parameters

getCurrency

Get the currency the FIAT denomination of the deposit token.

function getCurrency() external view returns (string memory);

Returns

getDescription

Get the description the description of the deposit token.

function getDescription() external view returns (string memory);

Returns

getFundIBAN

Get the IBAN which Frictionless Markets S.à.r.l holds a matching FIAT currency ledger with a G-SIB for this currency, attestations are provided on this IBAN. This is restricted to onlyAgent roles.

function getFundIBAN() external returns (string memory);

Returns

Errors

FrictionlessFundDepositTokenUnableToUpdateInitData

error throw if there is an attempt to modify the immutable data.

error FrictionlessFundDepositTokenUnableToUpdateInitData();

Structs

FFDImmutableData

Struct which represents the immutable data in the Token. Once set it cannot be modified.

struct FFDImmutableData {
    string currency;
    string description;
    string fundIBAN;
}

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: IToken

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 IBasicFrictionlessToken Represents the base interface for Frictionless protocol tokens, this interface is used to determine a token type.

Functions

setFrictionlessTokenType

Sets the token type according to the specified enumeration

function setFrictionlessTokenType(FrictionlessTokenTypes newTokenType_) external;

Parameters

getFrictionlessTokenType

Returns the token type according to the specified enumeration

function getFrictionlessTokenType() external view returns (FrictionlessTokenTypes);

Returns

Errors

BasicFrictionlessTokenUnableToUpdateFrictionlessTokenType

error thrown if an attempt to set an invalid token type during function setFrictionlessTokenType

error BasicFrictionlessTokenUnableToUpdateFrictionlessTokenType();

Enums

FrictionlessTokenTypes

Enumeration to represent each of the tokens in the Frictionless protocol.

enum FrictionlessTokenTypes {
    NONE,
    FUND_DEPOSIT_TOKEN,
    DIGITAL_SECURITY_TOKEN,
    ON_CHAIN_ASSET_TOKEN
}

Git Source

Inherits: IBasicFrictionlessToken

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.

This is the permissioned & transferable digital security which represents the future cash flow from the FrictionlessOnChainAssetToken and is purchased by the Investor using FrictionlessFundDepositTokens. These digital securities are permissioned and transferable between permissioned Investors in a permissioned secondary market. This token is linked to the FrictionlessOnChainAssetToken and denominated in a FIAT currency at a future date for settlement.

Functions

setInitData

Sets the immutable data for the FrictionlessDigitalSecurityToken

function setInitData(FDSImmutableData calldata initData) external;

Parameters

setUpdateData

Sets the updatable data for the FrictionlessDigitalSecurityToken

function setUpdateData(FDSMutableData calldata mutableData) external;

Parameters

getCurrency

Get the baseCurrency is the FIAT denomination of the digital security, this is the currency the FrictionlessOnChainAssetToken is issued in.

function getCurrency() external view returns (string memory);

Returns

getTokenType

Get the type of the token as defined in the enum FrictionlessDigitalSecurityTokenType.

function getTokenType() external view returns (FrictionlessDigitalSecurityTokenType);

Returns

getOnChainAssetAddress

Get the onChainAssetAddress the address of the FrictionlessOnChainAssetToken for which this token is a future cash distribution.

function getOnChainAssetAddress() external view returns (address);

Returns

getMaturesOn

Get the maturity date of the digital security.

function getMaturesOn() external view returns (uint256);

Returns

Errors

FrictionlessDigitalSecurityTokenInitDataHasAlreadyBeenSet

error throw if there is an attempt to modify the immutable data.

error FrictionlessDigitalSecurityTokenInitDataHasAlreadyBeenSet();

Structs

FDSImmutableData

Struct which represents the immutable data in the Token. Once set it cannot be modified.

struct FDSImmutableData {
    string baseCurrency;
    FrictionlessDigitalSecurityTokenType tokenType;
    address onChainAssetAddress;
}

FDSMutableData

Struct which represents the updatable data in the Token. This data can be modified by the Agent only.

struct FDSMutableData {
    uint256 maturesOn;
}

Enums

FrictionlessDigitalSecurityTokenType

enum FrictionlessDigitalSecurityTokenType {
    COUPON,
    STRIP
}

The Frictionless protocol smart contracts are documented using the NATSPEC standard.

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);

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.

Functions

getFeeInfo

get the FeeInfo for a given key.

Parameters

Returns

getFeeInBps

get the feeInBps value for a given key

Parameters

Returns

getFeeRecipient

get the feeRecipientAddr value for a given key

Parameters

Returns

calculateFeeAmount

Calculates the actual fee in absolute terms for a given fee in basis points.

Parameters

Returns

Events

FrictionlessFeeSet

Event emitted during _setTokenFee

Errors

AbstractFeeModuleInvalidFeeRecipient

error thrown if the recipient is a zero address

AbstractFeeModuleInvalidFee

error thrown if the feesInBps is outside the valid range

Structs

FeeInfo

Struct which defines the FeeInfo, representing the fee in basis points and the recipient of the fees on-chain.

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

Inherits: IAbstractFeeModule

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.

State Variables

ZERO_FEES_IN_BPS

Use SafeERC20 for any ERC20 token in the conversion

represents 0 bps in fees (the minima of fees or 0%)

MAX_FEES_IN_BPS

represents 10000 bps in fees (the maxima of fees or 100%)

_feesInfo

Functions

getFeeInfo

getFeeInBps

getFeeRecipient

calculateFeeAmount

_setTokenFee

Shouldnt arrise due to validation, but being doubly sure, we can't compute incorrect fees.

_transferFees

_validateFeeInfo

Validates the FeeInfo, specifically validates the non zero address of the feeRecipientAddr and the range for the feeInBps (0 to MAX_FEES_IN_BPS).

Parameters