aboutsummaryrefslogtreecommitdiffstats
path: root/contracts/exchange/contracts/src/interfaces/IOrderbook.sol
blob: 74179d8aa4803a7eff56516026284bbf43401582 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/*

  Copyright 2019 DEXON Foundation.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

*/
pragma solidity ^0.4.24;
pragma experimental ABIEncoderV2;

import "@0x/contracts-exchange-libs/contracts/src/LibOrder.sol";
import "@0x/contracts-exchange-libs/contracts/src/LibFillResults.sol";


contract IOrderbook {

    /// @dev Place a limit order into orderbook.
    /// @param order Order struct containing order specifications.
    /// @return Amounts filled and fees paid by maker and taker.
    function placeLimitOrder(
        LibOrder.Order memory order
    )
        public
        returns (LibFillResults.FillResults memory fillResults);

    /// @dev Fill orders in orderbook that match desired specifications.
    ///      But unlike 'placeLimitOrder', remaining amount will not be put into orderbook.
    /// @param order Order struct containing order specifications.
    /// @return Amounts filled and fees paid by maker and taker.
    function placeMarketOrder(
        LibOrder.Order memory order
    )
        public
        returns (LibFillResults.FillResults memory fillResults);

    /// @dev Get a list of valid orders on orderbook of a specific pair.
    /// @param makerAssetData Maker asset data of the pair.
    /// @param takerAssetData Taker asset data of the pair.
    /// @param limit Maximum number of orders to be returned.
    /// @return Orders of the pair, sorted by price.
    function getOrders(
        bytes makerAssetData,
        bytes takerAssetData,
        uint8 limit
    )
        public
        view
        returns (LibOrder.Order[] memory orders);
}