smeb_y/0g-chain
1
0
Fork 0
mirror of https://github.com/0glabs/0g-chain.git synced 2024-12-26 16:25:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
d849d690e5
0g-chain/x/auction/spec
History
Ruaridh e1c11d411a Update Auction Module (#276) 
* rough auction type refactor

* replace endTime type

* split keeper file up

* update store methods

* move store methods to keeper.go

* move nextAuctionID from params to genState

* simplify auction type to not use pointers

* add basic auction tests

* update endblocker test

* add payout to depositors feature

* add more tests

* move index updates to Get/Set for more safety

* remove slightly unecessary ID type

* remove unused message types

* feat: add spec, update redundant type names

* stop sending zero coins

* use only one coins field in MsgPlaceBid

* remove uncessary Auction interface methods

* give auction types more accurate names

* remove vuepress comments from spec

* minor spec updates

* update doc comments

* add params validation

* code cleanup, address review comments

* resolve minor TODOs

* sync spec with code

Co-authored-by: Kevin Davis <karzak@users.noreply.github.com>
2020-01-12 16:12:22 +01:00
..
01_concepts.md Update Auction Module (#276) 2020-01-12 16:12:22 +01:00
02_state.md Update Auction Module (#276) 2020-01-12 16:12:22 +01:00
03_messages.md Update Auction Module (#276) 2020-01-12 16:12:22 +01:00
04_events.md Update Auction Module (#276) 2020-01-12 16:12:22 +01:00
05_params.md Update Auction Module (#276) 2020-01-12 16:12:22 +01:00
06_end_block.md Update Auction Module (#276) 2020-01-12 16:12:22 +01:00
README.md Update Auction Module (#276) 2020-01-12 16:12:22 +01:00

README.md

auction

  1. Concepts
  2. State
  3. Messages
  4. Events
  5. Params
  6. BeginBlock

Abstract

x/auction is an implementation of a Cosmos SDK Module that handles the creation, bidding, and payout of 3 distinct auction types. All auction types implement the Auction interface. Each auction type is used at different points during the normal functioning of the CDP system.