dusk-core 1.7.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.

//! Types related to Dusk's transfer contract that are shared across the
//! network.

use alloc::string::String;
use alloc::vec::Vec;
use core::cmp::max;
use core::fmt::Debug;

use bytecheck::CheckBytes;
use dusk_bytes::{DeserializableSlice, Error as BytesError};
use poseidon_merkle::Opening;
use rand::{CryptoRng, RngCore};
use rkyv::{Archive, Deserialize, Serialize};
#[cfg(feature = "serde")]
use serde_with::hex::Hex;
#[cfg(feature = "serde")]
use serde_with::{As, DisplayFromStr, Same};

use self::data::{
    BlobData, BlobSidecar, ContractCall, ContractDeploy, TransactionData,
};
use self::moonlight::Transaction as MoonlightTransaction;
use self::phoenix::{
    NOTES_TREE_DEPTH, Note, Prove, PublicKey as PhoenixPublicKey,
    SecretKey as PhoenixSecretKey, Sender, StealthAddress,
    Transaction as PhoenixTransaction,
};
use self::withdraw::{Withdraw, WithdrawReceiver};
use crate::abi::ContractId;
use crate::error::TxPreconditionError;
use crate::signatures::bls::{
    PublicKey as AccountPublicKey, SecretKey as AccountSecretKey,
};
use crate::{BlsScalar, Error};

pub mod data;
pub mod moonlight;
pub mod phoenix;
pub mod withdraw;

/// ID of the genesis transfer contract
pub const TRANSFER_CONTRACT: ContractId = crate::reserved(0x1);

/// Panic of "Nonce not ready to be used yet"
pub const PANIC_NONCE_NOT_READY: &str = "Nonce not ready to be used yet";

/// Topic for the moonlight transaction event.
pub const MOONLIGHT_TOPIC: &str = "moonlight";
/// Topic for the phoenix transaction event.
pub const PHOENIX_TOPIC: &str = "phoenix";
/// Topic for the contract to contract transaction event.
pub const CONTRACT_TO_CONTRACT_TOPIC: &str = "contract_to_contract";
/// Topic for the contract to account transaction event.
pub const CONTRACT_TO_ACCOUNT_TOPIC: &str = "contract_to_account";
/// Topic for the withdraw event.
pub const WITHDRAW_TOPIC: &str = "withdraw";
/// Topic for the deposit event.
pub const DEPOSIT_TOPIC: &str = "deposit";
/// Topic for the convert event.
pub const CONVERT_TOPIC: &str = "convert";
/// Topic for the mint event.
pub const MINT_TOPIC: &str = "mint";
/// Topic for the mint to contract event.
pub const MINT_CONTRACT_TOPIC: &str = "mint_c";

const BOREAS_FORMAT_VERSION: u8 = 2;

#[derive(Debug, Clone, Copy, Eq, PartialEq)]
#[repr(u8)]
enum TransactionTag {
    LegacyPhoenix = 0,
    LegacyMoonlight = 1,
    VersionedPhoenix = 2,
    VersionedMoonlight = 3,
}

impl TryFrom<u8> for TransactionTag {
    type Error = BytesError;

    fn try_from(value: u8) -> Result<Self, Self::Error> {
        match value {
            0 => Ok(Self::LegacyPhoenix),
            1 => Ok(Self::LegacyMoonlight),
            2 => Ok(Self::VersionedPhoenix),
            3 => Ok(Self::VersionedMoonlight),
            _ => Err(BytesError::InvalidData),
        }
    }
}

impl TransactionTag {
    fn from_transaction(
        transaction: &Transaction,
        format: TransactionFormat,
    ) -> Self {
        match (transaction, format) {
            (Transaction::Phoenix(_), TransactionFormat::Boreas) => {
                Self::VersionedPhoenix
            }
            (Transaction::Moonlight(_), TransactionFormat::Boreas) => {
                Self::VersionedMoonlight
            }
            (Transaction::Phoenix(_), _) => Self::LegacyPhoenix,
            (Transaction::Moonlight(_), _) => Self::LegacyMoonlight,
        }
    }

    fn is_versioned(self) -> bool {
        matches!(self, Self::VersionedPhoenix | Self::VersionedMoonlight)
    }
}

