-
Notifications
You must be signed in to change notification settings - Fork 0
/
ibc_handlers.go
160 lines (132 loc) · 6.64 KB
/
ibc_handlers.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
package transfer
import (
"strings"
sdk "github.com/cosmos/cosmos-sdk/types"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
transfertypes "github.com/cosmos/ibc-go/v4/modules/apps/transfer/types"
channeltypes "github.com/cosmos/ibc-go/v4/modules/core/04-channel/types"
feetypes "github.com/furyahub/furya/x/feerefunder/types"
"github.com/furyahub/furya/x/interchaintxs/types"
)
const (
// We need to reserve this amount of gas on the context gas meter in order to add contract failure to keeper
GasReserve = 15000
)
func (im IBCModule) outOfGasRecovery(
ctx sdk.Context,
gasMeter sdk.GasMeter,
senderAddress sdk.AccAddress,
packet channeltypes.Packet,
data transfertypes.FungibleTokenPacketData,
failureType string,
) {
if r := recover(); r != nil {
_, ok := r.(sdk.ErrorOutOfGas)
if !ok || !gasMeter.IsOutOfGas() {
panic(r)
}
im.keeper.Logger(ctx).Debug("Out of gas", "Gas meter", gasMeter.String(), "Packet data", data)
im.ContractManagerKeeper.AddContractFailure(ctx, packet.SourceChannel, senderAddress.String(), packet.GetSequence(), failureType)
// FIXME: add distribution call
}
}
// createCachedContext creates a cached context for handling Sudo calls to CosmWasm smart-contracts.
// If there is an error during Sudo call, we can safely revert changes made in cached context.
func (im *IBCModule) createCachedContext(ctx sdk.Context) (sdk.Context, func(), sdk.GasMeter) {
gasMeter := ctx.GasMeter()
// determines type of gas meter by its prefix:
// * BasicGasMeter - basic gas meter which is used for processing tx directly in block;
// * InfiniteGasMeter - is used to process txs during simulation calls. We don't need to create a limit for such meter,
// since it's infinite.
gasMeterIsLimited := strings.HasPrefix(ctx.GasMeter().String(), "BasicGasMeter")
cacheCtx, writeFn := ctx.CacheContext()
// if gas meter is limited:
// 1. calculate how much free gas left we have for a Sudo call;
// 2. If gasLeft less than reserved gas (GasReserved), we set gas limit for cached context to zero, meaning we can't
// process Sudo call;
// 3. If we have more gas left than reserved gas (GasReserved) for Sudo call, we set gas limit for cached context to
// difference between gas left and reserved gas: (gasLeft - GasReserve);
//
// GasReserve is the amount of gas on the context gas meter we need to reserve in order to add contract failure to keeper
// and process failed Sudo call
if gasMeterIsLimited {
gasLeft := gasMeter.Limit() - gasMeter.GasConsumed()
var newLimit uint64
if gasLeft < GasReserve {
newLimit = 0
} else {
newLimit = gasLeft - GasReserve
}
gasMeter = sdk.NewGasMeter(newLimit)
}
cacheCtx = cacheCtx.WithGasMeter(gasMeter)
return cacheCtx, writeFn, gasMeter
}
// HandleAcknowledgement passes the acknowledgement data to the appropriate contract via a Sudo call.
func (im IBCModule) HandleAcknowledgement(ctx sdk.Context, packet channeltypes.Packet, acknowledgement []byte, relayer sdk.AccAddress) error {
var ack channeltypes.Acknowledgement
if err := channeltypes.SubModuleCdc.UnmarshalJSON(acknowledgement, &ack); err != nil {
return sdkerrors.Wrapf(sdkerrors.ErrUnknownRequest, "cannot unmarshal ICS-20 transfer packet acknowledgement: %v", err)
}
var data transfertypes.FungibleTokenPacketData
if err := types.ModuleCdc.UnmarshalJSON(packet.GetData(), &data); err != nil {
return sdkerrors.Wrapf(sdkerrors.ErrUnknownRequest, "cannot unmarshal ICS-20 transfer packet data: %s", err.Error())
}
senderAddress, err := sdk.AccAddressFromBech32(data.GetSender())
if err != nil {
return sdkerrors.Wrapf(sdkerrors.ErrInvalidAddress, "failed to decode address from bech32: %v", err)
}
cacheCtx, writeFn, newGasMeter := im.createCachedContext(ctx)
defer im.outOfGasRecovery(ctx, newGasMeter, senderAddress, packet, data, "ack")
if ack.Success() {
_, err = im.ContractManagerKeeper.SudoResponse(cacheCtx, senderAddress, packet, ack.GetResult())
} else {
// Actually we have only one kind of error returned from acknowledgement
// maybe later we'll retrieve actual errors from events
im.keeper.Logger(cacheCtx).Debug(ack.GetError(), "CheckTx", cacheCtx.IsCheckTx())
_, err = im.ContractManagerKeeper.SudoError(cacheCtx, senderAddress, packet, ack.GetError())
}
if err != nil {
im.ContractManagerKeeper.AddContractFailure(ctx, packet.SourceChannel, senderAddress.String(), packet.GetSequence(), "ack")
im.keeper.Logger(ctx).Debug("failed to Sudo contract on packet acknowledgement", err)
} else {
ctx.EventManager().EmitEvents(cacheCtx.EventManager().Events())
writeFn()
}
ctx.GasMeter().ConsumeGas(newGasMeter.GasConsumed(), "consume from cached context")
im.keeper.Logger(ctx).Debug("acknowledgement received", "Packet data", data, "CheckTx", ctx.IsCheckTx())
// distribute fees only if the sender is a contract
if im.ContractManagerKeeper.HasContractInfo(ctx, senderAddress) {
im.wrappedKeeper.FeeKeeper.DistributeAcknowledgementFee(ctx, relayer, feetypes.NewPacketID(packet.SourcePort, packet.SourceChannel, packet.Sequence))
}
return nil
}
// HandleTimeout passes the timeout data to the appropriate contract via a Sudo call.
// Since all ICA channels are ORDERED, a single timeout shuts down a channel.
// The affected zone should be paused after a timeout.
func (im IBCModule) HandleTimeout(ctx sdk.Context, packet channeltypes.Packet, relayer sdk.AccAddress) error {
var data transfertypes.FungibleTokenPacketData
if err := types.ModuleCdc.UnmarshalJSON(packet.GetData(), &data); err != nil {
return sdkerrors.Wrapf(sdkerrors.ErrUnknownRequest, "cannot unmarshal ICS-20 transfer packet data: %s", err.Error())
}
senderAddress, err := sdk.AccAddressFromBech32(data.GetSender())
if err != nil {
return sdkerrors.Wrapf(sdkerrors.ErrInvalidAddress, "failed to decode address from bech32: %v", err)
}
cacheCtx, writeFn, newGasMeter := im.createCachedContext(ctx)
defer im.outOfGasRecovery(ctx, newGasMeter, senderAddress, packet, data, "timeout")
_, err = im.ContractManagerKeeper.SudoTimeout(cacheCtx, senderAddress, packet)
if err != nil {
im.ContractManagerKeeper.AddContractFailure(ctx, packet.SourceChannel, senderAddress.String(), packet.GetSequence(), "timeout")
im.keeper.Logger(ctx).Debug("failed to Sudo contract on packet timeout", err)
} else {
ctx.EventManager().EmitEvents(cacheCtx.EventManager().Events())
writeFn()
}
// distribute fee only if the sender is a contract
if im.ContractManagerKeeper.HasContractInfo(ctx, senderAddress) {
im.wrappedKeeper.FeeKeeper.DistributeTimeoutFee(ctx, relayer, feetypes.NewPacketID(packet.SourcePort, packet.SourceChannel, packet.Sequence))
}
ctx.GasMeter().ConsumeGas(newGasMeter.GasConsumed(), "consume from cached context")
return nil
}