-
Notifications
You must be signed in to change notification settings - Fork 323
/
conn_open_ack.rs
289 lines (262 loc) · 12.1 KB
/
conn_open_ack.rs
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
//! Protocol logic specific to processing ICS3 messages of type `MsgConnectionOpenAck`.
use crate::events::IbcEvent;
use crate::handler::{HandlerOutput, HandlerResult};
use crate::ics03_connection::connection::{ConnectionEnd, Counterparty, State};
use crate::ics03_connection::context::ConnectionReader;
use crate::ics03_connection::error::{Error, Kind};
use crate::ics03_connection::events::Attributes;
use crate::ics03_connection::handler::verify::{check_client_consensus_height, verify_proofs};
use crate::ics03_connection::handler::{ConnectionIdState, ConnectionResult};
use crate::ics03_connection::msgs::conn_open_ack::MsgConnectionOpenAck;
pub(crate) fn process(
ctx: &dyn ConnectionReader,
msg: MsgConnectionOpenAck,
) -> HandlerResult<ConnectionResult, Error> {
let mut output = HandlerOutput::builder();
// Check the client's (consensus state) proof height.
check_client_consensus_height(ctx, msg.consensus_height())?;
// Unwrap the old connection end & validate it.
let mut new_conn_end = match ctx.connection_end(msg.connection_id()) {
// A connection end must exist and must be Init or TryOpen; otherwise we return an error.
Some(old_conn_end) => {
// Check if the connection state is either Init or TryOpen and message version
// is compatible.
let state_is_consistent = old_conn_end.state_matches(&State::Init)
&& old_conn_end.versions().contains(msg.version())
|| old_conn_end.state_matches(&State::TryOpen)
&& old_conn_end.versions().get(0).eq(&Some(msg.version()));
// Check that if the msg's counterparty connection id is not empty then it matches
// the old connection's counterparty.
let counterparty_matches = msg.counterparty_connection_id().is_none()
|| old_conn_end.counterparty().connection_id() == msg.counterparty_connection_id();
if state_is_consistent && counterparty_matches {
Ok(old_conn_end)
} else {
// Old connection end is in incorrect state, propagate the error.
Err(Into::<Error>::into(Kind::ConnectionMismatch(
msg.connection_id().clone(),
)))
}
}
None => {
// No connection end exists for this conn. identifier. Impossible to continue handshake.
Err(Into::<Error>::into(Kind::UninitializedConnection(
msg.connection_id().clone(),
)))
}
}?;
// Proof verification.
let expected_conn = ConnectionEnd::new(
State::TryOpen,
new_conn_end.counterparty().client_id().clone(),
Counterparty::new(
// The counterparty is the local chain.
new_conn_end.client_id().clone(), // The local client identifier.
msg.counterparty_connection_id().cloned(), // This chain's connection id as known on counterparty.
ctx.commitment_prefix(), // Local commitment prefix.
),
vec![msg.version().clone()],
new_conn_end.delay_period,
);
// 2. Pass the details to the verification function.
verify_proofs(
ctx,
msg.client_state(),
&new_conn_end,
&expected_conn,
msg.proofs(),
)?;
output.log("success: connection verification passed");
new_conn_end.set_state(State::Open);
new_conn_end.set_version(msg.version().clone());
let result = ConnectionResult {
connection_id: msg.connection_id().clone(),
connection_id_state: ConnectionIdState::Reused,
connection_end: new_conn_end,
};
let event_attributes = Attributes {
connection_id: Some(result.connection_id.clone()),
..Default::default()
};
output.emit(IbcEvent::OpenAckConnection(event_attributes.into()));
Ok(output.with_result(result))
}
#[cfg(test)]
mod tests {
use std::convert::TryFrom;
use std::str::FromStr;
use crate::events::IbcEvent;
use crate::ics03_connection::connection::{ConnectionEnd, Counterparty, State};
use crate::ics03_connection::error::Kind;
use crate::ics03_connection::handler::{dispatch, ConnectionResult};
use crate::ics03_connection::msgs::conn_open_ack::test_util::get_dummy_raw_msg_conn_open_ack;
use crate::ics03_connection::msgs::conn_open_ack::MsgConnectionOpenAck;
use crate::ics03_connection::msgs::ConnectionMsg;
use crate::ics23_commitment::commitment::CommitmentPrefix;
use crate::ics24_host::identifier::{ChainId, ClientId};
use crate::mock::context::MockContext;
use crate::mock::host::HostType;
#[test]
fn conn_open_ack_msg_processing() {
struct Test {
name: String,
ctx: MockContext,
msg: ConnectionMsg,
want_pass: bool,
error_kind: Option<Kind>,
}
let msg_ack =
MsgConnectionOpenAck::try_from(get_dummy_raw_msg_conn_open_ack(10, 10)).unwrap();
let conn_id = msg_ack.connection_id.clone();
// Client parameters -- identifier and correct height (matching the proof height)
let client_id = ClientId::from_str("mock_clientid").unwrap();
let proof_height = msg_ack.proofs.height();
// Parametrize the host chain to have a height at least as recent as the
// the height of the proofs in the Ack msg.
let latest_height = proof_height.increment();
let max_history_size = 5;
let default_context = MockContext::new(
ChainId::new("mockgaia".to_string(), latest_height.revision_number),
HostType::Mock,
max_history_size,
latest_height,
);
// A connection end that will exercise the successful path.
let default_conn_end = ConnectionEnd::new(
State::Init,
client_id.clone(),
Counterparty::new(
client_id.clone(),
msg_ack.counterparty_connection_id().cloned(),
CommitmentPrefix::from(b"ibc".to_vec()),
),
vec![msg_ack.version().clone()],
0_u64,
);
// A connection end with incorrect state `Open`; will be part of the context.
let mut conn_end_open = default_conn_end.clone();
conn_end_open.set_state(State::Open); // incorrect field
// A connection end with correct state, but incorrect prefix for the
// counterparty; will be part of the context to exercise unsuccessful path.
let mut conn_end_prefix = conn_end_open.clone();
conn_end_prefix.set_state(State::Init);
conn_end_prefix.set_counterparty(Counterparty::new(
client_id.clone(),
msg_ack.counterparty_connection_id().cloned(),
CommitmentPrefix::from(vec![]), // incorrect field
));
// A connection end with correct state & prefix, but incorrect counterparty; exercises
// unsuccessful processing path.
let mut conn_end_cparty = conn_end_open.clone();
conn_end_cparty.set_state(State::Init);
conn_end_cparty.set_counterparty(Counterparty::new(
client_id.clone(),
None, // incorrect field
CommitmentPrefix::from(b"ibc".to_vec()),
));
let tests: Vec<Test> = vec![
Test {
name: "Successful processing of an Ack message".to_string(),
ctx: default_context
.clone()
.with_client(&client_id, proof_height)
.with_connection(conn_id.clone(), default_conn_end),
msg: ConnectionMsg::ConnectionOpenAck(Box::new(msg_ack.clone())),
want_pass: true,
error_kind: None,
},
Test {
name: "Processing fails because the connection does not exist in the context".to_string(),
ctx: default_context.clone(),
msg: ConnectionMsg::ConnectionOpenAck(Box::new(msg_ack.clone())),
want_pass: false,
error_kind: Some(Kind::UninitializedConnection(conn_id.clone())),
},
Test {
name: "Processing fails due to connections mismatch (incorrect 'open' state)".to_string(),
ctx: default_context
.clone()
.with_client(&client_id, proof_height)
.with_connection(conn_id.clone(), conn_end_open),
msg: ConnectionMsg::ConnectionOpenAck(Box::new(msg_ack.clone())),
want_pass: false,
error_kind: Some(Kind::ConnectionMismatch(conn_id.clone()))
},
Test {
name: "Processing fails: ConsensusStateVerificationFailure due to empty counterparty prefix".to_string(),
ctx: default_context
.clone()
.with_client(&client_id, proof_height)
.with_connection(conn_id.clone(), conn_end_prefix),
msg: ConnectionMsg::ConnectionOpenAck(Box::new(msg_ack.clone())),
want_pass: false,
error_kind: Some(Kind::ConsensusStateVerificationFailure(proof_height))
},
Test {
name: "Processing fails due to mismatching counterparty conn id".to_string(),
ctx: default_context
.with_client(&client_id, proof_height)
.with_connection(conn_id.clone(), conn_end_cparty),
msg: ConnectionMsg::ConnectionOpenAck(Box::new(msg_ack)),
want_pass: false,
error_kind: Some(Kind::ConnectionMismatch(conn_id))
},
/*
Test {
name: "Processing fails due to MissingLocalConsensusState".to_string(),
ctx: MockContext::default()
.with_client(&client_id, proof_height)
.with_connection(conn_id, default_conn_end),
msg: ConnectionMsg::ConnectionOpenAck(Box::new(msg_ack)),
want_pass: false,
error_kind: Some(Kind::MissingLocalConsensusState)
},
*/
];
for test in tests {
let res = dispatch(&test.ctx, test.msg.clone());
// Additionally check the events and the output objects in the result.
match res {
Ok(proto_output) => {
assert_eq!(
test.want_pass,
true,
"conn_open_ack: test passed but was supposed to fail for test: {}, \nparams {:?} {:?}",
test.name,
test.msg.clone(),
test.ctx.clone()
);
assert_ne!(proto_output.events.is_empty(), true); // Some events must exist.
// The object in the output is a ConnectionEnd, should have OPEN state.
let res: ConnectionResult = proto_output.result;
assert_eq!(res.connection_end.state().clone(), State::Open);
for e in proto_output.events.iter() {
assert!(matches!(e, &IbcEvent::OpenAckConnection(_)));
}
}
Err(e) => {
assert_eq!(
test.want_pass,
false,
"conn_open_ack: failed for test: {}, \nparams {:?} {:?} error: {:?}",
test.name,
test.msg,
test.ctx.clone(),
e,
);
// Verify that the error kind matches
if let Some(expected_kind) = test.error_kind {
assert_eq!(
&expected_kind,
e.kind(),
"conn_open_ack: failed for test: {}\nexpected error kind: {:?}\nfound: {:?}",
test.name,
expected_kind,
e.kind()
)
}
}
}
}
}
}