-
Notifications
You must be signed in to change notification settings - Fork 0
/
naive-strategy.go
477 lines (420 loc) · 14.3 KB
/
naive-strategy.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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
package relayer
import (
"fmt"
"strconv"
"strings"
"time"
retry "github.com/avast/retry-go"
sdk "github.com/cosmos/cosmos-sdk/types"
chanTypes "github.com/cosmos/cosmos-sdk/x/ibc/04-channel/types"
ctypes "github.com/tendermint/tendermint/rpc/core/types"
"golang.org/x/sync/errgroup"
)
var _ Strategy = &NaiveStrategy{}
// NewNaiveStrategy returns the proper config for the NaiveStrategy
func NewNaiveStrategy() *StrategyCfg {
return &StrategyCfg{
Type: (&NaiveStrategy{}).GetType(),
}
}
// NaiveStrategy is an implementation of Strategy.
type NaiveStrategy struct {
Ordered bool
MaxTxSize uint64 // maximum permitted size of the msgs in a bundled relay transaction
MaxMsgLength uint64 // maximum amount of messages in a bundled relay transaction
}
// GetType implements Strategy
func (nrs *NaiveStrategy) GetType() string {
return "naive"
}
// UnrelayedSequencesOrdered returns the unrelayed sequence numbers between two chains
func (nrs *NaiveStrategy) UnrelayedSequencesOrdered(src, dst *Chain, sh *SyncHeaders) (*RelaySequences, error) {
var (
eg = new(errgroup.Group)
srcPacketSeq = []uint64{}
dstPacketSeq = []uint64{}
err error
rs = &RelaySequences{Src: []uint64{}, Dst: []uint64{}}
)
eg.Go(func() error {
var res *chanTypes.QueryPacketCommitmentsResponse
if err = retry.Do(func() error {
res, err = src.QueryPacketCommitments(0, 1000, sh.GetHeight(src.ChainID))
if err != nil || res == nil {
return err
}
return nil
}); err != nil {
return err
}
for _, pc := range res.Commitments {
srcPacketSeq = append(srcPacketSeq, pc.Sequence)
}
return nil
})
eg.Go(func() error {
var res *chanTypes.QueryPacketCommitmentsResponse
if err = retry.Do(func() error {
res, err = dst.QueryPacketCommitments(0, 1000, sh.GetHeight(dst.ChainID))
if err != nil || res == nil {
return err
}
return nil
}); err != nil {
return err
}
for _, pc := range res.Commitments {
dstPacketSeq = append(dstPacketSeq, pc.Sequence)
}
return nil
})
if err := eg.Wait(); err != nil {
return nil, err
}
eg.Go(func() error {
// Query all packets sent by src that have been received by dst
rs.Src, err = dst.QueryUnrecievedPackets(sh.GetHeight(dst.ChainID), srcPacketSeq)
return err
})
eg.Go(func() error {
// Query all packets sent by dst that have been received by src
rs.Dst, err = src.QueryUnrecievedPackets(sh.GetHeight(src.ChainID), dstPacketSeq)
return err
})
if err := eg.Wait(); err != nil {
return nil, err
}
return rs, nil
}
// UnrelayedSequencesUnordered returns the unrelayed sequence numbers between two chains
func (nrs *NaiveStrategy) UnrelayedSequencesUnordered(src, dst *Chain, sh *SyncHeaders) (*RelaySequences, error) {
return nrs.UnrelayedSequencesOrdered(src, dst, sh)
}
// HandleEvents defines how the relayer will handle block and transaction events as they are emitted
func (nrs *NaiveStrategy) HandleEvents(src, dst *Chain, sh *SyncHeaders, events map[string][]string) {
rlyPackets, err := relayPacketsFromEventListener(src.PathEnd, dst.PathEnd, events)
if len(rlyPackets) > 0 && err == nil {
nrs.sendTxFromEventPackets(src, dst, rlyPackets, sh)
}
}
func relayPacketsFromEventListener(src, dst *PathEnd, events map[string][]string) (rlyPkts []relayPacket, err error) {
// check for send packets
if pdval, ok := events["send_packet.packet_data"]; ok {
for i, pd := range pdval {
// Ensure that we only relay over the channel and port specified
// OPTIONAL FEATURE: add additional filtering options
// Example Events - "transfer.amount(sdk.Coin)", "message.sender(sdk.AccAddress)"
srcChan, srcPort := events["send_packet.packet_src_channel"], events["send_packet.packet_src_port"]
dstChan, dstPort := events["send_packet.packet_dst_channel"], events["send_packet.packet_dst_port"]
// NOTE: Src and Dst are switched here
if dst.PortID == srcPort[i] && dst.ChannelID == srcChan[i] &&
src.PortID == dstPort[i] && src.ChannelID == dstChan[i] {
rp := &relayMsgRecvPacket{packetData: []byte(pd)}
// next, get and parse the sequence
if sval, ok := events["send_packet.packet_sequence"]; ok {
seq, err := strconv.ParseUint(sval[i], 10, 64)
if err != nil {
return nil, err
}
rp.seq = seq
}
// finally, get and parse the timeout
if sval, ok := events["send_packet.packet_timeout_height"]; ok {
timeout, err := strconv.ParseUint(sval[i], 10, 64)
if err != nil {
return nil, err
}
rp.timeout = timeout
}
// finally, get and parse the timeout
if sval, ok := events["send_packet.packet_timeout_timestamp"]; ok {
timeout, err := strconv.ParseUint(sval[i], 10, 64)
if err != nil {
return nil, err
}
rp.timeoutStamp = timeout
}
// queue the packet for return
rlyPkts = append(rlyPkts, rp)
}
}
}
// then, check for packet acks
if pdval, ok := events["recv_packet.packet_data"]; ok {
for i, pd := range pdval {
// Ensure that we only relay over the channel and port specified
// OPTIONAL FEATURE: add additional filtering options
srcChan, srcPort := events["recv_packet.packet_src_channel"], events["recv_packet.packet_src_port"]
dstChan, dstPort := events["recv_packet.packet_dst_channel"], events["recv_packet.packet_dst_port"]
// NOTE: Src and Dst are not switched here
if src.PortID == srcPort[i] && src.ChannelID == srcChan[i] &&
dst.PortID == dstPort[i] && dst.ChannelID == dstChan[i] {
rp := &relayMsgPacketAck{packetData: []byte(pd)}
// first get the ack
if ack, ok := events["recv_packet.packet_ack"]; ok {
rp.ack = []byte(ack[i])
}
// next, get and parse the sequence
if sval, ok := events["recv_packet.packet_sequence"]; ok {
seq, err := strconv.ParseUint(sval[i], 10, 64)
if err != nil {
return nil, err
}
rp.seq = seq
}
// finally, get and parse the timeout
if sval, ok := events["recv_packet.packet_timeout_height"]; ok {
timeout, err := strconv.ParseUint(sval[i], 10, 64)
if err != nil {
return nil, err
}
rp.timeout = timeout
}
// finally, get and parse the timeout
if sval, ok := events["recv_packet.packet_timeout_timestamp"]; ok {
timeout, err := strconv.ParseUint(sval[i], 10, 64)
if err != nil {
return nil, err
}
rp.timeoutStamp = timeout
}
// queue the packet for return
rlyPkts = append(rlyPkts, rp)
}
}
}
return rlyPkts, nil
}
func (nrs *NaiveStrategy) sendTxFromEventPackets(src, dst *Chain, rlyPackets []relayPacket, sh *SyncHeaders) {
// fetch the proofs for the relayPackets
for _, rp := range rlyPackets {
if err := rp.FetchCommitResponse(src, dst, sh); err != nil {
// we don't expect many errors here because of the retry
// in FetchCommitResponse
src.Error(err)
}
}
// send the transaction, retrying if not successful
if err := retry.Do(func() error {
updateHeader, err := sh.GetUpdateHeader(src, dst)
if err != nil {
return err
}
// instantiate the RelayMsgs with the appropriate update client
txs := &RelayMsgs{
Src: []sdk.Msg{
src.PathEnd.UpdateClient(updateHeader, src.MustGetAddress()),
},
Dst: []sdk.Msg{},
MaxTxSize: nrs.MaxTxSize,
MaxMsgLength: nrs.MaxMsgLength,
}
// add the packet msgs to RelayPackets
for _, rp := range rlyPackets {
txs.Src = append(txs.Src, rp.Msg(src, dst))
}
if txs.Send(src, dst); !txs.success {
return fmt.Errorf("failed to send packets")
}
return nil
}); err != nil {
src.Error(err)
}
}
// RelaySequences represents unrelayed packets on src and dst
type RelaySequences struct {
Src []uint64 `json:"src"`
Dst []uint64 `json:"dst"`
}
// RelayPacketsUnorderedChan creates transactions to relay un-relayed messages
func (nrs *NaiveStrategy) RelayPacketsUnorderedChan(src, dst *Chain, sp *RelaySequences, sh *SyncHeaders) error {
// TODO: Implement unordered channels
return nrs.RelayPacketsOrderedChan(src, dst, sp, sh)
}
// RelayPacketsOrderedChan creates transactions to clear both queues
// CONTRACT: the SyncHeaders passed in here must be up to date or being kept updated
func (nrs *NaiveStrategy) RelayPacketsOrderedChan(src, dst *Chain, sp *RelaySequences, sh *SyncHeaders) error {
// set the maximum relay transaction constraints
msgs := &RelayMsgs{
Src: []sdk.Msg{},
Dst: []sdk.Msg{},
MaxTxSize: nrs.MaxTxSize,
MaxMsgLength: nrs.MaxMsgLength,
}
// add messages for src -> dst
for _, seq := range sp.Src {
chain, msg, err := packetMsgFromTxQuery(src, dst, sh, seq)
if err != nil {
return err
}
if chain == dst {
msgs.Dst = append(msgs.Dst, msg)
} else {
msgs.Src = append(msgs.Src, msg)
}
}
// add messages for dst -> src
for _, seq := range sp.Dst {
chain, msg, err := packetMsgFromTxQuery(dst, src, sh, seq)
if err != nil {
return err
}
if chain == src {
msgs.Src = append(msgs.Src, msg)
} else {
msgs.Dst = append(msgs.Dst, msg)
}
}
if !msgs.Ready() {
src.Log(fmt.Sprintf("- No packets to relay between [%s]port{%s} and [%s]port{%s}",
src.ChainID, src.PathEnd.PortID, dst.ChainID, dst.PathEnd.PortID))
return nil
}
// Prepend non-empty msg lists with UpdateClient
if len(msgs.Dst) != 0 {
// Sending an update from src to dst
updateHeader, err := sh.GetUpdateHeader(src, dst)
if err != nil {
return err
}
msgs.Dst = append([]sdk.Msg{dst.PathEnd.UpdateClient(updateHeader, dst.MustGetAddress())}, msgs.Dst...)
}
if len(msgs.Src) != 0 {
// Sending an update from dst to src
updateHeader, err := sh.GetUpdateHeader(dst, src)
if err != nil {
return err
}
msgs.Src = append([]sdk.Msg{src.PathEnd.UpdateClient(updateHeader, src.MustGetAddress())}, msgs.Src...)
}
// TODO: increase the amount of gas as the number of messages increases
// notify the user of that
if msgs.Send(src, dst); msgs.success {
if len(msgs.Dst) > 1 {
dst.logPacketsRelayed(src, len(msgs.Dst)-1)
}
if len(msgs.Src) > 1 {
src.logPacketsRelayed(dst, len(msgs.Src)-1)
}
}
return nil
}
// packetMsgFromTxQuery returns a sdk.Msg to relay a packet with a given seq on src
func packetMsgFromTxQuery(src, dst *Chain, sh *SyncHeaders, seq uint64) (*Chain, sdk.Msg, error) {
eveSend, err := ParseEvents(fmt.Sprintf(defaultPacketSendQuery, src.PathEnd.ChannelID, seq))
if err != nil {
return nil, nil, err
}
txs, err := src.QueryTxs(sh.GetHeight(src.ChainID), 1, 1000, eveSend)
switch {
case err != nil:
return nil, nil, err
case len(txs) == 0:
return nil, nil, fmt.Errorf("no transactions returned with query")
case len(txs) > 1:
return nil, nil, fmt.Errorf("more than one transaction returned with query")
}
rcvPackets, timeoutPackets, err := relayPacketFromQueryResponse(src.PathEnd, dst.PathEnd, txs[0], sh)
switch {
case err != nil:
return nil, nil, err
case len(rcvPackets) == 0 && len(timeoutPackets) == 0:
return nil, nil, fmt.Errorf("no relay msgs created from query response")
case len(rcvPackets)+len(timeoutPackets) > 1:
return nil, nil, fmt.Errorf("more than one relay msg found in tx query")
}
// If relayPacketFromQueryResponse returned a packet to be received on destination chain
// then create receive msg to be sent to destination chain
if len(rcvPackets) == 1 {
// sanity check the sequence number against the one we are querying for
// TODO: move this into relayPacketFromQueryResponse?
if seq != rcvPackets[0].Seq() {
return nil, nil,
fmt.Errorf("different sequence number from query (%d vs %d)", seq, rcvPackets[0].Seq())
}
// fetch the proof from the sending chain
if err = rcvPackets[0].FetchCommitResponse(dst, src, sh); err != nil {
return nil, nil, err
}
// return the sending msg
return dst, rcvPackets[0].Msg(dst, src), nil
}
// NOTE: Since timeout packets are sent to the original sending chain, src and dst are flipped relative to the
// recv packets
// relayPacketFromQueryResponse returned a timeout msg, create a timeout msg to be sent to original sender chain
if seq != timeoutPackets[0].Seq() {
return nil, nil,
fmt.Errorf("different sequence number from query (%d vs %d)", seq, timeoutPackets[0].Seq())
}
// fetch the timeout proof from the receiving chain
if err = timeoutPackets[0].FetchCommitResponse(src, dst, sh); err != nil {
return nil, nil, err
}
// return the sending msg
return src, timeoutPackets[0].Msg(src, dst), nil
}
// relayPacketFromQueryResponse looks through the events in a sdk.Response
// and returns relayPackets with the appropriate data
func relayPacketFromQueryResponse(src, dst *PathEnd, res *ctypes.ResultTx,
sh *SyncHeaders) (rcvPackets []relayPacket, timeoutPackets []relayPacket, err error) {
for _, e := range res.TxResult.Events {
if e.Type == "send_packet" {
// NOTE: Src and Dst are switched here
rp := &relayMsgRecvPacket{pass: false}
for _, p := range e.Attributes {
if string(p.Key) == "packet_src_channel" {
if string(p.Value) != src.ChannelID {
rp.pass = true
continue
}
}
if string(p.Key) == "packet_dst_channel" {
if string(p.Value) != dst.ChannelID {
rp.pass = true
continue
}
}
if string(p.Key) == "packet_src_port" {
if string(p.Value) != src.PortID {
rp.pass = true
continue
}
}
if string(p.Key) == "packet_dst_port" {
if string(p.Value) != dst.PortID {
rp.pass = true
continue
}
}
if string(p.Key) == "packet_data" {
rp.packetData = p.Value
}
if string(p.Key) == "packet_timeout_height" {
timeout, _ := strconv.ParseUint(strings.Split(string(p.Value), "-")[1], 10, 64)
rp.timeout = timeout
}
if string(p.Key) == "packet_timeout_timestamp" {
timeout, _ := strconv.ParseUint(string(p.Value), 10, 64)
rp.timeoutStamp = timeout
}
if string(p.Key) == "packet_sequence" {
seq, _ := strconv.ParseUint(string(p.Value), 10, 64)
rp.seq = seq
}
}
// if we have decided not to relay this packet, don't add it
switch {
case sh.GetHeight(src.ChainID) >= rp.timeout:
timeoutPackets = append(timeoutPackets, rp.timeoutPacket())
case rp.timeoutStamp != 0 && time.Now().UnixNano() >= int64(rp.timeoutStamp):
timeoutPackets = append(timeoutPackets, rp.timeoutPacket())
case !rp.pass:
rcvPackets = append(rcvPackets, rp)
}
}
}
if len(rcvPackets)+len(timeoutPackets) > 0 {
return
}
return nil, nil, fmt.Errorf("no packet data found")
}