Auctions #

Hiro Auctions provides an open marketplace for users to trade items through competitive bidding within a set time frame. The system ensures fair participation by validating a user’s ability to afford bids, and guarantees reliable exchanges between the highest bidder and the seller at the end of each listing.

An auction listing is essentially an item for sale with a series of bids. Key elements include:

  • The end time of the listing.
  • The current highest bid or starting bid.
  • The minimum required bid for the next participant.

Listings can only be created for items in the seller’s Hiro Inventory.

Lifecycle #

Each auction progresses through a simple, linear process:

  1. Creating a Listing: The seller chooses an item from their inventory, and it is removed from their possession until the auction concludes.
  2. Bidding: Other users bid, with amounts deducted from their wallets to ensure they can afford the bid at both placement and auction close. Users cannot bid on their own listings or on those where they are the current highest bidder. Bidders that were outbid get their currency back immediately, no waiting until the end of the auction.
  3. End of Auction: The listing concludes, and both the seller and winning bidder are notified to claim their rewards.
    • The seller collects the bid amount (minus fees).
    • The bidder receives the item.

Customization Parameters: #

The following JSON represents the customization parameters you can use to configure the default user experience for the Auctions system.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
{
  "auctions": {
    "auction1": {
      "items": [],
      "item_sets": ["weapons"],
      "conditions": {
        "short": {
          "duration_sec": 3600,
          "listing_cost": {
            "currencies": {
              "coins": 50
            }
          },
          "bid_start": {
            "currencies": {
              "coins": 10
            }
          },
          "fee": {
            "percentage": 0.10
          },
          "extension_threshold_sec": 30,
          "extension_sec": 60,
          "extension_max_sec": 300
        },
        "long": {
          "duration_sec": 86400,
          "listing_cost": {
            "currencies": {
              "coins": 200
            }
          },
          "bid_start": {
            "currencies": {
              "coins": 10
            }
          },
          "fee": {
            "percentage": 0.05
          }
        }
      }
    }
  }
}

Auction #

PropertyTypeDescription
items[]stringThe list of items that are allowed to be sold in this type of auction.
item_sets[]stringThe list of item_sets that are allowed to be sold in this type of auction.
conditions[]AuctionConditionsA set of configuration variants for the auction.

Auction Conditions #

PropertyTypeDescription
duration_secint64The duration of the auction.
listing_costAuctionListingCostThe list of item_sets that are allowed to be sold in this type of auction.
bid_startAuctionBidStartDefines the minimum starting bid and which currencies will be used to bid on this auction listing.
bid_incrementAuctionBidIncrementDefines the minimum difference between the current bid and the next bid amount, expressed as either a flat amount or a percentage based on current bid. If both a flat value and percentage are specified, both must be satisfied by any new bid for it to be allowed.
extension_threshold_secint64If a bid is placed within this number of seconds from the listing ending, the listing is extended.
extension_secint64The number of seconds to add to the listing. This time is added to the original listing end time, not based on the time the bid was placed.
extension_max_secint64The maximum total number of seconds that may be added on to the original listing end time.
feeAuctionFeeFlat or percentage-based fee paid by the seller when collecting the winning bid amount. The successful bidder does not pay an additional fee when claiming their item at the end of the listing. If both a flat fee as well as a percentage are specified, the fee will be the minimum amount that satisfies both conditions.

Auction Listing Cost #

PropertyTypeDescription
currenciesstring:int64A map of currency IDs and quantities to be paid.
itemsstring:int64A map of items IDs and quantities to be paid.
energiesstring:int64A map of energies IDs and quantities to be paid.

Auction Bidding Start #

PropertyTypeDescription
currenciesstring:int64A map of currency IDs and quantities to be paid.

Auction Bid Increment #

PropertyTypeDescription
percentagestring:int64A map of currency IDs and quantities.
fixedstring:int64A map of currency IDs and quantities.

Auction Fee #

PropertyTypeDescription
percentagestring:int64A map of currency IDs and quantities to be paid.
fixedstring:int64A map of currency IDs and quantities to be paid.