/// Canonical protocol transaction format.
#[derive(Debug, Clone, Copy, Eq, PartialEq)]
pub enum TransactionFormat {
    /// Historical transactions before AEGIS.
    PreAegis,
    /// Historical and produced transactions under AEGIS rules.
    Aegis,
    /// Explicitly versioned transactions introduced in the Boreas era.
    Boreas,
}

/// Result of a version-aware transaction decode.
#[derive(Debug, Clone, Eq, PartialEq)]
pub struct DecodedTransaction {
    /// Decoded semantic transaction.
    pub transaction: Transaction,
    /// Canonical transaction format used for the decoded bytes.
    pub format: TransactionFormat,
}

/// The transaction used by the transfer contract.
#[derive(Debug, Clone, Archive, PartialEq, Eq, Serialize, Deserialize)]
#[archive_attr(derive(CheckBytes))]
#[allow(clippy::large_enum_variant)]
pub enum Transaction {
    /// A phoenix transaction.
    Phoenix(PhoenixTransaction),
    /// A moonlight transaction.
    Moonlight(MoonlightTransaction),
}

impl Transaction {
    fn decode_tagged(
        tag: TransactionTag,
        buf: &[u8],
        phoenix_tag: TransactionTag,
        moonlight_tag: TransactionTag,
        parse_phoenix: fn(&[u8]) -> Result<PhoenixTransaction, BytesError>,
    ) -> Result<Transaction, BytesError> {
        match tag {
            tag if tag == phoenix_tag => Ok(Self::Phoenix(parse_phoenix(buf)?)),
            tag if tag == moonlight_tag => {
                Ok(Self::Moonlight(MoonlightTransaction::from_slice(buf)?))
            }
            _ => Err(BytesError::InvalidData),
        }
    }

    fn decode_legacy(
        format: TransactionFormat,
        buf: &[u8],
        parse_phoenix: fn(&[u8]) -> Result<PhoenixTransaction, BytesError>,
    ) -> Result<DecodedTransaction, BytesError> {
        let mut buf = buf;
        let family_tag = TransactionTag::try_from(u8::from_reader(&mut buf)?)?;

        let transaction = Self::decode_tagged(
            family_tag,
            buf,
            TransactionTag::LegacyPhoenix,
            TransactionTag::LegacyMoonlight,
            parse_phoenix,
        )?;

        Ok(DecodedTransaction {
            transaction,
            format,
        })
    }

    fn decode_boreas(buf: &[u8]) -> Result<DecodedTransaction, BytesError> {
        let mut buf = buf;
        let family_tag = TransactionTag::try_from(u8::from_reader(&mut buf)?)?;
        let format_version = u8::from_reader(&mut buf)?;

        if format_version != BOREAS_FORMAT_VERSION {
            return Err(BytesError::InvalidData);
        }

        let transaction = Self::decode_tagged(
            family_tag,
            buf,
            TransactionTag::VersionedPhoenix,
            TransactionTag::VersionedMoonlight,
            PhoenixTransaction::from_slice,
        )?;

        Ok(DecodedTransaction {
            transaction,
            format: TransactionFormat::Boreas,
        })
    }

    /// Decode a transaction according to the selected protocol format.
    ///
    /// # Errors
    /// Returns [`BytesError::InvalidData`] when the bytes do not match the
    /// transaction families or formats accepted under `format`.
    pub fn decode_with_format(
        format: TransactionFormat,
        buf: &[u8],
    ) -> Result<DecodedTransaction, BytesError> {
        match format {
            TransactionFormat::PreAegis => Self::decode_legacy(
                format,
                buf,
                PhoenixTransaction::from_slice_ledger_compat,
            ),
            TransactionFormat::Aegis => {
                Self::decode_legacy(format, buf, PhoenixTransaction::from_slice)
            }
            TransactionFormat::Boreas => Self::decode_boreas(buf),
        }
    }

    /// Decode a transaction for live ingress under the selected protocol
    /// format.
    ///
    /// This path is intended for mempool and network admission, where only the
    /// format valid at the target block height should be accepted.
    ///
    /// # Errors
    /// Returns [`BytesError::InvalidData`] when the bytes do not match the
    /// transaction families or format accepted under `format`.
    pub fn decode_for_ingress(
        format: TransactionFormat,
        buf: &[u8],
    ) -> Result<DecodedTransaction, BytesError> {
        Self::decode_with_format(format, buf)
    }

