For the complete documentation index, see llms.txt. This page is also available as Markdown.

Order

Git Source

Title: Order

A user's intent to trade tokens with price defined as a delta to the mid price.

struct Order {
address owner;
address sellToken;
address buyToken;
uint256 sellAmount;
uint256 minBuyAmount;
uint32 maxGas;
uint32 startMidPriceDelta;
uint32 endMidPriceDelta;
uint32 startTime;
uint32 endTime;
uint64 createdTimestamp;
bool partialFill;
bytes callData;
address callDataTarget;
AllowanceParams allowanceParams;
bytes32 salt;
}

Properties

Name
Type
Description

owner

address

The address that originally created the order and holds the sellToken amount

sellToken

address

The token to be sold

buyToken

address

The token to be bought

sellAmount

uint256

The amount of sellToken to be sold

minBuyAmount

uint256

The minimum amount of buyToken to be bought

maxGas

uint32

The maximum amount of gas to be used for the order

startMidPriceDelta

uint32

The minimum delta to the mid price (units are basis points)

endMidPriceDelta

uint32

The maximum delta to the mid price (units are basis points)

startTime

uint32

The block timestamp at which the order became active

endTime

uint32

The block timestamp at which the order expires

createdTimestamp

uint64

The timestamp at which the order was added to the orderbook

partialFill

bool

Whether the order can be partially filled

callData

bytes

The calldata for the order, allows for custom routing

callDataTarget

address

allowanceParams

AllowanceParams

The permit signature and permit data for the order

salt

bytes32

Used to differentiate between orders with the same parameters

Last updated

Was this helpful?