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

simplify auction type to not use pointers

Browse Source
This commit is contained in:
rhuairahrighairigh 2019-12-28 17:17:46 +00:00
parent c867e8ba9e
commit ac27571d15
3 changed files with 27 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
x/auction/keeper/auctions.go
View File

@ -96,7 +96,7 @@ func (k Keeper) PlaceBid(ctx sdk.Context, auctionID types.ID, bidder sdk.AccAddr
return err return err
} }
default: default:
panic("unrecognized auction type") panic(fmt.Sprintf("unrecognized auction type: %T", auction))
} }
// store updated auction // store updated auction

39
x/auction/types/auctions.go
View File

@ -13,6 +13,7 @@ import (
// ID type for auction IDs // ID type for auction IDs
type ID uint64 type ID uint64
// TODO can this be removed?
// NewIDFromString generate new auction ID from a string // NewIDFromString generate new auction ID from a string
func NewIDFromString(s string) (ID, error) { func NewIDFromString(s string) (ID, error) {
n, err := strconv.ParseUint(s, 10, 64) // copied from how the gov module rest handler's parse proposal IDs n, err := strconv.ParseUint(s, 10, 64) // copied from how the gov module rest handler's parse proposal IDs
@ -34,7 +35,7 @@ func (id ID) Bytes() []byte {
// Auction is an interface to several types of auction. // Auction is an interface to several types of auction.
type Auction interface { type Auction interface {
GetID() ID GetID() ID
SetID(ID) WithID(ID) Auction
GetBidder() sdk.AccAddress GetBidder() sdk.AccAddress
GetLot() sdk.Coin GetLot() sdk.Coin
GetEndTime() time.Time GetEndTime() time.Time
@ -52,21 +53,18 @@ type BaseAuction struct {
} }
// GetID getter for auction ID // GetID getter for auction ID
func (a *BaseAuction) GetID() ID { return a.ID } func (a BaseAuction) GetID() ID { return a.ID }
// SetID setter for auction ID
func (a *BaseAuction) SetID(id ID) { a.ID = id } // TODO if this returns a new auction with ID then no pointers are needed
// GetBid getter for auction bid // GetBid getter for auction bid
func (a *BaseAuction) GetBidder() sdk.AccAddress { return a.Bidder } func (a BaseAuction) GetBidder() sdk.AccAddress { return a.Bidder }
// GetLot getter for auction lot // GetLot getter for auction lot
func (a *BaseAuction) GetLot() sdk.Coin { return a.Lot } func (a BaseAuction) GetLot() sdk.Coin { return a.Lot }
// GetEndTime getter for auction end time // GetEndTime getter for auction end time
func (a *BaseAuction) GetEndTime() time.Time { return a.EndTime } func (a BaseAuction) GetEndTime() time.Time { return a.EndTime }
func (a *BaseAuction) String() string { func (a BaseAuction) String() string {
return fmt.Sprintf(`Auction %d: return fmt.Sprintf(`Auction %d:
Initiator: %s Initiator: %s
Lot: %s Lot: %s
@ -82,12 +80,15 @@ func (a *BaseAuction) String() string {
// ForwardAuction type for forward auctions // ForwardAuction type for forward auctions
type ForwardAuction struct { type ForwardAuction struct {
*BaseAuction BaseAuction
} }
// WithID returns an auction wtih the ID set
func (a ForwardAuction) WithID(id ID) Auction { a.ID = id; return a }
// NewForwardAuction creates a new forward auction // NewForwardAuction creates a new forward auction
func NewForwardAuction(seller string, lot sdk.Coin, bidDenom string, endTime time.Time) ForwardAuction { func NewForwardAuction(seller string, lot sdk.Coin, bidDenom string, endTime time.Time) ForwardAuction {
auction := ForwardAuction{&BaseAuction{ auction := ForwardAuction{BaseAuction{
// no ID // no ID
Initiator: seller, Initiator: seller,
Lot: lot, Lot: lot,
@ -102,16 +103,19 @@ func NewForwardAuction(seller string, lot sdk.Coin, bidDenom string, endTime tim
// ReverseAuction type for reverse auctions // ReverseAuction type for reverse auctions
type ReverseAuction struct { type ReverseAuction struct {
*BaseAuction BaseAuction
} }
// WithID returns an auction wtih the ID set
func (a ReverseAuction) WithID(id ID) Auction { a.ID = id; return a }
// NewReverseAuction creates a new reverse auction // NewReverseAuction creates a new reverse auction
func NewReverseAuction(buyerModAccName string, bid sdk.Coin, initialLot sdk.Coin, EndTime time.Time) ReverseAuction { func NewReverseAuction(buyerModAccName string, bid sdk.Coin, initialLot sdk.Coin, EndTime time.Time) ReverseAuction {
// TODO setting the bidder here is a bit hacky // TODO setting the bidder here is a bit hacky
// Needs to be set so that when the first bid is placed, it is paid out to the initiator. // Needs to be set so that when the first bid is placed, it is paid out to the initiator.
// Setting to the module account address bypasses calling supply.SendCoinsFromModuleToModule, instead calls SendCoinsFromModuleToModule. Not a problem currently but if checks/logic regarding modules accounts where added to those methods they would be bypassed. // Setting to the module account address bypasses calling supply.SendCoinsFromModuleToModule, instead calls SendCoinsFromModuleToModule. Not a problem currently but if checks/logic regarding modules accounts where added to those methods they would be bypassed.
// Alternative: set address to nil, and catch it in an if statement in place bid // Alternative: set address to nil, and catch it in an if statement in place bid
auction := ReverseAuction{&BaseAuction{ auction := ReverseAuction{BaseAuction{
// no ID // no ID
Initiator: buyerModAccName, Initiator: buyerModAccName,
Lot: initialLot, Lot: initialLot,
@ -125,12 +129,15 @@ func NewReverseAuction(buyerModAccName string, bid sdk.Coin, initialLot sdk.Coin
// ForwardReverseAuction type for forward reverse auction // ForwardReverseAuction type for forward reverse auction
type ForwardReverseAuction struct { type ForwardReverseAuction struct {
*BaseAuction BaseAuction
MaxBid sdk.Coin MaxBid sdk.Coin
OtherPerson sdk.AccAddress // TODO rename, this is normally the original CDP owner, will have to be updated to account for deposits OtherPerson sdk.AccAddress // TODO rename, this is normally the original CDP owner, will have to be updated to account for deposits
} }
func (a *ForwardReverseAuction) String() string { // WithID returns an auction wtih the ID set
func (a ForwardReverseAuction) WithID(id ID) Auction { a.ID = id; return a }
func (a ForwardReverseAuction) String() string {
return fmt.Sprintf(`Auction %d: return fmt.Sprintf(`Auction %d:
Initiator: %s Initiator: %s
Lot: %s Lot: %s
@ -149,7 +156,7 @@ func (a *ForwardReverseAuction) String() string {
// NewForwardReverseAuction creates a new forward reverse auction // NewForwardReverseAuction creates a new forward reverse auction
func NewForwardReverseAuction(seller string, lot sdk.Coin, EndTime time.Time, maxBid sdk.Coin, otherPerson sdk.AccAddress) ForwardReverseAuction { func NewForwardReverseAuction(seller string, lot sdk.Coin, EndTime time.Time, maxBid sdk.Coin, otherPerson sdk.AccAddress) ForwardReverseAuction {
auction := ForwardReverseAuction{ auction := ForwardReverseAuction{
BaseAuction: &BaseAuction{ BaseAuction: BaseAuction{
// no ID // no ID
Initiator: seller, Initiator: seller,
Lot: lot, Lot: lot,

6
x/auction/types/codec.go
View File

@ -17,7 +17,7 @@ func RegisterCodec(cdc *codec.Codec) {
// Register the Auction interface and concrete types // Register the Auction interface and concrete types
cdc.RegisterInterface((*Auction)(nil), nil) cdc.RegisterInterface((*Auction)(nil), nil)
cdc.RegisterConcrete(&ForwardAuction{}, "auction/ForwardAuction", nil) cdc.RegisterConcrete(ForwardAuction{}, "auction/ForwardAuction", nil)
cdc.RegisterConcrete(&ReverseAuction{}, "auction/ReverseAuction", nil) cdc.RegisterConcrete(ReverseAuction{}, "auction/ReverseAuction", nil)
cdc.RegisterConcrete(&ForwardReverseAuction{}, "auction/ForwardReverseAuction", nil) cdc.RegisterConcrete(ForwardReverseAuction{}, "auction/ForwardReverseAuction", nil)
} }