dusk-core 1.6.0

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
//
// Copyright (c) DUSK NETWORK. All rights reserved.

//! Extra data that may be sent with the `data` field of either transaction
//! type.

#[cfg(feature = "kzg")]
mod kzg_blob;

use alloc::string::String;
use alloc::vec::Vec;
use alloc::{format, vec};

use bytecheck::CheckBytes;
use dusk_bytes::{DeserializableSlice, Error as BytesError, Serializable};
use piecrust_uplink::StandardBufSerializer;
use rkyv::ser::Serializer;
use rkyv::ser::serializers::{
    BufferScratch, BufferSerializer, CompositeSerializer,
};
use rkyv::validation::validators::DefaultValidator;
use rkyv::{Archive, Deserialize, Infallible, Serialize};
#[cfg(feature = "serde")]
use serde_with::As;
#[cfg(feature = "serde")]
use serde_with::hex::Hex;
use sha2::{Digest, Sha256};

use crate::Error;
use crate::abi::ContractId;

/// The maximum size of a memo.
pub const MAX_MEMO_SIZE: usize = 512;

/// Data for either contract call or contract deployment.
#[derive(Debug, Clone, PartialEq, Eq, Archive, Serialize, Deserialize)]
#[archive_attr(derive(CheckBytes))]
#[allow(clippy::large_enum_variant)]
pub enum TransactionData {
    /// Data for a contract call.
    Call(ContractCall),
    /// Data for a contract deployment.
    Deploy(ContractDeploy),
    /// Additional data added to a transaction, that is not a deployment or a
    /// call.
    Memo(Vec<u8>),
    /// Data for blob storage together with contract call.    
    Blob(Vec<BlobData>),
}

impl TransactionData {
    const NONE_ID: u8 = 0x00;
    const CALL_ID: u8 = 0x01;
    const DEPLOY_ID: u8 = 0x02;
    const MEMO_ID: u8 = 0x03;
    const BLOB_ID: u8 = 0x04;

    /// Return input bytes to hash the `TransactionData`.
    ///
    /// Note: The result of this function is *only* meant to be used as an input
    /// for hashing and *cannot* be used to deserialize the payload again.
    #[must_use]
    pub fn signature_message(&self) -> Vec<u8> {
        let mut bytes = vec![];

        #[allow(clippy::match_same_arms)]
        match &self {
            TransactionData::Deploy(d) => {
                bytes.extend(&d.bytecode.to_hash_input_bytes());
                bytes.extend(&d.owner);
                if let Some(init_args) = &d.init_args {
                    bytes.extend(init_args);
                }
            }
            TransactionData::Call(c) => {
                bytes.extend(c.contract.as_bytes());
                bytes.extend(c.fn_name.as_bytes());
                bytes.extend(&c.fn_args);
            }
            TransactionData::Memo(m) => {
                bytes.extend(m);
            }
            TransactionData::Blob(blobs) => {
                // We only return the bytes of the blobs' versioned hashes to
                // be signed.
                // We do not sign the rest of the blob data because this can be
                // deleted in the future, making it impossible to verify its
                // signature.
                // Instead, it is essential to verify commitments and proofs
                // against the blob data before including them
                // in a block
                for blob in blobs {
                    bytes.extend(blob.to_hash_input_bytes());
                }
            }
        }

        bytes
    }

