Feat/extend delta orders filtering #215
Conversation
size-limit report 📦
|
| * Filter by any known DeltaAuctionStatus and some custom statuses: | ||
| * - **INSUFFICIENT_BALANCE** — returned as SUSPENDED from API | ||
| * - **INSUFFICIENT_ALLOWANCE** — returned as SUSPENDED from API | ||
| * - **INVALIDATED** — returned as FAILED from API | ||
| * - **ACTIVE** — All orders with NOT_STARTED, RUNNING, EXECUTING or SUSPENDED statuses. | ||
| * - **INACTIVE** — All orders with EXECUTED, FAILED, EXPIRED, CANCELLED or INVALIDATED statuses. | ||
| */ | ||
| status?: DeltaOrderFilterByStatus[]; |
There was a problem hiding this comment.
I'm not sure I like SDK accepting all statuses even those that are never returned because they are internal to API.
It's very useful to query for SUSPENDED and API will return all Orders with INSUFFICIENT_*
On the other hand I do want to keep the option to query for very specific statuses, so maybe your approach with a comprehensive jsdoc comment is the best.
| chainId?: number; // @TODO currently not working | ||
| /** @description Filter by type. MARKET, LIMIT, or ALL. Default is ALL */ | ||
| type?: 'MARKET' | 'LIMIT' | 'ALL'; | ||
| chainId?: number[]; |
There was a problem hiding this comment.
Why not always require an array? Would be cleaner
There was a problem hiding this comment.
chainIds?
I'd like to keep it the same as API does. chainId=, status=
Why not always require an array? Would be cleaner
Maybe, but why would I pass an array with a single value?
There was a problem hiding this comment.
Pass as array, because it's simpler than a variable type. We have it in a bunch of places: include/exclude methods, dexs, bridges -- off the top of my head
andriy-shymkiv
force-pushed
the
feat/extend_delta_orders_filtering
branch
from
55956cf to
d3e5555
Compare
| const chainIdString = options.chainId | ||
| ? options.chainId.join(',') | ||
| : undefined; | ||
| const statusString = options.status ? options.status.join(',') : undefined; |
There was a problem hiding this comment.
can probably do options.chainId?.join()
2 participants
getDeltaOrders:
chainIdandstatusfilterstype=ALLfilter option