-
Notifications
You must be signed in to change notification settings - Fork 169
/
ibc_module.go
110 lines (95 loc) · 3.58 KB
/
ibc_module.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
package quota
import (
"encoding/json"
"cosmossdk.io/errors"
sdkmath "cosmossdk.io/math"
"github.com/cosmos/cosmos-sdk/codec"
sdk "github.com/cosmos/cosmos-sdk/types"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
transfertypes "github.com/cosmos/ibc-go/v6/modules/apps/transfer/types"
channeltypes "github.com/cosmos/ibc-go/v6/modules/core/04-channel/types"
porttypes "github.com/cosmos/ibc-go/v6/modules/core/05-port/types"
"github.com/umee-network/umee/v4/util/sdkutil"
"github.com/umee-network/umee/v4/x/uibc"
"github.com/umee-network/umee/v4/x/uibc/quota/keeper"
)
var _ porttypes.Middleware = ICS20Middleware{}
// ICS20Middleware overwrites OnAcknowledgementPacket and OnTimeoutPacket to revert
// quota update on acknowledgement error or timeout.
type ICS20Middleware struct {
porttypes.IBCModule
keeper keeper.Keeper
cdc codec.JSONCodec
}
// NewICS20Middleware is an IBCMiddlware constructor.
// `app` must be an ICS20 app.
func NewICS20Middleware(app porttypes.IBCModule, k keeper.Keeper, cdc codec.JSONCodec) ICS20Middleware {
return ICS20Middleware{
IBCModule: app,
keeper: k,
cdc: cdc,
}
}
// OnAcknowledgementPacket implements types.Middleware
func (im ICS20Middleware) OnAcknowledgementPacket(ctx sdk.Context, packet channeltypes.Packet, acknowledgement []byte,
relayer sdk.AccAddress,
) error {
var ack channeltypes.Acknowledgement
if err := im.cdc.UnmarshalJSON(acknowledgement, &ack); err != nil {
return errors.Wrap(err, "cannot unmarshal ICS-20 transfer packet acknowledgement")
}
if _, ok := ack.Response.(*channeltypes.Acknowledgement_Error); ok {
params := im.keeper.GetParams(ctx)
if params.IbcStatus == uibc.IBCTransferStatus_IBC_TRANSFER_STATUS_QUOTA_ENABLED {
err := im.revertQuotaUpdate(ctx, packet.Data)
emitOnRevertQuota(&ctx, "acknowledgement", packet.Data, err)
}
}
return im.IBCModule.OnAcknowledgementPacket(ctx, packet, acknowledgement, relayer)
}
// OnTimeoutPacket implements types.Middleware
func (im ICS20Middleware) OnTimeoutPacket(ctx sdk.Context, packet channeltypes.Packet, relayer sdk.AccAddress) error {
err := im.revertQuotaUpdate(ctx, packet.Data)
emitOnRevertQuota(&ctx, "timeout", packet.Data, err)
return im.IBCModule.OnTimeoutPacket(ctx, packet, relayer)
}
// revertQuotaUpdate must be called on packet acknnowledgemenet error to revert necessary changes.
func (im ICS20Middleware) revertQuotaUpdate(
ctx sdk.Context,
packetData []byte,
) error {
var data transfertypes.FungibleTokenPacketData
if err := im.cdc.UnmarshalJSON(packetData, &data); err != nil {
return errors.Wrap(err,
"cannot unmarshal ICS-20 transfer packet data")
}
amount, ok := sdkmath.NewIntFromString(data.Amount)
if !ok {
return sdkerrors.ErrInvalidRequest.Wrapf("invalid transfer amount %s", data.Amount)
}
return im.keeper.UndoUpdateQuota(ctx, data.Denom, amount)
}
func ValidateReceiverAddress(packet channeltypes.Packet) error {
var packetData transfertypes.FungibleTokenPacketData
if err := json.Unmarshal(packet.GetData(), &packetData); err != nil {
return err
}
if len(packetData.Receiver) >= 4096 {
return sdkerrors.ErrInvalidAddress.Wrapf(
"IBC Receiver address too long. Max supported length is %d", 4096,
)
}
return nil
}
// emitOnRevertQuota emits events related to quota update revert.
// packetData is ICS 20 packet data bytes.
func emitOnRevertQuota(ctx *sdk.Context, failureType string, packetData []byte, err error) {
if err == nil {
return
}
ctx.Logger().Error("revert quota update error", "err", err)
sdkutil.Emit(ctx, &uibc.EventBadRevert{
FailureType: failureType,
Packet: string(packetData),
})
}