/
keys.go
265 lines (228 loc) · 8.96 KB
/
keys.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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
package types
import (
"bytes"
"fmt"
"time"
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/cosmos/cosmos-sdk/types/address"
)
const (
// ModuleName is the name of the farming module
ModuleName = "farming"
// RouterKey is the message router key for the farming module
RouterKey = ModuleName
// StoreKey is the default store key for the farming module
StoreKey = ModuleName
// QuerierRoute is the querier route for the farming module
QuerierRoute = ModuleName
)
// keys for farming store prefixes
var (
GlobalPlanIdKey = []byte("globalPlanId")
LastEpochTimeKey = []byte("lastEpochTime")
CurrentEpochDaysKey = []byte("currentEpochDays")
PlanKeyPrefix = []byte{0x11}
StakingKeyPrefix = []byte{0x21}
StakingIndexKeyPrefix = []byte{0x22}
QueuedStakingKeyPrefix = []byte{0x23}
QueuedStakingIndexKeyPrefix = []byte{0x24}
TotalStakingKeyPrefix = []byte{0x25}
HistoricalRewardsKeyPrefix = []byte{0x31}
CurrentEpochKeyPrefix = []byte{0x32}
OutstandingRewardsKeyPrefix = []byte{0x33}
UnharvestedRewardsKeyPrefix = []byte{0x34}
)
// GetPlanKey returns kv indexing key of the plan
func GetPlanKey(planID uint64) []byte {
return append(PlanKeyPrefix, sdk.Uint64ToBigEndian(planID)...)
}
// GetStakingKey returns a key for staking of corresponding the id
func GetStakingKey(stakingCoinDenom string, farmerAcc sdk.AccAddress) []byte {
return append(append(StakingKeyPrefix, LengthPrefixString(stakingCoinDenom)...), farmerAcc...)
}
// GetStakingIndexKey returns an indexing key for a staking.
func GetStakingIndexKey(farmerAcc sdk.AccAddress, stakingCoinDenom string) []byte {
return append(append(StakingIndexKeyPrefix, address.MustLengthPrefix(farmerAcc)...), []byte(stakingCoinDenom)...)
}
// GetStakingsByFarmerPrefix returns a key prefix used to iterate
// stakings by a farmer.
func GetStakingsByFarmerPrefix(farmerAcc sdk.AccAddress) []byte {
return append(StakingIndexKeyPrefix, address.MustLengthPrefix(farmerAcc)...)
}
// GetQueuedStakingKey returns a key for a queued staking.
func GetQueuedStakingKey(endTime time.Time, stakingCoinDenom string, farmerAcc sdk.AccAddress) []byte {
return append(
append(
append(QueuedStakingKeyPrefix, LengthPrefixTimeBytes(endTime)...),
LengthPrefixString(stakingCoinDenom)...),
farmerAcc...)
}
// GetQueuedStakingIndexKey returns an indexing key for a queued staking.
func GetQueuedStakingIndexKey(farmerAcc sdk.AccAddress, stakingCoinDenom string, endTime time.Time) []byte {
return append(
append(
append(QueuedStakingIndexKeyPrefix, address.MustLengthPrefix(farmerAcc)...),
LengthPrefixString(stakingCoinDenom)...),
sdk.FormatTimeBytes(endTime)...)
}
// GetQueuedStakingsByFarmerPrefix returns a key prefix used to iterate
// queued stakings by a farmer.
func GetQueuedStakingsByFarmerPrefix(farmerAcc sdk.AccAddress) []byte {
return append(QueuedStakingIndexKeyPrefix, address.MustLengthPrefix(farmerAcc)...)
}
// GetQueuedStakingsByFarmerAndDenomPrefix returns a key prefix used to
// iterate queued stakings by farmer address and staking coin denom.
func GetQueuedStakingsByFarmerAndDenomPrefix(farmerAcc sdk.AccAddress, stakingCoinDenom string) []byte {
return append(
append(
QueuedStakingIndexKeyPrefix, address.MustLengthPrefix(farmerAcc)...),
LengthPrefixString(stakingCoinDenom)...)
}
// GetQueuedStakingEndBytes returns end bytes for iteration of queued stakings.
// The returned end bytes should be used directly, not through
// sdk.InclusiveEndBytes.
// The range this end bytes form includes queued stakings with same endTime.
func GetQueuedStakingEndBytes(endTime time.Time) []byte {
return append(QueuedStakingKeyPrefix, LengthPrefixTimeBytes(endTime.Add(1))...)
}
// GetTotalStakingsKey returns a key for a total stakings info.
func GetTotalStakingsKey(stakingCoinDenom string) []byte {
return append(TotalStakingKeyPrefix, []byte(stakingCoinDenom)...)
}
// GetHistoricalRewardsKey returns a key for a historical rewards record.
func GetHistoricalRewardsKey(stakingCoinDenom string, epoch uint64) []byte {
return append(append(HistoricalRewardsKeyPrefix, LengthPrefixString(stakingCoinDenom)...), sdk.Uint64ToBigEndian(epoch)...)
}
// GetHistoricalRewardsPrefix returns a key prefix used to iterate
// historical rewards by a staking coin denom.
func GetHistoricalRewardsPrefix(stakingCoinDenom string) []byte {
return append(HistoricalRewardsKeyPrefix, LengthPrefixString(stakingCoinDenom)...)
}
// GetCurrentEpochKey returns a key for a current epoch info.
func GetCurrentEpochKey(stakingCoinDenom string) []byte {
return append(CurrentEpochKeyPrefix, []byte(stakingCoinDenom)...)
}
// GetOutstandingRewardsKey returns a key for an outstanding rewards record.
func GetOutstandingRewardsKey(stakingCoinDenom string) []byte {
return append(OutstandingRewardsKeyPrefix, []byte(stakingCoinDenom)...)
}
// GetUnharvestedRewardsKey returns a key for unharvested rewards.
func GetUnharvestedRewardsKey(farmerAcc sdk.AccAddress, stakingCoinDenom string) []byte {
return append(append(UnharvestedRewardsKeyPrefix, address.MustLengthPrefix(farmerAcc)...), stakingCoinDenom...)
}
// GetUnharvestedRewardsPrefix returns a key to iterate unharvested rewards
// by a farmer.
func GetUnharvestedRewardsPrefix(farmerAcc sdk.AccAddress) []byte {
return append(UnharvestedRewardsKeyPrefix, address.MustLengthPrefix(farmerAcc)...)
}
// ParseStakingKey parses a staking key.
func ParseStakingKey(key []byte) (stakingCoinDenom string, farmerAcc sdk.AccAddress) {
if !bytes.HasPrefix(key, StakingKeyPrefix) {
panic("key does not have proper prefix")
}
denomLen := key[1]
stakingCoinDenom = string(key[2 : 2+denomLen])
farmerAcc = key[2+denomLen:]
return
}
// ParseStakingIndexKey parses a staking index key.
func ParseStakingIndexKey(key []byte) (farmerAcc sdk.AccAddress, stakingCoinDenom string) {
if !bytes.HasPrefix(key, StakingIndexKeyPrefix) {
panic("key does not have proper prefix")
}
addrLen := key[1]
farmerAcc = key[2 : 2+addrLen]
stakingCoinDenom = string(key[2+addrLen:])
return
}
// ParseQueuedStakingKey parses a queued staking key.
func ParseQueuedStakingKey(key []byte) (endTime time.Time, stakingCoinDenom string, farmerAcc sdk.AccAddress) {
if !bytes.HasPrefix(key, QueuedStakingKeyPrefix) {
panic("key does not have proper prefix")
}
timeLen := key[1]
var err error
endTime, err = sdk.ParseTimeBytes(key[2 : 2+timeLen])
if err != nil {
panic(fmt.Errorf("parse end time: %w", err))
}
denomLen := key[2+timeLen]
stakingCoinDenom = string(key[3+timeLen : 3+timeLen+denomLen])
farmerAcc = key[3+timeLen+denomLen:]
return
}
// ParseQueuedStakingIndexKey parses a queued staking index key.
func ParseQueuedStakingIndexKey(key []byte) (farmerAcc sdk.AccAddress, stakingCoinDenom string, endTime time.Time) {
if !bytes.HasPrefix(key, QueuedStakingIndexKeyPrefix) {
panic("key does not have proper prefix")
}
addrLen := key[1]
farmerAcc = key[2 : 2+addrLen]
denomLen := key[2+addrLen]
stakingCoinDenom = string(key[3+addrLen : 3+addrLen+denomLen])
var err error
endTime, err = sdk.ParseTimeBytes(key[3+addrLen+denomLen:])
if err != nil {
panic(fmt.Errorf("parse end time: %w", err))
}
return
}
// ParseTotalStakingsKey parses a total stakings key.
func ParseTotalStakingsKey(key []byte) (stakingCoinDenom string) {
if !bytes.HasPrefix(key, TotalStakingKeyPrefix) {
panic("key does not have proper prefix")
}
stakingCoinDenom = string(key[1:])
return
}
// ParseHistoricalRewardsKey parses a historical rewards key.
func ParseHistoricalRewardsKey(key []byte) (stakingCoinDenom string, epoch uint64) {
if !bytes.HasPrefix(key, HistoricalRewardsKeyPrefix) {
panic("key does not have proper prefix")
}
denomLen := key[1]
stakingCoinDenom = string(key[2 : 2+denomLen])
epoch = sdk.BigEndianToUint64(key[2+denomLen:])
return
}
// ParseCurrentEpochKey parses a current epoch key.
func ParseCurrentEpochKey(key []byte) (stakingCoinDenom string) {
if !bytes.HasPrefix(key, CurrentEpochKeyPrefix) {
panic("key does not have proper prefix")
}
stakingCoinDenom = string(key[1:])
return
}
// ParseOutstandingRewardsKey parses an outstanding rewards key.
func ParseOutstandingRewardsKey(key []byte) (stakingCoinDenom string) {
if !bytes.HasPrefix(key, OutstandingRewardsKeyPrefix) {
panic("key does not have proper prefix")
}
stakingCoinDenom = string(key[1:])
return
}
func ParseUnharvestedRewardsKey(key []byte) (farmerAcc sdk.AccAddress, stakingCoinDenom string) {
if !bytes.HasPrefix(key, UnharvestedRewardsKeyPrefix) {
panic("key does not have proper prefix")
}
addrLen := key[1]
farmerAcc = key[2 : 2+addrLen]
stakingCoinDenom = string(key[2+addrLen:])
return
}
// LengthPrefixString returns length-prefixed bytes representation
// of a string.
func LengthPrefixString(s string) []byte {
bz := []byte(s)
bzLen := len(bz)
if bzLen == 0 {
return bz
}
return append([]byte{byte(bzLen)}, bz...)
}
// LengthPrefixTimeBytes returns length-prefixed bytes representation
// of time.Time.
func LengthPrefixTimeBytes(t time.Time) []byte {
bz := sdk.FormatTimeBytes(t)
return append([]byte{byte(len(bz))}, bz...)
}