-
Notifications
You must be signed in to change notification settings - Fork 799
/
keeper.go
183 lines (156 loc) · 5.6 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
package keeper
import (
"fmt"
"time"
"github.com/cosmos/cosmos-sdk/codec"
sdk "github.com/cosmos/cosmos-sdk/types"
paramtypes "github.com/cosmos/cosmos-sdk/x/params/types"
epochTypes "github.com/sei-protocol/sei-chain/x/epoch/types"
"github.com/sei-protocol/sei-chain/x/mint/types"
"github.com/tendermint/tendermint/libs/log"
)
// Keeper of the mint store
type Keeper struct {
cdc codec.BinaryCodec
storeKey sdk.StoreKey
paramSpace paramtypes.Subspace
stakingKeeper types.StakingKeeper
bankKeeper types.BankKeeper
hooks types.MintHooks
feeCollectorName string
}
// NewKeeper creates a new mint Keeper instance
func NewKeeper(
cdc codec.BinaryCodec, key sdk.StoreKey, paramSpace paramtypes.Subspace,
sk types.StakingKeeper, ak types.AccountKeeper, bk types.BankKeeper,
_ types.EpochKeeper, feeCollectorName string,
) Keeper {
// ensure mint module account is set
if addr := ak.GetModuleAddress(types.ModuleName); addr == nil {
panic("the mint module account has not been set")
}
// set KeyTable if it has not already been set
if !paramSpace.HasKeyTable() {
paramSpace = paramSpace.WithKeyTable(types.ParamKeyTable())
}
return Keeper{
cdc: cdc,
storeKey: key,
paramSpace: paramSpace,
stakingKeeper: sk,
bankKeeper: bk,
feeCollectorName: feeCollectorName,
}
}
// Logger returns a module-specific logger.
func (k Keeper) Logger(ctx sdk.Context) log.Logger {
return ctx.Logger().With("module", "x/"+types.ModuleName)
}
// Set the mint hooks.
func (k *Keeper) SetHooks(h types.MintHooks) *Keeper {
if k.hooks != nil {
panic("cannot set mint hooks twice")
}
k.hooks = h
return k
}
// get the minter
func (k Keeper) GetMinter(ctx sdk.Context) (minter types.Minter) {
store := ctx.KVStore(k.storeKey)
b := store.Get(types.MinterKey)
if b == nil {
panic("stored minter should not have been nil")
}
k.cdc.MustUnmarshal(b, &minter)
return minter
}
// set the minter
func (k Keeper) SetMinter(ctx sdk.Context, minter types.Minter) {
store := ctx.KVStore(k.storeKey)
b := k.cdc.MustMarshal(&minter)
store.Set(types.MinterKey, b)
}
// GetParams returns the total set of minting parameters.
func (k Keeper) GetParams(ctx sdk.Context) (params types.Params) {
k.paramSpace.GetParamSet(ctx, ¶ms)
return params
}
// SetParams sets the total set of minting parameters.
func (k Keeper) SetParams(ctx sdk.Context, params types.Params) {
k.paramSpace.SetParamSet(ctx, ¶ms)
}
// StakingTokenSupply implements an alias call to the underlying staking keeper's
func (k Keeper) StakingTokenSupply(ctx sdk.Context) sdk.Int {
return k.stakingKeeper.StakingTokenSupply(ctx)
}
// BondedRatio implements an alias call to the underlying staking keeper's
func (k Keeper) BondedRatio(ctx sdk.Context) sdk.Dec {
return k.stakingKeeper.BondedRatio(ctx)
}
// MintCoins implements an alias call to the underlying supply keeper's
// MintCoins to be used in BeginBlocker.
func (k Keeper) MintCoins(ctx sdk.Context, newCoins sdk.Coins) error {
if newCoins.Empty() {
// skip as no coins need to be minted
return nil
}
return k.bankKeeper.MintCoins(ctx, types.ModuleName, newCoins)
}
// AddCollectedFees implements an alias call to the underlying supply keeper's
// AddCollectedFees to be used in BeginBlocker.
func (k Keeper) AddCollectedFees(ctx sdk.Context, fees sdk.Coins) error {
return k.bankKeeper.SendCoinsFromModuleToModule(ctx, types.ModuleName, k.feeCollectorName, fees)
}
// GetProportions gets the balance of the `MintedDenom` from minted coins and returns coins according to the `AllocationRatio`.
func (k Keeper) GetOrUpdateLatestMinter(
ctx sdk.Context,
epoch epochTypes.Epoch,
) types.Minter {
params := k.GetParams(ctx)
currentReleaseMinter := k.GetMinter(ctx)
nextScheduledRelease := GetNextScheduledTokenRelease(epoch, params.TokenReleaseSchedule, currentReleaseMinter)
// There's still an ongoing release (> 0 remaining amount or same start date) or there's no release scheduled
if currentReleaseMinter.OngoingRelease() || nextScheduledRelease.GetStartDate() == currentReleaseMinter.GetStartDate() || nextScheduledRelease == nil {
k.Logger(ctx).Debug("Ongoing token release or no nextScheduledRelease", "minter", currentReleaseMinter)
return currentReleaseMinter
}
return types.NewMinter(
nextScheduledRelease.GetStartDate(),
nextScheduledRelease.GetEndDate(),
params.GetMintDenom(),
nextScheduledRelease.GetTokenReleaseAmount(),
)
}
func (k Keeper) GetCdc() codec.BinaryCodec {
return k.cdc
}
func (k Keeper) GetStoreKey() sdk.StoreKey {
return k.storeKey
}
func (k Keeper) GetParamSpace() paramtypes.Subspace {
return k.paramSpace
}
func (k *Keeper) SetParamSpace(subspace paramtypes.Subspace) {
k.paramSpace = subspace
}
func GetNextScheduledTokenRelease(
epoch epochTypes.Epoch,
tokenReleaseSchedule []types.ScheduledTokenRelease,
currentMinter types.Minter,
) *types.ScheduledTokenRelease {
for _, scheduledRelease := range tokenReleaseSchedule {
scheduledStartDate, err := time.Parse(types.TokenReleaseDateFormat, scheduledRelease.GetStartDate())
if err != nil {
// This should not happen as the scheduled release date is validated when the param is updated
panic(fmt.Errorf("invalid scheduled release date: %s", err))
}
scheduledStartDateTime := scheduledStartDate.UTC()
// If epoch is after the currentScheduled date and it's after the current release
if epoch.GetCurrentEpochStartTime().After(scheduledStartDateTime) {
if scheduledStartDateTime.After(currentMinter.GetEndDateTime()) || scheduledStartDateTime.Equal(currentMinter.GetEndDateTime()) {
return &scheduledRelease
}
}
}
return nil
}