    /// Serialize a `TransactionData` into a variable length byte buffer.
    #[must_use]
    pub fn to_var_bytes(&self) -> Vec<u8> {
        let mut bytes = Vec::new();
        // serialize the contract call, deployment or memo, if present.
        match &self {
            TransactionData::Call(call) => {
                bytes.push(Self::CALL_ID);
                bytes.extend(call.to_var_bytes());
            }
            TransactionData::Deploy(deploy) => {
                bytes.push(Self::DEPLOY_ID);
                bytes.extend(deploy.to_var_bytes());
            }
            TransactionData::Memo(memo) => {
                bytes.push(Self::MEMO_ID);
                bytes.extend((memo.len() as u64).to_bytes());
                bytes.extend(memo);
            }
            TransactionData::Blob(blobs) => {
                bytes.push(Self::BLOB_ID);
                // It's safe to use `u8` here because the maximum number of
                // blobs per transaction is 16 (MAX_MEMO_SIZE /
                // VERSIONED_HASH_SIZE), which fits in a `u8`.
                #[allow(clippy::cast_possible_truncation)]
                bytes.extend((blobs.len() as u8).to_bytes());
                for blob in blobs {
                    bytes.extend(blob.to_var_bytes());
                }
            }
        }

        bytes
    }

    /// Serialize an `Option<TransactionData>` into a variable length byte
    /// buffer.
    #[must_use]
    pub fn option_to_var_bytes(data: Option<&TransactionData>) -> Vec<u8> {
        let mut bytes = Vec::new();
        if let Some(data) = data {
            bytes.extend(data.to_var_bytes());
        } else {
            bytes.push(Self::NONE_ID);
        }
        bytes
    }

    /// Deserialize the optional `TransactionData` from bytes slice.
    ///
    /// # Errors
    /// Errors when the bytes are not canonical.
    pub fn from_slice(buf: &[u8]) -> Result<Option<Self>, BytesError> {
        let mut buf = buf;

        // deserialize optional transaction data
        let data = match u8::from_reader(&mut buf)? {
            Self::NONE_ID => None,
            Self::CALL_ID => {
                Some(TransactionData::Call(ContractCall::from_slice(buf)?))
            }
            Self::DEPLOY_ID => {
                Some(TransactionData::Deploy(ContractDeploy::from_slice(buf)?))
            }
            Self::MEMO_ID => {
                // we only build for 64-bit so this truncation is impossible
                #[allow(clippy::cast_possible_truncation)]
                let size = u64::from_reader(&mut buf)? as usize;

                if buf.len() != size || size > MAX_MEMO_SIZE {
                    return Err(BytesError::InvalidData);
                }

                let memo = buf[..size].to_vec();
                Some(TransactionData::Memo(memo))
            }
            Self::BLOB_ID => {
                let blobs_len = u8::from_reader(&mut buf)?;
                let mut blobs = Vec::with_capacity(blobs_len as usize);
                for _ in 0..blobs_len {
                    let blob = BlobData::from_buf(&mut buf)?;
                    blobs.push(blob);
                }
                Some(TransactionData::Blob(blobs))
            }
            _ => {
                return Err(BytesError::InvalidData);
            }
        };

        Ok(data)
    }
}

impl From<ContractCall> for TransactionData {
    fn from(c: ContractCall) -> Self {
        TransactionData::Call(c)
    }
}

impl From<ContractDeploy> for TransactionData {
    fn from(d: ContractDeploy) -> Self {
        TransactionData::Deploy(d)
    }
}

impl From<Vec<u8>> for TransactionData {
    fn from(d: Vec<u8>) -> Self {
        TransactionData::Memo(d)
    }
}

impl From<String> for TransactionData {
    fn from(d: String) -> Self {
        TransactionData::Memo(d.as_bytes().to_vec())
    }
}

impl From<Vec<BlobData>> for TransactionData {
    fn from(blobs: Vec<BlobData>) -> Self {
        TransactionData::Blob(blobs)
    }
}

/// Data for performing a contract deployment
#[derive(Debug, Clone, PartialEq, Eq, Archive, Serialize, Deserialize)]
#[archive_attr(derive(CheckBytes))]
pub struct ContractDeploy {
    /// Bytecode of the contract to be deployed.
    pub bytecode: ContractBytecode,
    /// Owner of the contract to be deployed.
    pub owner: Vec<u8>,
    /// Init method arguments of the deployed contract.
    pub init_args: Option<Vec<u8>>,
    /// Nonce for contract id uniqueness and vanity
    pub nonce: u64,
}

