Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(feat) Added documentation about order types #137

Merged
merged 2 commits into from
Sep 27, 2023

Conversation

aarmoa
Copy link
Contributor

@aarmoa aarmoa commented Sep 25, 2023

  • Added a page in Overview section detailing all order types

## Order types

- BUY (1): A standard buy order to purchase an asset at either the current market price or a set limit price.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even for market orders, users MUST set the worst price so I think we should make that clear, the price for both limit and market orders is 'set'.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have applied the change in the latest commit

- BUY_PO (7): Post-Only Buy. This order type ensures that the order will only be added to the order book and not match with a pre-existing order. It guarantees that you will be the market "maker" and not the "taker".
- SELL_PO (8): Post-Only Sell. Similar to BUY_PO, this ensures that your sell order will only add liquidity to the order book and not match with a pre-existing order.
- BUY_ATOMIC (9): An atomic buy order is a market order that gets executed instantly, bypassing the Frequent Batch Auctions (FBA). It's intended for smart contracts that need to execute a trade instantly. A higher fee is paid defined in the global exchange parameters.
Copy link
Contributor

@achilleas-kal achilleas-kal Sep 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe here we can mention the fee for atomic orders is currently "double" the normal trading fee.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have added the clarification in the last commit

@aarmoa
Copy link
Contributor Author

aarmoa commented Sep 26, 2023

@arcayne please check the comments from Achilleas. We might want to do the same clarifications in the injective-core documentation

@aarmoa aarmoa merged commit 98c35cc into main Sep 27, 2023
7 checks passed
@aarmoa aarmoa deleted the feat/add_order_type_documentation branch September 27, 2023 12:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants