0f-ARK-010: Document protocol capacities

[lgalabru]

• Type: informational
• Git commit: https://github.com/arkadiko-dao/arkadiko/commit/3a3d66012041da0cd386d16d7360aa863d38f25c

Context

The Arkadiko protocol, for very good reasons, is bounding its capacity (vaults, auctions, bids, etc). It could be worthwhile to document all these limits, and ensure cohesion / consistency across the protocol.

Instances (not exhaustive)

• Number of concurrent auctions limited to 1500

  (var-set auction-ids (unwrap-panic (as-max-len? (append (var-get auction-ids) auction-id) u1500)))

• Number of winning lots limited to 100

  (map-set winning-lots
  { user: tx-sender }
  {
  ids: (unwrap-panic (as-max-len? (append (get ids lots) (tuple (auction-id auction-id) (lot-index lot-index))) u100))
  }
  )

• Number of vaults per user limited to 500

  (define-map vault-entries { user: principal } { ids: (list 500 uint) })

Informational issues indicate an improvement request, a general question, a cosmetic or documentation error, or a request for information. There is low-to-no impact.

[philiphacks]

@lgalabru Thanks, good idea.

Where would you document this? In the smart contract itself?

[philiphacks]

updated here: https://github.com/arkadiko-dao/arkadiko/pull/239

We will add the list limits to our gitbook docs.