/// Represents a reference to blob data, including its hash and optional
/// sidecar.
#[derive(Debug, Clone, PartialEq, Eq, Archive, Serialize, Deserialize)]
#[archive_attr(derive(CheckBytes))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct BlobData {
    /// Versioned hash of the KZG commitment: 0x01 ‖ SHA256(commitment)[1..]
    #[cfg_attr(feature = "serde", serde(with = "As::<Hex>"))]
    pub hash: [u8; 32],

    /// Optional sidecar containing the full blob, commitment, and proof.
    /// This field is optional to allow the sidecar to be deleted after the
    /// challenge period.
    pub data: Option<BlobSidecar>,
}

/// Contains the full contents of a blob, including its KZG commitment and
/// proof.
#[derive(Debug, Clone, PartialEq, Eq, Archive, Serialize, Deserialize)]
#[archive_attr(derive(CheckBytes))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct BlobSidecar {
    /// KZG commitment to the blob (compressed G₁ point, 48 bytes)
    #[cfg_attr(feature = "serde", serde(with = "As::<Hex>"))]
    pub commitment: [u8; 48],

    /// KZG proof for evaluation correctness (compressed G₁ point, 48 bytes)
    #[cfg_attr(feature = "serde", serde(with = "As::<Hex>"))]
    pub proof: [u8; 48],

    /// Blob data: 4096 field elements, each 32 bytes (128 KiB total)
    #[cfg_attr(feature = "serde", serde(with = "As::<Hex>"))]
    pub data: BlobDataPart,
}

const BYTES_PER_BLOB: usize = 4096 * 32;
/// A type alias for the BLOB data part, which consists of 4096 field elements
/// (each 32 bytes), total 128 KiB
pub type BlobDataPart = [u8; BYTES_PER_BLOB];

/// All the data the transfer-contract needs to perform a contract-call.
#[derive(Debug, Clone, PartialEq, Eq, Archive, Serialize, Deserialize)]
#[archive_attr(derive(CheckBytes))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct ContractCall {
    /// The unique ID of the contract to be called.
    pub contract: ContractId,
    /// The function of the contract that should be called.
    pub fn_name: String,
    /// The function arguments for the contract call, in bytes.
    #[cfg_attr(feature = "serde", serde(with = "As::<Hex>"))]
    pub fn_args: Vec<u8>,
}

impl ContractDeploy {
    /// Serialize a `ContractDeploy` into a variable length byte buffer.
    #[must_use]
    pub fn to_var_bytes(&self) -> Vec<u8> {
        let mut bytes = Vec::new();

        bytes.extend(&self.bytecode.to_var_bytes());

        bytes.extend((self.owner.len() as u64).to_bytes());
        bytes.extend(&self.owner);

        match &self.init_args {
            Some(init_args) => {
                bytes.push(1);
                bytes.extend((init_args.len() as u64).to_bytes());
                bytes.extend(init_args);
            }
            None => bytes.push(0),
        }

        bytes.extend(self.nonce.to_bytes());

        bytes
    }

    /// Deserialize a `ContractDeploy` from a byte buffer.
    ///
    /// # Errors
    /// Errors when the bytes are not canonical.
    pub fn from_slice(buf: &[u8]) -> Result<Self, BytesError> {
        let mut buf = buf;

        let bytecode = ContractBytecode::from_buf(&mut buf)?;

        let owner = crate::read_vec(&mut buf)?;

        let init_args = match u8::from_reader(&mut buf)? {
            0 => None,
            1 => Some(crate::read_vec(&mut buf)?),
            _ => return Err(BytesError::InvalidData),
        };

        let nonce = u64::from_reader(&mut buf)?;

        Ok(Self {
            bytecode,
            owner,
            init_args,
            nonce,
        })
    }
}

