Struct Metadata 

pub struct Metadata {

    pub referrer: Option<Referrer>,
    pub utm: Option<Utm>,
    pub quote: Option<Quote>,
    pub order_class: Option<OrderClass>,
    pub hooks: Option<OrderInteractionHooks>,
    pub widget: Option<Widget>,
    pub partner_fee: Option<PartnerFee>,
    pub replaced_order: Option<ReplacedOrder>,
    pub signer: Option<String>,
    pub bridging: Option<Bridging>,
    pub flashloan: Option<Flashloan>,
    pub wrappers: Option<Vec<WrapperEntry>>,
    pub user_consents: Option<Vec<UserConsent>>,
}

Metadata container — all fields are optional.

Each field corresponds to a section of the CoW Protocol app-data schema. Fields are serialised only when Some (via #[serde(skip_serializing_if = "Option::is_none")]), keeping the JSON compact.

Use the builder methods (with_*) to populate fields, or the has_* predicates to check which fields are set.

Example

use cow_app_data::{Metadata, Quote, Referrer};

let meta = Metadata::default()
    .with_referrer(Referrer::code("COWRS-PARTNER"))
    .with_quote(Quote::new(50));

assert!(meta.has_referrer());
assert!(meta.has_quote());
assert!(!meta.has_hooks());

Fields

referrer: Option<Referrer>

Referrer address for partner attribution.

utm: Option<Utm>

UTM tracking parameters.

quote: Option<Quote>

Quote-level slippage settings.

order_class: Option<OrderClass>

Classification of the order intent.

hooks: Option<OrderInteractionHooks>

Pre- and post-interaction hooks.

widget: Option<Widget>

Widget metadata when the order originates from a widget integration.

partner_fee: Option<PartnerFee>

Protocol fee charged by an integration partner.

replaced_order: Option<ReplacedOrder>

UID of a previous order that this order replaces.

signer: Option<String>

Signer wallet address (for EIP-1271 or other non-EOA signers).

bridging: Option<Bridging>

Cross-chain bridging metadata (if the order used a bridge).

flashloan: Option<Flashloan>

Flash loan metadata (if the order used a flash loan).

wrappers: Option<Vec<WrapperEntry>>

Token wrapper entries applied during execution.

user_consents: Option<Vec<UserConsent>>

User consent records attached to this order.

Implementations

impl Metadata

pub fn with_referrer(self, referrer: Referrer) -> Metadata

Set the Referrer address for partner attribution.

Parameters

• referrer — the Referrer containing the partner address.

Returns

self with referrer set.

pub fn with_utm(self, utm: Utm) -> Metadata

Set the Utm campaign tracking parameters.

Parameters

• utm — the Utm parameters (source, medium, campaign, …).

Returns

self with utm set.

pub const fn with_quote(self, quote: Quote) -> Metadata

Set the quote-level slippage settings.

Parameters

• quote — the Quote containing the slippage tolerance in basis points and optional smart-slippage flag.

Returns

self with quote set.

pub const fn with_order_class(self, order_class: OrderClass) -> Metadata

Set the order class classification.

Parameters

• order_class — the OrderClass wrapping an OrderClassKind.

Returns

self with order_class set.

pub fn with_hooks(self, hooks: OrderInteractionHooks) -> Metadata

Set the pre- and post-settlement interaction hooks.

Parameters

• hooks — the OrderInteractionHooks containing pre/post lists.

Returns

self with hooks set.

pub fn with_widget(self, widget: Widget) -> Metadata

Set the widget integration metadata.

Parameters

• widget — the Widget identifying the widget host.

Returns

self with widget set.

pub fn with_partner_fee(self, fee: PartnerFee) -> Metadata

Set the partner fee policy.

Parameters

• fee — the PartnerFee (single or multi-entry).

Returns

self with partner_fee set.

pub fn with_replaced_order(self, order: ReplacedOrder) -> Metadata

Set the replaced-order reference.

Parameters

• order — the ReplacedOrder containing the UID of the order being superseded.

Returns

self with replaced_order set.

pub fn with_signer(self, signer: impl Into<String>) -> Metadata

Set the signer address override for smart-contract wallets.

Parameters

• signer — 0x-prefixed Ethereum address of the signing contract.

Returns

self with signer set.

pub fn with_bridging(self, bridging: Bridging) -> Metadata

Set the cross-chain Bridging metadata.

Parameters

• bridging — the Bridging record.

Returns

self with bridging set.

pub fn with_flashloan(self, flashloan: Flashloan) -> Metadata

Set the Flashloan execution metadata.

Parameters

• flashloan — the Flashloan record.

Returns

self with flashloan set.

pub fn with_wrappers(self, wrappers: Vec<WrapperEntry>) -> Metadata

Set the token WrapperEntry records.

Parameters

• wrappers — list of wrapper entries applied during execution.

Returns

self with wrappers set.

pub fn with_user_consents(self, consents: Vec<UserConsent>) -> Metadata

Set the UserConsent records for terms of service acceptance.

Parameters

• consents — list of consent records.

Returns

self with user_consents set.

pub const fn has_referrer(&self) -> bool

Returns true if a referrer tracking code is set.

pub const fn has_utm(&self) -> bool

Returns true if UTM campaign parameters are set.

pub const fn has_quote(&self) -> bool

Returns true if quote-level slippage settings are set.

pub const fn has_order_class(&self) -> bool

Returns true if an order class classification is set.

pub const fn has_hooks(&self) -> bool

Returns true if pre/post interaction hooks are set.

pub const fn has_widget(&self) -> bool

Returns true if widget integration metadata is set.

pub const fn has_partner_fee(&self) -> bool

Returns true if a partner fee is set.

pub const fn has_replaced_order(&self) -> bool

Returns true if a replaced-order reference is set.

pub const fn has_signer(&self) -> bool

Returns true if a signer address override is set.

pub const fn has_bridging(&self) -> bool

Returns true if cross-chain bridging metadata is set.

pub const fn has_flashloan(&self) -> bool

Returns true if flash loan metadata is set.

pub fn has_wrappers(&self) -> bool

Returns true if at least one token wrapper entry is set.

pub fn has_user_consents(&self) -> bool

Returns true if at least one user consent record is set.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl Default for Metadata

fn default() -> Metadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Metadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Metadata

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

Formats the value using the given formatter.

impl Serialize for Metadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.