Initial codec module

This commit is contained in:
Age Manning 2019-07-13 18:56:08 +10:00
parent d84780a339
commit 15cdd2afb9
No known key found for this signature in database
GPG Key ID: 05EED64B79E06A93
6 changed files with 415 additions and 873 deletions

View File

@ -1,442 +1,119 @@
///! This handles the various supported encoding mechanism for the Eth 2.0 RPC.
///! This handles the various supported encoding mechanism for the Eth 2.0 RPC. pub trait InnerCodec: Encoder + Decoder {
///! type Error;
///! Currently supported encodings are:
///! - ssz - Varint length-prefixed SSZ-encoding.
fn decode_error(
&mut self,
&mut BytesMut,
) -> Result<Option<Self::Error>, <Self as Decoder>::Error>;
}
pub struct BaseCodec<TCodec: Codec> { pub struct BaseInboundCodec<TCodec: InnerCodec> {
/// Inner codec for handling various encodings
inner: TCodec,
}
pub struct BaseOutboundCodec<TCodec>
where
TCodec: InnerCodec,
<TCodec as Decoder>::Item = RPCResponse,
<TCodec as InnerCodec>::ErrorItem = ErrorMessage,
{
/// Inner codec for handling various encodings /// Inner codec for handling various encodings
inner: TCodec, inner: TCodec,
/// Optimisation for decoding. True if the response code has been read and we are awaiting a /// Optimisation for decoding. True if the response code has been read and we are awaiting a
/// response. /// response.
read_response_code: bool, response_code: Option<u8>,
} }
impl<TCodec> Encoder for BaseInboundCodec<TCodec>
where
TCodec: Encoder,
<TCodec as Encoder>::Item = RPCResponse,
{
type Item = RPCResponse;
type Error = <TCodec as Encoder>::Error;
fn encode(&mut self, item: Self::Item, dst: &mut BytesMut) -> Result<(), Self::Error> {
dst.clear();
dst.reserve(1);
dst.put_u8(item.as_u8);
return self.inner.encode();
}
}
impl<TCodec> Decoder for BaseInboundCodec<TCodec>
where
TCodec: Decoder,
<TCodec as Decoder>::Item: RPCrequest,
<TCodec as Decoder>::Error: From<RPCError>,
{
type Item = RPCRequest;
type Error = <TCodec as Decoder>::Error;
fn decode(&mut self, src: &mut BytesMut) -> Result<Option<Self::Item>, Self::Error> {
self.inner.decode(src)
}
}
impl<TCodec> Encoder for BaseOutboundCodec<TCodec> impl<TCodec> Encoder for BaseOutboundCodec<TCodec>
where where
TCodec: Encoder TCodec: Encoder,
{ {
type Item = RPCRequest; type Item = RPCRequest;
type Error = <TCodec as Encoder>::Error; type Error = <TCodec as Encoder>::Error;
fn encode( fn encode(&mut self, item: Self::Item, dst: &mut BytesMut) -> Result<(), Self::Error> {
&mut self,
item: Self::Item,
dst: &mut BytesMut
) -> Result<(), Self::Error> {
self.inner.encode(item, dst) self.inner.encode(item, dst)
} }
} }
impl<TCodec> Decoder for BaseOutboundCodec<TCodec>
impl<TCodec> Encoder for BaseInboundCodec<TCodec> where
where TCodec: InnerCodec,
TCodec: Encoder <TCodec as Decoder>::Error: From<RPCError>,
{ {
type Item = RPCResponse;
type Error = <TCodec as Encoder>::Error;
fn encode(
&mut self,
item: Self::Item,
dst: &mut BytesMut
) -> Result<(), Self::Error> {
match item {
RPCResponse::Error(response) => {
match response = {
ErrorResponse::EncodingError => {
dst.clear();
dst.reserve(1);
dst.put(response as u8);
return;
}
ErrorResponse::
self.inner.encode(item, dst)
}
}
impl<TCodec> Decoder for BaseCodec<TCodec>
where
TCodec: Decoder,
<TCodec as Decoder>::Error: From<RPCError>,
{
type Item = RPCResponse; type Item = RPCResponse;
type Error = <TCodec as Decoder>::Error; type Error = <TCodec as Decoder>::Error;
fn decode( fn decode(&mut self, src: &mut BytesMut) -> Result<Option<Self::Item>, Self::Error> {
&mut self, let response_code = {
src: &mut BytesMut if let Some(resp_code) = self.response_code {
) -> Result<Option<Self::Item>, Self::Error> { resp_code;
} else {
if !self.read_response_code { if src.is_empty() {
if src.len() < 1 { return Err(io::Error::new(
return Err(io::Error::new(io::ErrorKind::InvalidData, "no bytes received")); io::ErrorKind::InvalidData,
} "no bytes received",
let resp_code_byte = [0; 1];
// data must be only 1-byte - this cannot panic
resp_code_byte.copy_from_slice(&src);
let response_code =
ResponseCode::from(u8::from_be_bytes(resp_code_byte));
match response_code {
ResponseCode::EncodingError => {
// invalid encoding
let response = RPCResponse::Error("Invalid Encoding".into());
return Ok(Async::Ready(response));
}
ResponseCode::Success
| ResponseCode::InvalidRequest
| ResponseCode::ServerError => {
// need to read another packet
self.inner = RPCRequestResponseInner::Read(
read_one(socket, max_size),
response_code,
)
}
ResponseCode::Unknown => {
// unknown response code
let response = RPCResponse::Error(format!(
"Unknown response code: {}",
(response_code as u8)
)); ));
return Ok(Async::Ready(response)); }
let resp_byte = src.split_to(1);
let resp_code_byte = [0; 1];
resp_code_byte.copy_from_slice(&resp_byte);
let resp_code = u8::from_be_bytes(resp_code_byte);
if let Some(response) = RPCErrorResponse::internal_data(resp_code) {
self.response_code = None;
return response;
} }
resp_code
}
/// SSZ Input stream
pub struct SSZInboundSink<TSocket> {
inner:
protocol: ProtocolId
impl<TSocket> for SSZInputStream<TSocket>
where
TSocket: AsyncRead + AsyncWrite
{
/// Set up the initial input stream object.
pub fn new(incomming: TSocket, protocol: ProtocolId, max_size: usize) -> Self {
// this type of stream should only apply to ssz protocols
debug_assert!(protocol.encoding.as_str() == "ssz");
let mut uvi_codec = UviBytes::default();
uvi_codec.set_max_len(max_size);
let inner = Framed::new(incomming, uvi_codec).from_err()
.with(|response| {
self.encode(response)
})
.and_then(|bytes| {
self.decode(request)
}).into_future();
//TODO: add timeout
SSZInputStream {
inner,
protocol
}
}
/// Decodes an SSZ-encoded RPCRequest.
fn decode(&self, request: RPCRequest) {
match self.protocol.message_name.as_str() {
"hello" => match protocol.version.as_str() {
"1.0.0" => Ok(RPCRequest::Hello(HelloMessage::from_ssz_bytes(&packet)?)),
_ => Err(RPCError::InvalidProtocol("Unknown HELLO version")),
},
"goodbye" => match protocol.version.as_str() {
"1.0.0" => Ok(RPCRequest::Goodbye(Goodbye::from_ssz_bytes(&packet)?)),
_ => Err(RPCError::InvalidProtocol(
"Unknown GOODBYE version.as_str()",
)),
},
"beacon_block_roots" => match protocol.version.as_str() {
"1.0.0" => Ok(RPCRequest::BeaconBlockRoots(
BeaconBlockRootsRequest::from_ssz_bytes(&packet)?,
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_ROOTS version.",
)),
},
"beacon_block_headers" => match protocol.version.as_str() {
"1.0.0" => Ok(RPCRequest::BeaconBlockHeaders(
BeaconBlockHeadersRequest::from_ssz_bytes(&packet)?,
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_HEADERS version.",
)),
},
"beacon_block_bodies" => match protocol.version.as_str() {
"1.0.0" => Ok(RPCRequest::BeaconBlockBodies(
BeaconBlockBodiesRequest::from_ssz_bytes(&packet)?,
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_BODIES version.",
)),
},
"beacon_chain_state" => match protocol.version.as_str() {
"1.0.0" => Ok(RPCRequest::BeaconChainState(
BeaconChainStateRequest::from_ssz_bytes(&packet)?,
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_CHAIN_STATE version.",
)),
},
}
}
fn encode(&self, response: RPCResponse) {
// TODO: Add error code
match response {
RPCResponse::Hello(res) => res.as_ssz_bytes(),
RPCResponse::Goodbye => unreachable!(),
RPCResponse::BeaconBlockRoots(res) => res.as_ssz_bytes(),
RPCResponse::BeaconBlockHeaders(res) => res.headers, // already raw bytes
RPCResponse::BeaconBlockBodies(res) => res.block_bodies, // already raw bytes
RPCResponse::BeaconChainState(res) => res.as_ssz_bytes(),
}
}
}
type SSZInboundOutput = stream::AndThen<sink::With<stream::FromErr<Framed<TSocket, UviBytes<Vec<u8>>>, RPCError>,
RPCResponse,
fn(RPCResponse) -> Result<Vec<u8>, RPCError>,
Result<Vec<u8>, RPCError>,
>,
fn(BytesMut) -> Result<RPCRequest, RPCError>,
Result<RPCRequest, RPCError>
>;
impl<TSocket> Sink for SSZInputStreamSink<TSocket> {
type SinkItem = RPCResponse;
type SinkError = RPCError;
fn start_send(
&mut self,
item: Self::SinkItem
) -> Result<AsyncSink<Self::SinkItem>, Self::SinkError> {
self.inner.start_send(item)
}
fn poll_complete(&mut self) -> Result<Async<()>, Self::SinkError> {
self.inner.poll_complete()
}
}
/* Outbound specific stream */
// Implement our own decoder to handle the response byte
struct SSZOutboundCodec
pub struct SSZOutboundStreamSink<TSocket> {
inner:
protocol: ProtocolId
impl<TSocket> for SSZOutboundStreamSink<TSocket>
where
TSocket: AsyncRead + AsyncWrite
{
/// Set up the initial outbound stream object.
pub fn new(socket: TSocket, protocol: ProtocolId, max_size: usize) -> Self {
// this type of stream should only apply to ssz protocols
debug_assert!(protocol.encoding.as_str() == "ssz");
let mut uvi_codec = UviBytes::default();
uvi_codec.set_max_len(max_size);
let inner = Framed::new(socket, uvi_codec).from_err()
.with(|request| {
self.encode(request)
})
.and_then(|bytes| {
self.decode(response)
});
SSZOutboundStream {
inner,
protocol
}
}
/// Decodes a response that was received on the same stream as a request. The response type should
/// therefore match the request protocol type.
pub fn decode(&self, response: Vec<u8>,
protocol: ProtocolId,
response_code: ResponseCode,
) -> Result<Self, RPCError> {
match response_code {
ResponseCode::EncodingError => Ok(RPCResponse::Error("Encoding error".into())),
ResponseCode::InvalidRequest => {
let response = match protocol.encoding.as_str() {
"ssz" => ErrorResponse::from_ssz_bytes(&packet)?,
_ => return Err(RPCError::InvalidProtocol("Unknown Encoding")),
};
Ok(RPCResponse::Error(format!(
"Invalid Request: {}",
response.error_message
)))
} }
ResponseCode::ServerError => { };
let response = match protocol.encoding.as_str() {
"ssz" => ErrorResponse::from_ssz_bytes(&packet)?, if RPCErrorResponse::is_response(response_code) {
_ => return Err(RPCError::InvalidProtocol("Unknown Encoding")), // decode an actual response
}; return self
Ok(RPCResponse::Error(format!( .inner
"Remote Server Error: {}", .decode(src)
response.error_message .map(|r| r.map(|resp| RPCErrorResponse::Success(resp)));
))) } else {
} // decode an error
ResponseCode::Success => match protocol.message_name.as_str() { return self
"hello" => match protocol.version.as_str() { .inner
"1.0.0" => match protocol.encoding.as_str() { .decode_error(src)
"ssz" => Ok(RPCResponse::Hello(HelloMessage::from_ssz_bytes(&packet)?)), .map(|r| r.map(|resp| RPCErrorResponse::from_error(response_code, resp)));
_ => Err(RPCError::InvalidProtocol("Unknown HELLO encoding")),
},
_ => Err(RPCError::InvalidProtocol("Unknown HELLO version.")),
},
"goodbye" => Err(RPCError::Custom(
"GOODBYE should not have a response".into(),
)),
"beacon_block_roots" => match protocol.version.as_str() {
"1.0.0" => match protocol.encoding.as_str() {
"ssz" => Ok(RPCResponse::BeaconBlockRoots(
BeaconBlockRootsResponse::from_ssz_bytes(&packet)?,
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_ROOTS encoding",
)),
},
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_ROOTS version.",
)),
},
"beacon_block_headers" => match protocol.version.as_str() {
"1.0.0" => match protocol.encoding.as_str() {
"ssz" => Ok(RPCResponse::BeaconBlockHeaders(
BeaconBlockHeadersResponse { headers: packet },
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_HEADERS encoding",
)),
},
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_HEADERS version.",
)),
},
"beacon_block_bodies" => match protocol.version.as_str() {
"1.0.0" => match protocol.encoding.as_str() {
"ssz" => Ok(RPCResponse::BeaconBlockBodies(BeaconBlockBodiesResponse {
block_bodies: packet,
})),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_BODIES encoding",
)),
},
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_BODIES version.",
)),
},
"beacon_chain_state" => match protocol.version.as_str() {
"1.0.0" => match protocol.encoding.as_str() {
"ssz" => Ok(RPCResponse::BeaconChainState(
BeaconChainStateResponse::from_ssz_bytes(&packet)?,
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_CHAIN_STATE encoding",
)),
},
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_CHAIN_STATE version.",
)),
},
},
} }
} }
fn encode(&self, response: RPCResponse) {
match response {
RPCResponse::Hello(res) => res.as_ssz_bytes(),
RPCResponse::Goodbye => unreachable!(),
RPCResponse::BeaconBlockRoots(res) => res.as_ssz_bytes(),
RPCResponse::BeaconBlockHeaders(res) => res.headers, // already raw bytes
RPCResponse::BeaconBlockBodies(res) => res.block_bodies, // already raw bytes
RPCResponse::BeaconChainState(res) => res.as_ssz_bytes(),
}
}
} }
type SSZOutboundStream = stream::AndThen<sink::With<stream::FromErr<Framed<TSocket, UviBytes<Vec<u8>>>, RPCError>,
RPCResponse,
fn(RPCResponse) -> Result<Vec<u8>, RPCError>,
Result<Vec<u8>, RPCError>,
>,
fn(BytesMut) -> Result<RPCRequest, RPCError>,
Result<RPCRequest, RPCError>
>;
impl<TSocket> Stream for SSZInputStreamSink<TSocket> {
type Item = SSZInboundOutput;
type Error = RPCError;
fn poll(&mut self) -> Result<Async<Option<Self::Item>>, Self::Error> {
self.inner.poll()
}
}
impl<TSocket> Sink for SSZInputStreamSink<TSocket> {
type SinkItem = RPCResponse;
type SinkError = RPCError;
fn start_send(
&mut self,
item: Self::SinkItem
) -> Result<AsyncSink<Self::SinkItem>, Self::SinkError> {
self.inner.start_send(item)
}
fn poll_complete(&mut self) -> Result<Async<()>, Self::SinkError> {
self.inner.poll_complete()
}
}

