agglayer-interop-types 0.14.0

agglayer-interop-types contains structs and traits for the interoperability layer of agglayer.
Documentation
use agglayer_primitives::Signature;
use educe::Educe;
use serde::{Deserialize, Serialize};
use sp1_core_executor::SP1RecursionProof;
use sp1_hypercube::SP1PcsProofInner;
use sp1_primitives::SP1GlobalContext;
use sp1_sdk::SP1VerifyingKey;
pub use unified_bridge::AggchainProofPublicValues;

use crate::Digest;

// Aggchain data submitted via the [`Certificate`].
#[derive(Serialize, Deserialize, Clone, Debug)]
#[cfg_attr(feature = "testutils", derive(arbitrary::Arbitrary, Eq, PartialEq))]
#[serde(untagged)]
pub enum AggchainData {
    ECDSA {
        signature: Signature,
    },
    Generic {
        /// proof of the aggchain proof.
        proof: Proof,
        /// Chain-specific commitment forwarded through the PP.
        aggchain_params: Digest,
        /// Signature of the aggchain proof.
        signature: Option<Box<Signature>>,
        /// Optional aggchain proof public values.
        public_values: Option<Box<AggchainProofPublicValues>>,
    },
    MultisigOnly {
        multisig: MultisigPayload,
    },
    MultisigAndAggchainProof {
        multisig: MultisigPayload,
        aggchain_proof: AggchainProof,
    },
}

#[derive(Debug, Deserialize, Serialize, Clone)]
#[cfg_attr(feature = "testutils", derive(arbitrary::Arbitrary, Eq, PartialEq))]
pub struct MultisigPayload(pub Vec<Option<Signature>>);

// Aggchain proof data submitted via the Certificate.
#[derive(Serialize, Deserialize, Clone, Debug)]
#[cfg_attr(feature = "testutils", derive(arbitrary::Arbitrary, Eq, PartialEq))]
pub struct AggchainProof {
    /// proof of the aggchain proof.
    pub proof: Proof,
    /// Chain-specific commitment forwarded through the PP.
    pub aggchain_params: Digest,
    /// Optional aggchain proof public values.
    pub public_values: Option<Box<AggchainProofPublicValues>>,
}

pub type SP1StarkProof = SP1RecursionProof<SP1GlobalContext, SP1PcsProofInner>;

#[derive(Educe, Serialize, Deserialize, Clone)]
#[educe(Debug)]
pub struct SP1StarkWithContext {
    pub proof: Box<SP1StarkProof>,
    #[educe(Debug(ignore))]
    pub vkey: SP1VerifyingKey,
    pub version: String,
}

/// Proof that is part of the aggchain proof submitted via the [`Certificate`].
#[derive(Serialize, Deserialize, Clone, Debug)]
pub enum Proof {
    SP1Stark(SP1StarkWithContext),
}

#[cfg(feature = "testutils")]
impl<'a> arbitrary::Arbitrary<'a> for Proof {
    fn arbitrary(u: &mut arbitrary::Unstructured<'a>) -> arbitrary::Result<Self> {
        use bincode::Options as _;
        let bytes = <&[u8]>::arbitrary(u)?;
        let proof = std::panic::catch_unwind(|| {
            bincode::options()
                .with_limit(bytes.len() as u64)
                .deserialize(bytes)
        })
        .map_err(|_| arbitrary::Error::IncorrectFormat)?
        .map_err(|e| match *e {
            bincode::ErrorKind::SizeLimit => arbitrary::Error::NotEnoughData,
            _ => arbitrary::Error::IncorrectFormat,
        })?;

        let bytes = <&[u8]>::arbitrary(u)?;
        let vkey = std::panic::catch_unwind(|| {
            bincode::options()
                .with_limit(bytes.len() as u64)
                .deserialize(bytes)
        })
        .map_err(|_| arbitrary::Error::IncorrectFormat)?
        .map_err(|e| match *e {
            bincode::ErrorKind::SizeLimit => arbitrary::Error::NotEnoughData,
            _ => arbitrary::Error::IncorrectFormat,
        })?;
        Ok(Proof::SP1Stark(
            crate::aggchain_proof::SP1StarkWithContext {
                proof,
                vkey,
                version: String::arbitrary(u)?,
            },
        ))
    }
}

#[cfg(feature = "testutils")]
impl std::cmp::PartialEq for Proof {
    fn eq(&self, other: &Self) -> bool {
        bincode::serialize(self).unwrap() == bincode::serialize(other).unwrap()
    }
}

#[cfg(feature = "testutils")]
impl std::cmp::Eq for Proof {}

#[cfg(test)]
mod test;