    /// Decode a transaction in any currently supported format.
    ///
    /// This path is intended for historical ledger replay and storage decoding,
    /// where legacy transactions from earlier protocol eras must remain
    /// decodable.
    ///
    /// # Errors
    /// Returns [`BytesError::InvalidData`] when the bytes do not encode a
    /// supported transaction family or explicit format version.
    pub fn decode_any(buf: &[u8]) -> Result<DecodedTransaction, BytesError> {
        let tag = TransactionTag::try_from(
            buf.first().copied().ok_or(BytesError::InvalidData)?,
        )?;

        if tag.is_versioned() {
            Self::decode_boreas(buf)
        } else {
            Self::decode_legacy(
                TransactionFormat::Aegis,
                buf,
                PhoenixTransaction::from_slice,
            )
            .or_else(|_| {
                Self::decode_legacy(
                    TransactionFormat::PreAegis,
                    buf,
                    PhoenixTransaction::from_slice_ledger_compat,
                )
            })
        }
    }

    /// Create a new phoenix transaction.
    ///
    /// # Errors
    /// The creation of a transaction is not possible and will error if:
    /// - one of the input-notes doesn't belong to the `sender_sk`
    /// - the transaction input doesn't cover the transaction costs
    /// - the `inputs` vector is either empty or larger than 4 elements
    /// - the `inputs` vector contains duplicate `Note`s
    /// - the `Prove` trait is implemented incorrectly
    #[allow(clippy::too_many_arguments)]
    pub fn phoenix<R: RngCore + CryptoRng, P: Prove>(
        rng: &mut R,
        sender_sk: &PhoenixSecretKey,
        refund_pk: &PhoenixPublicKey,
        receiver_pk: &PhoenixPublicKey,
        inputs: Vec<(Note, Opening<(), NOTES_TREE_DEPTH>)>,
        root: BlsScalar,
        transfer_value: u64,
        obfuscated_transaction: bool,
        deposit: u64,
        gas_limit: u64,
        gas_price: u64,
        chain_id: u8,
        data: Option<impl Into<TransactionData>>,
        prover: &P,
    ) -> Result<Self, Error> {
        Ok(Self::Phoenix(PhoenixTransaction::new::<R, P>(
            rng,
            sender_sk,
            refund_pk,
            receiver_pk,
            inputs,
            root,
            transfer_value,
            obfuscated_transaction,
            deposit,
            gas_limit,
            gas_price,
            chain_id,
            data,
            prover,
        )?))
    }

    /// Create a new moonlight transaction.
    ///
    /// # Errors
    /// The creation of a transaction is not possible and will error if:
    /// - the memo, if given, is too large
    #[allow(clippy::too_many_arguments)]
    pub fn moonlight(
        sender_sk: &AccountSecretKey,
        receiver: Option<AccountPublicKey>,
        value: u64,
        deposit: u64,
        gas_limit: u64,
        gas_price: u64,
        nonce: u64,
        chain_id: u8,
        data: Option<impl Into<TransactionData>>,
    ) -> Result<Self, Error> {
        Ok(Self::Moonlight(MoonlightTransaction::new(
            sender_sk, receiver, value, deposit, gas_limit, gas_price, nonce,
            chain_id, data,
        )?))
    }

    /// Return the sender of the account for Moonlight transactions.
    #[must_use]
    pub fn moonlight_sender(&self) -> Option<&AccountPublicKey> {
        match self {
            Self::Phoenix(_) => None,
            Self::Moonlight(tx) => Some(tx.sender()),
        }
    }

    /// Get the receiver of the transaction for Moonlight transactions, if it
    /// exists.
    ///
    /// # Returns
    ///
    /// - `Some(&AccountPublicKey)` if the transaction is a Moonlight
    ///   transaction and the receiver is different from the sender.
    /// - `None` if the transaction is a Moonlight transaction and the receiver
    ///   is the same as the sender.
    /// - `None` if the transaction is a Phoenix transaction.
    #[must_use]
    pub fn moonlight_receiver(&self) -> Option<&AccountPublicKey> {
        match self {
            Self::Phoenix(_) => None,
            Self::Moonlight(tx) => tx.receiver(),
        }
    }

    /// Return the value transferred in a Moonlight transaction.
    #[must_use]
    pub fn value(&self) -> Option<u64> {
        match self {
            Self::Phoenix(_) => None,
            Self::Moonlight(tx) => Some(tx.value()),
        }
    }

