ODCdataobjects

FungibleFractionsDO

DataObject with base funtionality of Fungible Fractions (Can be used for ERC1155-Compatible DataManagers)

_This contract exposes base functionality of Fungible Fraction tokens, including balanceOf, totalSupply, exists, transferFrom, mint, burn and their batch variants. It also implements the IDODataTransfer interface to handle the transfer of DataPoint data between diids (transfering the balances of the tokens to a different diid if target is empty)

 NOTE: This contract is expected to be used by a DataManager contract, which could
 implement a fungible token interface and provide more advanced features like approvals,
 access control, metadata management, etc. As may be an ERC1155 token.

 This contract does not emit token events, it is expected that the DataManager contract will
 emit the events for the token operations_

InsufficientBalance

error InsufficientBalance(bytes32 diid, uint256 id, uint256 balance, uint256 value)

Error thrown when the balance is insufficient

Parameters

Name	Type	Description
diid	bytes32	The Data index id of the user
id	uint256	The id of the token
balance	uint256	The current balance
value	uint256	The requested amount

InsufficientTotalSupply

error InsufficientTotalSupply(uint256 id, uint256 totalSupply, uint256 value)

Error thrown when the total supply is insufficient

Parameters

Name	Type	Description
id	uint256	The id of the token
totalSupply	uint256	The current total supply
value	uint256	The requested amount NOTE: This should never happen because we've already checked "from" balance

ArrayLengthMismatch

error ArrayLengthMismatch()

Error thrown when the params length mismatch

TransferConflict

error TransferConflict()

Error thrown when there is a conflict in the transfer

DpData

Data structure for storing Fungible Fractions data

Parameters

Name	Type	Description

struct DpData {
  uint256 totalSupplyAll;
  mapping(uint256 => uint256) totalSupply;
}

DiidData

Data structure for storing Fungible Fractions data of a user

Parameters

Name	Type	Description

struct DiidData {
  struct EnumerableSet.UintSet ids;
  mapping(uint256 => uint256) balances;
}

onDataPointTransfer

function onDataPointTransfer(DataPoint dp, bytes32 fromDiid, bytes32 toDiid) external virtual

Transfers data from one id to another

Access to this function MUST be protected and allowed only for Data Index Implementation registered for this DataPoint NOTE: Transfers using this function will skip hook functions on the Data Manager, disable it if required

Parameters

Name	Type	Description
dp	DataPoint	Identifier of the DataPoint
fromDiid	bytes32	ID to transfer from
toDiid	bytes32	ID to transfer to

_dispatchRead

function _dispatchRead(DataPoint dp, bytes4 operation, bytes data) internal view virtual returns (bytes)

_dispatchWrite

function _dispatchWrite(DataPoint dp, bytes4 operation, bytes data) internal virtual returns (bytes)

_balanceOf

function _balanceOf(DataPoint dp, address account, uint256 id) internal view returns (uint256)

Function used to get the balance of an account

Parameters

Name	Type	Description
dp	DataPoint	The DataPoint identifier
account	address	The account address
id	uint256	The id of the token

Return Values

Name	Type	Description
[0]	uint256	The balance of the account

_balanceOfBatch

function _balanceOfBatch(DataPoint dp, address account, uint256[] ids) internal view returns (uint256[] balances)

Function used to get the balance of an account

Parameters

Name	Type	Description
dp	DataPoint	The DataPoint identifier
account	address	The account address
ids	uint256[]	The ids of the tokens

Return Values

Name	Type	Description
balances	uint256[]	The balance of the account

_balanceOfBatchAccounts

function _balanceOfBatchAccounts(DataPoint dp, address[] accounts, uint256[] ids) internal view returns (uint256[] balances)

Function used to get the balance of multiple accounts

Parameters

Name	Type	Description
dp	DataPoint	The DataPoint identifier
accounts	address[]	The account addresses
ids	uint256[]	The ids of the tokens

Return Values

Name	Type	Description
balances	uint256[]	The balance of the accounts

_totalSupply

function _totalSupply(DataPoint dp, uint256 id) internal view returns (uint256)

