-
Notifications
You must be signed in to change notification settings - Fork 0
/
ibc_module.go
234 lines (210 loc) · 6.88 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
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
package ibc_rate_limit
import (
"encoding/json"
"strings"
"github.com/osmosis-labs/osmosis/osmoutils"
sdk "github.com/cosmos/cosmos-sdk/types"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
capabilitytypes "github.com/cosmos/cosmos-sdk/x/capability/types"
transfertypes "github.com/cosmos/ibc-go/v3/modules/apps/transfer/types"
channeltypes "github.com/cosmos/ibc-go/v3/modules/core/04-channel/types"
porttypes "github.com/cosmos/ibc-go/v3/modules/core/05-port/types"
"github.com/cosmos/ibc-go/v3/modules/core/exported"
"github.com/tessornetwork/mokita/x/ibc-rate-limit/types"
)
type IBCModule struct {
app porttypes.IBCModule
ics4Middleware *ICS4Wrapper
}
func NewIBCModule(app porttypes.IBCModule, ics4 *ICS4Wrapper) IBCModule {
return IBCModule{
app: app,
ics4Middleware: ics4,
}
}
// OnChanOpenInit implements the IBCModule interface
func (im *IBCModule) OnChanOpenInit(ctx sdk.Context,
order channeltypes.Order,
connectionHops []string,
portID string,
channelID string,
channelCap *capabilitytypes.Capability,
counterparty channeltypes.Counterparty,
version string,
) error {
return im.app.OnChanOpenInit(
ctx,
order,
connectionHops,
portID,
channelID,
channelCap,
counterparty,
version,
)
}
// OnChanOpenTry implements the IBCModule interface
func (im *IBCModule) OnChanOpenTry(
ctx sdk.Context,
order channeltypes.Order,
connectionHops []string,
portID,
channelID string,
channelCap *capabilitytypes.Capability,
counterparty channeltypes.Counterparty,
counterpartyVersion string,
) (string, error) {
return im.app.OnChanOpenTry(ctx, order, connectionHops, portID, channelID, channelCap, counterparty, counterpartyVersion)
}
// OnChanOpenAck implements the IBCModule interface
func (im *IBCModule) OnChanOpenAck(
ctx sdk.Context,
portID,
channelID string,
counterpartyChannelID string,
counterpartyVersion string,
) error {
// Here we can add initial limits when a new channel is open. For now, they can be added manually on the contract
return im.app.OnChanOpenAck(ctx, portID, channelID, counterpartyChannelID, counterpartyVersion)
}
// OnChanOpenConfirm implements the IBCModule interface
func (im *IBCModule) OnChanOpenConfirm(
ctx sdk.Context,
portID,
channelID string,
) error {
// Here we can add initial limits when a new channel is open. For now, they can be added manually on the contract
return im.app.OnChanOpenConfirm(ctx, portID, channelID)
}
// OnChanCloseInit implements the IBCModule interface
func (im *IBCModule) OnChanCloseInit(
ctx sdk.Context,
portID,
channelID string,
) error {
// Here we can remove the limits when a new channel is closed. For now, they can remove them manually on the contract
return im.app.OnChanCloseInit(ctx, portID, channelID)
}
// OnChanCloseConfirm implements the IBCModule interface
func (im *IBCModule) OnChanCloseConfirm(
ctx sdk.Context,
portID,
channelID string,
) error {
// Here we can remove the limits when a new channel is closed. For now, they can remove them manually on the contract
return im.app.OnChanCloseConfirm(ctx, portID, channelID)
}
func ValidateReceiverAddress(packet exported.PacketI) error {
var packetData transfertypes.FungibleTokenPacketData
if err := json.Unmarshal(packet.GetData(), &packetData); err != nil {
return err
}
if len(packetData.Receiver) >= 4096 {
return sdkerrors.Wrapf(sdkerrors.ErrInvalidAddress, "IBC Receiver address too long. Max supported length is %d", 4096)
}
return nil
}
// OnRecvPacket implements the IBCModule interface
func (im *IBCModule) OnRecvPacket(
ctx sdk.Context,
packet channeltypes.Packet,
relayer sdk.AccAddress,
) exported.Acknowledgement {
if err := ValidateReceiverAddress(packet); err != nil {
return channeltypes.NewErrorAcknowledgement(err.Error())
}
contract := im.ics4Middleware.GetParams(ctx)
if contract == "" {
// The contract has not been configured. Continue as usual
return im.app.OnRecvPacket(ctx, packet, relayer)
}
err := CheckAndUpdateRateLimits(ctx, im.ics4Middleware.ContractKeeper, "recv_packet", contract, packet)
if err != nil {
if strings.Contains(err.Error(), "rate limit exceeded") {
return channeltypes.NewErrorAcknowledgement(types.ErrRateLimitExceeded.Error())
}
fullError := sdkerrors.Wrap(types.ErrContractError, err.Error())
return channeltypes.NewErrorAcknowledgement(fullError.Error())
}
// if this returns an Acknowledgement that isn't successful, all state changes are discarded
return im.app.OnRecvPacket(ctx, packet, relayer)
}
// OnAcknowledgementPacket implements the IBCModule interface
func (im *IBCModule) OnAcknowledgementPacket(
ctx sdk.Context,
packet channeltypes.Packet,
acknowledgement []byte,
relayer sdk.AccAddress,
) error {
if osmoutils.IsAckError(acknowledgement) {
err := im.RevertSentPacket(ctx, packet) // If there is an error here we should still handle the ack
if err != nil {
ctx.EventManager().EmitEvent(
sdk.NewEvent(
types.EventBadRevert,
sdk.NewAttribute(sdk.AttributeKeyModule, types.ModuleName),
sdk.NewAttribute(types.AttributeKeyFailureType, "acknowledgment"),
sdk.NewAttribute(types.AttributeKeyPacket, string(packet.GetData())),
sdk.NewAttribute(types.AttributeKeyAck, string(acknowledgement)),
),
)
}
}
return im.app.OnAcknowledgementPacket(ctx, packet, acknowledgement, relayer)
}
// OnTimeoutPacket implements the IBCModule interface
func (im *IBCModule) OnTimeoutPacket(
ctx sdk.Context,
packet channeltypes.Packet,
relayer sdk.AccAddress,
) error {
err := im.RevertSentPacket(ctx, packet) // If there is an error here we should still handle the timeout
if err != nil {
ctx.EventManager().EmitEvent(
sdk.NewEvent(
types.EventBadRevert,
sdk.NewAttribute(sdk.AttributeKeyModule, types.ModuleName),
sdk.NewAttribute(types.AttributeKeyFailureType, "timeout"),
sdk.NewAttribute(types.AttributeKeyPacket, string(packet.GetData())),
),
)
}
return im.app.OnTimeoutPacket(ctx, packet, relayer)
}
// RevertSentPacket Notifies the contract that a sent packet wasn't properly received
func (im *IBCModule) RevertSentPacket(
ctx sdk.Context,
packet exported.PacketI,
) error {
contract := im.ics4Middleware.GetParams(ctx)
if contract == "" {
// The contract has not been configured. Continue as usual
return nil
}
if err := UndoSendRateLimit(
ctx,
im.ics4Middleware.ContractKeeper,
contract,
packet,
); err != nil {
return err
}
return nil
}
// SendPacket implements the ICS4 Wrapper interface
func (im *IBCModule) SendPacket(
ctx sdk.Context,
chanCap *capabilitytypes.Capability,
packet exported.PacketI,
) error {
return im.ics4Middleware.SendPacket(ctx, chanCap, packet)
}
// WriteAcknowledgement implements the ICS4 Wrapper interface
func (im *IBCModule) WriteAcknowledgement(
ctx sdk.Context,
chanCap *capabilitytypes.Capability,
packet exported.PacketI,
ack exported.Acknowledgement,
) error {
return im.ics4Middleware.WriteAcknowledgement(ctx, chanCap, packet, ack)
}