    /// Returns the nullifiers of the transaction, if the transaction is a
    /// moonlight transaction, the result will be empty.
    #[must_use]
    pub fn nullifiers(&self) -> &[BlsScalar] {
        match self {
            Self::Phoenix(tx) => tx.nullifiers(),
            Self::Moonlight(_) => &[],
        }
    }

    /// Return the root of the UTXO tree for Phoenix transactions.
    #[must_use]
    pub fn root(&self) -> Option<&BlsScalar> {
        match self {
            Self::Phoenix(tx) => Some(tx.root()),
            Self::Moonlight(_) => None,
        }
    }

    /// Return the UTXO outputs of the transaction.
    #[must_use]
    pub fn outputs(&self) -> &[Note] {
        match self {
            Self::Phoenix(tx) => &tx.outputs()[..],
            Self::Moonlight(_) => &[],
        }
    }

    /// Returns the sender data for Phoenix transactions.
    #[must_use]
    pub fn phoenix_sender(&self) -> Option<&Sender> {
        match self {
            Self::Phoenix(tx) => Some(tx.sender()),
            Self::Moonlight(_) => None,
        }
    }

    /// Returns the deposit of the transaction.
    #[must_use]
    pub fn deposit(&self) -> u64 {
        match self {
            Self::Phoenix(tx) => tx.deposit(),
            Self::Moonlight(tx) => tx.deposit(),
        }
    }

    /// Returns the gas limit of the transaction.
    #[must_use]
    pub fn gas_limit(&self) -> u64 {
        match self {
            Self::Phoenix(tx) => tx.gas_limit(),
            Self::Moonlight(tx) => tx.gas_limit(),
        }
    }

    /// Returns the gas price of the transaction.
    #[must_use]
    pub fn gas_price(&self) -> u64 {
        match self {
            Self::Phoenix(tx) => tx.gas_price(),
            Self::Moonlight(tx) => tx.gas_price(),
        }
    }

