Struct AppDataDoc 

pub struct AppDataDoc {
    pub version: String,
    pub app_code: Option<String>,
    pub environment: Option<String>,
    pub metadata: Metadata,
}

Root document for CoW Protocol order app-data (schema v1.14.0).

Every CoW Protocol order carries a 32-byte appData field that commits to a JSON document describing the order’s intent, referral, hooks, and more. AppDataDoc is the Rust representation of that JSON document.

Serialise this struct to canonical JSON with appdata_hex to obtain the keccak256 hash used on-chain, or use get_app_data_info to derive the hash, CID, and canonical JSON in one call.

Use the builder methods (with_*) to attach optional metadata:

Example

use cow_app_data::{AppDataDoc, OrderClassKind, Quote, Referrer};

let doc = AppDataDoc::new("MyDApp")
    .with_environment("production")
    .with_referrer(Referrer::code("COWRS-PARTNER"))
    .with_order_class(OrderClassKind::Limit);

assert_eq!(doc.app_code.as_deref(), Some("MyDApp"));
assert_eq!(doc.environment.as_deref(), Some("production"));
assert!(doc.metadata.has_referrer());
assert!(doc.metadata.has_order_class());

Fields

version: String

Schema version, e.g. "1.14.0".

app_code: Option<String>

Application identifier, e.g. "CoW Swap" or your app name.

environment: Option<String>

Deployment environment, e.g. "production".

metadata: Metadata

Structured metadata attached to the order.

Implementations

impl AppDataDoc

pub fn new(app_code: impl Into<String>) -> Self

Create a minimal AppDataDoc with the given app_code and no extra metadata.

Sets version to LATEST_APP_DATA_VERSION, app_code to the provided value, and metadata to its Default (all fields None).

Parameters

• app_code — application identifier (e.g. "CoW Swap", "MyDApp"). Must be ≤ 50 characters to pass validation.

Returns

A new AppDataDoc ready to be hashed or further customised with the with_* builder methods.

Example

use cow_app_data::AppDataDoc;

let doc = AppDataDoc::new("MyDApp");
assert_eq!(doc.app_code.as_deref(), Some("MyDApp"));
assert_eq!(doc.version, "1.14.0");
assert!(!doc.metadata.has_referrer());

pub fn with_environment(self, env: impl Into<String>) -> Self

Set the deployment environment (e.g. "production", "staging").

The environment string is included in the canonical JSON and therefore affects the keccak256 hash. Use it to distinguish orders from different deployment stages.

Parameters

• env — free-form environment label.

Returns

self with environment set.

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

Attach a Referrer address for partner attribution.

The referrer’s Ethereum address is embedded in the order’s app-data so the protocol can attribute volume to integration partners.

Parameters

• referrer — the Referrer containing the partner address.

Returns

self with metadata.referrer set.

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

Attach Utm campaign tracking parameters.

UTM parameters (source, medium, campaign, content, term) let analytics pipelines attribute order volume to marketing campaigns.

Parameters

• utm — the Utm tracking parameters.

Returns

self with metadata.utm set.

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

Attach pre- and/or post-settlement interaction hooks.

Hooks are arbitrary contract calls the settlement contract executes before (pre) or after (post) the trade. See CowHook for details on individual hook entries.

Parameters

• hooks — the OrderInteractionHooks containing pre/post lists.

Returns

self with metadata.hooks set.

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

Attach a PartnerFee policy to this order.

Partner fees are charged by integration partners as a percentage of the trade. Each fee entry specifies a basis-point rate and a recipient address.

Parameters

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

Returns

self with metadata.partner_fee set.

Example

use cow_app_data::{AppDataDoc, PartnerFee, PartnerFeeEntry};

let doc = AppDataDoc::new("MyDApp")
    .with_partner_fee(PartnerFee::single(PartnerFeeEntry::volume(50, "0xRecipient")));
assert!(doc.metadata.has_partner_fee());

pub fn with_replaced_order(self, uid: impl Into<String>) -> Self

Mark this order as replacing a previously submitted order.

The protocol uses this to link replacement orders for analytics and to avoid double-fills.

Parameters

• uid — the 0x-prefixed order UID of the order being replaced (56 bytes = 0x + 112 hex chars).

Returns

self with metadata.replaced_order set.

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

Attach the signer address for EIP-1271 or other smart-contract signers.

When the order is signed by a smart contract (not an EOA), this field records the contract address that will validate the signature on-chain.

Parameters

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

Returns

self with metadata.signer set.

pub const fn with_order_class(self, kind: OrderClassKind) -> Self

Set the order class kind (market, limit, liquidity, or twap).

Solvers and the protocol UI use this to decide execution strategy and display. See OrderClassKind for the available variants.

Parameters

• kind — the OrderClassKind variant.

Returns

self with metadata.order_class set.

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

Attach cross-chain Bridging metadata.

Records which bridge provider was used, the destination chain, and the destination token address so solvers and analytics can trace cross-chain flows.

Parameters

• bridging — the Bridging record.

Returns

self with metadata.bridging set.

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

Attach Flashloan execution metadata.

Records the flash-loan parameters (amount, provider, token, adapter, receiver) so the settlement contract and solvers can reconstruct the flash-loan flow.

Parameters

• flashloan — the Flashloan record.

Returns

self with metadata.flashloan set.

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

Attach token WrapperEntry records.

Wrapper entries describe token wrapping/unwrapping operations applied during order execution (e.g. WETH ↔ ETH).

Parameters

• wrappers — list of WrapperEntry records.

Returns

self with metadata.wrappers set.

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

Attach UserConsent records for terms of service acceptance.

Parameters

• consents — list of UserConsent records.

Returns

self with metadata.user_consents set.

Trait Implementations

impl Clone for AppDataDoc

fn clone(&self) -> AppDataDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AppDataDoc

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

Formats the value using the given formatter.

impl Default for AppDataDoc

fn default() -> AppDataDoc

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AppDataDoc

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AppDataDoc

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

Formats the value using the given formatter.

impl Serialize for AppDataDoc

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

where __S: Serializer,

Serialize this value into the given Serde serializer.