Skip to main content

MessageHeader

Struct MessageHeader 

Source
pub struct MessageHeader {
    pub version: u32,
    pub source_domain: DomainId,
    pub destination_domain: DomainId,
    pub nonce: FixedBytes<32>,
    pub sender: FixedBytes<32>,
    pub recipient: FixedBytes<32>,
    pub destination_caller: FixedBytes<32>,
    pub min_finality_threshold: u32,
    pub finality_threshold_executed: u32,
}
Expand description

CCTP v2 Message Header

The message header contains metadata about cross-chain messages, including source/destination domains, finality requirements, and routing.

§Format

  • version: uint32 (4 bytes)
  • sourceDomain: uint32 (4 bytes)
  • destinationDomain: uint32 (4 bytes)
  • nonce: bytes32 (32 bytes) - unique identifier assigned by Circle
  • sender: bytes32 (32 bytes) - message sender address
  • recipient: bytes32 (32 bytes) - message recipient address
  • destinationCaller: bytes32 (32 bytes) - authorized caller on destination
  • minFinalityThreshold: uint32 (4 bytes) - minimum required finality
  • finalityThresholdExecuted: uint32 (4 bytes) - actual finality level

Total fixed size: 4 + 4 + 4 + 32 + 32 + 32 + 32 + 4 + 4 = 148 bytes

Fields§

§version: u32

Message format version

§source_domain: DomainId

Source blockchain domain ID

§destination_domain: DomainId

Destination blockchain domain ID

§nonce: FixedBytes<32>

Unique message nonce assigned by Circle

§sender: FixedBytes<32>

Address that sent the message (padded to 32 bytes)

§recipient: FixedBytes<32>

Address that will receive the message (padded to 32 bytes)

§destination_caller: FixedBytes<32>

Address authorized to call receiveMessage on destination (0 = anyone)

§min_finality_threshold: u32

Minimum finality threshold required (1000 = Fast, 2000 = Standard)

§finality_threshold_executed: u32

Actual finality threshold when message was attested

Implementations§

Source§

impl MessageHeader

Source

pub const SIZE: usize = 148

Size of the message header in bytes

Source

pub fn new( version: u32, source_domain: DomainId, destination_domain: DomainId, nonce: FixedBytes<32>, sender: FixedBytes<32>, recipient: FixedBytes<32>, destination_caller: FixedBytes<32>, min_finality_threshold: u32, finality_threshold_executed: u32, ) -> Self

Creates a new message header

Source

pub fn encode(&self) -> Bytes

Encodes the message header to bytes

The encoding follows Circle’s v2 message format specification.

Source

pub fn decode(bytes: &[u8]) -> Option<Self>

Decodes a message header from bytes

Returns None if the bytes are not at least MessageHeader::SIZE bytes long or if domain IDs are invalid.

Source

pub fn parse(bytes: &[u8]) -> Result<Self, ParseMessageError>

Parses a message header and returns a descriptive error on failure.

Source

pub fn has_placeholder_nonce(&self) -> bool

Returns true when the nonce is still the placeholder zero value from the on-chain event.

Source

pub fn sender_address(&self) -> Address

Returns the EVM sender address encoded in the 32-byte sender field.

This helper assumes the source domain uses the EVM trailing-20-byte convention for bytes32 addresses. For non-EVM domains, the raw Self::sender field is authoritative.

Source

pub fn recipient_address(&self) -> Address

Returns the EVM recipient address encoded in the 32-byte recipient field.

This helper assumes the destination domain uses the EVM trailing-20-byte convention for bytes32 addresses. For non-EVM domains, the raw Self::recipient field is authoritative.

Source

pub fn destination_caller_address(&self) -> Option<Address>

Returns the destination caller as an EVM address if the message is not permissionless.

This helper assumes the destination domain uses the EVM trailing-20-byte convention for bytes32 addresses. For non-EVM domains, the raw Self::destination_caller field is authoritative.

Source

pub fn is_permissionless(&self) -> bool

Returns true when the message can be relayed by anyone.

Source

pub fn requested_finality(&self) -> Option<FinalityThreshold>

Returns the requested finality threshold when it matches a known CCTP mode.

Source

pub fn attested_finality(&self) -> Option<FinalityThreshold>

Returns the finality threshold that Circle actually used for the attestation.

Trait Implementations§

Source§

impl Clone for MessageHeader

Source§

fn clone(&self) -> MessageHeader

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MessageHeader

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for MessageHeader

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for MessageHeader

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for MessageHeader

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for MessageHeader

Source§

impl StructuralPartialEq for MessageHeader

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<'de, T> BorrowedRpcObject<'de> for T
where T: RpcBorrow<'de> + RpcSend,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<'de, T> RpcBorrow<'de> for T
where T: Deserialize<'de> + Debug + Send + Sync + Unpin,

Source§

impl<T> RpcObject for T
where T: RpcSend + RpcRecv,

Source§

impl<T> RpcRecv for T
where T: DeserializeOwned + Debug + Send + Sync + Unpin + 'static,

Source§

impl<T> RpcSend for T
where T: Serialize + Clone + Debug + Send + Sync + Unpin,