    /// Returns the refund-address of the transaction.
    #[must_use]
    pub fn refund_address(&self) -> RefundAddress<'_> {
        match self {
            Self::Phoenix(tx) => RefundAddress::Phoenix(tx.stealth_address()),
            Self::Moonlight(tx) => {
                RefundAddress::Moonlight(tx.refund_address())
            }
        }
    }

    /// Return the contract call data, if there is any.
    ///
    /// Call data is present only when inter-contract calls happen.
    ///
    /// # Returns
    ///
    /// - `Some(&ContractCall)` if the transaction invokes another call to a
    ///   contract.
    /// - `None` if the transaction is an entrypoint call to a protocol contract
    ///   without a second call attached to it.
    #[must_use]
    pub fn call(&self) -> Option<&ContractCall> {
        match self {
            Self::Phoenix(tx) => tx.call(),
            Self::Moonlight(tx) => tx.call(),
        }
    }

    /// Return the contract deploy data, if there is any.
    #[must_use]
    pub fn deploy(&self) -> Option<&ContractDeploy> {
        match self {
            Self::Phoenix(tx) => tx.deploy(),
            Self::Moonlight(tx) => tx.deploy(),
        }
    }

    /// Returns the memo used with the transaction, if any.
    #[must_use]
    pub fn memo(&self) -> Option<&[u8]> {
        match self {
            Self::Phoenix(tx) => tx.memo(),
            Self::Moonlight(tx) => tx.memo(),
        }
    }

    /// Returns the Blob used with the transaction, if any.
    #[must_use]
    pub fn blob(&self) -> Option<&Vec<BlobData>> {
        match self {
            Self::Phoenix(tx) => tx.blob(),
            Self::Moonlight(tx) => tx.blob(),
        }
    }

    /// Returns the Blob used with the transaction, if any.
    #[must_use]
    pub fn blob_mut(&mut self) -> Option<&mut Vec<BlobData>> {
        match self {
            Self::Phoenix(tx) => tx.blob_mut(),
            Self::Moonlight(tx) => tx.blob_mut(),
        }
    }

    /// Extracts and removes the blob sidecar from the transaction, if any, and
    /// returns it as a vector of tuples containing the blob hash and the
    /// corresponding blob sidecar.
    ///
    /// This function mutably accesses the blob storage within the transaction,
    /// clears the stored data, and returns the extracted parts while
    /// preserving their hashes.
    ///
    /// Returns `None` if there are no blobs present in the transaction.
    #[must_use]
    pub fn strip_blobs(&mut self) -> Option<Vec<([u8; 32], BlobSidecar)>> {
        let blob = match self {
            Self::Phoenix(tx) => tx.blob_mut(),
            Self::Moonlight(tx) => tx.blob_mut(),
        }?;

        let ret = blob
            .iter_mut()
            .filter_map(|b| b.take_sidecar().map(|d| (b.hash, d)))
            .collect::<Vec<_>>();

        Some(ret)
    }

    /// Creates a modified clone of this transaction if it contains a Blob,
    /// clones all fields except for the Blob, whose versioned hashes are set as
    /// Memo.
    ///
    /// Returns none if the transaction is not a Blob transaction.
    #[must_use]
    pub fn blob_to_memo(&self) -> Option<Self> {
        Some(match self {
            Transaction::Phoenix(tx) => {
                Transaction::Phoenix(tx.blob_to_memo()?)
            }
            Transaction::Moonlight(tx) => {
                Transaction::Moonlight(tx.blob_to_memo()?)
            }
        })
    }

    /// Creates a modified clone of this transaction if it contains data for
    /// deployment, clones all fields except for the bytecode' 'bytes' part.
    /// Returns none if the transaction is not a deployment transaction.
    #[must_use]
    pub fn strip_off_bytecode(&self) -> Option<Self> {
        Some(match self {
            Transaction::Phoenix(tx) => {
                Transaction::Phoenix(tx.strip_off_bytecode()?)
            }
            Transaction::Moonlight(tx) => {
                Transaction::Moonlight(tx.strip_off_bytecode()?)
            }
        })
    }

    /// Serialize the transaction into a byte buffer.
    #[must_use]
    pub fn encode_for_format(&self, format: TransactionFormat) -> Vec<u8> {
        let mut bytes = Vec::new();
        let tag = TransactionTag::from_transaction(self, format);

        bytes.push(tag as u8);
        if tag.is_versioned() {
            bytes.push(BOREAS_FORMAT_VERSION);
        }

        match self {
            Self::Phoenix(tx) => bytes.extend(tx.to_var_bytes()),
            Self::Moonlight(tx) => bytes.extend(tx.to_var_bytes()),
        }

        bytes
    }

    /// Serialize the transaction into the stable client-facing network format.
    ///
    /// Nodes accept these bytes across supported hardforks and normalize them
    /// internally, so ordinary clients do not need fork-aware envelope
    /// selection just to submit a transaction.
    #[must_use]
    pub fn to_network_bytes(&self) -> Vec<u8> {
        self.encode_for_format(TransactionFormat::Aegis)
    }

    /// Backward-compatible alias for [`Transaction::to_network_bytes`].
    #[must_use]
    pub fn to_var_bytes(&self) -> Vec<u8> {
        self.to_network_bytes()
    }

    /// Deserialize the transaction from a byte slice.
    ///
    /// # Errors
    /// Errors when the bytes are not canonical.
    pub fn from_slice(buf: &[u8]) -> Result<Self, BytesError> {
        Self::decode_any(buf).map(|decoded| decoded.transaction)
    }

    /// Return input bytes to hash the transaction.
    ///
    /// Note: The result of this function is *only* meant to be used as an input
    /// for hashing and *cannot* be used to deserialize the transaction again.
    #[must_use]
    pub fn to_hash_input_bytes(&self) -> Vec<u8> {
        match self {
            Self::Phoenix(tx) => tx.to_hash_input_bytes(),
            Self::Moonlight(tx) => tx.to_hash_input_bytes(),
        }
    }

    /// Create the unique transaction hash.
    #[must_use]
    pub fn hash(&self) -> BlsScalar {
        match self {
            Self::Phoenix(tx) => tx.hash(),
            Self::Moonlight(tx) => tx.hash(),
        }
    }

    /// Returns the charge for a contract deployment. The deployment of a
    /// contract will cost at least `min_deploy_points`.
    /// If the transaction is not a deploy-transaction, the deploy-charge will
    /// be 0.
    ///
    /// # Errors
    /// Returns an error if the deploy charge overflows while calculating
    /// `bytecode_len * gas_per_deploy_byte`.
    pub fn deploy_charge(
        &self,
        gas_per_deploy_byte: u64,
        min_deploy_points: u64,
    ) -> Result<u64, TxPreconditionError> {
        if let Some(deploy) = self.deploy() {
            let bytecode_len = deploy.bytecode.bytes.len() as u64;
            let deploy_charge =
                bytecode_len
                    .checked_mul(gas_per_deploy_byte)
                    .ok_or(TxPreconditionError::DeployChargeOverflow)?;

            Ok(max(deploy_charge, min_deploy_points))
        } else {
            Ok(0)
        }
    }

    /// Returns the minimum gas charged for a blob transaction deployment.
    /// If the transaction is not a blob transaction, it returns None.
    ///
    /// # Errors
    /// Returns an error if the blob charge overflows while calculating
    /// `blob_count * gas_per_blob`.
    pub fn blob_charge(
        &self,
        gas_per_blob: u64,
    ) -> Result<Option<u64>, TxPreconditionError> {
        self.blob()
            .map(|blobs| {
                (blobs.len() as u64)
                    .checked_mul(gas_per_blob)
                    .ok_or(TxPreconditionError::BlobChargeOverflow)
            })
            .transpose()
    }

    /// Check the validity of the phoenix fee and return an error if it is
    /// invalid.
    ///
    /// # Errors
    /// Returns an error if the transaction is a Phoenix transaction and:
    /// - the fee overflows when calculating `gas_limit * gas_price`
    /// - the fee does not match the proven `max_fee`
    pub fn phoenix_fee_check(&self) -> Result<(), TxPreconditionError> {
        if let Transaction::Phoenix(tx) = self {
            let max_fee = tx
                .fee()
                .gas_limit
                .checked_mul(tx.fee().gas_price)
                .ok_or(TxPreconditionError::PhoenixFeeOverflow)?;

            if max_fee != tx.max_fee() {
                return Err(TxPreconditionError::PhoenixFeeTampered);
            }
        }
        Ok(())
    }

    /// Check that the phoenix fee's refund address matches the ZK-proven
    /// change note (`outputs[1]`).
    ///
    /// This prevents a malicious block producer from redirecting the gas
    /// refund to a different stealth address.
    ///
    /// # Errors
    /// Returns an error if the transaction is a Phoenix transaction and
    /// the fee's stealth address does not match `outputs[1]`.
    pub fn phoenix_refund_check(&self) -> Result<(), TxPreconditionError> {
        if let Transaction::Phoenix(tx) = self
            && tx.fee().stealth_address != *tx.outputs()[1].stealth_address()
        {
            return Err(TxPreconditionError::PhoenixFeeRefundMismatch);
        }
        Ok(())
    }

    /// Check if the transaction is a deployment transaction and if it
    /// meets the minimum requirements for gas price and gas limit.
    ///
    /// # Errors
    /// Returns an error if the transaction is a deployment transaction and
    /// the gas price is lower than the minimum required gas price or if the
    /// gas limit is lower than the required deployment charge.
    pub fn deploy_check(
        &self,
        gas_per_deploy_byte: u64,
        min_deploy_gas_price: u64,
        min_deploy_points: u64,
    ) -> Result<(), TxPreconditionError> {
        if self.deploy().is_some() {
            let deploy_charge =
                self.deploy_charge(gas_per_deploy_byte, min_deploy_points)?;

            if self.gas_price() < min_deploy_gas_price {
                return Err(TxPreconditionError::DeployLowPrice(
                    min_deploy_gas_price,
                ));
            }
            if self.gas_limit() < deploy_charge {
                return Err(TxPreconditionError::DeployLowLimit(deploy_charge));
            }
        }

        Ok(())
    }

    /// Check if the transaction is a blob transaction and if it meets the
    /// minimum requirements for gas limit.
    ///
    /// # Returns
    /// - `Ok(Some(u64))` the minimum gas amount to charge if the transaction is
    ///   a blob transaction.
    /// - `Ok(None)` if the transaction is not a blob transaction.
    /// - `Err(TxPreconditionError)` in case of an error.
    ///
    /// # Errors
    /// Returns an error if the transaction is a blob transaction and:
    /// - the gas limit is lower than the minimum charge.
    /// - the number of blobs is zero or greater than 6.
    pub fn blob_check(
        &self,
        gas_per_blob: u64,
    ) -> Result<Option<u64>, TxPreconditionError> {
        if let Some(blobs) = self.blob() {
            match blobs.len() {
                0 => Err(TxPreconditionError::BlobEmpty),
                n if n > 6 => Err(TxPreconditionError::BlobTooMany(n)),
                _ => Ok(()),
            }?;
        } else {
            return Ok(None);
        }

        let min_charge = self.blob_charge(gas_per_blob)?;
        if let Some(min_charge) = min_charge
            && self.gas_limit() < min_charge
        {
            return Err(TxPreconditionError::BlobLowLimit(min_charge));
        }
        Ok(min_charge)
    }
}

