From 272add367dcd97bd3a8a4f16faaf907853f38314 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sehyun=20Chung=20=E2=9C=8C=EF=B8=8E?= <41171808+sehyunc@users.noreply.github.com> Date: Wed, 18 Sep 2024 19:24:25 -0700 Subject: [PATCH] docs: add docs for worst case price --- .../docs/technical-reference/typescript-sdk.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs.renegade.fi/docs/technical-reference/typescript-sdk.md b/docs.renegade.fi/docs/technical-reference/typescript-sdk.md index 3934d883..cb5aa07b 100644 --- a/docs.renegade.fi/docs/technical-reference/typescript-sdk.md +++ b/docs.renegade.fi/docs/technical-reference/typescript-sdk.md @@ -670,6 +670,14 @@ await createOrder(config, { - side - `"buy" | "sell"` - The side this order is for +- amount + - `bigint` + - Amount to place the order for (should be multiplied by the number of decimals the ERC-20 supports) +- worstCasePrice (optional) + - `string` + - The worse case price that the order may be executed at. For buy side orders this is a maximum price, for sell side orders this is a minimum price. + - If no worst case price is provided, the action will fall back to setting default values (`u64::MAX` for buy side orders and `0` for sell side orders) + - Value should be decimal corrected according to the token pair (e.g. `price * 10**(quoteDecimals - baseDecimals)`) **Return Type**