neo-devpack 0.5.8

Neo N3 Rust Development Pack for Smart Contract Development
Documentation
// Copyright (c) 2025-2026 R3E Network
// Licensed under the MIT License

//! Serialization and deserialization utilities for Neo N3 smart contracts.
//!
//! This module provides compact binary serialization using postcard for storage
//! and cross-contract communication.

use neo_types::{NeoError, NeoResult};
use serde::de::DeserializeOwned;
use serde::Serialize;

const MAX_CODEC_BYTES: usize = 1024 * 1024;

/// Serializes a value to bytes using postcard.
///
/// # Type Parameters
/// * `T` - The type to serialize, must implement `Serialize`
///
/// # Arguments
/// * `value` - A reference to the value to serialize
///
/// # Returns
/// * `Ok(Vec<u8>)` - The serialized bytes on success
/// * `Err(NeoError)` - If serialization fails
///
/// # Examples
///
/// ```
/// use neo_devpack::codec::serialize;
///
/// let value = 42i32;
/// let bytes = serialize(&value).unwrap();
/// ```
pub fn serialize<T: Serialize>(value: &T) -> NeoResult<Vec<u8>> {
    let bytes = postcard::to_allocvec(value)
        .map_err(|err| NeoError::new(&format!("Failed to serialize value: {err}")))?;
    if bytes.len() > MAX_CODEC_BYTES {
        return Err(NeoError::new(
            "Failed to serialize value: encoded payload exceeds 1048576 bytes",
        ));
    }
    Ok(bytes)
}

/// Deserializes bytes to a value using postcard.
///
/// # Type Parameters
/// * `T` - The type to deserialize, must implement `DeserializeOwned`
///
/// # Arguments
/// * `bytes` - The bytes to deserialize from
///
/// # Returns
/// * `Ok(T)` - The deserialized value on success
/// * `Err(NeoError)` - If deserialization fails (e.g., invalid format)
///
/// # Examples
///
/// ```
/// use neo_devpack::codec::{serialize, deserialize};
///
/// let value = 42i32;
/// let bytes = serialize(&value).unwrap();
/// let restored: i32 = deserialize(&bytes).unwrap();
/// assert_eq!(value, restored);
/// ```
pub fn deserialize<T: DeserializeOwned>(bytes: &[u8]) -> NeoResult<T> {
    if bytes.len() > MAX_CODEC_BYTES {
        return Err(NeoError::new(
            "Failed to deserialize bytes: encoded payload exceeds 1048576 bytes",
        ));
    }
    postcard::from_bytes(bytes)
        .map_err(|err| NeoError::new(&format!("Failed to deserialize bytes: {err}")))
}