@lifi/perps-types 4.0.1 → 4.1.0

package/dist/cjs/index.d.ts

@@ -6,6 +6,7 @@ export * from './enums.js';
 export * from './errors.js';
 export * from './market.js';
 export * from './meta.js';
+export * from './positionMargin.js';
 export * from './primitives.js';
 export * from './providers.js';
 export * from './quote.js';

package/dist/cjs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AASA,cAAc,kBAAkB,CAAA;AAChC,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,oBAAoB,CAAA;AAClC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AASA,cAAc,kBAAkB,CAAA;AAChC,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,oBAAoB,CAAA;AAClC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA"}

package/dist/cjs/index.js

@@ -22,6 +22,7 @@ __exportStar(require("./enums.js"), exports);
 __exportStar(require("./errors.js"), exports);
 __exportStar(require("./market.js"), exports);
 __exportStar(require("./meta.js"), exports);
+__exportStar(require("./positionMargin.js"), exports);
 __exportStar(require("./primitives.js"), exports);
 __exportStar(require("./providers.js"), exports);
 __exportStar(require("./quote.js"), exports);

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AASA,mDAAgC;AAChC,+CAA4B;AAC5B,8CAA2B;AAC3B,6CAA0B;AAC1B,6CAA0B;AAC1B,8CAA2B;AAC3B,8CAA2B;AAC3B,4CAAyB;AACzB,kDAA+B;AAC/B,iDAA8B;AAC9B,6CAA0B;AAC1B,qDAAkC;AAClC,iDAA8B;AAC9B,4CAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AASA,mDAAgC;AAChC,+CAA4B;AAC5B,8CAA2B;AAC3B,6CAA0B;AAC1B,6CAA0B;AAC1B,8CAA2B;AAC3B,8CAA2B;AAC3B,4CAAyB;AACzB,sDAAmC;AACnC,kDAA+B;AAC/B,iDAA8B;AAC9B,6CAA0B;AAC1B,qDAAkC;AAClC,iDAA8B;AAC9B,4CAAyB"}

package/dist/cjs/positionMargin.d.ts

@@ -0,0 +1,4 @@
+import type { Position } from './account.js';
+export declare function positionSupportsMarginAdjustment(position: Position): boolean;
+export declare function positionSupportsMarginRemoval(position: Position): boolean;
+//# sourceMappingURL=positionMargin.d.ts.map

package/dist/cjs/positionMargin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"positionMargin.d.ts","sourceRoot":"","sources":["../../src/positionMargin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAS5C,wBAAgB,gCAAgC,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAK5E;AAQD,wBAAgB,6BAA6B,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAMzE"}

package/dist/cjs/positionMargin.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.positionSupportsMarginAdjustment = positionSupportsMarginAdjustment;
+exports.positionSupportsMarginRemoval = positionSupportsMarginRemoval;
+const enums_js_1 = require("./enums.js");
+function positionSupportsMarginAdjustment(position) {
+    return (position.marginMode === enums_js_1.MarginMode.ISOLATED &&
+        position.market.positionMarginAdjustment !== enums_js_1.PositionMarginAdjustment.NONE);
+}
+function positionSupportsMarginRemoval(position) {
+    return (positionSupportsMarginAdjustment(position) &&
+        position.market.positionMarginAdjustment ===
+            enums_js_1.PositionMarginAdjustment.ADD_AND_REMOVE);
+}
+//# sourceMappingURL=positionMargin.js.map

package/dist/cjs/positionMargin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"positionMargin.js","sourceRoot":"","sources":["../../src/positionMargin.ts"],"names":[],"mappings":";;AASA,4EAKC;AAQD,sEAMC;AA3BD,yCAAiE;AAQjE,SAAgB,gCAAgC,CAAC,QAAkB;IACjE,OAAO,CACL,QAAQ,CAAC,UAAU,KAAK,qBAAU,CAAC,QAAQ;QAC3C,QAAQ,CAAC,MAAM,CAAC,wBAAwB,KAAK,mCAAwB,CAAC,IAAI,CAC3E,CAAA;AACH,CAAC;AAQD,SAAgB,6BAA6B,CAAC,QAAkB;IAC9D,OAAO,CACL,gCAAgC,CAAC,QAAQ,CAAC;QAC1C,QAAQ,CAAC,MAAM,CAAC,wBAAwB;YACtC,mCAAwB,CAAC,cAAc,CAC1C,CAAA;AACH,CAAC"}

package/dist/esm/index.d.ts

@@ -14,6 +14,7 @@ export * from './enums.js';
 export * from './errors.js';
 export * from './market.js';
 export * from './meta.js';
+export * from './positionMargin.js';
 export * from './primitives.js';
 export * from './providers.js';
 export * from './quote.js';

package/dist/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,cAAc,kBAAkB,CAAA;AAChC,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,oBAAoB,CAAA;AAClC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,cAAc,kBAAkB,CAAA;AAChC,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,oBAAoB,CAAA;AAClC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA"}

package/dist/esm/index.js

@@ -14,6 +14,7 @@ export * from './enums.js';
 export * from './errors.js';
 export * from './market.js';
 export * from './meta.js';
+export * from './positionMargin.js';
 export * from './primitives.js';
 export * from './providers.js';
 export * from './quote.js';

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,cAAc,kBAAkB,CAAA;AAChC,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,oBAAoB,CAAA;AAClC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,cAAc,kBAAkB,CAAA;AAChC,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,oBAAoB,CAAA;AAClC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA"}

package/dist/esm/positionMargin.d.ts

