feat(rpc): add owner parameter for listorders

This commit adds an optional `owner` parameter for the `listorders` command while removing `include_own_orders_parmeter` and replacing its functionality.
The default value for the new parameter is `Both`, other options are `Own` and `Peer`.

The commit also fixes a bug that caused a situation where sell orders were displayed instead of buy orders when the limit was set.

Closes #1323

lib/cli/commands/listorders.ts

@@ -4,6 +4,7 @@ import { ListOrdersRequest, ListOrdersResponse, Order } from '../../proto/xudrpc
 import Table, { HorizontalTable } from 'cli-table3';
 import colors from 'colors/safe';
 import { satsToCoinsStr } from '../utils';
+import { Owner } from '../../constants/enums';
 
 type FormattedTradingPairOrders = {
   pairId: string,
@@ -78,7 +79,7 @@ const displayTables = (orders: ListOrdersResponse.AsObject) => {
   formatOrders(orders).forEach(displayOrdersTable);
 };
 
-export const command = 'listorders [pair_id] [include_own_orders] [limit]';
+export const command = 'listorders [pair_id] [owner] [limit]';
 
 export const describe = 'list orders from the order book';
 
@@ -87,10 +88,11 @@ export const builder = {
     describe: 'trading pair for which to retrieve orders',
     type: 'string',
   },
-  include_own_orders: {
-    describe: 'whether to include own orders',
-    type: 'boolean',
-    default: true,
+  owner: {
+    describe: 'whether to include own, peer or both orders',
+    type: 'string',
+    choices: ['Both', 'Own', 'Peer'],
+    default: 'Both',
   },
   limit: {
     describe: 'max number of orders to return',
@@ -103,7 +105,7 @@ export const handler = (argv: Arguments<any>) => {
   const request = new ListOrdersRequest();
   const pairId = argv.pair_id ? argv.pair_id.toUpperCase() : undefined;
   request.setPairId(pairId);
-  request.setIncludeOwnOrders(argv.include_own_orders);
+  request.setOwner(Number(Owner[argv.owner]));
   request.setLimit(argv.limit);
   loadXudClient(argv).listOrders(request, callback(argv, displayTables));
 };

lib/cli/commands/orderbook.ts

@@ -4,6 +4,7 @@ import { ListOrdersRequest, ListOrdersResponse, Order } from '../../proto/xudrpc
 import Table, { HorizontalTable } from 'cli-table3';
 import colors from 'colors/safe';
 import { satsToCoinsStr } from '../utils';
+import { Owner } from '../../constants/enums';
 
 type FormattedOrderbook = {
   pairId: string,
@@ -181,6 +182,6 @@ export const handler = (argv: Arguments<any>) => {
   const request = new ListOrdersRequest();
   const pairId = argv.pair_id ? argv.pair_id.toUpperCase() : undefined;
   request.setPairId(pairId);
-  request.setIncludeOwnOrders(true);
+  request.setOwner(Number(Owner.Both));
   loadXudClient(argv).listOrders(request, callback(argv, displayTables, displayJson));
 };

lib/constants/enums.ts

@@ -14,6 +14,12 @@ export enum OrderSide {
   Sell,
 }
 
+export enum Owner {
+  Both,
+  Own,
+  Peer,
+}
+
 export enum XuNetwork {
   // real coins.
   MainNet = 'mainnet',

lib/service/Service.ts

@@ -1,4 +1,4 @@
-import { OrderSide, SwapClientType, SwapRole } from '../constants/enums';
+import { OrderSide, SwapClientType, SwapRole, Owner } from '../constants/enums';
 import { LndInfo } from '../lndclient/types';
 import OrderBook from '../orderbook/OrderBook';
 import { OrderSidesArrays } from '../orderbook/TradingPair';
@@ -358,8 +358,12 @@ class Service {
   /**
    * Get a map between pair ids and its orders from the order book.
    */
-  public listOrders = (args: { pairId: string, includeOwnOrders: boolean, limit: number }): Map<string, OrderSidesArrays<any>> => {
-    const { pairId, includeOwnOrders, limit } = args;
+  public listOrders = (
+    args: { pairId: string, owner: Owner | number, limit: number },
+    ): Map<string, OrderSidesArrays<any>> => {
+    const { pairId, owner, limit } = args;
+    const includeOwnOrders = owner === Owner.Both || owner === Owner.Own;
+    const includePeerOrders = owner === Owner.Both || owner === Owner.Peer;
 
     const result = new Map<string, OrderSidesArrays<any>>();
 
@@ -369,9 +373,11 @@ class Service {
         sellArray: [],
       };
 
-      const peerOrders = this.orderBook.getPeersOrders(pairId);
-      orders.buyArray = peerOrders.buyArray;
-      orders.sellArray = peerOrders.sellArray;
+      if (includePeerOrders) {
+        const peerOrders = this.orderBook.getPeersOrders(pairId);
+        orders.buyArray = peerOrders.buyArray;
+        orders.sellArray = peerOrders.sellArray;
+      }
 
       if (includeOwnOrders) {
         const ownOrders = this.orderBook.getOwnOrders(pairId);
@@ -386,7 +392,7 @@ class Service {
 
       if (limit > 0) {
         orders.buyArray = orders.buyArray.slice(0, limit);
-        orders.sellArray = orders.buyArray.slice(0, limit);
+        orders.sellArray = orders.sellArray.slice(0, limit);
       }
       return orders;
     };

proto/xudrpc.proto

@@ -456,8 +456,13 @@ message ListCurrenciesResponse {
 message ListOrdersRequest {
   // The trading pair for which to retrieve orders.
   string pair_id = 1 [json_name = "pair_id"];
-  // Whether own orders should be included in result or not.
-  bool include_own_orders = 2 [json_name = "include_own_orders"];
+  enum Owner {
+    BOTH = 0;
+    OWN = 1;
+    PEER = 2;
+  }
+  // Whether only own, only peer or both orders should be included in result.
+  Owner owner = 2 [json_name = "owner"];
   // The maximum number of orders to return from each side of the order book.
   uint32 limit = 3 [json_name = "limit"];
 }

test/integration/Service.spec.ts

@@ -2,7 +2,7 @@ import chai, { expect } from 'chai';
 import Xud from '../../lib/Xud';
 import chaiAsPromised from 'chai-as-promised';
 import Service from '../../lib/service/Service';
-import { SwapClientType, OrderSide } from '../../lib/constants/enums';
+import { SwapClientType, OrderSide, Owner } from '../../lib/constants/enums';
 import { getTempDir } from '../utils';
 
 chai.use(chaiAsPromised);
@@ -88,7 +88,7 @@ describe('API Service', () => {
   it('should get orders', async () => {
     const args = {
       pairId,
-      includeOwnOrders: true,
+      owner: Owner.Both,
       limit: 0,
     };
     const orders = service.listOrders(args);