0g-chain/x/auction/spec/03_messages.md
Denali Marsh 2d7f5c4080
[R4R] Better docs (#541)
* update sidebar order

* update event backticks

* fix broken links

* fix spelling
2020-06-03 14:54:31 -04:00

940 B

Messages

Bidding

Users can bid on auctions using the MsgPlaceBid message type. All auction types can be bid on using the same message type.

// MsgPlaceBid is the message type used to place a bid on any type of auction.
type MsgPlaceBid struct {
	AuctionID uint64
	Bidder    sdk.AccAddress
	Amount    sdk.Coin
}

State Modifications:

  • Update bidder if different than previous bidder
  • For Surplus auctions:
    • Update Bid to msg.Amount
    • Return bid coins to previous bidder
    • Burn coins equal to the increment in the bid (CurrentBid - PreviousBid)
  • For Debt auctions:
    • Update Lot amount to msg.Amount
    • Return bid coins to previous bidder
  • For Collateral auctions:
    • Return bid coins to previous bidder
    • If in forward phase:
      • Update Bid amount to msg.Amount
    • If in reverse phase:
      • Update Lot amount to msg.Amount
  • Extend auction by BidDuration, up to MaxEndTime