Quipuswap
  • introduction
    • What is QuipuSwap?
    • Participants
    • QuipuSwap subprojects
      • QuipuSwap Farms
      • Quipuswap Stable DEX
      • Token to Token Swaps
      • Governance (text-only)
  • Get Started
    • Install Wallet
    • How to get TEZ
    • How to find my tokens
    • Connect wallet
    • FAQ
  • Dex Guides
    • Overview
    • Types of the exchange (Token/TEZ, Token/Token)
    • How to use the DEX
      • Trade
      • How to add liquidity to an existing liquidity pool
      • How to create a new liquidity pool
      • How to remove liquidity
      • How to vote for a baker
      • How to ban/veto a baker
  • Tezos Tokens
    • What is a Token?
    • What is the difference between FA1.2 and FA2 standards?
    • QUIPU Tokenomics
  • Smart Contracts
    • Dex token edition
      • Overview
      • Dex
      • Exceptions
    • QuipuSwap stable swap DEX
      • ๐Ÿ› ๏ธDeveloper module
        • ๐Ÿ“„Storage & action types
        • ๐Ÿ”ตDeveloper setter entrypoints
          • set_dev_address
          • set_dev_fee
      • ๐Ÿ Standalone DEX
        • ๐Ÿ“„Storage and types overview
        • ๐ŸŸกInitialization
          • set_admin_function
          • set_dev_function
          • set_dex_function
          • set_token_function
        • ๐ŸŸ Add new dex
          • add_pool
        • ๐Ÿ”ตDEX methods
          • invest
          • swap
          • ๐Ÿ“คDivesting
            • divest
            • divest_imbalanced
            • divest_one_coin
          • ๐Ÿค‘DEX rewards
            • claim_referral
            • stake
        • ๐Ÿ› ๏ธDeveloper methods
          • claim_developer
          • Dev module entrypoints
        • ๐Ÿ›‘Admin methods
          • add_rem_managers
          • ramp_A
          • set_admin
          • set_fees
          • stop_ramp_A
      • ๐ŸญFactory
        • ๐Ÿ“„Storage and types overview
        • ๐ŸŸกInitial setup
          • set_init_function
          • set_dev_function
          • DEX compiled codebase setup
            • set_admin_function
            • set_dex_function
            • set_token_function
        • ๐ŸŸ Initialize new DEX flow
          • add_pool
          • start_dex
        • ๐Ÿ’ฑDeployed from factory DEX
          • ๐Ÿ“„Storage and types overview
          • ๐ŸŸกInitialization
            • copy_dex_function
            • freeze
          • ๐Ÿ”ตDEX methods
          • ๐Ÿ› ๏ธClaim developer rewards
          • ๐Ÿ›‘Admin methods
        • ๐Ÿ›‘Developer methods
          • claim_rewards
          • ๐Ÿง‘โ€๐Ÿ’ปFactory management
            • ๐ŸŸขFactory params
              • set_burn_rate
              • set_price
              • set_whitelist
            • ๐Ÿ”ตDev module entrypoints
    • Dex 2.0
      • โ‰๏ธErrors overview
      • ๐ŸฅBakerRegistry contract
        • Storage and types overview
        • Entrypoints overview
          • validate
          • register
      • โš™๏ธFlashSwapsProxy contract
        • Storage and types overview
        • Entrypoints overview
          • default
      • ๐ŸงบBucket contract
        • Storage and types overview
        • Entrypoints overview
          • fill
          • pour_out
          • pour_over
          • withdraw_rewards
          • ban_baker
          • vote
          • default
        • On-chain views overview
          • is_banned_baker
          • get_tez_balance
          • get_user_candidate
      • โš–๏ธAuction contract
        • Storage and types overview
        • Entrypoints overview
          • Auction entrypoints
            • receive_fee
            • launch_auction
            • place_bid
            • claim
          • Admin entrypoints
            • set_admin
            • confirm_admin
            • set_baker
            • set_fees
            • set_auction_duration
            • set_min_bid
            • update_whitelist
            • withdraw_dev_fee
            • withdraw_public_fee
            • burn_bid_fee
      • ๐ŸฆDexCore contract
        • Storage and types overview
        • Entrypoints overview
          • DEX entrypoints
            • launch_exchange
            • invest_liquidity
            • divest_liquidity
            • swap
            • withdraw_profit
            • claim_interface_fee
            • claim_interface_tez_fee
            • withdraw_auction_fee
            • vote
          • Admin entrypoints
            • set_admin
            • confirm_admin
            • set_flash_swaps_proxy
            • set_auction
            • add_managers
            • set_fees
            • set_collecting_period
            • update_token_metadata
            • ban
          • Permits' entrypoints
            • permit
            • set_expiry
          • FA2 entrypoints
            • transfer
            • update_operators
            • balance_of
          • Callbacks
            • launch_callback
            • flash_swap_callback
            • close
        • On-chain views overview
          • check_is_banned_baker
          • get_reserves
          • get_total_supply
          • get_swap_min_res
          • get_toks_per_share
          • get_cumulative_prices
          • get_collecting_period
    • Trusted contracts
    • Farming
      • Referral system overview
      • Fees overview
      • Rewards precision overview
      • BakerRegistry contract
        • Storage and types overview
        • Entrypoints overview
          • validate
          • register
      • Burner contract
        • Storage and types overview
        • Entrypoints overview
          • default
          • burn_callback
      • ProxyMinter contract
        • Storage and types overview
        • Entrypoints overview
          • Admin entrypoints
            • add_minter
            • withdraw_tokens
            • set_admin
            • confirm_admin
          • Minter entrypoint
            • mint_tokens
      • QFarm contract
        • Storage and types overview
        • Entrypoints overview
          • Farming entrypoints
            • deposit
            • withdraw
            • harvest
          • FA2 entrypoints
            • transfer
            • update_operators
            • balance_of
          • Admin entrypoints
            • set_admin
            • confirm_admin
            • set_fees
            • set_reward_per_second
            • set_burner
            • set_proxy_minter
            • set_baker_registry
            • set_is_v1_lp
            • ban_bakers
            • add_new_farm
            • pause_farms
            • burn_tez_rewards
            • withdraw_farm_depo
            • update_token_metadata
          • Other entrypoints
            • burn_farm_rewards
            • default
      • TFarm contract
        • Storage and types overview
        • Entrypoints overview
          • Farming entrypoints
            • deposit
            • withdraw
            • harvest
          • FA2 entrypoints
            • transfer
            • update_operators
            • balance_of
          • Admin entrypoints
            • set_admin
            • confirm_admin
            • set_fees
            • set_reward_per_second
            • set_burner
            • set_baker_registry
            • set_is_v1_lp
            • ban_bakers
            • add_new_farm
            • pause_farms
            • burn_tez_rewards
            • claim_farm_rewards
            • withdraw_farm_depo
            • update_token_metadata
          • Other entrypoints
            • default
  • Brand and Logos
