englishauction state

Auction

Auction is a single ascending-bid auction.

auctions

// key(id) -> \*Auction

pending

// "\<id>:\<addr>" -> uint64 refundable amount

nextID

key

key formats an id into a zero-padded, lexicographically-sortable string.

pendKey

pendKey formats the refund key for a given auction id and bidder.

Start

Start opens a new auction for \`item\` running for \`durationBlocks\` blocks from the current height. The caller becomes the seller. Returns the auction id.

Bid

Bid places a bid of \`amount\` on auction \`id\`. It must strictly exceed the current highest bid. The displaced highest bid becomes refundable to its bidder via Withdraw.

Withdraw

Withdraw refunds the caller's accumulated displaced bids for auction \`id\`. Returns the amount refunded (0 if nothing pending).

End

End closes auction \`id\` once its end height is reached, awarding the item to the highest bidder (if any). Anyone may call it.

mustGet

mustGet returns the auction for \`id\`, panicking if it does not exist.

pendingOf

pendingOf returns the refundable amount owed to \`bidder\` for auction \`id\`.

blocksLeft

blocksLeft returns how many blocks remain before \`a\` can be ended (0 if the end height has been reached).

hasWinner

hasWinner reports whether the auction received at least one bid.

Render

Render lists every auction with item, top bid + bidder, time left, and winner.