impl From<PhoenixTransaction> for Transaction {
    fn from(tx: PhoenixTransaction) -> Self {
        Self::Phoenix(tx)
    }
}

impl From<MoonlightTransaction> for Transaction {
    fn from(tx: MoonlightTransaction) -> Self {
        Self::Moonlight(tx)
    }
}

/// Enum defining the address to refund unspent gas to for both Phoenix and
/// Moonlight transactions.
pub enum RefundAddress<'a> {
    /// The address of the Phoenix refund note.
    Phoenix(&'a StealthAddress),
    /// The moonlight account to which to send the refund.
    Moonlight(&'a AccountPublicKey),
}

/// The payload sent by a contract to the transfer contract to transfer some of
/// its funds to another contract.
#[derive(Debug, Clone, Archive, PartialEq, Eq, Serialize, Deserialize)]
#[archive_attr(derive(CheckBytes))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct ContractToContract {
    /// Contract to transfer funds to.
    pub contract: ContractId,
    /// Amount to send to the contract.
    #[cfg_attr(feature = "serde", serde(with = "As::<DisplayFromStr>"))]
    pub value: u64,
    /// Function name to call on the contract.
    pub fn_name: String,
    /// Extra data sent along with [`ReceiveFromContract`]
    #[cfg_attr(feature = "serde", serde(with = "As::<Hex>"))]
    pub data: Vec<u8>,
}