Powered by GitBook
On this page
  • user_reward_info_t
  • baker_t
  • user_t
  • storage_t - main contract storage
  1. Smart Contracts
  2. Dex 2.0
  3. Bucket contract

Storage and types overview

user_reward_info_t

Field
Type
Hint
Description

reward_f

nat

Float value multiplied by 1e+18

Reward that must be paid to a user

reward_paid_f

nat

Float value multiplied by 1e+18

Reward that is already paid to a user

type user_reward_info_t is [@layout:comb] record [
  reward_f                : nat;
  reward_paid_f           : nat;
]

baker_t

Field
Type
Description

ban_start_time

timestamp

Start timestamp of baker's banning period

ban_period

nat

Banning period duration (in seconds)

votes

nat

Amount of votes delegated to baker by all users

type baker_t            is [@layout:comb] record [
  ban_start_time          : timestamp;
  ban_period              : nat;
  votes                   : nat;
]

user_t

Field
Type
Description

candidate

option(key_hash)

Baker candidate of a user

votes

nat

Amount of votes delegated to the user's candidate

type user_t             is [@layout:comb] record [
  candidate               : option(key_hash);
  votes                   : nat;
]

storage_t - main contract storage

Field
Type
Description

users

Mapping of users' addresses to theirs info

bakers

Mapping of bakers' addresses to theirs info

users_rewards

Mapping of users' addresses to theirs reward info

previous_delegated

key_hash

Previous delegate

current_delegated

key_hash

Current delegate

next_candidate

key_hash

Next possible delegate

baker_registry

address

dex_core

address

pair_id

token_id_t

next_reward

nat

Accumulator for bakers' rewards that will be distributed between all voters

total_reward

nat

Total rewards that will be distributed among all voters

reward_paid

nat

Amount of paid to users bakers' rewards

reward_per_share

nat

Accumulator for reward per 1 staked token's unit

reward_per_block

nat

Reward per 1 block

last_update_level

nat

Level when a rewards were updated last time

collecting_period_end

nat

Level when rewards will be collected and distributed among all voters

type storage_t          is [@layout:comb] record [
  users                   : big_map(address, user_t);
  bakers                  : big_map(key_hash, baker_t);
  users_rewards           : big_map(address, user_reward_info_t);
  previous_delegated      : key_hash;
  current_delegated       : key_hash;
  next_candidate          : key_hash;
  baker_registry          : address;
  dex_core                : address;
  pair_id                 : token_id_t;
  next_reward             : nat;
  total_reward            : nat;
  reward_paid             : nat;
  reward_per_share        : nat;
  reward_per_block        : nat;
  last_update_level       : nat;
  collecting_period_end   : nat;
]
PreviousBucket contractNextEntrypoints overview

Last updated 3 years ago

big_map(address, )

big_map(key_hash, )

big_map(address, )

contract address

contract address

Pair ID on contract to which the current contract is linked

๐Ÿงบ
BakerRegistry
DexCore
DexCore
user_t
baker_t
user_reward_info_t