View File

@ -0,0 +1 @@
mod base;

View File

@ -0,0 +1,323 @@
/// SSZ Input stream
pub struct SSZInboundSink<TSocket> {
inner:
protocol: ProtocolId
impl<TSocket> for SSZInputStream<TSocket>
where
TSocket: AsyncRead + AsyncWrite
{
/// Set up the initial input stream object.
pub fn new(incomming: TSocket, protocol: ProtocolId, max_size: usize) -> Self {
// this type of stream should only apply to ssz protocols
debug_assert!(protocol.encoding.as_str() == "ssz");
let mut uvi_codec = UviBytes::default();
uvi_codec.set_max_len(max_size);
let inner = Framed::new(incomming, uvi_codec).from_err()
.with(|response| {
self.encode(response)
})
.and_then(|bytes| {
self.decode(request)
}).into_future();
//TODO: add timeout
SSZInputStream {
inner,
protocol
}
}
/// Decodes an SSZ-encoded RPCRequest.
fn decode(&self, request: RPCRequest) {
match self.protocol.message_name.as_str() {
"hello" => match protocol.version.as_str() {
"1.0.0" => Ok(RPCRequest::Hello(HelloMessage::from_ssz_bytes(&packet)?)),
_ => Err(RPCError::InvalidProtocol("Unknown HELLO version")),
},
"goodbye" => match protocol.version.as_str() {
"1.0.0" => Ok(RPCRequest::Goodbye(Goodbye::from_ssz_bytes(&packet)?)),
_ => Err(RPCError::InvalidProtocol(
"Unknown GOODBYE version.as_str()",
)),
},
"beacon_block_roots" => match protocol.version.as_str() {
"1.0.0" => Ok(RPCRequest::BeaconBlockRoots(
BeaconBlockRootsRequest::from_ssz_bytes(&packet)?,
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_ROOTS version.",
)),
},
"beacon_block_headers" => match protocol.version.as_str() {
"1.0.0" => Ok(RPCRequest::BeaconBlockHeaders(
BeaconBlockHeadersRequest::from_ssz_bytes(&packet)?,
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_HEADERS version.",
)),
},
"beacon_block_bodies" => match protocol.version.as_str() {
"1.0.0" => Ok(RPCRequest::BeaconBlockBodies(
BeaconBlockBodiesRequest::from_ssz_bytes(&packet)?,
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_BODIES version.",
)),
},
"beacon_chain_state" => match protocol.version.as_str() {
"1.0.0" => Ok(RPCRequest::BeaconChainState(
BeaconChainStateRequest::from_ssz_bytes(&packet)?,
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_CHAIN_STATE version.",
)),
},
}
}
fn encode(&self, response: RPCResponse) {
// TODO: Add error code
match response {
RPCResponse::Hello(res) => res.as_ssz_bytes(),
RPCResponse::Goodbye => unreachable!(),
RPCResponse::BeaconBlockRoots(res) => res.as_ssz_bytes(),
RPCResponse::BeaconBlockHeaders(res) => res.headers, // already raw bytes
RPCResponse::BeaconBlockBodies(res) => res.block_bodies, // already raw bytes
RPCResponse::BeaconChainState(res) => res.as_ssz_bytes(),
}
}
}
type SSZInboundOutput = stream::AndThen<sink::With<stream::FromErr<Framed<TSocket, UviBytes<Vec<u8>>>, RPCError>,
RPCResponse,
fn(RPCResponse) -> Result<Vec<u8>, RPCError>,
Result<Vec<u8>, RPCError>,
>,
fn(BytesMut) -> Result<RPCRequest, RPCError>,
Result<RPCRequest, RPCError>
>;
impl<TSocket> Sink for SSZInputStreamSink<TSocket> {
type SinkItem = RPCResponse;
type SinkError = RPCError;
fn start_send(
&mut self,
item: Self::SinkItem
) -> Result<AsyncSink<Self::SinkItem>, Self::SinkError> {
self.inner.start_send(item)
}
fn poll_complete(&mut self) -> Result<Async<()>, Self::SinkError> {
self.inner.poll_complete()
}
}
/* Outbound specific stream */
// Implement our own decoder to handle the response byte
struct SSZOutboundCodec
pub struct SSZOutboundStreamSink<TSocket> {
inner:
protocol: ProtocolId
impl<TSocket> for SSZOutboundStreamSink<TSocket>
where
TSocket: AsyncRead + AsyncWrite
{
/// Set up the initial outbound stream object.
pub fn new(socket: TSocket, protocol: ProtocolId, max_size: usize) -> Self {
// this type of stream should only apply to ssz protocols
debug_assert!(protocol.encoding.as_str() == "ssz");
let mut uvi_codec = UviBytes::default();
uvi_codec.set_max_len(max_size);
let inner = Framed::new(socket, uvi_codec).from_err()
.with(|request| {
self.encode(request)
})
.and_then(|bytes| {
self.decode(response)
});
SSZOutboundStream {
inner,
protocol
}
}
/// Decodes a response that was received on the same stream as a request. The response type should
/// therefore match the request protocol type.
pub fn decode(&self, response: Vec<u8>,
protocol: ProtocolId,
response_code: ResponseCode,
) -> Result<Self, RPCError> {
match response_code {
ResponseCode::EncodingError => Ok(RPCResponse::Error("Encoding error".into())),
ResponseCode::InvalidRequest => {
let response = match protocol.encoding.as_str() {
"ssz" => ErrorResponse::from_ssz_bytes(&packet)?,
_ => return Err(RPCError::InvalidProtocol("Unknown Encoding")),
};
Ok(RPCResponse::Error(format!(
"Invalid Request: {}",
response.error_message
)))
}
ResponseCode::ServerError => {
let response = match protocol.encoding.as_str() {
"ssz" => ErrorResponse::from_ssz_bytes(&packet)?,
_ => return Err(RPCError::InvalidProtocol("Unknown Encoding")),
};
Ok(RPCResponse::Error(format!(
"Remote Server Error: {}",
response.error_message
)))
}
ResponseCode::Success => match protocol.message_name.as_str() {
"hello" => match protocol.version.as_str() {
"1.0.0" => match protocol.encoding.as_str() {
"ssz" => Ok(RPCResponse::Hello(HelloMessage::from_ssz_bytes(&packet)?)),
_ => Err(RPCError::InvalidProtocol("Unknown HELLO encoding")),
},
_ => Err(RPCError::InvalidProtocol("Unknown HELLO version.")),
},
"goodbye" => Err(RPCError::Custom(
"GOODBYE should not have a response".into(),
)),
"beacon_block_roots" => match protocol.version.as_str() {
"1.0.0" => match protocol.encoding.as_str() {
"ssz" => Ok(RPCResponse::BeaconBlockRoots(
BeaconBlockRootsResponse::from_ssz_bytes(&packet)?,
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_ROOTS encoding",
)),
},
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_ROOTS version.",
)),
},
"beacon_block_headers" => match protocol.version.as_str() {
"1.0.0" => match protocol.encoding.as_str() {
"ssz" => Ok(RPCResponse::BeaconBlockHeaders(
BeaconBlockHeadersResponse { headers: packet },
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_HEADERS encoding",
)),
},
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_HEADERS version.",
)),
},
"beacon_block_bodies" => match protocol.version.as_str() {
"1.0.0" => match protocol.encoding.as_str() {
"ssz" => Ok(RPCResponse::BeaconBlockBodies(BeaconBlockBodiesResponse {
block_bodies: packet,
})),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_BODIES encoding",
)),
},
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_BODIES version.",
)),
},
"beacon_chain_state" => match protocol.version.as_str() {
"1.0.0" => match protocol.encoding.as_str() {
"ssz" => Ok(RPCResponse::BeaconChainState(
BeaconChainStateResponse::from_ssz_bytes(&packet)?,
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_CHAIN_STATE encoding",
)),
},
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_CHAIN_STATE version.",
)),
},
},
}
}
fn encode(&self, response: RPCResponse) {
match response {
RPCResponse::Hello(res) => res.as_ssz_bytes(),
RPCResponse::Goodbye => unreachable!(),
RPCResponse::BeaconBlockRoots(res) => res.as_ssz_bytes(),
RPCResponse::BeaconBlockHeaders(res) => res.headers, // already raw bytes
RPCResponse::BeaconBlockBodies(res) => res.block_bodies, // already raw bytes
RPCResponse::BeaconChainState(res) => res.as_ssz_bytes(),
}
}
}
type SSZOutboundStream = stream::AndThen<sink::With<stream::FromErr<Framed<TSocket, UviBytes<Vec<u8>>>, RPCError>,
RPCResponse,
fn(RPCResponse) -> Result<Vec<u8>, RPCError>,
Result<Vec<u8>, RPCError>,
>,
fn(BytesMut) -> Result<RPCRequest, RPCError>,
Result<RPCRequest, RPCError>
>;
impl<TSocket> Stream for SSZInputStreamSink<TSocket> {
type Item = SSZInboundOutput;
type Error = RPCError;
fn poll(&mut self) -> Result<Async<Option<Self::Item>>, Self::Error> {
self.inner.poll()
}
}
impl<TSocket> Sink for SSZInputStreamSink<TSocket> {
type SinkItem = RPCResponse;
type SinkError = RPCError;
fn start_send(
&mut self,
item: Self::SinkItem
) -> Result<AsyncSink<Self::SinkItem>, Self::SinkError> {
self.inner.start_send(item)
}
fn poll_complete(&mut self) -> Result<Async<()>, Self::SinkError> {
self.inner.poll_complete()
}
}

