Struct SettlementEncoder 

pub struct SettlementEncoder { /* private fields */ }

Orchestrates building a complete GPv2Settlement.settle() calldata payload.

Collects tokens, clearing prices, trades, and interactions, then ABI-encodes everything into the format expected by the settlement contract’s settle function.

Example

use alloy_primitives::{Address, B256, Bytes, U256, address};
use cow_rs::{
    OrderKind, SigningScheme, TokenBalance,
    order_signing::{trade::SignatureData, types::UnsignedOrder},
    settlement::encoder::{InteractionStage, SettlementEncoder},
};

let mut encoder = SettlementEncoder::new();

let sell = address!("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa");
let buy = address!("bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb");

let sell_idx = encoder.add_token(sell);
let buy_idx = encoder.add_token(buy);

encoder.set_clearing_price(sell_idx, U256::from(1000));
encoder.set_clearing_price(buy_idx, U256::from(900));

assert_eq!(encoder.token_count(), 2);
// Encoder with only tokens/prices but no trades is still "empty".
assert!(encoder.is_empty());

Implementations

impl SettlementEncoder

pub fn new() -> Self

Create a new empty settlement encoder.

Returns

An empty SettlementEncoder with no tokens, trades, or interactions.

pub fn add_token(&mut self, token: Address) -> usize

Register a token in the settlement and return its index.

If the token is already registered, its existing index is returned. New tokens also get a default clearing price of zero.

Arguments

• token - The token Address to register.

Returns

The zero-based index of the token in the settlement.

pub fn set_clearing_price(&mut self, token_index: usize, price: U256)

Set the clearing price for a token at the given index.

The clearing price array is extended with zeros if needed to accommodate the index.

Arguments

• token_index - The zero-based index of the token.
• price - The clearing price as U256.

pub fn add_trade( &mut self, order: &UnsignedOrder, signature: &SignatureData, executed_amount: U256, )

Encode and append a trade to the settlement.

The order’s sell and buy tokens are automatically registered in the token registry if not already present.

Arguments

• order - The unsigned order to encode.
• signature - The signature data (scheme + bytes).
• executed_amount - The amount already executed for this trade.

pub fn add_interaction( &mut self, stage: InteractionStage, target: Address, value: U256, calldata: Vec<u8>, )

Add an interaction to the specified stage.

Arguments

• stage - When the interaction should execute (InteractionStage).
• target - The contract Address to call.
• value - ETH value to send with the call (in wei).
• calldata - ABI-encoded calldata for the interaction.

pub fn encode_settlement(&self) -> Vec<u8>

ABI-encode the full settle(tokens[], clearingPrices[], trades[], interactions[][]) calldata.

Produces the calldata for the GPv2Settlement.settle() function, including the 4-byte function selector.

Returns

The complete ABI-encoded calldata as a Vec<u8>.

pub fn token_count(&self) -> usize

Return the number of registered tokens.

Returns

The count of unique tokens in the settlement.

pub const fn trade_count(&self) -> usize

Return the number of trades in the settlement.

Returns

The count of encoded trades.

pub const fn interaction_count(&self, stage: InteractionStage) -> usize

Return the number of interactions for a given stage.

Arguments

• stage - The interaction stage to count.

Returns

The count of interactions in the specified stage.

pub fn is_empty(&self) -> bool

Check whether the encoder contains any trades or interactions.

Returns

true if there are no trades and no interactions in any stage.

pub fn clear(&mut self)

Reset the encoder, removing all tokens, prices, trades, and interactions.

Trait Implementations

impl Clone for SettlementEncoder

fn clone(&self) -> SettlementEncoder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SettlementEncoder

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

Formats the value using the given formatter.

impl Default for SettlementEncoder

fn default() -> Self

Returns the “default value” for a type.