introduce an unchecked path to the Streamable trait, and make the BLS…

… types support unchecked parsing

chia-bls/benches/parse.rs

@@ -1,7 +1,7 @@
 use chia_bls::secret_key::SecretKey;
 use chia_bls::signature::sign;
-use chia_bls::Signature;
 use chia_bls::PublicKey;
+use chia_bls::Signature;
 use criterion::{black_box, criterion_group, criterion_main, Criterion};
 use rand::rngs::StdRng;
 use rand::{Rng, SeedableRng};
@@ -16,8 +16,8 @@ fn parse_benchmark(c: &mut Criterion) {
     let msg = b"The quick brown fox jumps over the lazy dog";
     let sig = sign(&sk, msg);
 
-	let sig_bytes = sig.to_bytes();
-	let pk_bytes = pk.to_bytes();
+    let sig_bytes = sig.to_bytes();
+    let pk_bytes = pk.to_bytes();
 
     c.bench_function("parse Signature", |b| {
         b.iter(|| {
@@ -46,4 +46,3 @@ fn parse_benchmark(c: &mut Criterion) {
 
 criterion_group!(parse, parse_benchmark);
 criterion_main!(parse);
-

chia-bls/src/gtelement.rs

@@ -1,6 +1,6 @@
 use blst::*;
 use chia_traits::chia_error::Result;
-use chia_traits::{read_bytes, Streamable};
+use chia_traits::{read_bytes, Streamable, Validation};
 use sha2::{Digest, Sha256};
 use std::fmt;
 use std::hash::{Hash, Hasher};
@@ -57,12 +57,6 @@ impl GTElement {
     #[pyo3(name = "SIZE")]
     const PY_SIZE: usize = Self::SIZE;
 
-    #[staticmethod]
-    #[pyo3(name = "from_bytes_unchecked")]
-    fn py_from_bytes_unchecked(bytes: [u8; Self::SIZE]) -> Result<GTElement> {
-        Ok(Self::from_bytes(&bytes))
-    }
-
     pub fn __repr__(&self) -> String {
         let bytes = self.to_bytes();
         format!("<GTElement {}>", &hex::encode(bytes))
@@ -151,7 +145,7 @@ impl Streamable for GTElement {
         Ok(())
     }
 
-    fn parse(input: &mut Cursor<&[u8]>) -> Result<Self> {
+    fn parse(input: &mut Cursor<&[u8]>, _checked: Validation) -> Result<Self> {
         Ok(GTElement::from_bytes(
             read_bytes(input, Self::SIZE)?.try_into().unwrap(),
         ))

chia-bls/src/public_key.rs

@@ -1,7 +1,7 @@
 use crate::secret_key::is_all_zero;
 use crate::{DerivableKey, Error, Result};
 use blst::*;
-use chia_traits::{read_bytes, Streamable};
+use chia_traits::{read_bytes, Streamable, Validation};
 use clvm_traits::{FromClvm, ToClvm};
 use clvmr::allocator::{Allocator, NodePtr, SExp};
 use sha2::{digest::FixedOutput, Digest, Sha256};
@@ -167,12 +167,6 @@ impl PublicKey {
         Self::default()
     }
 
-    #[staticmethod]
-    #[pyo3(name = "from_bytes_unchecked")]
-    fn py_from_bytes_unchecked(bytes: [u8; Self::SIZE]) -> Result<Self> {
-        Self::from_bytes_unchecked(&bytes)
-    }
-
     #[staticmethod]
     #[pyo3(name = "generator")]
     pub fn py_generator() -> Self {
@@ -219,10 +213,13 @@ impl Streamable for PublicKey {
         Ok(())
     }
 
-    fn parse(input: &mut Cursor<&[u8]>) -> chia_traits::Result<Self> {
-        Ok(Self::from_bytes(
-            read_bytes(input, 48)?.try_into().unwrap(),
-        )?)
+    fn parse(input: &mut Cursor<&[u8]>, checked: Validation) -> chia_traits::Result<Self> {
+        let input = read_bytes(input, 48)?.try_into().unwrap();
+        if checked == Validation::On {
+            Ok(Self::from_bytes(input)?)
+        } else {
+            Ok(Self::from_bytes_unchecked(input)?)
+        }
     }
 }
 

chia-bls/src/secret_key.rs

@@ -1,6 +1,6 @@
 use crate::{DerivableKey, Error, PublicKey, Result};
 use blst::*;
-use chia_traits::{read_bytes, Streamable};
+use chia_traits::{read_bytes, Streamable, Validation};
 use hkdf::HkdfExtract;
 use sha2::{Digest, Sha256};
 use std::fmt;
@@ -168,7 +168,10 @@ impl Streamable for SecretKey {
         Ok(())
     }
 
-    fn parse(input: &mut Cursor<&[u8]>) -> chia_traits::chia_error::Result<Self> {
+    fn parse(
+        input: &mut Cursor<&[u8]>,
+        _checked: Validation,
+    ) -> chia_traits::chia_error::Result<Self> {
         Ok(Self::from_bytes(
             read_bytes(input, 32)?.try_into().unwrap(),
         )?)

chia-bls/src/signature.rs

@@ -1,6 +1,6 @@
 use crate::{Error, GTElement, PublicKey, Result, SecretKey};
 use blst::*;
-use chia_traits::{read_bytes, Streamable};
+use chia_traits::{read_bytes, Streamable, Validation};
 use clvm_traits::{FromClvm, ToClvm};
 use clvmr::allocator::{Allocator, NodePtr, SExp};
 use sha2::{Digest, Sha256};
@@ -145,10 +145,16 @@ impl Streamable for Signature {
         Ok(())
     }
 
-    fn parse(input: &mut Cursor<&[u8]>) -> chia_traits::chia_error::Result<Self> {
-        Ok(Self::from_bytes(
-            read_bytes(input, 96)?.try_into().unwrap(),
-        )?)
+    fn parse(
+        input: &mut Cursor<&[u8]>,
+        checked: Validation,
+    ) -> chia_traits::chia_error::Result<Self> {
+        let input = read_bytes(input, 96)?.try_into().unwrap();
+        if checked == Validation::On {
+            Ok(Self::from_bytes(input)?)
+        } else {
+            Ok(Self::from_bytes_unchecked(input)?)
+        }
     }
 }
 
@@ -281,12 +287,6 @@ impl Signature {
         Self::default()
     }
 
-    #[staticmethod]
-    #[pyo3(name = "from_bytes_unchecked")]
-    pub fn py_from_bytes_unchecked(bytes: [u8; Self::SIZE]) -> Result<Signature> {
-        Self::from_bytes_unchecked(&bytes)
-    }
-
     #[pyo3(name = "pair")]
     pub fn py_pair(&self, other: &PublicKey) -> GTElement {
         self.pair(other)

chia-protocol/fuzz/fuzz_targets/streamable.rs

@@ -21,6 +21,9 @@ pub fn test_streamable<T: Streamable + std::fmt::Debug + PartialEq>(obj: &T) {
     };
     assert_eq!(obj, &obj2);
 
+    let obj3 = T::from_bytes_unchecked(&bytes).unwrap();
+    assert_eq!(obj, &obj3);
+
     let mut ctx = Sha256::new();
     ctx.update(&bytes);
     let expect_hash: [u8; 32] = ctx.finalize().into();

chia-protocol/src/bytes.rs

@@ -1,5 +1,5 @@
 use chia_traits::chia_error;
-use chia_traits::{read_bytes, Streamable};
+use chia_traits::{read_bytes, Streamable, Validation};
 use clvm_traits::{FromClvm, ToClvm};
 use clvmr::allocator::{NodePtr, SExp};
 use clvmr::Allocator;
@@ -56,8 +56,8 @@ impl Streamable for Bytes {
         }
     }
 
-    fn parse(input: &mut Cursor<&[u8]>) -> chia_error::Result<Self> {
-        let len = u32::parse(input)?;
+    fn parse(input: &mut Cursor<&[u8]>, checked: Validation) -> chia_error::Result<Self> {
+        let len = u32::parse(input, checked)?;
         Ok(Bytes(read_bytes(input, len as usize)?.to_vec()))
     }
 }
@@ -196,7 +196,7 @@ impl<const N: usize> Streamable for BytesImpl<N> {
         Ok(())
     }
 
-    fn parse(input: &mut Cursor<&[u8]>) -> chia_error::Result<Self> {
+    fn parse(input: &mut Cursor<&[u8]>, _checked: Validation) -> chia_error::Result<Self> {
         Ok(BytesImpl(read_bytes(input, N)?.try_into().unwrap()))
     }
 }
@@ -568,15 +568,15 @@ mod tests {
 
     fn from_bytes<T: Streamable + std::fmt::Debug + std::cmp::PartialEq>(buf: &[u8], expected: T) {
         let mut input = Cursor::<&[u8]>::new(buf);
-        assert_eq!(T::parse(&mut input).unwrap(), expected);
+        assert_eq!(T::parse(&mut input, Validation::On).unwrap(), expected);
     }
 
     fn from_bytes_fail<T: Streamable + std::fmt::Debug + std::cmp::PartialEq>(
         buf: &[u8],
         expected: chia_error::Error,
     ) {
         let mut input = Cursor::<&[u8]>::new(buf);
-        assert_eq!(T::parse(&mut input).unwrap_err(), expected);
+        assert_eq!(T::parse(&mut input, Validation::On).unwrap_err(), expected);
     }
 
     fn stream<T: Streamable>(v: &T) -> Vec<u8> {

chia-protocol/src/program.rs

@@ -1,6 +1,6 @@
 use crate::bytes::Bytes;
 use chia_traits::chia_error::{Error, Result};
-use chia_traits::Streamable;
+use chia_traits::{Streamable, Validation};
 use clvm_traits::{FromClvm, ToClvm};
 use clvmr::allocator::NodePtr;
 use clvmr::serde::{node_from_bytes, node_to_bytes, serialized_length_from_bytes};
@@ -69,7 +69,7 @@ impl Streamable for Program {
         Ok(())
     }
 
-    fn parse(input: &mut Cursor<&[u8]>) -> Result<Self> {
+    fn parse(input: &mut Cursor<&[u8]>, _checked: Validation) -> Result<Self> {
         let pos = input.position();
         let buf: &[u8] = &input.get_ref()[pos as usize..];
         let len = serialized_length_from_bytes(buf).map_err(|_e| Error::EndOfBuffer)?;

chia-tools/src/bin/analyze-chain.rs

@@ -86,8 +86,8 @@ fn main() {
         let block_buffer =
             zstd::stream::decode_all(&mut std::io::Cursor::<Vec<u8>>::new(block_buffer))
                 .expect("failed to decompress block");
-        let block = FullBlock::parse(&mut std::io::Cursor::<&[u8]>::new(&block_buffer))
-            .expect("failed to parse FullBlock");
+        let block =
+            FullBlock::from_bytes_unchecked(&block_buffer).expect("failed to parse FullBlock");
 
         let ti = match block.transactions_info {
             Some(ti) => ti,
@@ -141,8 +141,8 @@ fn main() {
                     zstd::stream::decode_all(&mut std::io::Cursor::<Vec<u8>>::new(ref_block))
                         .expect("failed to decompress block");
 
-                let ref_block = FullBlock::parse(&mut std::io::Cursor::<&[u8]>::new(&ref_block))
-                    .expect("failed to parse ref-block");
+                let ref_block =
+                    FullBlock::from_bytes_unchecked(&ref_block).expect("failed to parse ref-block");
                 let ref_gen = match ref_block.transactions_generator {
                     None => {
                         panic!("block ref has no generator");

chia-tools/src/bin/fast-forward-spend.rs

@@ -1,6 +1,5 @@
 use clap::Parser;
 use std::fs;
-use std::io::Cursor;
 
 use chia::fast_forward::fast_forward_singleton;
 use chia_protocol::bytes::Bytes32;
@@ -31,7 +30,7 @@ fn main() {
     let args = Args::parse();
 
     let spend_bytes = fs::read(args.spend).expect("read file");
-    let spend = CoinSpend::parse(&mut Cursor::new(&spend_bytes)).expect("parse CoinSpend");
+    let spend = CoinSpend::from_bytes(&spend_bytes).expect("parse CoinSpend");
 
     let new_parents_parent: Bytes32 = hex::decode(args.new_parents_parent)
         .expect("invalid hex")

chia-tools/src/bin/run-spend.rs

@@ -7,7 +7,6 @@ use clvm_utils::tree_hash;
 use clvm_utils::CurriedProgram;
 use clvmr::{allocator::NodePtr, Allocator};
 use hex_literal::hex;
-use std::io::Cursor;
 
 /// Run a puzzle given a solution and print the resulting conditions
 #[derive(Parser, Debug)]
@@ -235,7 +234,7 @@ fn main() {
 
     let mut a = Allocator::new();
     let spend = read(args.spend).expect("spend file not found");
-    let spend = CoinSpend::parse(&mut Cursor::new(spend.as_slice())).expect("parse CoinSpend");
+    let spend = CoinSpend::from_bytes(&spend).expect("parse CoinSpend");
 
     let puzzle = spend
         .puzzle_reveal

chia-tools/src/bin/test-block-generators.rs

@@ -179,8 +179,8 @@ fn main() {
         let block_buffer =
             zstd::stream::decode_all(&mut std::io::Cursor::<Vec<u8>>::new(block_buffer))
                 .expect("failed to decompress block");
-        let block = FullBlock::parse(&mut std::io::Cursor::<&[u8]>::new(&block_buffer))
-            .expect("failed to parse FullBlock");
+        let block =
+            FullBlock::from_bytes_unchecked(&block_buffer).expect("failed to parse FullBlock");
 
         let ti = match block.transactions_info {
             Some(ti) => ti,
@@ -218,8 +218,8 @@ fn main() {
                 zstd::stream::decode_all(&mut std::io::Cursor::<Vec<u8>>::new(ref_block))
                     .expect("failed to decompress block");
 
-            let ref_block = FullBlock::parse(&mut std::io::Cursor::<&[u8]>::new(&ref_block))
-                .expect("failed to parse ref-block");
+            let ref_block =
+                FullBlock::from_bytes_unchecked(&ref_block).expect("failed to parse ref-block");
             let ref_gen = ref_block
                 .transactions_generator
                 .expect("block ref has no generator");

chia-tools/src/visit_spends.rs

@@ -53,8 +53,8 @@ pub fn iterate_tx_blocks(
         let block_buffer =
             zstd::stream::decode_all(&mut std::io::Cursor::<Vec<u8>>::new(block_buffer))
                 .expect("failed to decompress block");
-        let block = FullBlock::parse(&mut std::io::Cursor::<&[u8]>::new(&block_buffer))
-            .expect("failed to parse FullBlock");
+        let block =
+            FullBlock::from_bytes_unchecked(&block_buffer).expect("failed to parse FullBlock");
 
         if block.transactions_info.is_none() {
             continue;
@@ -83,8 +83,8 @@ pub fn iterate_tx_blocks(
                 zstd::stream::decode_all(&mut std::io::Cursor::<Vec<u8>>::new(ref_block))
                     .expect("failed to decompress block");
 
-            let ref_block = FullBlock::parse(&mut std::io::Cursor::<&[u8]>::new(&ref_block))
-                .expect("failed to parse ref-block");
+            let ref_block =
+                FullBlock::from_bytes_unchecked(&ref_block).expect("failed to parse ref-block");
             let ref_gen = ref_block
                 .transactions_generator
                 .expect("block ref has no generator");