fix(dex-api): best orders proper is_mine provided

[rozhkovdmitrii]

best_orders rpc returns is_mine: false for own orders.
Changes fix this bug and also introduce an optional exclude_my rpc field that exclude orders marked as is_mine from response

[shamardy]

@rozhkovdmitrii I agree with this comment #1015 (comment) that we should exclude orders if they belong to the node from best_orders response instead of setting is_mine to true, what do you think?

[rozhkovdmitrii]

@rozhkovdmitrii I agree with this comment #1015 (comment) that we should exclude orders if they belong to the node from best_orders response instead of setting is_mine to true, what do you think?

Excuse me for having a contrary opinion.
This could certainly be an option, but the truth is that we have a protocol that is already nominated as API 2.0 (Master) containing is_mine as a part of response. Without the right to waver and spoil it leading our own (as a team) arbitrariness. Continuing the thought, another argument is that the protocol assumes that RPC API clients can exclude orders if they think it is ought to be. These use cases are implicitly assumed by the inclusion of is_mine as part of the protocol.

What I wanted to say is if we leave is_mine it doesn't hurt anything, though if we don't it does.
This is why I would keep the protocol consistent, transparent, simple and stupid.

[shamardy]

Right now we go through all orders in best orders and check if they are is_mine or not, I believe this process is repeated in GUIs to filter my orders out. I agree that keeping is_mine to find how my orders rank in best orders can be beneficial too, how about adding a parameter in BestOrdersRequestV2 called exclude_my_orders which defaults to false to keep the original functionality intact if this new parameter was not included in the request?

[rozhkovdmitrii]

Right now we go through all orders in best orders and check if they are is_mine or not, I believe this process is repeated in GUIs to filter my orders out. I agree that keeping is_mine to find how my orders rank in best orders can be beneficial too, how about adding a parameter in BestOrdersRequestV2 called exclude_my_orders which defaults to false to keep the original functionality intact if this new parameter was not included in the request?

Sure ) - extending is not reducing

[rozhkovdmitrii]

Sure ) - extending is not reducing

@shamardy

Dared to use an abridged version, if you allow me of course

[]$ adex-cli best-orders --number 100 MORTY sell
Getting best orders: Sell MORTY
┌───┬───────┬──────────────────────────────────────┬────────────────────┬────────────────────┬────────────────────────────────────┬───────────────────┐
│   │ Price │ Uuid                                 │ Base vol(min:max)  │ Rel vol(min:max)   │ Address                            │ Confirmation      │
│ RICK                                                                                                                                                │
│ * │ 0.50  │ 1fc0df20-9c21-461a-ad78-a4b37d4ab336 │ 0.00020:1.00       │ 0.000100:0.50      │ RPFGrvJWjSYN4qYvcXsECW1HoHbvQjowZM │ 111,true:555,true │
│   │ 1.00  │ 7cb4735b-0c1e-4c55-a58e-35699e26e194 │ 0.000100:0.65      │ 0.000100:0.65      │ R9gWj7fzSxZtJZCSDMQz5G5J7x4rg6UmiQ │ 1,false:1,false   │
│   │ 1.00  │ 880fadcb-ec7e-40dc-9299-6957dd8ce467 │ 0.000100:1.99      │ 0.00010:2.00       │ RMaprYNUp8ErJ9ZAKcxMfpC4ioVycYCCCc │ 1,false:1,false   │
│   │ 0.04  │ 9199a9f3-d0ca-4746-b99a-438bf85f9204 │ 0.0022:42.77       │ 0.000100:1.94      │ RJVrcGS1H8LKqdFxbreTcRzpGiWsHQZDpc │ 1,false:1,false   │
│ * │ 0.90  │ 9664d472-0313-494c-9a03-f8cd5d4f7e5b │ 0.00011:1.00       │ 0.000100:0.90      │ RPFGrvJWjSYN4qYvcXsECW1HoHbvQjowZM │ 1,false:1,false   │
│   │ 1.00  │ eeb888af-5392-4b1a-a4a1-28250d6c3c7e │ 0.000100:363783.58 │ 0.000100:363783.58 │ RB8yufv3YTfdzYnwz5paNnnDynGJG6WsqD │ 1,false:1,false   │
│ ZOMBIE                                                                                                                                              │
│   │ 1.00  │ b1d92c46-b782-4dea-9825-f009708627d7 │ 0.000100:2.00      │ 0.000100:2.00      │ Shielded                           │ 1,false:1,false   │
└───┴───────┴──────────────────────────────────────┴────────────────────┴────────────────────┴────────────────────────────────────┴───────────────────┘
[]$ adex-cli best-orders --number 100 MORTY sell --exclude-my
Getting best orders: Sell MORTY
┌──┬───────┬──────────────────────────────────────┬────────────────────┬────────────────────┬────────────────────────────────────┬─────────────────┐
│  │ Price │ Uuid                                 │ Base vol(min:max)  │ Rel vol(min:max)   │ Address                            │ Confirmation    │
│ RICK                                                                                                                                             │
│  │ 1.00  │ 7cb4735b-0c1e-4c55-a58e-35699e26e194 │ 0.000100:0.65      │ 0.000100:0.65      │ R9gWj7fzSxZtJZCSDMQz5G5J7x4rg6UmiQ │ 1,false:1,false │
│  │ 1.00  │ 880fadcb-ec7e-40dc-9299-6957dd8ce467 │ 0.000100:1.99      │ 0.00010:2.00       │ RMaprYNUp8ErJ9ZAKcxMfpC4ioVycYCCCc │ 1,false:1,false │
│  │ 0.04  │ 9199a9f3-d0ca-4746-b99a-438bf85f9204 │ 0.0022:42.77       │ 0.000100:1.94      │ RJVrcGS1H8LKqdFxbreTcRzpGiWsHQZDpc │ 1,false:1,false │
│  │ 1.00  │ eeb888af-5392-4b1a-a4a1-28250d6c3c7e │ 0.000100:363783.58 │ 0.000100:363783.58 │ RB8yufv3YTfdzYnwz5paNnnDynGJG6WsqD │ 1,false:1,false │
│ ZOMBIE                                                                                                                                           │
│  │ 1.00  │ b1d92c46-b782-4dea-9825-f009708627d7 │ 0.000100:2.00      │ 0.000100:2.00      │ Shielded                           │ 1,false:1,false │
└──┴───────┴──────────────────────────────────────┴────────────────────┴────────────────────┴────────────────────────────────────┴─────────────────┘

[caglaryucekaya]

LGTM! Can you also add a test case in best_orders_tests to check if the exclude_mine and is_mine are working as intended?

[shamardy]

Thanks a lot for the fix! I have a few comments.

[shamardy]

Last 2 minor comments :)

[shamardy]

One more last comment!

[shamardy]

Thanks a lot for your patience with the fixes! LGTM!