Struct MagicSig

pub struct MagicSig {
    pub ty: MagicSigInfo,
    pub txid: B256,
    pub event_idx: usize,
}

A magic signature, containing information about the host-chain event which caused the rollup transaction to occur.

This is used to “recover” the sender of a transaction that is not actually signed by the sender. This is used for enter events, enter token events, and transact events.

Magic signatures are used for Signet system events to allow the system to “recover” the sender of a transaction that is not actually signed by the sender. This is used for enter events, enter token events, and transact events. These signatures contain the sender, a sentinel, and a type flag, and are used by the RPC and other systems to determine the sender of the “transaction”.

The magic signature format is as follows:

• odd_y_parity: RESERVED (false)
• r: 32-byte txid of the transaction that emitted the event
• s:
  • [0..4]: A 4-byte sentinel value (0xffeeddcc).
  • [4..8]: A 4-bytes BE u32 containing the index of the event in the transaction’s log array.
  • [8..9]: A 1-byte flag (0x01 for enter, 0x02 for enter token, 0x03 for transact).
  • [9..12]: A 3-byte RESERVED region.
  • [12..32]: For transact events, (flag byte 3) the sender’s address. RESERVED otherwise.

Because Ethereum-like chains enforce low-S signatures, the S value of the magic signature is invalid for Ethereum-based chains supporting EIP-2. This means that the magic signature is never a valid signature for any relevant Ethereum-like chain.

Fields

ty: MagicSigInfo

The type of event, with any additional information.

txid: B256

The transaction ID of the host chain transaction that emitted the event.

event_idx: usize

The index of the event in the transaction’s log array.

Implementations

impl MagicSig

pub fn try_from_signature(sig: &Signature) -> Option<Self>

Try to MagicSig from a signature.

pub const fn enter(txid: B256, event_idx: usize) -> Self

Create a new MagicSig for an enter event.

pub const fn enter_token(txid: B256, event_idx: usize) -> Self

Create a new MagicSig for an enter token event.

pub const fn transact(txid: B256, event_idx: usize, sender: Address) -> Self

Create a new MagicSig for a transact event.

pub const fn sender(&self) -> Address

Get the sender of the magic signature.

Trait Implementations

impl Clone for MagicSig

fn clone(&self) -> MagicSig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MagicSig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<MagicSig> for Signature

fn from(value: MagicSig) -> Self

Converts to this type from the input type.

impl Hash for MagicSig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MagicSig

fn cmp(&self, other: &MagicSig) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MagicSig

fn eq(&self, other: &MagicSig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for MagicSig

fn partial_cmp(&self, other: &MagicSig) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for MagicSig

impl Eq for MagicSig

impl StructuralPartialEq for MagicSig