impl ContractCall {
    /// Creates a new contract call with empty `fn_args`.
    ///
    /// Initializes a contract call by setting the function arguments to an
    /// empty vector.
    ///
    /// # Parameters
    /// - `contract`: A value convertible into a `ContractId`, representing the
    ///   target contract.
    /// - `fn_name`: A value convertible into a `String`, specifying the name of
    ///   the function to be called.
    pub fn new(
        contract: impl Into<ContractId>,
        fn_name: impl Into<String>,
    ) -> Self {
        Self {
            contract: contract.into(),
            fn_name: fn_name.into(),
            fn_args: vec![],
        }
    }

    /// Consumes `self` and returns a new contract call with raw function
    /// arguments.
    ///
    /// Updates the contract call with raw serialized arguments provided as a
    /// `Vec<u8>`.
    ///
    /// # Parameters
    /// - `fn_args`: A `Vec<u8>` representing pre-serialized function arguments.
    #[must_use]
    pub fn with_raw_args(mut self, fn_args: Vec<u8>) -> Self {
        self.fn_args = fn_args;
        self
    }

    /// Consumes `self` and returns a new contract call with serialized function
    /// arguments.
    ///
    /// Serializes the provided function arguments using `rkyv` serialization
    /// and returns an updated contract call.
    ///
    /// # Parameters
    /// - `fn_args`: A reference to an object implementing `Serialize` for the
    ///   given `AllocSerializer`.
    ///
    /// # Returns
    /// - `Ok(Self)`: If the serialization is successful.
    /// - `Err(Error::Rkyv)`: If the `rkyv` serialization fails.
    ///
    /// # Errors
    /// Returns an error if `rkyv` serialization fails.
    pub fn with_args<A>(self, fn_arg: &A) -> Result<Self, Error>
    where
        A: for<'b> Serialize<StandardBufSerializer<'b>>,
        A::Archived: for<'b> CheckBytes<DefaultValidator<'b>>,
    {
        // scratch-space and page-size values taken from piecrust-uplink
        const SCRATCH_SPACE: usize = 1024;
        const PAGE_SIZE: usize = 0x1000;

        let mut sbuf = [0u8; SCRATCH_SPACE];
        let scratch = BufferScratch::new(&mut sbuf);
        let mut buffer = [0u8; PAGE_SIZE];
        let ser = BufferSerializer::new(&mut buffer[..]);
        let mut ser = CompositeSerializer::new(ser, scratch, Infallible);

        ser.serialize_value(fn_arg)
            .map_err(|e| Error::Rkyv(format!("{e:?}")))?;
        let pos = ser.pos();

        let fn_args = buffer[..pos].to_vec();

        Ok(self.with_raw_args(fn_args))
    }

    /// Serialize a `ContractCall` into a variable length byte buffer.
    #[must_use]
    pub fn to_var_bytes(&self) -> Vec<u8> {
        let mut bytes = Vec::new();

        bytes.extend(self.contract.as_bytes());

        let fn_name_bytes = self.fn_name.as_bytes();
        bytes.extend((fn_name_bytes.len() as u64).to_bytes());
        bytes.extend(fn_name_bytes);

        bytes.extend((self.fn_args.len() as u64).to_bytes());
        bytes.extend(&self.fn_args);

        bytes
    }

    /// Deserialize a `ContractCall` from a byte buffer.
    ///
    /// # Errors
    /// Errors when the bytes are not canonical.
    pub fn from_slice(buf: &[u8]) -> Result<Self, BytesError> {
        let mut buf = buf;

        let contract = crate::read_arr::<32>(&mut buf)?;

        let fn_name = crate::read_str(&mut buf)?;

        let fn_args = crate::read_vec(&mut buf)?;

        Ok(Self {
            contract: contract.into(),
            fn_name,
            fn_args,
        })
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Archive, Serialize, Deserialize)]
#[archive_attr(derive(CheckBytes))]
/// Holds bytes of bytecode and its hash.
pub struct ContractBytecode {
    /// Blake3 hash of the bytecode bytes.
    pub hash: [u8; 32],
    /// Bytecode bytes.
    pub bytes: Vec<u8>,
}

