-
Notifications
You must be signed in to change notification settings - Fork 0
/
historical_info.go
112 lines (90 loc) · 3.68 KB
/
historical_info.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
package keeper
import (
"strconv"
sdk "github.com/cosmos/cosmos-sdk/types"
stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
ibccoretypes "github.com/cosmos/ibc-go/v3/modules/core/02-client/types"
"github.com/furyanrasta/furya/x/poe/types"
)
var _ ibccoretypes.StakingKeeper = &Keeper{}
// GetHistoricalInfo gets the historical info at a given height
func (k *Keeper) GetHistoricalInfo(ctx sdk.Context, height int64) (stakingtypes.HistoricalInfo, bool) {
store := ctx.KVStore(k.storeKey)
key := getHistoricalInfoKey(height)
value := store.Get(key)
if value == nil {
return stakingtypes.HistoricalInfo{}, false
}
return stakingtypes.MustUnmarshalHistoricalInfo(k.codec, value), true
}
// SetHistoricalInfo sets the historical info at a given height
func (k *Keeper) SetHistoricalInfo(ctx sdk.Context, height int64, hi *stakingtypes.HistoricalInfo) {
store := ctx.KVStore(k.storeKey)
key := getHistoricalInfoKey(height)
value := k.codec.MustMarshal(hi)
store.Set(key, value)
}
// DeleteHistoricalInfo deletes the historical info at a given height
func (k *Keeper) DeleteHistoricalInfo(ctx sdk.Context, height int64) {
store := ctx.KVStore(k.storeKey)
key := getHistoricalInfoKey(height)
store.Delete(key)
}
// iterateHistoricalInfo provides an interator over all stored HistoricalInfo
//
// objects. For each HistoricalInfo object, cb will be called. If the cb returns
//
// true, the iterator will close and stop.
func (k *Keeper) iterateHistoricalInfo(ctx sdk.Context, cb func(stakingtypes.HistoricalInfo) bool) { //nolint:unused
store := ctx.KVStore(k.storeKey)
iter := sdk.KVStorePrefixIterator(store, types.HistoricalInfoKey)
defer iter.Close()
for ; iter.Valid(); iter.Next() {
histInfo := stakingtypes.MustUnmarshalHistoricalInfo(k.codec, iter.Value())
if cb(histInfo) {
break
}
}
}
// getAllHistoricalInfo returns all stored HistoricalInfo objects.
func (k *Keeper) getAllHistoricalInfo(ctx sdk.Context) []stakingtypes.HistoricalInfo { //nolint:unused
var infos []stakingtypes.HistoricalInfo
k.iterateHistoricalInfo(ctx, func(histInfo stakingtypes.HistoricalInfo) bool {
infos = append(infos, histInfo)
return false
})
return infos
}
// TrackHistoricalInfo saves the latest historical-info and deletes the oldest
// heights that are below pruning height
func (k *Keeper) TrackHistoricalInfo(ctx sdk.Context) {
entryNum := k.HistoricalEntries(ctx)
// Prune store to ensure we only have parameter-defined historical entries.
// In most cases, this will involve removing a single historical entry.
// In the rare scenario when the historical entries gets reduced to a lower value k'
// from the original value k. k - k' entries must be deleted from the store.
// Since the entries to be deleted are always in a continuous range, we can iterate
// over the historical entries starting from the most recent version to be pruned
// and then return at the first empty entry.
for i := ctx.BlockHeight() - int64(entryNum); i >= 0; i-- {
_, found := k.GetHistoricalInfo(ctx, i)
if found {
k.DeleteHistoricalInfo(ctx, i)
} else {
break
}
}
// if there is no need to persist historicalInfo, return
if entryNum == 0 {
return
}
// Create HistoricalInfo struct
var valSet stakingtypes.Validators // not used by IBC so we keep it empty
historicalEntry := stakingtypes.NewHistoricalInfo(ctx.BlockHeader(), valSet, sdk.DefaultPowerReduction)
// Set latest HistoricalInfo at current height
k.SetHistoricalInfo(ctx, ctx.BlockHeight(), &historicalEntry)
}
// getHistoricalInfoKey returns a key prefix for indexing HistoricalInfo objects.
func getHistoricalInfoKey(height int64) []byte {
return append(types.HistoricalInfoKey, []byte(strconv.FormatInt(height, 10))...)
}