Function used to get the total supply of a token

Parameters

Name	Type	Description
dp	DataPoint	The DataPoint identifier
id	uint256	The id of the token

Return Values

Name	Type	Description
[0]	uint256	The total supply of the token

_totalSupplyAll

function _totalSupplyAll(DataPoint dp) internal view returns (uint256)

Function used to get the total supply of all ids tokens

Parameters

Name	Type	Description
dp	DataPoint	The DataPoint identifier

Return Values

Name	Type	Description
[0]	uint256	The total supply of all ids tokens

_exists

function _exists(DataPoint dp, uint256 id) internal view returns (bool)

Function used to check if an id exists

Parameters

Name	Type	Description
dp	DataPoint	The DataPoint identifier
id	uint256	The id of the token

Return Values

Name	Type	Description
[0]	bool	True if the id exists, false otherwise

_transferFrom

function _transferFrom(DataPoint dp, address from, address to, uint256 id, uint256 value) internal virtual

Function used to transfer tokens from one account to another

Parameters

Name	Type	Description
dp	DataPoint	The DataPoint identifier
from	address	The account to transfer from
to	address	The account to transfer to
id	uint256	The id of the token
value	uint256	The amount of tokens to transfer

_mint

function _mint(DataPoint dp, address to, uint256 id, uint256 value) internal virtual

Function used to mint tokens

Parameters

Name	Type	Description
dp	DataPoint	The DataPoint identifier
to	address	The account to mint to
id	uint256	The id of the token
value	uint256	The amount of tokens to mint

_burn

function _burn(DataPoint dp, address from, uint256 id, uint256 value) internal virtual

Function used to burn tokens

Parameters

Name	Type	Description
dp	DataPoint	The DataPoint identifier
from	address	The account to burn from
id	uint256	The id of the token
value	uint256	The amount of tokens to burn

_batchTransferFrom

function _batchTransferFrom(DataPoint dp, address from, address to, uint256[] ids, uint256[] values) internal virtual

Function used to transfer multiple tokens from one account to another at once

Parameters

Name	Type	Description
dp	DataPoint	The DataPoint identifier
from	address	The account to transfer from
to	address	The account to transfer to
ids	uint256[]	The ids of the tokens
values	uint256[]	The amounts of tokens to transfer

_batchMint

function _batchMint(DataPoint dp, address to, uint256[] ids, uint256[] values) internal virtual

Function used to mint multiple tokens at once

Parameters

Name	Type	Description
dp	DataPoint	The DataPoint identifier
to	address	The account to mint to
ids	uint256[]	The ids of the tokens
values	uint256[]	The amounts of tokens to mint

_batchBurn

function _batchBurn(DataPoint dp, address from, uint256[] ids, uint256[] values) internal virtual

Operation used to burn multiple tokens at once

Parameters

Name	Type	Description
dp	DataPoint	The DataPoint identifier
from	address	The account to burn from
ids	uint256[]	The ids of the tokens
values	uint256[]	The amounts of tokens to burn

_increaseBalance

function _increaseBalance(struct FungibleFractionsDO.DiidData diidd, uint256 id, uint256 value, DataPoint, bytes32) internal

_decreaseBalance

function _decreaseBalance(struct FungibleFractionsDO.DiidData diidd, uint256 id, uint256 value, DataPoint, bytes32 diidFrom) internal

_onDataPointTransfer

function _onDataPointTransfer(DataPoint dp, bytes32 fromDiid, bytes32 toDiid) internal

_dpData

function _dpData(DataPoint dp) internal returns (struct FungibleFractionsDO.DpData)

_diidData

function _diidData(DataPoint dp, bytes32 diid) internal returns (struct FungibleFractionsDO.DiidData)

_tryDpData

function _tryDpData(DataPoint dp) internal view returns (bool, struct FungibleFractionsDO.DpData)

_tryDiidData

function _tryDiidData(DataPoint dp, bytes32 diid) internal view returns (bool, struct FungibleFractionsDO.DiidData)

Previous

VaultDataObject

Next

IFungibleFractionsTransferCallback