Storage and types overview

token_t

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

status_auction_t

type status_auction_t   is
| Active                  of unit
| Finished                of unit

auction_t

Field	Type	Description
status	status_auction_t	Status of auction
token	token_t	FA1.2/FA2/TEZ token
end_time	timestamp	Time when auction will be finished
current_bidder	address	Address of a user who made current bid
current_bid	nat	Current bid
amt	nat	Amount of tokens that that were put up for auction

type auction_t          is [@layout:comb] record [
  status                  : status_auction_t;
  token                   : token_t;
  end_time                : timestamp;
  current_bidder          : address;
  current_bid             : nat;
  amt                     : nat;
]

fees_t

Field	Type	Hint	Description
dev_fee_f	nat	Float value multiplied by 1e+18	Fee that goes to the devs fund and can be withdrawn by an administrator
bid_fee_f	nat	Float value multiplied by 1e+18	Fee in QuipuSwap Governance token that applies on each bid for all auctions

type fees_t             is [@layout:comb] record [
  dev_fee_f               : nat;
  bid_fee_f               : nat;
]

storage_t - main contract storage

Field	Type	Hint	Description
auctions	big_map(nat, auction_t)		Mapping of auction IDs' to auctions
dev_fee_balances_f	big_map(token_t, nat)	Float value multiplied by 1e+18	Mapping of tokens to their balances that can be withdrawn by an administrator
public_fee_balances_f	big_map(token_t, nat)	Float value multiplied by 1e+18	Mapping of tokens to their balances for which auction can be launched (except of whitelisted tokens)
whitelist	set(token_t)		A set of tokens for which an auction can't be started. Can be updated by an administrator
quipu_token	fa2_token_t		QuipuSwap Governance token address and ID
fees	fees_t		Fees that applies to each received token
baker	option(key_hash)		Baker for whom all TEZ tokens on the contract were delegated. Can be changed by an administrator
admin	address		Administrator of the contract
pending_admin	option(address)		Pending administrator that should accept his new administrator role (if he is not None)
dex_core	address		DexCore contract address
bid_fee_balance_f	nat	Float value multiplied by 1e+18	Bid fee balance in QuipuSwap Governance token that were withdrawn from each bid. Can be burned by an administrator
auctions_count	nat		Number of auctions created by all users
auction_duration	nat		Duration of each auction that will be created. Can be changed by an administrator
min_bid	nat		Minimum possible bid in time of auction launch. Can be changed by an administrator

type storage_t          is [@layout:comb] record [
  auctions                : big_map(nat, auction_t);
  dev_fee_balances_f      : big_map(token_t, nat);
  public_fee_balances_f   : big_map(token_t, nat);
  whitelist               : set(token_t);
  quipu_token             : fa2_token_t;
  fees                    : fees_t;
  baker                   : option(key_hash);
  admin                   : address;
  pending_admin           : option(address);
  dex_core                : address;
  bid_fee_balance_f       : nat;
  auctions_count          : nat;
  auction_duration        : int;
  min_bid                 : nat;
]

full_storage_t - storage root

Field	Type	Description
storage	storage_t	Actual storage of the contract
auction_lambdas	big_map(nat, bytes)	Contract's lambda-methods
metadata	big_map(string, bytes)	Contract's metadata according to TZIP-016

type full_storage_t     is [@layout:comb] record [
  storage                 : storage_t;
  auction_lambdas         : big_map(nat, bytes);
  metadata                : big_map(string, bytes);
]