Struct AggregateFills 

pub struct AggregateFills { /* private fields */ }

The aggregate fills, to be populated via block extracts. Generally used to hold a running total of fills for a given user and asset across a block or set of transactions.

We use the following terminology:

• Add: push outputs from RollupOrders::Filled into the context. Self::add_fill is called when the filler transfers assets to the recipient specified in an order.
• Remove: pull outputs from RollupOrders::Order from the context. These are called when an order event is emitted by the rollup orders contract. All Orders should be aggregated into a single AggregateOrders before calling Self::checked_remove_aggregate or Self::unchecked_remove_aggregate.

Example

let mut context = AggregateFills::default();
// The first argument is the chain ID of the chain that emitted the event
// in this case, Ethereum.
context.add_fill(1, &fill);
context.checked_remove_order(&order)?;

Implementations

impl AggregateFills

pub fn new() -> Self

Create a new aggregate.

pub fn filled(&self, output_asset: &(u64, Address), recipient: Address) -> U256

Get the fill balance a specific asset for a specific user.

pub fn check_filled( &self, output_asset: &(u64, Address), recipient: Address, amount: U256, ) -> Result<(), MarketError>

Check if the context has enough filled for the asset, recipient, and amount.

pub fn add_raw_fill( &mut self, chain_id: u64, asset: Address, recipient: Address, amount: U256, )

Add an unstructured fill to the context. The chain_id is the ID of of the chain on which the fill occurred.

pub fn add_fill(&mut self, chain_id: u64, fill: &Filled)

Ingest a new fill into the aggregate. The chain_id is the ID of the chain which emitted the event.

Note:

This uses saturating arithmetic to avoid panics. If filling more than U256::MAX, re-examine life choices and don’t do that.

pub fn add_signed_fill(&mut self, chain_id: u64, fill: &SignedFill)

Ingest a SignedFill into the aggregate. The chain_id is the ID of the chain which emitted the event.

Note:

This uses saturating arithmetic to avoid panics. If filling more than U256::MAX, re-examine life choices and don’t do that.

pub fn absorb(&mut self, other: &Self)

Absorb the fills from another context.

pub fn unchecked_unabsorb(&mut self, other: &Self) -> Result<(), MarketError>

Unabsorb the fills from another context.

pub fn check_aggregate( &self, aggregate: &AggregateOrders, ) -> Result<(), MarketError>

Check that the context can remove the aggregate.

pub fn unchecked_remove_aggregate( &mut self, aggregate: &AggregateOrders, ) -> Result<(), MarketError>

Take the aggregate of some orders from the context, without checking in advance whether the context has sufficient fills to remove the aggregate. If the context does not have sufficient fills, the context will be left in a bad state after returning an error.

pub fn checked_remove_aggregate( &mut self, aggregate: &AggregateOrders, ) -> Result<(), MarketError>

Remove the aggregate of some orders from the context, checking in advance that the context has sufficient fills to remove the aggregate.

pub fn check_order(&self, order: &Order) -> Result<(), MarketError>

Check that the context can take the order.

pub fn checked_remove_order(&mut self, order: &Order) -> Result<(), MarketError>

Take the order from the context, checking in advance that the context has sufficient fills to remove the order.

pub fn unchecked_remove_order( &mut self, order: &Order, ) -> Result<(), MarketError>

Take the order from the context, without checking in advance that the context has sufficient fills to remove the order. If the context does not have sufficient fills, the context will be left in a bad state after returning an error.

pub const fn fills(&self) -> &HashMap<(u64, Address), HashMap<Address, U256>>

Borrow the current fill mapping.

pub const fn fills_mut( &mut self, ) -> &mut HashMap<(u64, Address), HashMap<Address, U256>>

Mutably borrow the current fill mapping

pub fn check_ru_tx_events( &self, fills: &AggregateFills, orders: &AggregateOrders, ) -> Result<(), MarketError>

Check the events emitted by a rollup transaction against the context.

This will process all fills first, and all orders second.

pub fn checked_remove_ru_tx_events( &mut self, fills: &AggregateFills, orders: &AggregateOrders, ) -> Result<(), MarketError>

Check and remove the events emitted by a rollup transaction. This function allows atomic ingestion of multiple Fills and Orders. If the check fails, the aggregate will not be mutated.

This will process all fills first, and all orders second.

pub fn unchecked_remove_ru_tx_events( &mut self, fills: &AggregateFills, orders: &AggregateOrders, ) -> Result<(), MarketError>

Check and remove the events emitted by a rollup transaction. This function allows atomic ingestion of multiple Fills and Orders. If the check fails, the aggregate may be mutated.

Trait Implementations

impl Clone for AggregateFills

fn clone(&self) -> AggregateFills

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AggregateFills

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

Formats the value using the given formatter.

impl Default for AggregateFills

fn default() -> AggregateFills

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AggregateFills

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AggregateFills

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for AggregateFills

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AggregateFills

impl StructuralPartialEq for AggregateFills