Skip to content

INestorDigitalSecurityToken

Git Source

Inherits: IBasicNestorToken

Author: Originally developed by DEFYCA Labs S.a.r.l., maintained by Nestor Exchange OÜ

MIT Licence. Originally Copyright © 2023 DEFYCA Labs S.a.r.l.

This represents a permissioned and transferable digital security reflecting future cash flows from the NestorOnChainAssetToken. Investors acquire these securities using NestorFundDepositTokens. The token operates within a permissioned secondary market, linking to the underlying on-chain asset and denominating values in FIAT currency for settlement purposes.

Functions

setInitData

Sets the immutable data for the NestorDigitalSecurityToken

function setInitData(FDSImmutableData calldata initData) external;

setUpdateData

Sets the updatable data for the NestorDigitalSecurityToken

function setUpdateData(FDSMutableData calldata mutableData) external;

getCurrency

Get the baseCurrency — the FIAT denomination of the digital security.

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

getTokenType

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

function getTokenType() external view returns (NestorDigitalSecurityTokenType);

getOnChainAssetAddress

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

function getOnChainAssetAddress() external view returns (address);

getMaturesOn

Get the maturity date of the digital security.

function getMaturesOn() external view returns (uint256);

Errors

NestorDigitalSecurityTokenInitDataHasAlreadyBeenSet

Error thrown if there is an attempt to modify the immutable data.

error NestorDigitalSecurityTokenInitDataHasAlreadyBeenSet();

Structs

FDSImmutableData

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

FDSMutableData

struct FDSMutableData {
    uint256 maturesOn;
}

Enums

NestorDigitalSecurityTokenType

enum NestorDigitalSecurityTokenType {
    COUPON,
    STRIP
}