Documentation ¶
Index ¶
- func ModuleAccountInvariants(k Keeper) sdk.Invariant
- func NewMsgServerImpl(keeper Keeper) types.MsgServer
- func NewQuerier(keeper Keeper, legacyQuerierCdc *codec.LegacyAmino) sdk.Querier
- func NewQueryServerImpl(k Keeper) types.QueryServer
- func RegisterInvariants(ir sdk.InvariantRegistry, k Keeper)
- func ValidAuctionInvariant(k Keeper) sdk.Invariant
- func ValidIndexInvariant(k Keeper) sdk.Invariant
- type Keeper
- func (k Keeper) CloseAuction(ctx sdk.Context, auctionID uint64) error
- func (k Keeper) CloseExpiredAuctions(ctx sdk.Context) error
- func (k Keeper) DeleteAuction(ctx sdk.Context, auctionID uint64)
- func (k Keeper) GetAllAuctions(ctx sdk.Context) (auctions []types.Auction)
- func (k Keeper) GetAuction(ctx sdk.Context, auctionID uint64) (types.Auction, bool)
- func (k Keeper) GetNextAuctionID(ctx sdk.Context) (uint64, error)
- func (k Keeper) GetParams(ctx sdk.Context) (params types.Params)
- func (k Keeper) IncrementNextAuctionID(ctx sdk.Context) error
- func (k Keeper) InsertIntoByTimeIndex(ctx sdk.Context, endTime time.Time, auctionID uint64)
- func (k Keeper) IterateAuctions(ctx sdk.Context, cb func(auction types.Auction) (stop bool))
- func (k Keeper) IterateAuctionsByTime(ctx sdk.Context, inclusiveCutoffTime time.Time, ...)
- func (k Keeper) Logger(ctx sdk.Context) log.Logger
- func (k Keeper) MarshalAuction(auctionI types.Auction) ([]byte, error)
- func (k Keeper) MustMarshalAuction(auction types.Auction) []byte
- func (k Keeper) MustUnmarshalAuction(bz []byte) types.Auction
- func (k Keeper) PayoutCollateralAuction(ctx sdk.Context, auction *types.CollateralAuction) error
- func (k Keeper) PayoutDebtAuction(ctx sdk.Context, auction *types.DebtAuction) error
- func (k Keeper) PayoutSurplusAuction(ctx sdk.Context, auction *types.SurplusAuction) error
- func (k Keeper) PlaceBid(ctx sdk.Context, auctionID uint64, bidder sdk.AccAddress, newAmount sdk.Coin) error
- func (k Keeper) PlaceBidDebt(ctx sdk.Context, auction *types.DebtAuction, bidder sdk.AccAddress, ...) (*types.DebtAuction, error)
- func (k Keeper) PlaceBidSurplus(ctx sdk.Context, auction *types.SurplusAuction, bidder sdk.AccAddress, ...) (*types.SurplusAuction, error)
- func (k Keeper) PlaceForwardBidCollateral(ctx sdk.Context, auction *types.CollateralAuction, bidder sdk.AccAddress, ...) (*types.CollateralAuction, error)
- func (k Keeper) PlaceReverseBidCollateral(ctx sdk.Context, auction *types.CollateralAuction, bidder sdk.AccAddress, ...) (*types.CollateralAuction, error)
- func (k Keeper) SetAuction(ctx sdk.Context, auction types.Auction)
- func (k Keeper) SetNextAuctionID(ctx sdk.Context, id uint64)
- func (k Keeper) SetParams(ctx sdk.Context, params types.Params)
- func (k Keeper) StartCollateralAuction(ctx sdk.Context, seller string, lot, maxBid sdk.Coin, ...) (uint64, error)
- func (k Keeper) StartDebtAuction(ctx sdk.Context, buyer string, bid sdk.Coin, initialLot sdk.Coin, ...) (uint64, error)
- func (k Keeper) StartSurplusAuction(ctx sdk.Context, seller string, lot sdk.Coin, bidDenom string) (uint64, error)
- func (k Keeper) StoreNewAuction(ctx sdk.Context, auction types.Auction) (uint64, error)
- func (k Keeper) UnmarshalAuction(bz []byte) (types.Auction, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ModuleAccountInvariants ¶ added in v0.8.0
ModuleAccountInvariants checks that the module account's coins matches those stored in auctions
func NewMsgServerImpl ¶ added in v0.16.0
NewMsgServerImpl returns an implementation of the auction MsgServer interface for the provided Keeper.
func NewQuerier ¶
func NewQuerier(keeper Keeper, legacyQuerierCdc *codec.LegacyAmino) sdk.Querier
NewQuerier is the module level router for state queries
func NewQueryServerImpl ¶ added in v0.16.0
func NewQueryServerImpl(k Keeper) types.QueryServer
NewQueryServerImpl creates a new server for handling gRPC queries.
func RegisterInvariants ¶ added in v0.8.0
func RegisterInvariants(ir sdk.InvariantRegistry, k Keeper)
RegisterInvariants registers all staking invariants
func ValidAuctionInvariant ¶ added in v0.8.0
ValidAuctionInvariant verifies that all auctions in the store are independently valid
func ValidIndexInvariant ¶ added in v0.8.0
ValidIndexInvariant checks that all auctions in the store are also in the index and vice versa.
Types ¶
type Keeper ¶
type Keeper struct {
// contains filtered or unexported fields
}
func NewKeeper ¶
func NewKeeper(cdc codec.Codec, storeKey sdk.StoreKey, paramstore paramtypes.Subspace, bankKeeper types.BankKeeper, accountKeeper types.AccountKeeper) Keeper
NewKeeper returns a new auction keeper.
func (Keeper) CloseAuction ¶
CloseAuction closes an auction and distributes funds to the highest bidder.
func (Keeper) CloseExpiredAuctions ¶
CloseExpiredAuctions iterates over all the auctions stored by until the current block timestamp and that are past (or at) their ending times and closes them, paying out to the highest bidder.
func (Keeper) DeleteAuction ¶
DeleteAuction removes an auction from the store, and any indexes.
func (Keeper) GetAllAuctions ¶ added in v0.8.0
GetAllAuctions returns all auctions from the store
func (Keeper) GetAuction ¶
GetAuction gets an auction from the store.
func (Keeper) GetNextAuctionID ¶
GetNextAuctionID reads the next available global ID from store
func (Keeper) IncrementNextAuctionID ¶
IncrementNextAuctionID increments the next auction ID in the store by 1.
func (Keeper) InsertIntoByTimeIndex ¶
InsertIntoByTimeIndex adds an auction ID and end time into the byTime index.
func (Keeper) IterateAuctions ¶
IterateAuctions provides an iterator over all stored auctions. For each auction, cb will be called. If cb returns true, the iterator will close and stop.
func (Keeper) IterateAuctionsByTime ¶
func (k Keeper) IterateAuctionsByTime(ctx sdk.Context, inclusiveCutoffTime time.Time, cb func(auctionID uint64) (stop bool))
IterateAuctionByTime provides an iterator over auctions ordered by auction.EndTime. For each auction cb will be callled. If cb returns true the iterator will close and stop.
func (Keeper) MarshalAuction ¶ added in v0.16.0
MarshalAuction protobuf serializes an Auction interface
func (Keeper) MustMarshalAuction ¶ added in v0.16.0
MustMarshalAuction attempts to encode an Auction object and returns the raw encoded bytes. It panics on error.
func (Keeper) MustUnmarshalAuction ¶ added in v0.16.0
MustUnmarshalAuction attempts to decode and return an Auction object from raw encoded bytes. It panics on error.
func (Keeper) PayoutCollateralAuction ¶
PayoutCollateralAuction pays out the proceeds for a collateral auction.
func (Keeper) PayoutDebtAuction ¶
PayoutDebtAuction pays out the proceeds for a debt auction, first minting the coins.
func (Keeper) PayoutSurplusAuction ¶
PayoutSurplusAuction pays out the proceeds for a surplus auction.
func (Keeper) PlaceBid ¶
func (k Keeper) PlaceBid(ctx sdk.Context, auctionID uint64, bidder sdk.AccAddress, newAmount sdk.Coin) error
PlaceBid places a bid on any auction.
func (Keeper) PlaceBidDebt ¶
func (k Keeper) PlaceBidDebt(ctx sdk.Context, auction *types.DebtAuction, bidder sdk.AccAddress, lot sdk.Coin) (*types.DebtAuction, error)
PlaceBidDebt places a reverse bid on a debt auction, moving coins and returning the updated auction.
func (Keeper) PlaceBidSurplus ¶
func (k Keeper) PlaceBidSurplus(ctx sdk.Context, auction *types.SurplusAuction, bidder sdk.AccAddress, bid sdk.Coin) (*types.SurplusAuction, error)
PlaceBidSurplus places a forward bid on a surplus auction, moving coins and returning the updated auction.
func (Keeper) PlaceForwardBidCollateral ¶
func (k Keeper) PlaceForwardBidCollateral(ctx sdk.Context, auction *types.CollateralAuction, bidder sdk.AccAddress, bid sdk.Coin) (*types.CollateralAuction, error)
PlaceForwardBidCollateral places a forward bid on a collateral auction, moving coins and returning the updated auction.
func (Keeper) PlaceReverseBidCollateral ¶
func (k Keeper) PlaceReverseBidCollateral(ctx sdk.Context, auction *types.CollateralAuction, bidder sdk.AccAddress, lot sdk.Coin) (*types.CollateralAuction, error)
PlaceReverseBidCollateral places a reverse bid on a collateral auction, moving coins and returning the updated auction.
func (Keeper) SetAuction ¶
SetAuction puts the auction into the store, and updates any indexes.
func (Keeper) SetNextAuctionID ¶
SetNextAuctionID stores an ID to be used for the next created auction
func (Keeper) StartCollateralAuction ¶
func (k Keeper) StartCollateralAuction( ctx sdk.Context, seller string, lot, maxBid sdk.Coin, lotReturnAddrs []sdk.AccAddress, lotReturnWeights []sdk.Int, debt sdk.Coin, ) (uint64, error)
StartCollateralAuction starts a new collateral (2-phase) auction.
func (Keeper) StartDebtAuction ¶
func (k Keeper) StartDebtAuction(ctx sdk.Context, buyer string, bid sdk.Coin, initialLot sdk.Coin, debt sdk.Coin) (uint64, error)
StartDebtAuction starts a new debt (reverse) auction.
func (Keeper) StartSurplusAuction ¶
func (k Keeper) StartSurplusAuction(ctx sdk.Context, seller string, lot sdk.Coin, bidDenom string) (uint64, error)
StartSurplusAuction starts a new surplus (forward) auction.
func (Keeper) StoreNewAuction ¶
StoreNewAuction stores an auction, adding a new ID