IFrictionlessDigitalSecurityToken

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

Name	Type	Description
initData	FDSImmutableData	the immutable data for the FrictionlessDigitalSecurityToken

setUpdateData

Sets the updatable data for the FrictionlessDigitalSecurityToken

function setUpdateData(FDSMutableData calldata mutableData) external;

Parameters

Name	Type	Description
mutableData	FDSMutableData	the updatable data for the FrictionlessDigitalSecurityToken

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

Name	Type	Description
<none>	string	the baseCurrency is the FIAT denomination of the digital security, this is the currency the FrictionlessOnChainAssetToken is issued in.

getTokenType

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

function getTokenType() external view returns (FrictionlessDigitalSecurityTokenType);

Returns

Name	Type	Description
<none>	FrictionlessDigitalSecurityTokenType	the type of the token as defined in the enum.

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

Name	Type	Description
<none>	address	onChainAssetAddress the address of the FrictionlessOnChainAssetToken for which this token is a future cash distribution.

getMaturesOn

Get the maturity date of the digital security.

function getMaturesOn() external view returns (uint256);

Returns

Name	Type	Description
<none>	uint256	the maturity date of the digital security.

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
}