sdk: Add try_from_slice_unchecked for Borsh (#16098)
* sdk: Add try_from_slice_unchecked for Borsh * Add tests * Rename + clarify comment * Rename back to unchecked
This commit is contained in:
@ -1,7 +1,13 @@
|
|||||||
#![allow(clippy::integer_arithmetic)]
|
#![allow(clippy::integer_arithmetic)]
|
||||||
//! Borsh utils
|
//! Borsh utils
|
||||||
use borsh::schema::{BorshSchema, Declaration, Definition, Fields};
|
use {
|
||||||
use std::collections::HashMap;
|
borsh::{
|
||||||
|
maybestd::io::Error,
|
||||||
|
schema::{BorshSchema, Declaration, Definition, Fields},
|
||||||
|
BorshDeserialize,
|
||||||
|
},
|
||||||
|
std::collections::HashMap,
|
||||||
|
};
|
||||||
|
|
||||||
/// Get packed length for the given BorchSchema Declaration
|
/// Get packed length for the given BorchSchema Declaration
|
||||||
fn get_declaration_packed_len(
|
fn get_declaration_packed_len(
|
||||||
@ -54,3 +60,101 @@ pub fn get_packed_len<S: BorshSchema>() -> usize {
|
|||||||
let schema_container = S::schema_container();
|
let schema_container = S::schema_container();
|
||||||
get_declaration_packed_len(&schema_container.declaration, &schema_container.definitions)
|
get_declaration_packed_len(&schema_container.declaration, &schema_container.definitions)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Deserializes without checking that the entire slice has been consumed
|
||||||
|
///
|
||||||
|
/// Normally, `try_from_slice` checks the length of the final slice to ensure
|
||||||
|
/// that the deserialization uses up all of the bytes in the slice.
|
||||||
|
///
|
||||||
|
/// Note that there is a potential issue with this function. Any buffer greater than
|
||||||
|
/// or equal to the expected size will properly deserialize. For example, if the
|
||||||
|
/// user passes a buffer destined for a different type, the error won't get caught
|
||||||
|
/// as easily.
|
||||||
|
pub fn try_from_slice_unchecked<T: BorshDeserialize>(data: &[u8]) -> Result<T, Error> {
|
||||||
|
let mut data_mut = data;
|
||||||
|
let result = T::deserialize(&mut data_mut)?;
|
||||||
|
Ok(result)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use {
|
||||||
|
super::*,
|
||||||
|
borsh::{maybestd::io::ErrorKind, BorshSchema, BorshSerialize},
|
||||||
|
std::mem::size_of,
|
||||||
|
};
|
||||||
|
|
||||||
|
#[derive(BorshSerialize, BorshDeserialize, BorshSchema)]
|
||||||
|
enum TestEnum {
|
||||||
|
NoValue,
|
||||||
|
Value(u32),
|
||||||
|
StructValue {
|
||||||
|
#[allow(dead_code)]
|
||||||
|
number: u64,
|
||||||
|
#[allow(dead_code)]
|
||||||
|
array: [u8; 8],
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(BorshSerialize, BorshDeserialize, BorshSchema)]
|
||||||
|
struct TestStruct {
|
||||||
|
pub array: [u64; 16],
|
||||||
|
pub number: u128,
|
||||||
|
pub tuple: (u8, u16),
|
||||||
|
pub enumeration: TestEnum,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, PartialEq, BorshSerialize, BorshDeserialize, BorshSchema)]
|
||||||
|
struct Child {
|
||||||
|
pub data: [u8; 64],
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, PartialEq, BorshSerialize, BorshDeserialize, BorshSchema)]
|
||||||
|
struct Parent {
|
||||||
|
pub data: Vec<Child>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn unchecked_deserialization() {
|
||||||
|
let data = vec![
|
||||||
|
Child { data: [0u8; 64] },
|
||||||
|
Child { data: [1u8; 64] },
|
||||||
|
Child { data: [2u8; 64] },
|
||||||
|
];
|
||||||
|
let parent = Parent { data };
|
||||||
|
|
||||||
|
// exact size, both work
|
||||||
|
let mut byte_vec = vec![0u8; 4 + get_packed_len::<Child>() * 3];
|
||||||
|
let mut bytes = byte_vec.as_mut_slice();
|
||||||
|
parent.serialize(&mut bytes).unwrap();
|
||||||
|
let deserialized = Parent::try_from_slice(&byte_vec).unwrap();
|
||||||
|
assert_eq!(deserialized, parent);
|
||||||
|
let deserialized = try_from_slice_unchecked::<Parent>(&byte_vec).unwrap();
|
||||||
|
assert_eq!(deserialized, parent);
|
||||||
|
|
||||||
|
// too big, only unchecked works
|
||||||
|
let mut byte_vec = vec![0u8; 4 + get_packed_len::<Child>() * 10];
|
||||||
|
let mut bytes = byte_vec.as_mut_slice();
|
||||||
|
parent.serialize(&mut bytes).unwrap();
|
||||||
|
let err = Parent::try_from_slice(&byte_vec).unwrap_err();
|
||||||
|
assert_eq!(err.kind(), ErrorKind::InvalidData);
|
||||||
|
let deserialized = try_from_slice_unchecked::<Parent>(&byte_vec).unwrap();
|
||||||
|
assert_eq!(deserialized, parent);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn packed_len() {
|
||||||
|
assert_eq!(
|
||||||
|
get_packed_len::<TestEnum>(),
|
||||||
|
size_of::<u8>() + size_of::<u64>() + size_of::<u8>() * 8
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
get_packed_len::<TestStruct>(),
|
||||||
|
size_of::<u64>() * 16
|
||||||
|
+ size_of::<u128>()
|
||||||
|
+ size_of::<u8>()
|
||||||
|
+ size_of::<u16>()
|
||||||
|
+ get_packed_len::<TestEnum>()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Reference in New Issue
Block a user