> For the complete documentation index, see [llms.txt](https://docs.quipuswap.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.quipuswap.com/smart-contracts/dex-2.0/dexcore-contract/storage-and-types-overview.md). # Storage and types overview ### token\_t ```pascaligo type token_id_t is nat type tez_t is unit type fa12_token_t is address type fa2_token_t is [@layout:comb] record [ token : address; id : nat; ] type token_t is | Tez of tez_t | Fa12 of fa12_token_t | Fa2 of fa2_token_t ``` ### token\_metadata\_t | Field | Type | Description | | ----------- | ------------------------ | --------------------------------------- | | token\_id | [token\_id\_t](#token_t) | Token's ID | | token\_info | map(string, bytes) | Mapping of token's keys to token's info | ```pascaligo type token_metadata_t is [@layout:comb] record [ token_id : token_id_t; token_info : map(string, bytes); ] ``` ### account\_t | Field | Type | Description | | ---------- | ------------ | ------------------------------------------------- | | allowances | set(address) | Set of accounts who can transfer user's LP tokens | ```pascaligo type account_t is [@layout:comb] record [ allowances : set(address); ] ``` ### tokens\_t | Field | Type | Description | | -------- | -------------------- | ----------- | | token\_a | [token\_t](#token_t) | Token A | | token\_b | [token\_t](#token_t) | Token B | ```pascaligo type tokens_t is [@layout:comb] record [ token_a : token_t; token_b : token_t; ] ``` ### pair\_t | Field | Type | Description | | ---------------------- | --------------- | ----------------------------------------------------------------------------------------------- | | token\_a\_pool | nat | Supply of token A in the pool | | token\_b\_pool | nat | Supply of token B in the pool | | token\_a\_price\_cml | nat | Cumulative price of token A | | token\_b\_price\_cml | nat | Cumulative price of token B | | total\_supply | nat | Total supply of LP token | | last\_block\_timestamp | timestamp | Timestamp of the last block that is used for cumulative prices calculation | | bucket | option(address) | [Bucket](/smart-contracts/dex-2.0/bucket-contract.md) contract address (only for TOK/TEZ pools) | ```pascaligo type pair_t is [@layout:comb] record [ token_a_pool : nat; token_b_pool : nat; token_a_price_cml : nat; token_b_price_cml : nat; total_supply : nat; last_block_timestamp : timestamp; bucket : option(address); ] ``` ### permit\_info\_t | Field | Type | Description | | ----------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------- | | created\_at | timestamp | Timestamp of permit creation | | expiry | option(seconds\_t) | Permit's default expiry (see [TZIP-017](https://gitlab.com/tezos/tzip/-/blob/master/proposals/tzip-17/tzip-17.md) for more details) | ```pascaligo type permit_info_t is [@layout:comb] record [ created_at : timestamp; expiry : option(seconds_t); ] ``` ### user\_permit\_t
FieldTypeDescription
permitsmap(blake2b_hash_t, permit_info_t)Mapping of permits' hashes (bytes) to their info
expiryoption(seconds_t)User's permits default expiry (see TZIP-017 for more details)
```pascaligo type user_permits_t is [@layout:comb] record [ permits : map(blake2b_hash_t, permit_info_t); expiry : option(seconds_t); ] ``` ### fees\_t
FieldTypeHintDescription
interface_feenatFloat value multiplied by 1e+18Fee that goes to referrers or UI/UX providers charged from exchanged amount
swap_feenatFloat value multiplied by 1e+18Fee charged from exchanged amount that goes to the liquidity pool (for liquidity providers)
auction_feenatFloat value multiplied by 1e+18Fee charged from exchanged amount that goes to the Auction contract
withdraw_fee_rewardnatFloat value multiplied by 1e+18The % of the rewards that will be transferred to the transaction sender when he calls withdraw_auction_fee entrypoint
```pascaligo type fees_t is [@layout:comb] record [ interface_fee : nat; swap_fee : nat; auction_fee : nat; withdraw_fee_reward : nat; ] ``` ### storage\_t - main contract storage
FieldTypeDescription
token_metadatabig_map(token_id_t, token_metadata_t)Mapping of pools' IDs to their metadata
ledgerbig_map((address * token_id_t), nat)Mapping of accounts' addresses and pools' IDs to their LP tokens' balances
accountsbig_map((address * token_id_t), account_t)Mapping of accounts' addresses and pools' IDs to their accounts
tokensbig_map(token_id_t, tokens_t)Mapping of pools' IDs to their tokens
token_to_idbig_map(bytes, token_id_t)Mapping of tokens (packed to bytes) to their pool IDs
pairsbig_map(token_id_t, pair_t)Mapping of tokens' IDs to information about the pools of these tokens
permitsbig_map(address, user_permits_t)Mapping of accounts to created by them permits (see TZIP-017 for more details)
interface_feebig_map((token_t * address), nat)Mapping of FA1.2/FA2 tokens and referrers or UI/UX providers to their fees balances in these tokens
interface_tez_feebig_map((token_id_t * address), nat)Mapping of pair IDs and referrers or UI/UX providers to their fees balances in TEZ tokens
auction_feebig_map(token_t, nat)Mapping of FA1.2/FA2 tokens to their fees balances in these tokens that will go to the Auction contract
auction_tez_feebig_map(token_id_t, nat)Mapping of pair IDs to their fees balances in TEZ tokens that will go to the Auction contract
managersset(address)A set of addresses who can update tokens metadata. Can be updated by an administrator
feesfees_tFees that applies during each swap or flash_swap operation
adminaddressAdministrator of the contract
pending_adminoption(address)Pending administrator that should accept his new administrator role (if he is not None)
baker_registryaddressBakerRegistry contract address
flash_swaps_proxyaddressFlashSwapsProxy contract address. Can be changed by an administrator
auctionaddressAuction contract address. Can be changed by an administrator
permits_countercounter_t (nat)Number of permits created in this contract
default_expiryseconds_t (nat)Permits default expiry (see TZIP-017 for more details)
enteredboolIndicator that helps to avoid reentrancy
tokens_countnatNumber of exchanges (pairs) launched in this contract
collecting_periodnatPeriod in blocks during which bakers' rewards are collected and not distributed between voters in Bucket contracts. Can be changed by an administrator
```pascaligo type storage_t is [@layout:comb] record [ token_metadata : big_map(token_id_t, token_metadata_t); ledger : big_map((address * token_id_t), nat); accounts : big_map((address * token_id_t), account_t); tokens : big_map(token_id_t, tokens_t); token_to_id : big_map(bytes, token_id_t); pairs : big_map(token_id_t, pair_t); permits : big_map(address, user_permits_t); interface_fee : big_map((token_t * address), nat); interface_tez_fee : big_map((token_id_t * address), nat); auction_fee : big_map(token_t, nat); auction_tez_fee : big_map(token_id_t, nat); managers : set(address); fees : fees_t; admin : address; pending_admin : option(address); baker_registry : address; flash_swaps_proxy : address; auction : address; permits_counter : counter_t; default_expiry : seconds_t; entered : bool; tokens_count : nat; collecting_period : nat; ] ``` ### full\_storage\_t - storage root | Field | Type | Description | | ------------------ | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | storage | [storage\_t](#storage_t-main-contract-storage) | Actual storage of the contract | | dex\_core\_lambdas | big\_map(nat, bytes) | Contract's lambda-methods | | metadata | big\_map(string, bytes) | Contract's metadata according to [TZIP-016](https://gitlab.com/tezos/tzip/-/blob/master/proposals/tzip-16/tzip-16.md) | ```pascaligo type full_storage_t is [@layout:comb] record [ storage : storage_t; dex_core_lambdas : big_map(nat, bytes); metadata : big_map(string, bytes); ] ```