-
Notifications
You must be signed in to change notification settings - Fork 0
/
keeper.go
229 lines (198 loc) · 6.99 KB
/
keeper.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
package keeper
import (
"fmt"
"sort"
"time"
"github.com/tendermint/tendermint/libs/log"
errorsmod "cosmossdk.io/errors"
"github.com/cosmos/cosmos-sdk/codec"
storetypes "github.com/cosmos/cosmos-sdk/store/types"
sdk "github.com/cosmos/cosmos-sdk/types"
paramtypes "github.com/cosmos/cosmos-sdk/x/params/types"
"github.com/elysium-station/black/x/pricefeed/types"
)
// Keeper struct for pricefeed module
type Keeper struct {
// key used to access the stores from Context
key storetypes.StoreKey
// Codec for binary encoding/decoding
cdc codec.Codec
// The reference to the Paramstore to get and set pricefeed specific params
paramSubspace paramtypes.Subspace
}
// NewKeeper returns a new keeper for the pricefeed module.
func NewKeeper(
cdc codec.Codec, key storetypes.StoreKey, paramstore paramtypes.Subspace,
) Keeper {
if !paramstore.HasKeyTable() {
paramstore = paramstore.WithKeyTable(types.ParamKeyTable())
}
return Keeper{
cdc: cdc,
key: key,
paramSubspace: paramstore,
}
}
// Logger returns a module-specific logger.
func (k Keeper) Logger(ctx sdk.Context) log.Logger {
return ctx.Logger().With("module", fmt.Sprintf("x/%s", types.ModuleName))
}
// SetPrice updates the posted price for a specific oracle
func (k Keeper) SetPrice(
ctx sdk.Context,
oracle sdk.AccAddress,
marketID string,
price sdk.Dec,
expiry time.Time,
) (types.PostedPrice, error) {
// If the expiry is less than or equal to the current blockheight, we consider the price valid
if !expiry.After(ctx.BlockTime()) {
return types.PostedPrice{}, types.ErrExpired
}
store := ctx.KVStore(k.key)
newRawPrice := types.NewPostedPrice(marketID, oracle, price, expiry)
// Emit an event containing the oracle's new price
ctx.EventManager().EmitEvent(
sdk.NewEvent(
types.EventTypeOracleUpdatedPrice,
sdk.NewAttribute(types.AttributeMarketID, marketID),
sdk.NewAttribute(types.AttributeOracle, oracle.String()),
sdk.NewAttribute(types.AttributeMarketPrice, price.String()),
sdk.NewAttribute(types.AttributeExpiry, expiry.UTC().String()),
),
)
// Sets the raw price for a single oracle instead of an array of all oracle's raw prices
store.Set(types.RawPriceKey(marketID, oracle), k.cdc.MustMarshal(&newRawPrice))
return newRawPrice, nil
}
// SetCurrentPrices updates the price of an asset to the median of all valid oracle inputs
func (k Keeper) SetCurrentPrices(ctx sdk.Context, marketID string) error {
_, ok := k.GetMarket(ctx, marketID)
if !ok {
return errorsmod.Wrap(types.ErrInvalidMarket, marketID)
}
// store current price
validPrevPrice := true
prevPrice, err := k.GetCurrentPrice(ctx, marketID)
if err != nil {
validPrevPrice = false
}
prices := k.GetRawPrices(ctx, marketID)
var notExpiredPrices []types.CurrentPrice
// filter out expired prices
for _, v := range prices {
if v.Expiry.After(ctx.BlockTime()) {
notExpiredPrices = append(notExpiredPrices, types.NewCurrentPrice(v.MarketID, v.Price))
}
}
if len(notExpiredPrices) == 0 {
// NOTE: The current price stored will continue storing the most recent (expired)
// price if this is not set.
// This zero's out the current price stored value for that market and ensures
// that CDP methods that GetCurrentPrice will return error.
k.setCurrentPrice(ctx, marketID, types.CurrentPrice{})
return types.ErrNoValidPrice
}
medianPrice := k.CalculateMedianPrice(notExpiredPrices)
// check case that market price was not set in genesis
if validPrevPrice && !medianPrice.Equal(prevPrice.Price) {
// only emit event if price has changed
ctx.EventManager().EmitEvent(
sdk.NewEvent(
types.EventTypeMarketPriceUpdated,
sdk.NewAttribute(types.AttributeMarketID, marketID),
sdk.NewAttribute(types.AttributeMarketPrice, medianPrice.String()),
),
)
}
currentPrice := types.NewCurrentPrice(marketID, medianPrice)
k.setCurrentPrice(ctx, marketID, currentPrice)
return nil
}
func (k Keeper) setCurrentPrice(ctx sdk.Context, marketID string, currentPrice types.CurrentPrice) {
store := ctx.KVStore(k.key)
store.Set(types.CurrentPriceKey(marketID), k.cdc.MustMarshal(¤tPrice))
}
// CalculateMedianPrice calculates the median prices for the input prices.
func (k Keeper) CalculateMedianPrice(prices []types.CurrentPrice) sdk.Dec {
l := len(prices)
if l == 1 {
// Return immediately if there's only one price
return prices[0].Price
}
// sort the prices
sort.Slice(prices, func(i, j int) bool {
return prices[i].Price.LT(prices[j].Price)
})
// for even numbers of prices, the median is calculated as the mean of the two middle prices
if l%2 == 0 {
median := k.calculateMeanPrice(prices[l/2-1], prices[l/2])
return median
}
// for odd numbers of prices, return the middle element
return prices[l/2].Price
}
func (k Keeper) calculateMeanPrice(priceA, priceB types.CurrentPrice) sdk.Dec {
sum := priceA.Price.Add(priceB.Price)
mean := sum.Quo(sdk.NewDec(2))
return mean
}
// GetCurrentPrice fetches the current median price of all oracles for a specific market
func (k Keeper) GetCurrentPrice(ctx sdk.Context, marketID string) (types.CurrentPrice, error) {
store := ctx.KVStore(k.key)
bz := store.Get(types.CurrentPriceKey(marketID))
if bz == nil {
return types.CurrentPrice{}, types.ErrNoValidPrice
}
var price types.CurrentPrice
err := k.cdc.Unmarshal(bz, &price)
if err != nil {
return types.CurrentPrice{}, err
}
if price.Price.Equal(sdk.ZeroDec()) {
return types.CurrentPrice{}, types.ErrNoValidPrice
}
return price, nil
}
// IterateCurrentPrices iterates over all current price objects in the store and performs a callback function
func (k Keeper) IterateCurrentPrices(ctx sdk.Context, cb func(cp types.CurrentPrice) (stop bool)) {
iterator := sdk.KVStorePrefixIterator(ctx.KVStore(k.key), types.CurrentPricePrefix)
defer iterator.Close()
for ; iterator.Valid(); iterator.Next() {
var cp types.CurrentPrice
k.cdc.MustUnmarshal(iterator.Value(), &cp)
if cb(cp) {
break
}
}
}
// GetCurrentPrices returns all current price objects from the store
func (k Keeper) GetCurrentPrices(ctx sdk.Context) types.CurrentPrices {
var cps types.CurrentPrices
k.IterateCurrentPrices(ctx, func(cp types.CurrentPrice) (stop bool) {
cps = append(cps, cp)
return false
})
return cps
}
// GetRawPrices fetches the set of all prices posted by oracles for an asset
func (k Keeper) GetRawPrices(ctx sdk.Context, marketId string) types.PostedPrices {
var pps types.PostedPrices
k.IterateRawPricesByMarket(ctx, marketId, func(pp types.PostedPrice) (stop bool) {
pps = append(pps, pp)
return false
})
return pps
}
// IterateRawPrices iterates over all raw prices in the store and performs a callback function
func (k Keeper) IterateRawPricesByMarket(ctx sdk.Context, marketId string, cb func(record types.PostedPrice) (stop bool)) {
iterator := sdk.KVStorePrefixIterator(ctx.KVStore(k.key), types.RawPriceIteratorKey((marketId)))
defer iterator.Close()
for ; iterator.Valid(); iterator.Next() {
var record types.PostedPrice
k.cdc.MustUnmarshal(iterator.Value(), &record)
if cb(record) {
break
}
}
}