nsekit 0.3.4 → 0.3.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -50,6 +50,20 @@ export declare function computeMarketFillPrice(ltp: number, side: 'BUY' | 'SELL'
50
50
  * SELL LIMIT fills when ltp >= limit price.
51
51
  */
52
52
  export declare function shouldLimitFill(side: 'BUY' | 'SELL', limitPrice: number, ltp: number): boolean;
53
+ /**
54
+ * Compute the fill price for a LIMIT order whose `shouldLimitFill` condition
55
+ * just became true. Real exchanges match limits at the prevailing market
56
+ * price (LTP), not at the user's limit price — the user's limit is a
57
+ * max/min boundary, better is allowed. Honoring the limit price would
58
+ * charge the full slippage of an aggressive limit (e.g. 5% above ask),
59
+ * which trips tight SL immediately on entry and breaks any strategy that
60
+ * relies on aggressive-limit fallback for fill guarantees.
61
+ *
62
+ * `side` and `limitPrice` are accepted for symmetry with shouldLimitFill
63
+ * and to keep the signature self-documenting at call sites; the function
64
+ * always returns ltp.
65
+ */
66
+ export declare function computeLimitFillPrice(_side: 'BUY' | 'SELL', _limitPrice: number, ltp: number): number;
53
67
  /**
54
68
  * Check if a stop-loss trigger has been hit.
55
69
  * BUY SL triggers when ltp >= trigger price.
@@ -1 +1 @@
1
- {"version":3,"file":"paper-fill-engine.d.ts","sourceRoot":"","sources":["../../../src/brokers/paper/paper-fill-engine.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAIpG,MAAM,WAAW,gBAAgB;IAC/B,6EAA6E;IAC7E,eAAe,EAAE,MAAM,CAAC;IACxB,kFAAkF;IAClF,YAAY,EAAE,MAAM,CAAC;IACrB,mFAAmF;IACnF,gBAAgB,EAAE,MAAM,CAAC;IACzB,uEAAuE;IACvE,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,eAAO,MAAM,mBAAmB,EAAE,gBAKjC,CAAC;AAIF,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,EAAE,WAAW,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;CACpB;AAID;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,gBAAgB,GACvB,MAAM,CAKR;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,KAAK,GAAG,MAAM,EACpB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,gBAAgB,GACvB,MAAM,CAIR;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,KAAK,GAAG,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,MAAM,GACV,OAAO,CAGT;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,KAAK,GAAG,MAAM,EACpB,YAAY,EAAE,MAAM,EACpB,GAAG,EAAE,MAAM,GACV,OAAO,CAGT;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM,GACtB,MAAM,CAQR;AAWD,qBAAa,eAAe;IAC1B,OAAO,CAAC,aAAa,CAAmC;IACxD,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,UAAU,CAA6B;IAC/C,OAAO,CAAC,MAAM,CAAC,CAAiD;IAChE,OAAO,CAAC,QAAQ,CAAC,CAA4C;gBAEjD,MAAM,GAAE,OAAO,CAAC,gBAAgB,CAAM;IAIlD,sDAAsD;IACtD,eAAe,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,KAAK,IAAI,GAAG,IAAI;IAIzE,wDAAwD;IACxD,iBAAiB,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAItE,sEAAsE;IACtE,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAIlD,4DAA4D;IAC5D,WAAW,CAAC,MAAM,EAAE,kBAAkB,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,WAAW;IA+ElE,sEAAsE;IACtE,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAWrC,gFAAgF;IAChF,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE;QACpC,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,IAAI,CAAC,EAAE,SAAS,CAAC;KAClB,GAAG,OAAO;IAcX;;;OAGG;IACH,WAAW,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI;IAkBpC,8BAA8B;IAC9B,gBAAgB,IAAI,YAAY,EAAE;IAMlC,kCAAkC;IAClC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAInD,mDAAmD;IACnD,YAAY,IAAI,YAAY,EAAE;IAI9B,6CAA6C;IAC7C,KAAK,IAAI,IAAI;IAOb,OAAO,CAAC,YAAY;IA6DpB,OAAO,CAAC,YAAY;IAYpB,OAAO,CAAC,SAAS;IAmCjB,OAAO,CAAC,UAAU;CASnB"}
1
+ {"version":3,"file":"paper-fill-engine.d.ts","sourceRoot":"","sources":["../../../src/brokers/paper/paper-fill-engine.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAIpG,MAAM,WAAW,gBAAgB;IAC/B,6EAA6E;IAC7E,eAAe,EAAE,MAAM,CAAC;IACxB,kFAAkF;IAClF,YAAY,EAAE,MAAM,CAAC;IACrB,mFAAmF;IACnF,gBAAgB,EAAE,MAAM,CAAC;IACzB,uEAAuE;IACvE,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,eAAO,MAAM,mBAAmB,EAAE,gBAKjC,CAAC;AAIF,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,EAAE,WAAW,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;CACpB;AAID;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,gBAAgB,GACvB,MAAM,CAKR;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,KAAK,GAAG,MAAM,EACpB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,gBAAgB,GACvB,MAAM,CAIR;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,KAAK,GAAG,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,MAAM,GACV,OAAO,CAGT;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,KAAK,GAAG,MAAM,EACrB,WAAW,EAAE,MAAM,EACnB,GAAG,EAAE,MAAM,GACV,MAAM,CAER;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,KAAK,GAAG,MAAM,EACpB,YAAY,EAAE,MAAM,EACpB,GAAG,EAAE,MAAM,GACV,OAAO,CAGT;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM,GACtB,MAAM,CAQR;AAWD,qBAAa,eAAe;IAC1B,OAAO,CAAC,aAAa,CAAmC;IACxD,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,UAAU,CAA6B;IAC/C,OAAO,CAAC,MAAM,CAAC,CAAiD;IAChE,OAAO,CAAC,QAAQ,CAAC,CAA4C;gBAEjD,MAAM,GAAE,OAAO,CAAC,gBAAgB,CAAM;IAIlD,sDAAsD;IACtD,eAAe,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,KAAK,IAAI,GAAG,IAAI;IAIzE,wDAAwD;IACxD,iBAAiB,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAItE,sEAAsE;IACtE,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAIlD,4DAA4D;IAC5D,WAAW,CAAC,MAAM,EAAE,kBAAkB,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,WAAW;IA+ElE,sEAAsE;IACtE,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAWrC,gFAAgF;IAChF,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE;QACpC,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,IAAI,CAAC,EAAE,SAAS,CAAC;KAClB,GAAG,OAAO;IAcX;;;OAGG;IACH,WAAW,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI;IAkBpC,8BAA8B;IAC9B,gBAAgB,IAAI,YAAY,EAAE;IAMlC,kCAAkC;IAClC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAInD,mDAAmD;IACnD,YAAY,IAAI,YAAY,EAAE;IAI9B,6CAA6C;IAC7C,KAAK,IAAI,IAAI;IAOb,OAAO,CAAC,YAAY;IA6DpB,OAAO,CAAC,YAAY;IAYpB,OAAO,CAAC,SAAS;IAmCjB,OAAO,CAAC,UAAU;CASnB"}
package/dist/index.js CHANGED
@@ -23920,6 +23920,9 @@ function shouldLimitFill(side, limitPrice, ltp) {
23920
23920
  return ltp <= limitPrice;
23921
23921
  return ltp >= limitPrice;
23922
23922
  }
23923
+ function computeLimitFillPrice(_side, _limitPrice, ltp) {
23924
+ return ltp;
23925
+ }
23923
23926
  function shouldTrigger(side, triggerPrice, ltp) {
23924
23927
  if (side === "BUY")
23925
23928
  return ltp >= triggerPrice;
@@ -24094,7 +24097,7 @@ class PaperFillEngine {
24094
24097
  case "LIMIT": {
24095
24098
  if (shouldLimitFill(params.side, params.price ?? 0, ltp)) {
24096
24099
  const fillQty = determineFillQty(remainingQty, this.config.partialFillProb);
24097
- const fillPrice = params.price ?? ltp;
24100
+ const fillPrice = computeLimitFillPrice(params.side, params.price ?? 0, ltp);
24098
24101
  this.applyFill(orderId, pending, fillQty, fillPrice);
24099
24102
  }
24100
24103
  break;
@@ -24111,7 +24114,7 @@ class PaperFillEngine {
24111
24114
  if (pending.triggered) {
24112
24115
  if (shouldLimitFill(params.side, params.price ?? 0, ltp)) {
24113
24116
  const fillQty = determineFillQty(remainingQty, this.config.partialFillProb);
24114
- const fillPrice = params.price ?? ltp;
24117
+ const fillPrice = computeLimitFillPrice(params.side, params.price ?? 0, ltp);
24115
24118
  this.applyFill(orderId, pending, fillQty, fillPrice);
24116
24119
  }
24117
24120
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "nsekit",
3
- "version": "0.3.4",
3
+ "version": "0.3.5",
4
4
  "description": "Unified broker abstraction for Indian stock markets - CCXT-like interface for NSE/BSE brokers",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",