-
Notifications
You must be signed in to change notification settings - Fork 4
/
keeper.go
289 lines (241 loc) · 7.76 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
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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
package keeper
import (
"context"
"fmt"
"cosmossdk.io/collections"
storetypes "cosmossdk.io/core/store"
"cosmossdk.io/errors"
"cosmossdk.io/log"
"cosmossdk.io/math"
minttypes "github.com/ODIN-PROTOCOL/odin-core/x/mint/types"
"github.com/cosmos/cosmos-sdk/codec"
sdk "github.com/cosmos/cosmos-sdk/types"
)
// Keeper of the mint store
type Keeper struct {
cdc codec.BinaryCodec
storeService storetypes.KVStoreService
stakingKeeper minttypes.StakingKeeper
authKeeper minttypes.AccountKeeper
bankKeeper minttypes.BankKeeper
feeCollectorName string
// the address capable of executing a MsgUpdateParams message. Typically, this
// should be the x/gov module account.
authority string
Schema collections.Schema
Params collections.Item[minttypes.Params]
Minter collections.Item[minttypes.Minter]
MintPool collections.Item[minttypes.MintPool]
}
// NewKeeper creates a new mint Keeper instance
func NewKeeper(
cdc codec.BinaryCodec,
storeService storetypes.KVStoreService,
sk minttypes.StakingKeeper,
ak minttypes.AccountKeeper,
bk minttypes.BankKeeper,
feeCollectorName string,
authority string,
) Keeper {
// ensure mint module account is set
if addr := ak.GetModuleAddress(minttypes.ModuleName); addr == nil {
panic(fmt.Sprintf("the x/%s module account has not been set", minttypes.ModuleName))
}
sb := collections.NewSchemaBuilder(storeService)
k := Keeper{
cdc: cdc,
storeService: storeService,
stakingKeeper: sk,
bankKeeper: bk,
authKeeper: ak,
feeCollectorName: feeCollectorName,
authority: authority,
Params: collections.NewItem(sb, minttypes.ParamsKey, "params", codec.CollValue[minttypes.Params](cdc)),
Minter: collections.NewItem(sb, minttypes.MinterKey, "minter", codec.CollValue[minttypes.Minter](cdc)),
MintPool: collections.NewItem(sb, minttypes.MintPoolStoreKey, "mint_pool", codec.CollValue[minttypes.MintPool](cdc)),
}
schema, err := sb.Build()
if err != nil {
panic(err)
}
k.Schema = schema
return k
}
// GetAuthority returns the x/mint module's authority.
func (k Keeper) GetAuthority() string {
return k.authority
}
// Logger returns a module-specific logger.
func (k Keeper) Logger(ctx context.Context) log.Logger {
sdkCtx := sdk.UnwrapSDKContext(ctx)
return sdkCtx.Logger().With("module", "x/"+minttypes.ModuleName)
}
// get the minter
func (k Keeper) GetMinter(ctx context.Context) (minttypes.Minter, error) {
return k.Minter.Get(ctx)
}
// set the minter
func (k Keeper) SetMinter(ctx context.Context, minter minttypes.Minter) error {
return k.Minter.Set(ctx, minter)
}
// GetMintPool returns the mint pool info
func (k Keeper) GetMintPool(ctx context.Context) (minttypes.MintPool, error) {
return k.MintPool.Get(ctx)
}
// SetMintPool sets mint pool to the store
func (k Keeper) SetMintPool(ctx context.Context, mintPool minttypes.MintPool) error {
return k.MintPool.Set(ctx, mintPool)
}
// GetParams returns the total set of minting parameters.
func (k Keeper) GetParams(ctx context.Context) (minttypes.Params, error) {
return k.Params.Get(ctx)
}
// SetParams sets the total set of minting parameters.
func (k Keeper) SetParams(ctx context.Context, params minttypes.Params) error {
return k.Params.Set(ctx, params)
}
// StakingTokenSupply implements an alias call to the underlying staking keeper's
// StakingTokenSupply to be used in BeginBlocker.
func (k Keeper) StakingTokenSupply(ctx context.Context) (math.Int, error) {
return k.stakingKeeper.StakingTokenSupply(ctx)
}
// BondedRatio implements an alias call to the underlying staking keeper's
// BondedRatio to be used in BeginBlocker.
func (k Keeper) BondedRatio(ctx context.Context) (math.LegacyDec, error) {
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 context.Context, newCoins sdk.Coins) error {
if newCoins.Empty() {
// skip as no coins need to be minted
return nil
}
return k.bankKeeper.MintCoins(ctx, minttypes.ModuleName, newCoins)
}
// AddCollectedFees implements an alias call to the underlying supply keeper's
// AddCollectedFees to be used in BeginBlocker.
func (k Keeper) AddCollectedFees(ctx context.Context, fees sdk.Coins) error {
return k.bankKeeper.SendCoinsFromModuleToModule(ctx, minttypes.ModuleName, k.feeCollectorName, fees)
}
// LimitExceeded checks if withdrawal amount exceeds the limit
func (k Keeper) LimitExceeded(ctx context.Context, amt sdk.Coins) (bool, error) {
moduleParams, err := k.GetParams(ctx)
if err != nil {
return false, err
}
return amt.IsAnyGT(moduleParams.MaxWithdrawalPerTime), nil
}
// IsEligibleAccount checks if addr exists in the eligible to withdraw account pool
func (k Keeper) IsEligibleAccount(ctx context.Context, addr string) (bool, error) {
params, err := k.GetParams(ctx)
if err != nil {
return false, err
}
for _, item := range params.EligibleAccountsPool {
if item == addr {
return true, nil
}
}
return false, nil
}
// WithdrawCoinsFromTreasury transfers coins from treasury pool to receiver account
func (k Keeper) WithdrawCoinsFromTreasury(ctx context.Context, receiver sdk.AccAddress, amount sdk.Coins) error {
mintPool, err := k.GetMintPool(ctx)
if err != nil {
return err
}
if amount.IsAllGT(mintPool.TreasuryPool) {
return errors.Wrapf(
minttypes.ErrWithdrawalAmountExceedsModuleBalance,
"withdrawal amount: %s exceeds %s module balance",
amount.String(),
minttypes.ModuleName,
)
}
if err := k.bankKeeper.SendCoinsFromModuleToAccount(ctx, minttypes.ModuleName, receiver, amount); err != nil {
return errors.Wrapf(
err,
"failed to withdraw %s from %s module account",
amount.String(),
minttypes.ModuleName,
)
}
for _, coinAmount := range amount {
mintPool.TreasuryPool = mintPool.TreasuryPool.Sub(coinAmount)
}
err = k.SetMintPool(ctx, mintPool)
if err != nil {
return err
}
return nil
}
// IsAllowedMintDenom checks if denom exists in the allowed mint denoms list
func (k Keeper) IsAllowedMintDenom(ctx context.Context, coin sdk.Coin) (bool, error) {
params, err := k.GetParams(ctx)
if err != nil {
return false, err
}
denom := coin.Denom
for i := range params.AllowedMintDenoms {
if denom == params.AllowedMintDenoms[i].TokenUnitDenom {
return true, nil
}
}
return false, nil
}
// IsAllowedMinter checks if address exists in the allowed minters list
func (k Keeper) IsAllowedMinter(ctx context.Context, addr string) (bool, error) {
params, err := k.GetParams(ctx)
if err != nil {
return false, err
}
for i := range params.AllowedMinter {
if addr == params.AllowedMinter[i] {
return true, nil
}
}
return false, nil
}
// MintVolumeExceeded checks if minting volume exceeds the limit
func (k Keeper) MintVolumeExceeded(ctx context.Context, amt sdk.Coins) (bool, error) {
moduleParams, err := k.GetParams(ctx)
if err != nil {
return false, err
}
minter, err := k.GetMinter(ctx)
if err != nil {
return false, err
}
amt = amt.Add(minter.CurrentMintVolume...)
return amt.IsAnyGT(moduleParams.MaxAllowedMintVolume), nil
}
// MintNewCoins issue new coins
func (k Keeper) MintNewCoins(ctx context.Context, amount sdk.Coins) error {
mintPool, err := k.GetMintPool(ctx)
if err != nil {
return err
}
minter, err := k.GetMinter(ctx)
if err != nil {
return err
}
if err := k.bankKeeper.MintCoins(ctx, minttypes.ModuleName, amount); err != nil {
return errors.Wrapf(
err,
"failed to mint %s new coins",
amount.String(),
)
}
mintPool.TreasuryPool = mintPool.TreasuryPool.Add(amount...)
err = k.SetMintPool(ctx, mintPool)
if err != nil {
return err
}
minter.CurrentMintVolume = minter.CurrentMintVolume.Add(amount...)
err = k.SetMinter(ctx, minter)
if err != nil {
return err
}
return nil
}