-
Notifications
You must be signed in to change notification settings - Fork 50
/
client_message.rs
227 lines (201 loc) · 7.06 KB
/
client_message.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
// Copyright (C) 2022 ComposableFi.
// SPDX-License-Identifier: Apache-2.0
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use crate::{
error::Error,
proto::{
self, client_message, ClientMessage as RawClientMessage, Header as RawHeader,
Misbehaviour as RawMisbehaviour,
},
};
use alloc::{collections::BTreeMap, vec::Vec};
use anyhow::anyhow;
use codec::{Decode, Encode};
use grandpa_client_primitives::{FinalityProof, ParachainHeaderProofs};
use ibc::Height;
use sp_core::H256;
use sp_runtime::traits::BlakeTwo256;
use tendermint_proto::Protobuf;
/// Protobuf type url for GRANDPA header
pub const GRANDPA_CLIENT_MESSAGE_TYPE_URL: &str = "/ibc.lightclients.grandpa.v1.ClientMessage";
pub const GRANDPA_HEADER_TYPE_URL: &str = "/ibc.lightclients.grandpa.v1.Header";
pub const GRANDPA_MISBEHAVIOUR_TYPE_URL: &str = "/ibc.lightclients.grandpa.v1.Misbehaviour";
/// Relay chain substrate header type
pub type RelayChainHeader = sp_runtime::generic::Header<u32, BlakeTwo256>;
/// Parachain headers with a Grandpa finality proof.
#[derive(Clone, Debug)]
pub struct Header {
/// The grandpa finality proof: contains relay chain headers from the
/// last known finalized grandpa block.
pub finality_proof: FinalityProof<RelayChainHeader>,
/// Contains a map of relay chain header hashes to parachain headers
/// finalzed at the relay chain height. We check for this parachain header finalization
/// via state proofs. Also contains extrinsic proof for timestamp.
pub parachain_headers: BTreeMap<H256, ParachainHeaderProofs>,
/// Lazily initialized height
pub height: Height,
}
impl Header {
pub fn height(&self) -> Height {
self.height
}
}
/// Misbehaviour type for GRANDPA. If both first and second proofs are valid
/// (that is, form a valid canonical chain of blocks where on of the chain is a fork of
/// the main one)
#[derive(Clone, Debug)]
pub struct Misbehaviour {
/// first proof of misbehaviour
pub first_finality_proof: FinalityProof<RelayChainHeader>,
/// second proof of misbehaviour
pub second_finality_proof: FinalityProof<RelayChainHeader>,
}
/// [`ClientMessage`] for Ics10-GRANDPA
#[derive(Clone, Debug)]
pub enum ClientMessage {
/// This is the variant for header updates
Header(Header),
/// This is for submitting misbehaviors.
Misbehaviour(Misbehaviour),
}
impl ibc::core::ics02_client::client_message::ClientMessage for ClientMessage {
fn encode_to_vec(&self) -> Result<Vec<u8>, tendermint_proto::Error> {
self.encode_vec()
}
}
impl Protobuf<RawHeader> for Header {}
impl TryFrom<RawHeader> for Header {
type Error = Error;
fn try_from(raw_header: RawHeader) -> Result<Self, Self::Error> {
let finality_proof = raw_header
.finality_proof
.ok_or_else(|| anyhow!("Grandpa finality proof is required!"))?;
let block = if finality_proof.block.len() == 32 {
H256::from_slice(&*finality_proof.block)
} else {
Err(anyhow!("Invalid hash type with length: {}", finality_proof.block.len()))?
};
let parachain_headers = raw_header
.parachain_headers
.into_iter()
.map(|header| {
let block = if header.relay_hash.len() == 32 {
H256::from_slice(&*header.relay_hash)
} else {
Err(anyhow!("Invalid hash type with length: {}", header.relay_hash.len()))?
};
let proto::ParachainHeaderProofs { state_proof, extrinsic_proof, extrinsic } =
header
.parachain_header
.ok_or_else(|| anyhow!("Parachain header is required!"))?;
let parachain_header_proofs =
ParachainHeaderProofs { state_proof, extrinsic, extrinsic_proof };
Ok((block, parachain_header_proofs))
})
.collect::<Result<_, Error>>()?;
let unknown_headers = finality_proof
.unknown_headers
.into_iter()
.map(|h| {
let header = codec::Decode::decode(&mut &h[..])?;
Ok(header)
})
.collect::<Result<_, Error>>()?;
Ok(Header {
finality_proof: FinalityProof {
block,
justification: finality_proof.justification,
unknown_headers,
},
parachain_headers,
height: Height::new(raw_header.para_id as u64, raw_header.para_height as u64),
})
}
}
impl From<Header> for RawHeader {
fn from(header: Header) -> Self {
let parachain_headers = header
.parachain_headers
.into_iter()
.map(|(hash, parachain_header_proofs)| proto::ParachainHeaderWithRelayHash {
relay_hash: hash.as_bytes().to_vec(),
parachain_header: Some(proto::ParachainHeaderProofs {
state_proof: parachain_header_proofs.state_proof,
extrinsic: parachain_header_proofs.extrinsic,
extrinsic_proof: parachain_header_proofs.extrinsic_proof,
}),
})
.collect();
let finality_proof = proto::FinalityProof {
block: header.finality_proof.block.as_bytes().to_vec(),
justification: header.finality_proof.justification,
unknown_headers: header
.finality_proof
.unknown_headers
.into_iter()
.map(|h| h.encode())
.collect(),
};
RawHeader {
finality_proof: Some(finality_proof),
parachain_headers,
para_id: header.height.revision_number as u32,
para_height: header.height.revision_height as u32,
}
}
}
impl Protobuf<RawMisbehaviour> for Misbehaviour {}
impl TryFrom<RawMisbehaviour> for Misbehaviour {
type Error = Error;
fn try_from(value: RawMisbehaviour) -> Result<Self, Self::Error> {
Ok(Misbehaviour {
first_finality_proof: Decode::decode(&mut &*value.first_finality_proof)?,
second_finality_proof: Decode::decode(&mut &*value.second_finality_proof)?,
})
}
}
impl From<Misbehaviour> for RawMisbehaviour {
fn from(value: Misbehaviour) -> Self {
RawMisbehaviour {
first_finality_proof: value.first_finality_proof.encode(),
second_finality_proof: value.second_finality_proof.encode(),
}
}
}
impl Protobuf<RawClientMessage> for ClientMessage {}
impl TryFrom<RawClientMessage> for ClientMessage {
type Error = Error;
fn try_from(raw_client_message: RawClientMessage) -> Result<Self, Self::Error> {
let message = match raw_client_message
.message
.ok_or_else(|| anyhow!("Must supply either Header or Misbehaviour type!"))?
{
client_message::Message::Header(raw_header) =>
ClientMessage::Header(Header::try_from(raw_header)?),
client_message::Message::Misbehaviour(raw_misbehaviour) =>
ClientMessage::Misbehaviour(Misbehaviour::try_from(raw_misbehaviour)?),
};
Ok(message)
}
}
impl From<ClientMessage> for RawClientMessage {
fn from(client_message: ClientMessage) -> Self {
match client_message {
ClientMessage::Header(header) =>
RawClientMessage { message: Some(client_message::Message::Header(header.into())) },
ClientMessage::Misbehaviour(misbehaviior) => RawClientMessage {
message: Some(client_message::Message::Misbehaviour(misbehaviior.into())),
},
}
}
}