forked from cosmos/ibc-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
events.go
214 lines (183 loc) · 6.53 KB
/
events.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
package ibctesting
import (
"fmt"
"slices"
"strconv"
testifysuite "github.com/stretchr/testify/suite"
abci "github.com/cometbft/cometbft/abci/types"
clienttypes "github.com/T-ragon/ibc-go/v9/modules/core/02-client/types"
connectiontypes "github.com/T-ragon/ibc-go/v9/modules/core/03-connection/types"
channeltypes "github.com/T-ragon/ibc-go/v9/modules/core/04-channel/types"
)
type EventsMap map[string]map[string]string
// ParseClientIDFromEvents parses events emitted from a MsgCreateClient and returns the
// client identifier.
func ParseClientIDFromEvents(events []abci.Event) (string, error) {
for _, ev := range events {
if ev.Type == clienttypes.EventTypeCreateClient {
for _, attr := range ev.Attributes {
if attr.Key == clienttypes.AttributeKeyClientID {
return attr.Value, nil
}
}
}
}
return "", fmt.Errorf("client identifier event attribute not found")
}
// ParseConnectionIDFromEvents parses events emitted from a MsgConnectionOpenInit or
// MsgConnectionOpenTry and returns the connection identifier.
func ParseConnectionIDFromEvents(events []abci.Event) (string, error) {
for _, ev := range events {
if ev.Type == connectiontypes.EventTypeConnectionOpenInit ||
ev.Type == connectiontypes.EventTypeConnectionOpenTry {
for _, attr := range ev.Attributes {
if attr.Key == connectiontypes.AttributeKeyConnectionID {
return attr.Value, nil
}
}
}
}
return "", fmt.Errorf("connection identifier event attribute not found")
}
// ParseChannelIDFromEvents parses events emitted from a MsgChannelOpenInit or
// MsgChannelOpenTry and returns the channel identifier.
func ParseChannelIDFromEvents(events []abci.Event) (string, error) {
for _, ev := range events {
if ev.Type == channeltypes.EventTypeChannelOpenInit || ev.Type == channeltypes.EventTypeChannelOpenTry {
for _, attr := range ev.Attributes {
if attr.Key == channeltypes.AttributeKeyChannelID {
return attr.Value, nil
}
}
}
}
return "", fmt.Errorf("channel identifier event attribute not found")
}
// ParsePacketFromEvents parses events emitted from a MsgRecvPacket and returns the
// acknowledgement.
func ParsePacketFromEvents(events []abci.Event) (channeltypes.Packet, error) {
for _, ev := range events {
if ev.Type == channeltypes.EventTypeSendPacket {
packet := channeltypes.Packet{}
for _, attr := range ev.Attributes {
switch attr.Key {
case channeltypes.AttributeKeyData: //nolint:staticcheck // DEPRECATED
packet.Data = []byte(attr.Value)
case channeltypes.AttributeKeySequence:
seq, err := strconv.ParseUint(attr.Value, 10, 64)
if err != nil {
return channeltypes.Packet{}, err
}
packet.Sequence = seq
case channeltypes.AttributeKeySrcPort:
packet.SourcePort = attr.Value
case channeltypes.AttributeKeySrcChannel:
packet.SourceChannel = attr.Value
case channeltypes.AttributeKeyDstPort:
packet.DestinationPort = attr.Value
case channeltypes.AttributeKeyDstChannel:
packet.DestinationChannel = attr.Value
case channeltypes.AttributeKeyTimeoutHeight:
height, err := clienttypes.ParseHeight(attr.Value)
if err != nil {
return channeltypes.Packet{}, err
}
packet.TimeoutHeight = height
case channeltypes.AttributeKeyTimeoutTimestamp:
timestamp, err := strconv.ParseUint(attr.Value, 10, 64)
if err != nil {
return channeltypes.Packet{}, err
}
packet.TimeoutTimestamp = timestamp
default:
continue
}
}
return packet, nil
}
}
return channeltypes.Packet{}, fmt.Errorf("acknowledgement event attribute not found")
}
// ParseAckFromEvents parses events emitted from a MsgRecvPacket and returns the
// acknowledgement.
func ParseAckFromEvents(events []abci.Event) ([]byte, error) {
for _, ev := range events {
if ev.Type == channeltypes.EventTypeWriteAck {
for _, attr := range ev.Attributes {
if attr.Key == channeltypes.AttributeKeyAck { //nolint:staticcheck // DEPRECATED
return []byte(attr.Value), nil
}
}
}
}
return nil, fmt.Errorf("acknowledgement event attribute not found")
}
// ParseProposalIDFromEvents parses events emitted from MsgSubmitProposal and returns proposalID
func ParseProposalIDFromEvents(events []abci.Event) (uint64, error) {
for _, event := range events {
for _, attribute := range event.Attributes {
if attribute.Key == "proposal_id" {
return strconv.ParseUint(attribute.Value, 10, 64)
}
}
}
return 0, fmt.Errorf("proposalID event attribute not found")
}
// AssertEventsLegacy asserts that expected events are present in the actual events.
// Expected map needs to be a subset of actual events to pass.
func AssertEventsLegacy(
suite *testifysuite.Suite,
expected EventsMap,
actual []abci.Event,
) {
hasEvents := make(map[string]bool)
for eventType := range expected {
hasEvents[eventType] = false
}
for _, event := range actual {
expEvent, eventFound := expected[event.Type]
if eventFound {
hasEvents[event.Type] = true
suite.Require().Len(event.Attributes, len(expEvent))
for _, attr := range event.Attributes {
expValue, found := expEvent[attr.Key]
suite.Require().True(found)
suite.Require().Equal(expValue, attr.Value)
}
}
}
for eventName, hasEvent := range hasEvents {
suite.Require().True(hasEvent, "event: %s was not found in events", eventName)
}
}
// AssertEvents asserts that expected events are present in the actual events.
func AssertEvents(
suite *testifysuite.Suite,
expected []abci.Event,
actual []abci.Event,
) {
foundEvents := make(map[int]bool)
for i, expectedEvent := range expected {
for _, actualEvent := range actual {
// the actual event will have an extra attribute added automatically
// by Cosmos SDK since v0.50, that's why we subtract 1 when comparing
// with the number of attributes in the expected event.
if expectedEvent.Type == actualEvent.Type && (len(expectedEvent.Attributes) == len(actualEvent.Attributes)-1) {
// multiple events with the same type may be emitted, only mark the expected event as found
// if all of the attributes match
attributeMatch := true
for _, expectedAttr := range expectedEvent.Attributes {
// any expected attributes that are not contained in the actual events will cause this event
// not to match
attributeMatch = attributeMatch && slices.Contains(actualEvent.Attributes, expectedAttr)
}
if attributeMatch {
foundEvents[i] = true
}
}
}
}
for i, expectedEvent := range expected {
suite.Require().True(foundEvents[i], "event: %s was not found in events", expectedEvent.Type)
}
}