+//! A very simple serialization framework which is used to serialize/deserialize messages as well
+//! as ChannelsManagers and ChannelMonitors.
+
use std::result::Result;
-use std::io::Read;
+use std::io::{Read, Write};
use std::collections::HashMap;
use std::hash::Hash;
-use secp256k1::{Secp256k1, Signature};
-use secp256k1::key::PublicKey;
-use bitcoin::util::hash::Sha256dHash;
+use secp256k1::Signature;
+use secp256k1::key::{PublicKey, SecretKey};
use bitcoin::blockdata::script::Script;
+use bitcoin::blockdata::transaction::OutPoint;
+use bitcoin_hashes::sha256d::Hash as Sha256dHash;
use std::marker::Sized;
use ln::msgs::DecodeError;
+use ln::channelmanager::{PaymentPreimage, PaymentHash};
+use util::byte_utils;
-use util::byte_utils::{be64_to_array, be32_to_array, be16_to_array, slice_to_be16, slice_to_be32, slice_to_be64};
+use util::byte_utils::{be64_to_array, be48_to_array, be32_to_array, be16_to_array, slice_to_be16, slice_to_be32, slice_to_be48, slice_to_be64};
const MAX_BUF_SIZE: usize = 64 * 1024;
fn size_hint(&mut self, size: usize);
}
-impl<W: ::std::io::Write> Writer for W {
+impl<W: Write> Writer for W {
#[inline]
fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
<Self as ::std::io::Write>::write_all(self, buf)
fn size_hint(&mut self, _size: usize) { }
}
+pub(crate) struct WriterWriteAdaptor<'a, W: Writer + 'a>(pub &'a mut W);
+impl<'a, W: Writer + 'a> Write for WriterWriteAdaptor<'a, W> {
+ fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
+ self.0.write_all(buf)
+ }
+ fn write(&mut self, buf: &[u8]) -> Result<usize, ::std::io::Error> {
+ self.0.write_all(buf)?;
+ Ok(buf.len())
+ }
+ fn flush(&mut self) -> Result<(), ::std::io::Error> {
+ Ok(())
+ }
+}
+
+struct VecWriter(Vec<u8>);
+impl Writer for VecWriter {
+ fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
+ self.0.extend_from_slice(buf);
+ Ok(())
+ }
+ fn size_hint(&mut self, size: usize) {
+ self.0.reserve_exact(size);
+ }
+}
+
/// A trait that various rust-lightning types implement allowing them to be written out to a Writer
-pub trait Writeable<W: Writer> {
+pub trait Writeable {
/// Writes self out to the given Writer
- fn write(&self, writer: &mut W) -> Result<(), DecodeError>;
+ fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error>;
+
+ /// Writes self out to a Vec<u8>
+ fn encode(&self) -> Vec<u8> {
+ let mut msg = VecWriter(Vec::new());
+ self.write(&mut msg).unwrap();
+ msg.0
+ }
+
+ /// Writes self out to a Vec<u8>
+ fn encode_with_len(&self) -> Vec<u8> {
+ let mut msg = VecWriter(Vec::new());
+ 0u16.write(&mut msg).unwrap();
+ self.write(&mut msg).unwrap();
+ let len = msg.0.len();
+ msg.0[..2].copy_from_slice(&byte_utils::be16_to_array(len as u16 - 2));
+ msg.0
+ }
}
/// A trait that various rust-lightning types implement allowing them to be read in from a Read
fn read(reader: &mut R) -> Result<Self, DecodeError>;
}
+/// A trait that various higher-level rust-lightning types implement allowing them to be read in
+/// from a Read given some additional set of arguments which is required to deserialize.
+pub trait ReadableArgs<R, P>
+ where Self: Sized,
+ R: Read
+{
+ /// Reads a Self in from the given Read
+ fn read(reader: &mut R, params: P) -> Result<Self, DecodeError>;
+}
+
+pub(crate) struct U48(pub u64);
+impl Writeable for U48 {
+ #[inline]
+ fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
+ writer.write_all(&be48_to_array(self.0))
+ }
+}
+impl<R: Read> Readable<R> for U48 {
+ #[inline]
+ fn read(reader: &mut R) -> Result<U48, DecodeError> {
+ let mut buf = [0; 6];
+ reader.read_exact(&mut buf)?;
+ Ok(U48(slice_to_be48(&buf)))
+ }
+}
+
macro_rules! impl_writeable_primitive {
($val_type:ty, $meth_write:ident, $len: expr, $meth_read:ident) => {
- impl<W: Writer> Writeable<W> for $val_type {
+ impl Writeable for $val_type {
#[inline]
- fn write(&self, writer: &mut W) -> Result<(), DecodeError> {
- Ok(writer.write_all(&$meth_write(*self))?)
+ fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
+ writer.write_all(&$meth_write(*self))
}
}
impl<R: Read> Readable<R> for $val_type {
impl_writeable_primitive!(u32, be32_to_array, 4, slice_to_be32);
impl_writeable_primitive!(u16, be16_to_array, 2, slice_to_be16);
-impl<W: Writer> Writeable<W> for u8 {
+impl Writeable for u8 {
#[inline]
- fn write(&self, writer: &mut W) -> Result<(), DecodeError> {
- Ok(writer.write_all(&[*self])?)
+ fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
+ writer.write_all(&[*self])
}
}
impl<R: Read> Readable<R> for u8 {
}
}
-impl<W: Writer> Writeable<W> for bool {
+impl Writeable for bool {
#[inline]
- fn write(&self, writer: &mut W) -> Result<(), DecodeError> {
- Ok(writer.write_all(&[if *self {1} else {0}])?)
+ fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
+ writer.write_all(&[if *self {1} else {0}])
}
}
impl<R: Read> Readable<R> for bool {
// u8 arrays
macro_rules! impl_array {
( $size:expr ) => (
- impl<W: Writer> Writeable<W> for [u8; $size]
+ impl Writeable for [u8; $size]
{
#[inline]
- fn write(&self, w: &mut W) -> Result<(), DecodeError> {
- w.write_all(self)?;
- Ok(())
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ w.write_all(self)
}
}
}
//TODO: performance issue with [u8; size] with impl_array!()
+impl_array!(3); // for rgb
+impl_array!(4); // for IPv4
+impl_array!(10); // for OnionV2
+impl_array!(16); // for IPv6
impl_array!(32); // for channel id & hmac
impl_array!(33); // for PublicKey
impl_array!(64); // for Signature
impl_array!(1300); // for OnionPacket.hop_data
// HashMap
-impl<W, K, V> Writeable<W> for HashMap<K, V>
- where W: Writer,
- K: Writeable<W> + Eq + Hash,
- V: Writeable<W>
+impl<K, V> Writeable for HashMap<K, V>
+ where K: Writeable + Eq + Hash,
+ V: Writeable
{
#[inline]
- fn write(&self, w: &mut W) -> Result<(), DecodeError> {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
(self.len() as u16).write(w)?;
for (key, value) in self.iter() {
key.write(w)?;
}
// Vectors
-impl<W: Writer> Writeable<W> for Vec<u8> {
+impl Writeable for Vec<u8> {
#[inline]
- fn write(&self, w: &mut W) -> Result<(), DecodeError> {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
(self.len() as u16).write(w)?;
- Ok(w.write_all(&self)?)
+ w.write_all(&self)
}
}
Ok(ret)
}
}
-impl<W: Writer> Writeable<W> for Vec<Signature> {
+impl Writeable for Vec<Signature> {
#[inline]
- fn write(&self, w: &mut W) -> Result<(), DecodeError> {
- let byte_size = (self.len() as usize)
- .checked_mul(33)
- .ok_or(DecodeError::BadLengthDescriptor)?;
- if byte_size > MAX_BUF_SIZE {
- return Err(DecodeError::BadLengthDescriptor);
- }
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
(self.len() as u16).write(w)?;
for e in self.iter() {
e.write(w)?;
}
}
-impl<W: Writer> Writeable<W> for Script {
- fn write(&self, w: &mut W) -> Result<(), DecodeError> {
+impl Writeable for Script {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
(self.len() as u16).write(w)?;
- Ok(w.write_all(self.as_bytes())?)
+ w.write_all(self.as_bytes())
}
}
}
}
-impl<W: Writer> Writeable<W> for Option<Script> {
- fn write(&self, w: &mut W) -> Result<(), DecodeError> {
- if let &Some(ref script) = self {
- script.write(w)?;
- }
- Ok(())
+impl Writeable for PublicKey {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ self.serialize().write(w)
}
}
-impl<R: Read> Readable<R> for Option<Script> {
+impl<R: Read> Readable<R> for PublicKey {
fn read(r: &mut R) -> Result<Self, DecodeError> {
- match <u16 as Readable<R>>::read(r) {
- Ok(len) => {
- let mut buf = vec![0; len as usize];
- r.read_exact(&mut buf)?;
- Ok(Some(Script::from(buf)))
- },
- Err(DecodeError::ShortRead) => Ok(None),
- Err(e) => Err(e)
+ let buf: [u8; 33] = Readable::read(r)?;
+ match PublicKey::from_slice(&buf) {
+ Ok(key) => Ok(key),
+ Err(_) => return Err(DecodeError::InvalidValue),
}
}
}
-impl<W: Writer> Writeable<W> for PublicKey {
- fn write(&self, w: &mut W) -> Result<(), DecodeError> {
- self.serialize().write(w)
+impl Writeable for SecretKey {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ let mut ser = [0; 32];
+ ser.copy_from_slice(&self[..]);
+ ser.write(w)
}
}
-impl<R: Read> Readable<R> for PublicKey {
+impl<R: Read> Readable<R> for SecretKey {
fn read(r: &mut R) -> Result<Self, DecodeError> {
- let buf: [u8; 33] = Readable::read(r)?;
- match PublicKey::from_slice(&Secp256k1::without_caps(), &buf) {
+ let buf: [u8; 32] = Readable::read(r)?;
+ match SecretKey::from_slice(&buf) {
Ok(key) => Ok(key),
- Err(_) => return Err(DecodeError::BadPublicKey),
+ Err(_) => return Err(DecodeError::InvalidValue),
}
}
}
-impl<W: Writer> Writeable<W> for Sha256dHash {
- fn write(&self, w: &mut W) -> Result<(), DecodeError> {
- self.as_bytes().write(w)
+impl Writeable for Sha256dHash {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ w.write_all(&self[..])
}
}
impl<R: Read> Readable<R> for Sha256dHash {
fn read(r: &mut R) -> Result<Self, DecodeError> {
+ use bitcoin_hashes::Hash;
+
let buf: [u8; 32] = Readable::read(r)?;
- Ok(From::from(&buf[..]))
+ Ok(Sha256dHash::from_slice(&buf[..]).unwrap())
}
}
-impl<W: Writer> Writeable<W> for Signature {
- fn write(&self, w: &mut W) -> Result<(), DecodeError> {
- self.serialize_compact(&Secp256k1::without_caps()).write(w)
+impl Writeable for Signature {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ self.serialize_compact().write(w)
}
}
impl<R: Read> Readable<R> for Signature {
fn read(r: &mut R) -> Result<Self, DecodeError> {
let buf: [u8; 64] = Readable::read(r)?;
- match Signature::from_compact(&Secp256k1::without_caps(), &buf) {
+ match Signature::from_compact(&buf) {
Ok(sig) => Ok(sig),
- Err(_) => return Err(DecodeError::BadSignature),
+ Err(_) => return Err(DecodeError::InvalidValue),
}
}
}
+
+impl Writeable for PaymentPreimage {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ self.0.write(w)
+ }
+}
+
+impl<R: Read> Readable<R> for PaymentPreimage {
+ fn read(r: &mut R) -> Result<Self, DecodeError> {
+ let buf: [u8; 32] = Readable::read(r)?;
+ Ok(PaymentPreimage(buf))
+ }
+}
+
+impl Writeable for PaymentHash {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ self.0.write(w)
+ }
+}
+
+impl<R: Read> Readable<R> for PaymentHash {
+ fn read(r: &mut R) -> Result<Self, DecodeError> {
+ let buf: [u8; 32] = Readable::read(r)?;
+ Ok(PaymentHash(buf))
+ }
+}
+
+impl<T: Writeable> Writeable for Option<T> {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ match *self {
+ None => 0u8.write(w)?,
+ Some(ref data) => {
+ 1u8.write(w)?;
+ data.write(w)?;
+ }
+ }
+ Ok(())
+ }
+}
+
+impl<R, T> Readable<R> for Option<T>
+ where R: Read,
+ T: Readable<R>
+{
+ fn read(r: &mut R) -> Result<Self, DecodeError> {
+ match <u8 as Readable<R>>::read(r)? {
+ 0 => Ok(None),
+ 1 => Ok(Some(Readable::read(r)?)),
+ _ => return Err(DecodeError::InvalidValue),
+ }
+ }
+}
+
+impl Writeable for OutPoint {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ self.txid.write(w)?;
+ self.vout.write(w)?;
+ Ok(())
+ }
+}
+
+impl<R: Read> Readable<R> for OutPoint {
+ fn read(r: &mut R) -> Result<Self, DecodeError> {
+ let txid = Readable::read(r)?;
+ let vout = Readable::read(r)?;
+ Ok(OutPoint {
+ txid,
+ vout,
+ })
+ }
+}
projects / rust-lightning / blobdiff