/
keeper.go
263 lines (216 loc) · 8.79 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
package keeper
import (
"fmt"
"strconv"
"cosmossdk.io/errors"
"github.com/cometbft/cometbft/libs/log"
"github.com/cosmos/cosmos-sdk/codec"
"github.com/cosmos/cosmos-sdk/store/prefix"
storetypes "github.com/cosmos/cosmos-sdk/store/types"
sdk "github.com/cosmos/cosmos-sdk/types"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
channeltypes "github.com/cosmos/ibc-go/v7/modules/core/04-channel/types"
"github.com/neutron-org/neutron/v2/x/feerefunder/types"
)
type (
Keeper struct {
cdc codec.BinaryCodec
bankKeeper types.BankKeeper
storeKey storetypes.StoreKey
memKey storetypes.StoreKey
channelKeeper types.ChannelKeeper
authority string
}
)
func NewKeeper(
cdc codec.BinaryCodec,
storeKey,
memKey storetypes.StoreKey,
channelKeeper types.ChannelKeeper,
bankKeeper types.BankKeeper,
authority string,
) *Keeper {
return &Keeper{
cdc: cdc,
storeKey: storeKey,
memKey: memKey,
channelKeeper: channelKeeper,
bankKeeper: bankKeeper,
authority: authority,
}
}
func (k Keeper) GetAuthority() string {
return k.authority
}
func (k Keeper) Logger(ctx sdk.Context) log.Logger {
return ctx.Logger().With("module", fmt.Sprintf("x/%s", types.ModuleName))
}
func (k Keeper) LockFees(ctx sdk.Context, payer sdk.AccAddress, packetID types.PacketID, fee types.Fee) error {
k.Logger(ctx).Debug("Trying to lock fees", "packetID", packetID, "fee", fee)
if _, ok := k.channelKeeper.GetChannel(ctx, packetID.PortId, packetID.ChannelId); !ok {
return errors.Wrapf(channeltypes.ErrChannelNotFound, "channel with id %s and port %s not found", packetID.ChannelId, packetID.PortId)
}
if err := k.checkFees(ctx, fee); err != nil {
return errors.Wrapf(err, "failed to lock fees")
}
feeInfo := types.FeeInfo{
Payer: payer.String(),
Fee: fee,
PacketId: packetID,
}
k.StoreFeeInfo(ctx, feeInfo)
if err := k.bankKeeper.SendCoinsFromAccountToModule(ctx, payer, types.ModuleName, fee.Total()); err != nil {
return errors.Wrapf(err, "failed to send coins during fees locking")
}
ctx.EventManager().EmitEvents(sdk.Events{
sdk.NewEvent(
types.EventTypeLockFees,
sdk.NewAttribute(types.AttributeKeyPayer, payer.String()),
sdk.NewAttribute(types.AttributeKeyPortID, packetID.PortId),
sdk.NewAttribute(types.AttributeKeyChannelID, packetID.ChannelId),
sdk.NewAttribute(types.AttributeKeySequence, strconv.FormatUint(packetID.Sequence, 10)),
),
sdk.NewEvent(
sdk.EventTypeMessage,
sdk.NewAttribute(sdk.AttributeKeyModule, types.ModuleName),
),
})
return nil
}
func (k Keeper) DistributeAcknowledgementFee(ctx sdk.Context, receiver sdk.AccAddress, packetID types.PacketID) {
k.Logger(ctx).Debug("Trying to distribute ack fee", "packetID", packetID)
feeInfo, err := k.GetFeeInfo(ctx, packetID)
if err != nil {
k.Logger(ctx).Error("no fee info", "error", err)
panic(errors.Wrapf(err, "no fee info"))
}
// try to distribute ack fee
if err := k.distributeFee(ctx, receiver, feeInfo.Fee.AckFee); err != nil {
k.Logger(ctx).Error("error distributing ack fee", "receiver", receiver, "payer", feeInfo.Payer, "packet", packetID)
panic(errors.Wrapf(err, "error distributing ack fee: receiver = %s, packetID=%v", receiver, packetID))
}
// try to return unused timeout fee
if err := k.distributeFee(ctx, sdk.MustAccAddressFromBech32(feeInfo.Payer), feeInfo.Fee.TimeoutFee); err != nil {
k.Logger(ctx).Error("error returning unused timeout fee", "receiver", feeInfo.Payer, "packet", packetID)
panic(errors.Wrapf(err, "error distributing unused timeout fee: receiver = %s, packetID=%v", feeInfo.Payer, packetID))
}
ctx.EventManager().EmitEvents(sdk.Events{
sdk.NewEvent(
types.EventTypeDistributeAcknowledgementFee,
sdk.NewAttribute(types.AttributeKeyReceiver, receiver.String()),
sdk.NewAttribute(types.AttributeKeyPortID, packetID.PortId),
sdk.NewAttribute(types.AttributeKeyChannelID, packetID.ChannelId),
sdk.NewAttribute(types.AttributeKeySequence, strconv.FormatUint(packetID.Sequence, 10)),
),
sdk.NewEvent(
sdk.EventTypeMessage,
sdk.NewAttribute(sdk.AttributeKeyModule, types.ModuleName),
),
})
k.removeFeeInfo(ctx, packetID)
}
func (k Keeper) DistributeTimeoutFee(ctx sdk.Context, receiver sdk.AccAddress, packetID types.PacketID) {
k.Logger(ctx).Debug("Trying to distribute timeout fee", "packetID", packetID)
feeInfo, err := k.GetFeeInfo(ctx, packetID)
if err != nil {
k.Logger(ctx).Error("no fee info", "error", err)
panic(errors.Wrapf(err, "no fee info"))
}
// try to distribute timeout fee
if err := k.distributeFee(ctx, receiver, feeInfo.Fee.TimeoutFee); err != nil {
k.Logger(ctx).Error("error distributing timeout fee", "receiver", receiver, "payer", feeInfo.Payer, "packet", packetID)
panic(errors.Wrapf(err, "error distributing timeout fee: receiver = %s, packetID=%v", receiver, packetID))
}
// try to return unused ack fee
if err := k.distributeFee(ctx, sdk.MustAccAddressFromBech32(feeInfo.Payer), feeInfo.Fee.AckFee); err != nil {
k.Logger(ctx).Error("error returning unused ack fee", "receiver", feeInfo.Payer, "packet", packetID)
panic(errors.Wrapf(err, "error distributing unused ack fee: receiver = %s, packetID=%v", feeInfo.Payer, packetID))
}
ctx.EventManager().EmitEvents(sdk.Events{
sdk.NewEvent(
types.EventTypeDistributeTimeoutFee,
sdk.NewAttribute(types.AttributeKeyReceiver, receiver.String()),
sdk.NewAttribute(types.AttributeKeyPortID, packetID.PortId),
sdk.NewAttribute(types.AttributeKeyChannelID, packetID.ChannelId),
sdk.NewAttribute(types.AttributeKeySequence, strconv.FormatUint(packetID.Sequence, 10)),
),
sdk.NewEvent(
sdk.EventTypeMessage,
sdk.NewAttribute(sdk.AttributeKeyModule, types.ModuleName),
),
})
k.removeFeeInfo(ctx, packetID)
}
func (k Keeper) GetFeeInfo(ctx sdk.Context, packetID types.PacketID) (*types.FeeInfo, error) {
store := ctx.KVStore(k.storeKey)
var feeInfo types.FeeInfo
bzFeeInfo := store.Get(types.GetFeePacketKey(packetID))
if bzFeeInfo == nil {
return nil, errors.Wrapf(sdkerrors.ErrKeyNotFound, "no fee info for the given channelID = %s, portID = %s and sequence = %d", packetID.ChannelId, packetID.PortId, packetID.Sequence)
}
k.cdc.MustUnmarshal(bzFeeInfo, &feeInfo)
return &feeInfo, nil
}
func (k Keeper) GetAllFeeInfos(ctx sdk.Context) []types.FeeInfo {
store := prefix.NewStore(ctx.KVStore(k.storeKey), types.FeeKey)
infos := make([]types.FeeInfo, 0)
iterator := sdk.KVStorePrefixIterator(store, []byte{})
defer iterator.Close()
for ; iterator.Valid(); iterator.Next() {
var info types.FeeInfo
k.cdc.MustUnmarshal(iterator.Value(), &info)
infos = append(infos, info)
}
return infos
}
func (k Keeper) StoreFeeInfo(ctx sdk.Context, feeInfo types.FeeInfo) {
store := ctx.KVStore(k.storeKey)
bzFeeInfo := k.cdc.MustMarshal(&feeInfo)
store.Set(types.GetFeePacketKey(feeInfo.PacketId), bzFeeInfo)
}
func (k Keeper) GetMinFee(ctx sdk.Context) types.Fee {
params := k.GetParams(ctx)
return params.GetMinFee()
}
func (k Keeper) removeFeeInfo(ctx sdk.Context, packetID types.PacketID) {
store := ctx.KVStore(k.storeKey)
store.Delete(types.GetFeePacketKey(packetID))
}
func (k Keeper) checkFees(ctx sdk.Context, fees types.Fee) error {
params := k.GetParams(ctx)
if !fees.TimeoutFee.IsAnyGTE(params.MinFee.TimeoutFee) {
return errors.Wrapf(sdkerrors.ErrInsufficientFee, "provided timeout fee is less than min governance set timeout fee: %v < %v", fees.TimeoutFee, params.MinFee.TimeoutFee)
}
if !fees.AckFee.IsAnyGTE(params.MinFee.AckFee) {
return errors.Wrapf(sdkerrors.ErrInsufficientFee, "provided ack fee is less than min governance set ack fee: %v < %v", fees.AckFee, params.MinFee.AckFee)
}
if allowedCoins(fees.TimeoutFee, params.MinFee.TimeoutFee) {
return errors.Wrapf(sdkerrors.ErrInvalidCoins, "timeout fee cannot have coins other than in params")
}
if allowedCoins(fees.AckFee, params.MinFee.AckFee) {
return errors.Wrapf(sdkerrors.ErrInvalidCoins, "ack fee cannot have coins other than in params")
}
// we don't allow users to set recv fees, because we can't refund relayers for such messages
if !fees.RecvFee.IsZero() {
return errors.Wrapf(sdkerrors.ErrInvalidCoins, "recv fee must be zero")
}
return nil
}
func (k Keeper) distributeFee(ctx sdk.Context, receiver sdk.AccAddress, fee sdk.Coins) error {
err := k.bankKeeper.SendCoinsFromModuleToAccount(ctx, types.ModuleName, receiver, fee)
if err != nil {
k.Logger(ctx).Error("error distributing fee", "receiver address", receiver, "fee", fee)
return errors.Wrapf(err, "error distributing fee to a receiver: %s", receiver.String())
}
return nil
}
// allowedCoins returns true if one or more coins from `fees` are not present in coins from `params`
// assumes that `params` is sorted
func allowedCoins(fees, params sdk.Coins) bool {
for _, fee := range fees {
if params.AmountOf(fee.Denom).IsZero() {
return true
}
}
return false
}