feat(cli): format buy & sell output

[sangaman]

This attempts to make the cli output for the buy and sell commands more human-readable and succint.

Closes #620.

The missing features that will need to be added in separate PRs are adding price to the swap result (#656) and adding an event for failed swaps to the streaming placeOrder rpc call (#609).

[sangaman]

I made a small tweak to the formatting. Here's an example of what the output looks like:

$ xucli sell 10 LTC/BTC 1
matched 1 LTC @ 1 with own order da8d3401-e75a-11e8-972d-a9036be5a943
matched 1 LTC @ 1 with own order 68381201-e75d-11e8-972d-a9036be5a943
matched 1 LTC @ 1 with own order 6c5191e1-e75d-11e8-972d-a9036be5a943
matched 1 LTC @ 1 with own order 9f589e81-e75d-11e8-972d-a9036be5a943
matched 1 LTC @ 1 with own order a2a160e1-e75d-11e8-972d-a9036be5a943
new order 8a22d201-e75e-11e8-972d-a9036be5a943 entered the order book with 5 quantity

[kilrau]

Looks much better!

How about:
matched 1 LTC @ price 1 with own order da8d3401-e75a-11e8-972d-a9036be5a943

Why this?
new order 8a22d201-e75e-11e8-972d-a9036be5a943 entered the order book with 5 quantity

don't see a need for this in the buy/sell output. Just matches.

[sangaman]

How about:
matched 1 LTC @ price 1 with own order da8d3401-e75a-11e8-972d-a9036be5a943

I thought about explicitly stating "price" too but I felt it was a little superfluous. It seems clear enough to me and also I know the "traded [quantity] @ [price]" shorthand is used elsewhere. Still it's close so maybe someone else can weigh in on which way looks better?

Edit: Also I realized I'd posted an older example before I'd changed the formatting to use the base currency ("LTC" in this case) instead of "quantity". So if that's what you were suggesting as well I'd already made that change.

Why this?
new order 8a22d201-e75e-11e8-972d-a9036be5a943 entered the order book with 5 quantity

don't see a need for this in the buy/sell output. Just matches.

To me it's an easy way to tell which portion of your order was unmatched and is being added to the orderbook. Also I figure we'd want something like that, otherwise there'd be no output in the case where we place a limit order that doesn't get matched. Others can weigh in on this too tho.

[kilrau]

Edit: Also I realized I'd posted an older example before I'd changed the formatting to use the base currency ("LTC" in this case) instead of "quantity". So if that's what you were suggesting as well I'd already made that change.

👍 that was the main feedback, yes (sry, didn't check the code). Leaving out price is fine.

Why this?
new order 8a22d201-e75e-11e8-972d-a9036be5a943 entered the order book with 5 quantity
don't see a need for this in the buy/sell output. Just matches.

To me it's an easy way to tell which portion of your order was unmatched and is being added to the orderbook. Also I figure we'd want something like that, otherwise there'd be no output in the case where we place a limit order that doesn't get matched. Others can weigh in on this too tho.

Oh then it's just confusing. To me this looks like some new peerOrder came in and the CLI reported about it which doesn't make much sense. Suggest to restructure to sth like this:
No more matches found
Remaining quantity 5 LTC entered order book as new order 8a22d201-e75e-11e8-972d-a9036be5a943

[sangaman]

Ok yeah I see what you mean. Basically I was trying to think about how it would look if there were no matches at all, where I think it's a bit confusing to say "no more matches found." Maybe just 5 unmatched quantity entered order book as 8a22d201-e75e-11e8-972d-a9036be5a943? @kilrau

[kilrau]

I'd prefer to stick with '"remaining" instead of "unmatched" since we use this elsewhere to, but your call. And definitely add "LTC", not only "quantity". Also, if there were no matches found we should say "No matches found".

No matches found
5 LTC remaining quantity entered order book as 8a22d201-e75e-11e8-972d-a9036be5a943

[ghost]

Looks good. Once we have the sinon dependency merged in #650 we can easily cover orderHandler with an integration test for the added logic.

In case of no matches found I'd display:
No matches found
remaining ${quantity} ${baseCurrency} entered the order book as ${orderId}

[sangaman]

OK thanks, I'm going to go with @erkarl's suggestion.