Interface

fulfillBasicOrder

Fulfill an order that offers ether (the native token for the given chain) or ERC20 to ERC721/ERC1155 or ERC721/ERC1155 to ERC20. An arbitrary number of "additional recipients" may also be supplied which will each receive native tokens from the fulfiller as consideration.

function fulfillBasicOrder(struct BasicOrderParameters parameters) 
  external payable returns (bool fulfilled)

fulfillOrder

Fulfill an order with an arbitrary number of items for offer and consideration. Note that this function does not support criteria-based orders or partial filling of orders (though filling the remainder of a partially-filled order is supported).

function fulfillOrder(struct Order order, bytes32 fulfillerConduitKey) 
  external payable returns (bool fulfilled)

fulfillAdvancedOrder

Fill an order, fully or partially, with an arbitrary number of items for offer and consideration alongside criteria resolvers containing specific token identifiers and associated proofs.

function fulfillAdvancedOrder(
  struct AdvancedOrder advancedOrder, 
  struct CriteriaResolver[] criteriaResolvers, 
  bytes32 fulfillerConduitKey, 
  address recipient) 
external payable returns (bool fulfilled)

fulfillAvailableOrders

Attempt to fill a group of orders, each with an arbitrary number of items for offer and consideration. Any order that is not currently active, has already been fully filled, or has been cancelled will be omitted. Remaining offer and consideration items will then be aggregated where possible as indicated by the supplied offer and consideration component arrays and aggregated items will be transferred to the fulfiller or to each intended recipient, respectively. Note that a failing item transfer or an issue with order formatting will cause the entire batch to fail. Note that this function does not support criteria-based orders or partial filling of orders (though filling the remainder of a partially-filled order is supported).

function fulfillAvailableOrders(struct Order[] orders, struct FulfillmentComponent[][] offerFulfillments, struct FulfillmentComponent[][] considerationFulfillments, bytes32 fulfillerConduitKey, uint256 maximumFulfilled) external payable returns (bool[] availableOrders, struct Execution[] executions)

fulfillAvailableAdvancedOrders

Attempt to fill a group of orders, fully or partially, with an arbitrary number of items for offer and consideration per order alongside criteria resolvers containing specific token identifiers and associated proofs. Any order that is not currently active, has already been fully filled, or has been cancelled will be omitted. Remaining offer and consideration items will then be aggregated where possible as indicated by the supplied offer and consideration component arrays and aggregated items will be transferred to the fulfiller or to each intended recipient, respectively. Note that a failing item transfer or an issue with order formatting will cause the entire batch to fail.

function fulfillAvailableAdvancedOrders(
  struct AdvancedOrder[] advancedOrders, 
  struct CriteriaResolver[] criteriaResolvers, 
  struct FulfillmentComponent[][] offerFulfillments, 
  struct FulfillmentComponent[][] considerationFulfillments, 
  bytes32 fulfillerConduitKey, 
  address recipient, 
  uint256 maximumFulfilled) 
  external payable returns (bool[] availableOrders, struct Execution[] executions)

matchOrders

Match an arbitrary number of orders, each with an arbitrary number of items for offer and consideration along with a set of fulfillments allocating offer components to consideration components. Note that this function does not support criteria-based or partial filling of orders (though filling the remainder of a partially-filled order is supported).

function matchOrders(
  struct Order[] orders, 
  struct Fulfillment[] fulfillments) 
 external payable returns (struct Execution[] executions)

matchAdvancedOrders

Match an arbitrary number of full or partial orders, each with an arbitrary number of items for offer and consideration, supplying criteria resolvers containing specific token identifiers and associated proofs as well as fulfillments allocating offer components to consideration components.

function matchAdvancedOrders(
  struct AdvancedOrder[] orders, 
  struct CriteriaResolver[] criteriaResolvers, 
  struct Fulfillment[] fulfillments, 
  address recipient) 
 external payable returns (struct Execution[] executions)

cancel

Cancel an arbitrary number of orders. Note that only the offerer or the zone of a given order may cancel it. Callers should ensure that the intended order was cancelled by calling getOrderStatus and confirming that isCancelled returns true.

function cancel(struct OrderComponents[] orders) external returns (bool cancelled)

validate

Validate an arbitrary number of orders, thereby registering their signatures as valid and allowing the fulfiller to skip signature verification on fulfillment. Note that validated orders may still be unfulfillable due to invalid item amounts or other factors; callers should determine whether validated orders are fulfillable by simulating the fulfillment call prior to execution. Also note that anyone can validate a signed order, but only the offerer can validate an order without supplying a signature.

function validate(struct Order[] orders) external returns (bool validated)

incrementCounter

Cancel all orders from a given offerer with a given zone in bulk by incrementing a counter. Note that only the offerer may increment the counter.

function incrementCounter() external returns (uint256 newCounter)

getOrderHash

Retrieve the order hash for a given order.

function getOrderHash(struct OrderComponents order) external view returns (bytes32 orderHash)

getOrderStatus

Retrieve the status of a given order by hash, including whether the order has been cancelled or validated and the fraction of the order that has been filled.

function getOrderStatus(bytes32 orderHash) external view returns (bool isValidated, bool isCancelled, uint256 totalFilled, uint256 totalSize)

getCounter

Retrieve the current counter for a given offerer.

function getCounter(address offerer) external view returns (uint256 counter)

information

Retrieve configuration information for this contract.

function information() external view returns (string version, bytes32 domainSeparator, address conduitController)

name

function name() external view returns (string contractName)

Retrieve the name of this contract.