Struct OrderQuoteRequest 

pub struct OrderQuoteRequest {
    pub sell_token: Address,
    pub buy_token: Address,
    pub receiver: Option<Address>,
    pub valid_to: Option<u32>,
    pub app_data: String,
    pub partially_fillable: bool,
    pub sell_token_balance: TokenBalance,
    pub buy_token_balance: TokenBalance,
    pub from: Address,
    pub price_quality: PriceQuality,
    pub signing_scheme: EcdsaSigningScheme,
    pub side: QuoteSide,
}

Request body for POST /api/v1/quote.

Fields

sell_token: Address

Token to sell.

buy_token: Address

Token to buy.

receiver: Option<Address>

Who receives the buyToken (defaults to from).

valid_to: Option<u32>

Order expiry as Unix timestamp. Omit to use DEFAULT_QUOTE_VALIDITY.

app_data: String

bytes32 keccak256 of the app-data JSON, or the JSON itself.

partially_fillable: bool

Whether the order may be partially filled.

sell_token_balance: TokenBalance

Source of sellToken funds.

buy_token_balance: TokenBalance

Destination of buyToken funds.

from: Address

Address placing the order.

price_quality: PriceQuality

Price quality hint.

signing_scheme: EcdsaSigningScheme

Signing scheme to use when submitting this order.

side: QuoteSide

Direction and amount — must contain exactly one variant.

Implementations

impl OrderQuoteRequest

pub fn new( sell_token: Address, buy_token: Address, from: Address, side: QuoteSide, ) -> OrderQuoteRequest

Construct a minimal quote request with sensible defaults.

Defaults: app_data = zero bytes32 hash, token balances = TokenBalance::Erc20, price_quality = PriceQuality::Optimal, signing_scheme = EcdsaSigningScheme::Eip712, partially_fillable = false.

Use the with_* builder methods to override individual fields.

Parameters

• sell_token — the ERC-20 Address to sell.
• buy_token — the ERC-20 Address to buy.
• from — the wallet Address placing the order.
• side — the QuoteSide specifying direction and amount.

Returns

A new OrderQuoteRequest ready to be sent to OrderBookApi::get_quote.

pub const fn with_receiver(self, receiver: Address) -> OrderQuoteRequest

Override the receiver address (defaults to from).

pub const fn with_valid_to(self, valid_to: u32) -> OrderQuoteRequest

Set an explicit validTo Unix timestamp.

pub fn with_app_data(self, app_data: impl Into<String>) -> OrderQuoteRequest

Override the bytes32 app-data hash.

pub const fn with_partially_fillable(self) -> OrderQuoteRequest

Allow partial fills.

pub const fn with_price_quality( self, quality: PriceQuality, ) -> OrderQuoteRequest

Override the price quality hint.

pub const fn with_sell_token_balance( self, balance: TokenBalance, ) -> OrderQuoteRequest

Override the source of sellToken funds.

pub const fn with_buy_token_balance( self, balance: TokenBalance, ) -> OrderQuoteRequest

Override the destination of buyToken funds.

pub const fn with_signing_scheme( self, scheme: EcdsaSigningScheme, ) -> OrderQuoteRequest

Override the signing scheme.

pub const fn has_receiver(&self) -> bool

Returns true if a custom receiver address has been set.

When false, the protocol defaults the receiver to from.

pub const fn has_valid_to(&self) -> bool

Returns true if an explicit validTo Unix timestamp has been set.

pub const fn is_sell(&self) -> bool

Returns true if this is a sell-side quote request.

use alloy_primitives::Address;
use cow_orderbook::{OrderQuoteRequest, QuoteSide};

let req = OrderQuoteRequest::new(
    Address::ZERO,
    Address::ZERO,
    Address::ZERO,
    QuoteSide::sell("1000"),
);
assert!(req.is_sell());
assert!(!req.is_buy());

pub const fn is_buy(&self) -> bool

Returns true if this is a buy-side quote request.

use alloy_primitives::Address;
use cow_orderbook::{OrderQuoteRequest, QuoteSide};

let req =
    OrderQuoteRequest::new(Address::ZERO, Address::ZERO, Address::ZERO, QuoteSide::buy("500"));
assert!(req.is_buy());
assert!(!req.is_sell());

pub const fn is_partially_fillable(&self) -> bool

Returns true if the order may be partially filled.

use alloy_primitives::Address;
use cow_orderbook::{OrderQuoteRequest, QuoteSide};

let req = OrderQuoteRequest::new(
    Address::ZERO,
    Address::ZERO,
    Address::ZERO,
    QuoteSide::sell("1000"),
);
assert!(!req.is_partially_fillable());
let req = req.with_partially_fillable();
assert!(req.is_partially_fillable());

Trait Implementations

impl Clone for OrderQuoteRequest

fn clone(&self) -> OrderQuoteRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderQuoteRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OrderQuoteRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OrderQuoteRequest

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

Formats the value using the given formatter.

impl Serialize for OrderQuoteRequest

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.