/// The payload sent by the transfer contract to a contract receiving funds from
/// another contract.
#[derive(Debug, Clone, Archive, PartialEq, Eq, Serialize, Deserialize)]
#[archive_attr(derive(CheckBytes))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct ReceiveFromContract {
    /// Contract that sent the funds.
    pub contract: ContractId,
    /// Amount sent by the contract.
    #[cfg_attr(feature = "serde", serde(with = "As::<DisplayFromStr>"))]
    pub value: u64,
    /// Extra data sent by the sender.
    #[cfg_attr(feature = "serde", serde(with = "As::<Hex>"))]
    pub data: Vec<u8>,
}

/// The payload sent by a contract to the transfer contract to transfer some of
/// its funds to an account.
#[derive(Debug, Clone, Archive, PartialEq, Eq, Serialize, Deserialize)]
#[archive_attr(derive(CheckBytes))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct ContractToAccount {
    /// Account to transfer funds to.
    pub account: AccountPublicKey,
    /// Amount to send to the account.
    #[cfg_attr(feature = "serde", serde(with = "As::<DisplayFromStr>"))]
    pub value: u64,
}

/// Event data emitted on a withdrawal from a contract.
#[derive(Debug, Clone, Archive, PartialEq, Serialize, Deserialize)]
#[archive_attr(derive(CheckBytes))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct WithdrawEvent {
    /// The contract withdrawn from.
    pub sender: ContractId,
    /// The receiver of the value.
    pub receiver: WithdrawReceiver,
    /// The value withdrawn.
    #[cfg_attr(feature = "serde", serde(with = "As::<DisplayFromStr>"))]
    pub value: u64,
}

impl From<Withdraw> for WithdrawEvent {
    fn from(w: Withdraw) -> Self {
        Self {
            sender: w.contract,
            receiver: w.receiver,
            value: w.value,
        }
    }
}

/// Event data emitted on a conversion from Phoenix to Moonlight, and
/// vice-versa.
#[derive(Debug, Clone, Archive, PartialEq, Serialize, Deserialize)]
#[archive_attr(derive(CheckBytes))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct ConvertEvent {
    /// The originator of the conversion, if it is possible to determine. From
    /// Moonlight to Phoenix it is possible, but the same cannot be done the
    /// other way round.
    pub sender: Option<AccountPublicKey>,
    /// The receiver of the value.
    pub receiver: WithdrawReceiver,
    /// The value converted.
    #[cfg_attr(feature = "serde", serde(with = "As::<DisplayFromStr>"))]
    pub value: u64,
}

impl ConvertEvent {
    /// Convert a sender and a withdraw into a conversion event.
    #[must_use]
    pub fn from_withdraw_and_sender(
        sender: Option<AccountPublicKey>,
        withdraw: &Withdraw,
    ) -> Self {
        Self {
            sender,
            receiver: withdraw.receiver,
            value: withdraw.value,
        }
    }
}

/// Event data emitted on a deposit to a contract.
#[derive(Debug, Clone, Archive, PartialEq, Serialize, Deserialize)]
#[archive_attr(derive(CheckBytes))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct DepositEvent {
    /// The originator of the deposit, if it is possible to determine. If the
    /// depositor is using Moonlight this will be available. If they're using
    /// Phoenix it will not.
    pub sender: Option<AccountPublicKey>,
    /// The receiver of the value.
    pub receiver: ContractId,
    /// The value deposited.
    #[cfg_attr(feature = "serde", serde(with = "As::<DisplayFromStr>"))]
    pub value: u64,
}

/// Event data emitted on a transfer from a contract to a contract.
#[derive(Debug, Clone, Archive, PartialEq, Serialize, Deserialize)]
#[archive_attr(derive(CheckBytes))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct ContractToContractEvent {
    /// The sender of the funds.
    pub sender: ContractId,
    /// The receiver of the funds.
    pub receiver: ContractId,
    /// The value transferred.
    #[cfg_attr(feature = "serde", serde(with = "As::<DisplayFromStr>"))]
    pub value: u64,
}

/// Event data emitted on a transfer from a contract to a Moonlight account.
#[derive(Debug, Clone, Archive, PartialEq, Serialize, Deserialize)]
#[archive_attr(derive(CheckBytes))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct ContractToAccountEvent {
    /// The sender of the funds.
    pub sender: ContractId,
    /// The receiver of the funds.
    pub receiver: AccountPublicKey,
    /// The value transferred.
    #[cfg_attr(feature = "serde", serde(with = "As::<DisplayFromStr>"))]
    pub value: u64,
}

/// Event data emitted on a phoenix transaction's completion.
#[derive(Debug, Clone, Archive, PartialEq, Serialize, Deserialize)]
#[archive_attr(derive(CheckBytes))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct PhoenixTransactionEvent {
    /// Nullifiers of the notes spent during the transaction.
    pub nullifiers: Vec<BlsScalar>,
    /// Notes produced during the transaction.
    pub notes: Vec<Note>,
    /// The memo included in the transaction.
    #[cfg_attr(feature = "serde", serde(with = "As::<Hex>"))]
    pub memo: Vec<u8>,
    /// Gas spent by the transaction.
    #[cfg_attr(feature = "serde", serde(with = "As::<DisplayFromStr>"))]
    pub gas_spent: u64,

    /// Optional gas-refund note if the refund is positive.
    pub refund_note: Option<Note>,
}

/// Event data emitted on a moonlight transaction's completion.
#[derive(Debug, Clone, Archive, PartialEq, Serialize, Deserialize)]
#[archive_attr(derive(CheckBytes))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct MoonlightTransactionEvent {
    /// The account that initiated the transaction.
    pub sender: AccountPublicKey,
    /// The receiver of the funds if any were transferred.
    pub receiver: Option<AccountPublicKey>,
    /// Transfer amount
    #[cfg_attr(feature = "serde", serde(with = "As::<DisplayFromStr>"))]
    pub value: u64,
    /// The memo included in the transaction.
    #[cfg_attr(feature = "serde", serde(with = "As::<Hex>"))]
    pub memo: Vec<u8>,
    /// Gas spent by the transaction.
    #[cfg_attr(feature = "serde", serde(with = "As::<DisplayFromStr>"))]
    pub gas_spent: u64,
    /// Optional refund-info in the case that the refund-address is different
    /// from the sender.
    #[cfg_attr(
        feature = "serde",
        serde(with = "As::<Option<(Same, DisplayFromStr)>>")
    )]
    pub refund_info: Option<(AccountPublicKey, u64)>,
}