@@ -0,0 +1,16 @@
+import type { Position } from './account.js';
+/**
+ * Whether this position can take a margin adjustment at all: it holds margin of
+ * its own and its market exposes individual position margin.
+ *
+ * @public
+ */
+export declare function positionSupportsMarginAdjustment(position: Position): boolean;
+/**
+ * Whether a removal is among the adjustments this position permits. An
+ * `ADD_ONLY` market takes adds and no withdrawal.
+ *
+ * @public
+ */
+export declare function positionSupportsMarginRemoval(position: Position): boolean;
+//# sourceMappingURL=positionMargin.d.ts.map

package/dist/esm/positionMargin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"positionMargin.d.ts","sourceRoot":"","sources":["../../src/positionMargin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAG5C;;;;;GAKG;AACH,wBAAgB,gCAAgC,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAK5E;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAMzE"}

package/dist/esm/positionMargin.js

@@ -0,0 +1,23 @@
+import { MarginMode, PositionMarginAdjustment } from './enums.js';
+/**
+ * Whether this position can take a margin adjustment at all: it holds margin of
+ * its own and its market exposes individual position margin.
+ *
+ * @public
+ */
+export function positionSupportsMarginAdjustment(position) {
+    return (position.marginMode === MarginMode.ISOLATED &&
+        position.market.positionMarginAdjustment !== PositionMarginAdjustment.NONE);
+}
+/**
+ * Whether a removal is among the adjustments this position permits. An
+ * `ADD_ONLY` market takes adds and no withdrawal.
+ *
+ * @public
+ */
+export function positionSupportsMarginRemoval(position) {
+    return (positionSupportsMarginAdjustment(position) &&
+        position.market.positionMarginAdjustment ===
+            PositionMarginAdjustment.ADD_AND_REMOVE);
+}
+//# sourceMappingURL=positionMargin.js.map

package/dist/esm/positionMargin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"positionMargin.js","sourceRoot":"","sources":["../../src/positionMargin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAA;AAEjE;;;;;GAKG;AACH,MAAM,UAAU,gCAAgC,CAAC,QAAkB;IACjE,OAAO,CACL,QAAQ,CAAC,UAAU,KAAK,UAAU,CAAC,QAAQ;QAC3C,QAAQ,CAAC,MAAM,CAAC,wBAAwB,KAAK,wBAAwB,CAAC,IAAI,CAC3E,CAAA;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,6BAA6B,CAAC,QAAkB;IAC9D,OAAO,CACL,gCAAgC,CAAC,QAAQ,CAAC;QAC1C,QAAQ,CAAC,MAAM,CAAC,wBAAwB;YACtC,wBAAwB,CAAC,cAAc,CAC1C,CAAA;AACH,CAAC"}

package/dist/types/index.d.ts

@@ -14,6 +14,7 @@ export * from './enums.js';
 export * from './errors.js';
 export * from './market.js';
 export * from './meta.js';
+export * from './positionMargin.js';
 export * from './primitives.js';
 export * from './providers.js';
 export * from './quote.js';

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,cAAc,kBAAkB,CAAA;AAChC,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,oBAAoB,CAAA;AAClC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,cAAc,kBAAkB,CAAA;AAChC,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,oBAAoB,CAAA;AAClC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA"}

package/dist/types/positionMargin.d.ts

@@ -0,0 +1,16 @@
+import type { Position } from './account.js';
+/**
+ * Whether this position can take a margin adjustment at all: it holds margin of
+ * its own and its market exposes individual position margin.
+ *
+ * @public
+ */
+export declare function positionSupportsMarginAdjustment(position: Position): boolean;
+/**
+ * Whether a removal is among the adjustments this position permits. An
+ * `ADD_ONLY` market takes adds and no withdrawal.
+ *
+ * @public
+ */
+export declare function positionSupportsMarginRemoval(position: Position): boolean;
+//# sourceMappingURL=positionMargin.d.ts.map

package/dist/types/positionMargin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"positionMargin.d.ts","sourceRoot":"","sources":["../../src/positionMargin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAG5C;;;;;GAKG;AACH,wBAAgB,gCAAgC,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAK5E;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAMzE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lifi/perps-types",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "description": "Shared types for the LI.FI perps stack",
   "keywords": [
     "lifi",

package/src/index.ts

@@ -15,6 +15,7 @@ export * from './enums.js'
 export * from './errors.js'
 export * from './market.js'
 export * from './meta.js'
+export * from './positionMargin.js'
 export * from './primitives.js'
 export * from './providers.js'
 export * from './quote.js'

package/src/positionMargin.ts

@@ -0,0 +1,29 @@
+import type { Position } from './account.js'
+import { MarginMode, PositionMarginAdjustment } from './enums.js'
+
+/**
+ * Whether this position can take a margin adjustment at all: it holds margin of
+ * its own and its market exposes individual position margin.
+ *
+ * @public
+ */
+export function positionSupportsMarginAdjustment(position: Position): boolean {
+  return (
+    position.marginMode === MarginMode.ISOLATED &&
+    position.market.positionMarginAdjustment !== PositionMarginAdjustment.NONE
+  )
+}
+
+/**
+ * Whether a removal is among the adjustments this position permits. An
+ * `ADD_ONLY` market takes adds and no withdrawal.
+ *
+ * @public
+ */
+export function positionSupportsMarginRemoval(position: Position): boolean {
+  return (
+    positionSupportsMarginAdjustment(position) &&
+    position.market.positionMarginAdjustment ===
+      PositionMarginAdjustment.ADD_AND_REMOVE
+  )
+}