idexio / idex-sdk-js Goto Github PK

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

No npm token specified.

An npm token must be created and set in the NPM_TOKEN environment variable on your CI environment.

Please make sure to create an npm token and to set it in the NPM_TOKEN environment variable on your CI environment. The token must allow to publish to the registry https://registry.npmjs.org/.

Good luck with your project ✨

Your semantic-release bot 📦🚀

Posting as an issue instead of a JIRA for this one. When working with the sdk from a developer perspective so far, I have run into it being slightly cumbersome to see what is expected. Since the doc tags are nested values as well, in the end things can be hard.

This is really two separate considerations:

Type Expansion Consideration

We may want to implement a simple fix to make this far nicer to use for the developer.

export type Expand<T> = T extends infer O ? { [K in keyof O]: O[K] } : never;

// then use like:
getOrders(findOrders: Expand<request.FindOrders>): Promise<response.Order[]>;

This trick will change the above to:

Being tsdoc compliant (Official Microsoft / Typescript Language Server spec)

In addition to this, if possible, it'd be ideal to also consider being compliant with tsdoc so that the typescript experience is as developers would expect.

/**
 * @typedef {Object} request.FindOrders
 * @property {string} nonce - UUIDv1
 * @property {string} wallet
 * @property {string} [market] - Base-quote pair e.g. 'IDEX-ETH'
 * @property {boolean} [closed] - false only returns active orders on the order book; true only returns orders that are no longer on the order book and resulted in at least one fill; only applies if orderId is absent
 * @property {number} [start] - Starting timestamp (inclusive)
 * @property {number} [end] - Ending timestamp (inclusive)
 * @property {number} [limit=50] - Max results to return from 1-1000
 * @property {string} [fromId] - orderId of the earliest (oldest) order, only applies if orderId is absent
 */
export interface FindOrders extends FindByWallet, FindWithPagination {
    market?: string;
    closed: boolean;
    fromId?: string;
}

Typescript currently will not have any context about any of the properties included here, requiring the end user to continually scan back to the docs rather than having it all inline

Whereas by just making sure we add the tsdoc compliance syntax, the user gets it without effort:

/**
 * @typedef {Object} request.FindOrders
 * @property {string} nonce - UUIDv1
 * @property {string} wallet
 * @property {string} [market] - Base-quote pair e.g. 'IDEX-ETH'
 * @property {boolean} [closed] - false only returns active orders on the order book; true only returns orders that are no longer on the order book and resulted in at least one fill; only applies if orderId is absent
 * @property {number} [start] - Starting timestamp (inclusive)
 * @property {number} [end] - Ending timestamp (inclusive)
 * @property {number} [limit=50] - Max results to return from 1-1000
 * @property {string} [fromId] - orderId of the earliest (oldest) order, only applies if orderId is absent
 */
export interface FindOrders extends FindByWallet, FindWithPagination {
    /** Base-quote pair e.g. 'IDEX-ETH'  */
    market?: string;
    closed: boolean;
    fromId?: string;
}

While it is slightly cumbersome to copy for both the jsdoc and the tsdoc cases, it makes the api FAR more useable without the constant need to reference the docs and find what you need.

l1orderbook subscription does not handle order removal correctly: no new messages arrived even if best bid/ask has changed.

It does not really related to idex-sdk-js, the issue is on backend, its not sending event on order removal, just havent found better place to create issue.