Prepare for rkyv::access (#1753)

We want to move from `rkyv::access_unchecked` to checked `rkyv::access`. We are trying to make that work in #1737, but it turns out to be non-trivial. Here's some prep work: introduce byte-check and derive Debug for a few of our sdk types.
0xmozak · May 30, 2024 · b3fe424 · b3fe424
1 parent f586e49
commit b3fe424
Show file tree

Hide file tree

Showing 8 changed files with 108 additions and 1 deletion.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/examples/Cargo.lock b/examples/Cargo.lock
diff --git a/sdk/Cargo.lock b/sdk/Cargo.lock
diff --git a/sdk/Cargo.toml b/sdk/Cargo.toml
@@ -14,7 +14,7 @@ version = "0.2.0"
 array-concat = { git = "https://github.com/Daniel-Aaron-Bloom/array-concat.git" }
 array-util = "1.0.2"
 once_cell = { version = "1.19", default-features = false, features = ["race"] }
-rkyv = { version = "=0.8.0-alpha.1", default-features = false, features = ["pointer_width_32", "alloc"] }
+rkyv = { version = "=0.8.0-alpha.1", default-features = false, features = ["pointer_width_32", "alloc", "bytecheck"] }
 rkyv_derive = "=0.8.0-alpha.1"
 vec-entries = "1.0"
 

diff --git a/sdk/src/common/types/cross_program_call.rs b/sdk/src/common/types/cross_program_call.rs
@@ -1,10 +1,12 @@
 #[derive(
     Default, Clone, Hash, PartialEq, PartialOrd, rkyv::Archive, rkyv::Serialize, rkyv::Deserialize,
 )]
+#[archive(check_bytes)]
 #[cfg_attr(
     not(target_os = "mozakvm"),
     derive(Debug, serde::Serialize, serde::Deserialize)
 )]
+#[archive_attr(derive(Debug))]
 #[allow(clippy::pub_underscore_fields)]
 pub struct CrossProgramCall {
     pub caller: super::ProgramIdentifier,

diff --git a/sdk/src/common/types/poseidon2hash.rs b/sdk/src/common/types/poseidon2hash.rs
@@ -16,10 +16,12 @@ use crate::core::constants::DIGEST_BYTES;
     rkyv::Deserialize,
     rkyv::Serialize,
 )]
+#[archive(check_bytes)]
 #[cfg_attr(
     not(target_os = "mozakvm"),
     derive(serde::Serialize, serde::Deserialize)
 )]
+#[archive_attr(derive(Debug))]
 pub struct Poseidon2Hash(
     #[cfg_attr(not(target_os = "mozakvm"), serde(with = "SerHex::<StrictPfx>"))]
     pub  [u8; DIGEST_BYTES],

diff --git a/sdk/src/common/types/program_identifier.rs b/sdk/src/common/types/program_identifier.rs
@@ -13,10 +13,12 @@ use crate::core::constants::DIGEST_BYTES;
     rkyv::Deserialize,
     rkyv::Serialize,
 )]
+#[archive(check_bytes)]
 #[cfg_attr(
     not(target_os = "mozakvm"),
     derive(serde::Serialize, serde::Deserialize)
 )]
+#[archive_attr(derive(Debug))]
 pub struct ProgramIdentifier(pub super::Poseidon2Hash);
 
 impl ProgramIdentifier {

diff --git a/sdk/src/common/types/raw_message.rs b/sdk/src/common/types/raw_message.rs
@@ -5,10 +5,12 @@ use serde_hex::{SerHexSeq, StrictPfx};
 #[derive(
     Default, Clone, Hash, PartialEq, PartialOrd, rkyv::Archive, rkyv::Serialize, rkyv::Deserialize,
 )]
+#[archive(check_bytes)]
 #[cfg_attr(
     not(target_os = "mozakvm"),
     derive(serde::Serialize, serde::Deserialize)
 )]
+#[archive_attr(derive(Debug))]
 pub struct RawMessage(
     #[cfg_attr(not(target_os = "mozakvm"), serde(with = "SerHexSeq::<StrictPfx>"))] pub Vec<u8>,
 );