0g-chain/x/auction/spec/05_params.md

<!--
order: 5
-->

# Parameters

The auction module contains the following parameters:

| Key                 | Type                   | Example                | Description                                                                           |
|---------------------|------------------------|------------------------|---------------------------------------------------------------------------------------|
| MaxAuctionDuration  | string (time.Duration) | "48h0m0s"              |                                                                                       |
| BidDuration         | string (time.Duration) | "3h0m0s"               |                                                                                       |
| IncrementSurplus    | string (dec)           | "0.050000000000000000" | percentage change in bid required for a new bid on a surplus auction                  |
| IncrementDebt       | string (dec)           | "0.050000000000000000" | percentage change in lot required for a new bid on a debt auction                     |
| IncrementCollateral | string (dec)           | "0.050000000000000000" | percentage change in either bid or lot required for a new bid on a collateral auction |
[R4R] Better docs (#541) * update sidebar order * update event backticks * fix broken links * fix spelling 2020-06-03 18:54:31 +00:00			`<!--`
			`order: 5`
			`-->`

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 15:12:22 +00:00			`# Parameters`

			`The auction module contains the following parameters:`

Add min bid increments (#380) * refactor bidding test * add some more bid test cases * add balance checks to bid tests * add more checks to bid tests * add min bid increments * protect against negative lot amounts * fix params tests * change endblocker to beginblocker * update spec * fix params tests * fix: update alias Co-authored-by: Kevin Davis <karzak@users.noreply.github.com> 2020-02-28 22:16:22 +00:00			`\| Key \| Type \| Example \| Description \|`
			`\|---------------------\|------------------------\|------------------------\|---------------------------------------------------------------------------------------\|`
			`\| MaxAuctionDuration \| string (time.Duration) \| "48h0m0s" \| \|`
			`\| BidDuration \| string (time.Duration) \| "3h0m0s" \| \|`
			`\| IncrementSurplus \| string (dec) \| "0.050000000000000000" \| percentage change in bid required for a new bid on a surplus auction \|`
			`\| IncrementDebt \| string (dec) \| "0.050000000000000000" \| percentage change in lot required for a new bid on a debt auction \|`
			`\| IncrementCollateral \| string (dec) \| "0.050000000000000000" \| percentage change in either bid or lot required for a new bid on a collateral auction \|`