impl ContractBytecode {
    /// Provides contribution bytes for an external hash.
    #[must_use]
    pub fn to_hash_input_bytes(&self) -> Vec<u8> {
        self.hash.to_vec()
    }

    /// Serializes this object into a variable length buffer
    #[must_use]
    pub fn to_var_bytes(&self) -> Vec<u8> {
        let mut bytes = Vec::new();
        bytes.extend(self.hash);
        bytes.extend((self.bytes.len() as u64).to_bytes());
        bytes.extend(&self.bytes);
        bytes
    }

    /// Deserializes from a bytes buffer.
    /// Resets buffer to a position after the bytes read.
    ///
    /// # Errors
    /// Errors when the bytes are not available.
    pub fn from_buf(buf: &mut &[u8]) -> Result<Self, BytesError> {
        let hash = crate::read_arr::<32>(buf)?;
        let bytes = crate::read_vec(buf)?;
        Ok(Self { hash, bytes })
    }
}

impl BlobData {
    /// Version of the KZG commitment hash used in versioned blob hashes.
    pub const VERSIONED_HASH_VERSION_KZG: u8 = 0x01;

    /// Provides contribution bytes for an external hash.
    #[must_use]
    pub fn to_hash_input_bytes(&self) -> Vec<u8> {
        self.hash.to_vec()
    }

    /// Serializes this object into a variable length buffer
    #[must_use]
    pub fn to_var_bytes(&self) -> Vec<u8> {
        let mut bytes = Vec::new();
        bytes.extend(self.hash);
        if let Some(data) = &self.data {
            bytes.push(1u8);
            bytes.extend(data.to_var_bytes());
        } else {
            bytes.push(0u8);
        }
        bytes
    }

    /// Deserializes from a bytes buffer.
    /// Resets buffer to a position after the bytes read.
    ///
    /// # Errors
    /// Errors when the bytes are not available.
    pub fn from_buf(buf: &mut &[u8]) -> Result<Self, BytesError> {
        let hash = crate::read_arr(buf)?;

        let data = match u8::from_reader(buf)? {
            0 => None,
            1 => Some(BlobSidecar::from_buf(buf)?),
            _ => return Err(BytesError::InvalidData),
        };

        Ok(Self { hash, data })
    }

    /// Take the data field, if it exists.
    #[must_use]
    pub fn take_sidecar(&mut self) -> Option<BlobSidecar> {
        self.data.take()
    }

    /// Computes the versioned blob hash from a 48-byte KZG commitment.
    ///
    /// This follows the EIP-4844 definition: 0x01 ‖ SHA256(commitment)[1..]
    #[must_use]
    pub fn hash_from_commitment(commitment: &[u8]) -> [u8; 32] {
        let digest = Sha256::digest(commitment);
        let mut out = [0u8; 32];
        out[0] = Self::VERSIONED_HASH_VERSION_KZG;
        out[1..].copy_from_slice(&digest[1..]);
        out
    }
}

impl BlobSidecar {
    /// Serializes this object into a variable length buffer
    #[must_use]
    pub fn to_var_bytes(&self) -> Vec<u8> {
        let mut bytes = Vec::new();
        bytes.extend(self.commitment);
        bytes.extend(self.proof);
        bytes.extend(self.data);
        bytes
    }

    /// Deserializes from a bytes buffer.
    /// Resets buffer to a position after the bytes read.
    ///
    /// # Errors
    /// Errors when the bytes are not available.
    pub fn from_buf(buf: &mut &[u8]) -> Result<Self, BytesError> {
        let commitment = crate::read_arr(buf)?;
        let proof = crate::read_arr(buf)?;
        let data = crate::read_arr(buf)?;

        Ok(Self {
            commitment,
            proof,
            data,
        })
    }
}