View File

@ -16,6 +16,7 @@ use slog::o;
use std::marker::PhantomData; use std::marker::PhantomData;
use tokio::io::{AsyncRead, AsyncWrite}; use tokio::io::{AsyncRead, AsyncWrite};
mod codecs;
mod handler; mod handler;
pub mod methods; pub mod methods;
mod protocol; mod protocol;

View File

@ -251,6 +251,7 @@ impl RPCErrorResponse {
} }
} }
/// Used to encode the response.
pub fn as_u8(&self) -> u8 { pub fn as_u8(&self) -> u8 {
match self { match self {
RPCErrorResponse::Success(_) => 0, RPCErrorResponse::Success(_) => 0,

461
codec.rs
View File

@ -1,461 +0,0 @@
///! This handles the various supported encoding mechanism for the Eth 2.0 RPC.
///!
///! Currently supported encodings are:
///! - ssz - Varint length-prefixed SSZ-encoding.
pub trait InnerCodec: Encoder + Decoder {
type Error;
pub fn decode_error(&mut self, &mut BytesMut) -> Result<Option<Self::Error>, <Self as Decoder>::Error>;
}
pub struct BaseInboundCodec<TCodec: InnerCodec> {
/// Inner codec for handling various encodings
inner: TCodec,
}
impl<TCodec> Encoder for BaseInboundCodec<TCodec>
where
TCodec: Encoder,
<TCodec as Encoder>::Item = RPCResponse,
{
type Item = RPCResponse;
type Error = <TCodec as Encoder>::Error;
fn encode(
&mut self,
item: Self::Item,
dst: &mut BytesMut
) -> Result<(), Self::Error> {
dst.clear();
dst.reserve(1);
dst.put_u8(item.as_u8);
return self.inner.encode();
}
}
impl<TCodec> Decoder for BaseInboundCodec<TCodec>
where
TCodec: Decoder,
<TCodec as Decoder>::Item: RPCrequest,
<TCodec as Decoder>::Error: From<RPCError>,
{
type Item = RPCRequest;
type Error = <TCodec as Decoder>::Error;
fn decode(
&mut self,
src: &mut BytesMut
) -> Result<Option<Self::Item>, Self::Error> {
self.inner.decode(src)
}
}
pub struct BaseOutboundCodec<TCodec>
where
TCodec: InnerCodec,
<TCodec as Decoder>::Item = RPCResponse,
<TCodec as InnerCodec>::ErrorItem = ErrorMessage,
{
/// Inner codec for handling various encodings
inner: TCodec,
/// Optimisation for decoding. True if the response code has been read and we are awaiting a
/// response.
response_code: Option<u8>,
}
impl<TCodec> Encoder for BaseOutboundCodec<TCodec>
where
TCodec: Encoder
{
type Item = RPCRequest;
type Error = <TCodec as Encoder>::Error;
fn encode(
&mut self,
item: Self::Item,
dst: &mut BytesMut
) -> Result<(), Self::Error> {
self.inner.encode(item, dst)
}
}
impl<TCodec> Decoder for BaseOutboundCodec<TCodec>
where
TCodec: InnerCodec,
<TCodec as Decoder>::Error: From<RPCError>,
{
type Item = RPCResponse;
type Error = <TCodec as Decoder>::Error;
fn decode(
&mut self,
src: &mut BytesMut
) -> Result<Option<Self::Item>, Self::Error> {
let response_code = {
if let Some(resp_code) = self.response_code {
resp_code;
}
else {
if src.is_empty() {
return Err(io::Error::new(io::ErrorKind::InvalidData, "no bytes received"));
}
let resp_byte = src.split_to(1);
let resp_code_byte = [0; 1];
resp_code_byte.copy_from_slice(&resp_byte);
let resp_code = u8::from_be_bytes(resp_code_byte);
if let Some(response) = RPCErrorResponse::internal_data(resp_code) {
self.response_code = None;
return response;
}
resp_code
}
};
if RPCErrorResponse::is_response(response_code) {
// decode an actual response
return self.inner.decode(src).map(|r| r.map(|resp| RPCErrorResponse::Success(resp)));
}
else {
// decode an error
return self.inner.decode_error(src).map(|r| r.map(|resp| RPCErrorResponse::from_error(response_code, resp)));
}
}
}
/// SSZ Input stream
pub struct SSZInboundSink<TSocket> {
inner:
protocol: ProtocolId
impl<TSocket> for SSZInputStream<TSocket>
where
TSocket: AsyncRead + AsyncWrite
{
/// Set up the initial input stream object.
pub fn new(incomming: TSocket, protocol: ProtocolId, max_size: usize) -> Self {
// this type of stream should only apply to ssz protocols
debug_assert!(protocol.encoding.as_str() == "ssz");
let mut uvi_codec = UviBytes::default();
uvi_codec.set_max_len(max_size);
let inner = Framed::new(incomming, uvi_codec).from_err()
.with(|response| {
self.encode(response)
})
.and_then(|bytes| {
self.decode(request)
}).into_future();
//TODO: add timeout
SSZInputStream {
inner,
protocol
}
}
/// Decodes an SSZ-encoded RPCRequest.
fn decode(&self, request: RPCRequest) {
match self.protocol.message_name.as_str() {
"hello" => match protocol.version.as_str() {
"1.0.0" => Ok(RPCRequest::Hello(HelloMessage::from_ssz_bytes(&packet)?)),
_ => Err(RPCError::InvalidProtocol("Unknown HELLO version")),
},
"goodbye" => match protocol.version.as_str() {
"1.0.0" => Ok(RPCRequest::Goodbye(Goodbye::from_ssz_bytes(&packet)?)),
_ => Err(RPCError::InvalidProtocol(
"Unknown GOODBYE version.as_str()",
)),
},
"beacon_block_roots" => match protocol.version.as_str() {
"1.0.0" => Ok(RPCRequest::BeaconBlockRoots(
BeaconBlockRootsRequest::from_ssz_bytes(&packet)?,
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_ROOTS version.",
)),
},
"beacon_block_headers" => match protocol.version.as_str() {
"1.0.0" => Ok(RPCRequest::BeaconBlockHeaders(
BeaconBlockHeadersRequest::from_ssz_bytes(&packet)?,
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_HEADERS version.",
)),
},
"beacon_block_bodies" => match protocol.version.as_str() {
"1.0.0" => Ok(RPCRequest::BeaconBlockBodies(
BeaconBlockBodiesRequest::from_ssz_bytes(&packet)?,
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_BODIES version.",
)),
},
"beacon_chain_state" => match protocol.version.as_str() {
"1.0.0" => Ok(RPCRequest::BeaconChainState(
BeaconChainStateRequest::from_ssz_bytes(&packet)?,
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_CHAIN_STATE version.",
)),
},
}
}
fn encode(&self, response: RPCResponse) {
// TODO: Add error code
match response {
RPCResponse::Hello(res) => res.as_ssz_bytes(),
RPCResponse::Goodbye => unreachable!(),
RPCResponse::BeaconBlockRoots(res) => res.as_ssz_bytes(),
RPCResponse::BeaconBlockHeaders(res) => res.headers, // already raw bytes
RPCResponse::BeaconBlockBodies(res) => res.block_bodies, // already raw bytes
RPCResponse::BeaconChainState(res) => res.as_ssz_bytes(),
}
}
}
type SSZInboundOutput = stream::AndThen<sink::With<stream::FromErr<Framed<TSocket, UviBytes<Vec<u8>>>, RPCError>,
RPCResponse,
fn(RPCResponse) -> Result<Vec<u8>, RPCError>,
Result<Vec<u8>, RPCError>,
>,
fn(BytesMut) -> Result<RPCRequest, RPCError>,
Result<RPCRequest, RPCError>
>;
impl<TSocket> Sink for SSZInputStreamSink<TSocket> {
type SinkItem = RPCResponse;
type SinkError = RPCError;
fn start_send(
&mut self,
item: Self::SinkItem
) -> Result<AsyncSink<Self::SinkItem>, Self::SinkError> {
self.inner.start_send(item)
}
fn poll_complete(&mut self) -> Result<Async<()>, Self::SinkError> {
self.inner.poll_complete()
}
}
/* Outbound specific stream */
// Implement our own decoder to handle the response byte
struct SSZOutboundCodec
pub struct SSZOutboundStreamSink<TSocket> {
inner:
protocol: ProtocolId
impl<TSocket> for SSZOutboundStreamSink<TSocket>
where
TSocket: AsyncRead + AsyncWrite
{
/// Set up the initial outbound stream object.
pub fn new(socket: TSocket, protocol: ProtocolId, max_size: usize) -> Self {
// this type of stream should only apply to ssz protocols
debug_assert!(protocol.encoding.as_str() == "ssz");
let mut uvi_codec = UviBytes::default();
uvi_codec.set_max_len(max_size);
let inner = Framed::new(socket, uvi_codec).from_err()
.with(|request| {
self.encode(request)
})
.and_then(|bytes| {
self.decode(response)
});
SSZOutboundStream {
inner,
protocol
}
}
/// Decodes a response that was received on the same stream as a request. The response type should
/// therefore match the request protocol type.
pub fn decode(&self, response: Vec<u8>,
protocol: ProtocolId,
response_code: ResponseCode,
) -> Result<Self, RPCError> {
match response_code {
ResponseCode::EncodingError => Ok(RPCResponse::Error("Encoding error".into())),
ResponseCode::InvalidRequest => {
let response = match protocol.encoding.as_str() {
"ssz" => ErrorResponse::from_ssz_bytes(&packet)?,
_ => return Err(RPCError::InvalidProtocol("Unknown Encoding")),
};
Ok(RPCResponse::Error(format!(
"Invalid Request: {}",
response.error_message
)))
}
ResponseCode::ServerError => {
let response = match protocol.encoding.as_str() {
"ssz" => ErrorResponse::from_ssz_bytes(&packet)?,
_ => return Err(RPCError::InvalidProtocol("Unknown Encoding")),
};
Ok(RPCResponse::Error(format!(
"Remote Server Error: {}",
response.error_message
)))
}
ResponseCode::Success => match protocol.message_name.as_str() {
"hello" => match protocol.version.as_str() {
"1.0.0" => match protocol.encoding.as_str() {
"ssz" => Ok(RPCResponse::Hello(HelloMessage::from_ssz_bytes(&packet)?)),
_ => Err(RPCError::InvalidProtocol("Unknown HELLO encoding")),
},
_ => Err(RPCError::InvalidProtocol("Unknown HELLO version.")),
},
"goodbye" => Err(RPCError::Custom(
"GOODBYE should not have a response".into(),
)),
"beacon_block_roots" => match protocol.version.as_str() {
"1.0.0" => match protocol.encoding.as_str() {
"ssz" => Ok(RPCResponse::BeaconBlockRoots(
BeaconBlockRootsResponse::from_ssz_bytes(&packet)?,
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_ROOTS encoding",
)),
},
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_ROOTS version.",
)),
},
"beacon_block_headers" => match protocol.version.as_str() {
"1.0.0" => match protocol.encoding.as_str() {
"ssz" => Ok(RPCResponse::BeaconBlockHeaders(
BeaconBlockHeadersResponse { headers: packet },
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_HEADERS encoding",
)),
},
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_HEADERS version.",
)),
},
"beacon_block_bodies" => match protocol.version.as_str() {
"1.0.0" => match protocol.encoding.as_str() {
"ssz" => Ok(RPCResponse::BeaconBlockBodies(BeaconBlockBodiesResponse {
block_bodies: packet,
})),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_BODIES encoding",
)),
},
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_BLOCK_BODIES version.",
)),
},
"beacon_chain_state" => match protocol.version.as_str() {
"1.0.0" => match protocol.encoding.as_str() {
"ssz" => Ok(RPCResponse::BeaconChainState(
BeaconChainStateResponse::from_ssz_bytes(&packet)?,
)),
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_CHAIN_STATE encoding",
)),
},
_ => Err(RPCError::InvalidProtocol(
"Unknown BEACON_CHAIN_STATE version.",
)),
},
},
}
}
fn encode(&self, response: RPCResponse) {
match response {
RPCResponse::Hello(res) => res.as_ssz_bytes(),
RPCResponse::Goodbye => unreachable!(),
RPCResponse::BeaconBlockRoots(res) => res.as_ssz_bytes(),
RPCResponse::BeaconBlockHeaders(res) => res.headers, // already raw bytes
RPCResponse::BeaconBlockBodies(res) => res.block_bodies, // already raw bytes
RPCResponse::BeaconChainState(res) => res.as_ssz_bytes(),
}
}
}
type SSZOutboundStream = stream::AndThen<sink::With<stream::FromErr<Framed<TSocket, UviBytes<Vec<u8>>>, RPCError>,
RPCResponse,
fn(RPCResponse) -> Result<Vec<u8>, RPCError>,
Result<Vec<u8>, RPCError>,
>,
fn(BytesMut) -> Result<RPCRequest, RPCError>,
Result<RPCRequest, RPCError>
>;
impl<TSocket> Stream for SSZInputStreamSink<TSocket> {
type Item = SSZInboundOutput;
type Error = RPCError;
fn poll(&mut self) -> Result<Async<Option<Self::Item>>, Self::Error> {
self.inner.poll()
}
}
impl<TSocket> Sink for SSZInputStreamSink<TSocket> {
type SinkItem = RPCResponse;
type SinkError = RPCError;
fn start_send(
&mut self,
item: Self::SinkItem
) -> Result<AsyncSink<Self::SinkItem>, Self::SinkError> {
self.inner.start_send(item)
}
fn poll_complete(&mut self) -> Result<Async<()>, Self::SinkError> {
self.inner.poll_complete()
}
}