dexbot 1.1.10

package/dist/modules/order/format.js

@@ -0,0 +1,232 @@
+"use strict";
+/**
+ * modules/order/format.ts - Numeric formatting utilities
+ *
+ * Centralized formatting utilities for consistent decimal precision display across logs and output.
+ * All functions return strings formatted to specified decimal places.
+ *
+ * ===============================================================================
+ * DECIMAL PRECISION STANDARDS
+ * ===============================================================================
+ *
+ * Asset Amounts:                8 decimals  - blockchain native precision
+ * Prices:                       6-8 decimals - price precision varies by pair
+ * Percentages:                  1-4 decimals - display precision
+ * Ratios/Metrics:               2-5 decimals - context dependent
+ * Time/Performance (ms, %):     1-2 decimals - readable metrics
+ *
+ * ===============================================================================
+ * TABLE OF CONTENTS (17 exported functions)
+ * ===============================================================================
+ *
+ * SECTION 1: ASSET FORMATTING (5 functions)
+ *   1. formatAmount8(value) - Format to 8 decimals (blockchain standard)
+ *   2. formatAmount(value, decimals) - Format with custom decimal places
+ *   3. formatAmountByPrecision(value, precision) - Format using chain precision
+ *   4. formatAmountStrict(value, precision) - Format using chain precision; returns 'N/A' if either arg is non-finite
+ *   5. formatSizeByOrderType(value, orderType, assets) - Format order size by BUY/SELL asset precision
+ *
+ * SECTION 2: PRICE FORMATTING (3 functions)
+ *   6. formatPrice(value) - Format to 8 decimals (maximum precision)
+ *   7. formatPrice6(value) - Format to 6 decimals
+ *   8. formatPrice4(value) - Format to 4 decimals (simplified display)
+ *
+ * SECTION 3: PERCENTAGE FORMATTING (3 functions)
+ *   9. formatPercent2(value) - Format to 2 decimals (spread %, ratios)
+ *   10. formatPercent(value, decimals) - Format with custom decimal places
+ *
+ * SECTION 4: RATIO/METRIC FORMATTING (3 functions)
+ *   12. formatRatio(value, decimals) - Format ratios with custom decimals (default 5)
+ *   13. formatMetric2(value) - Format to 2 decimals (timing, performance)
+ *   14. formatMetric5(value) - Format to 5 decimals (detailed metrics)
+ *
+ * SECTION 5: HELPER UTILITIES (4 functions)
+ *   15. isValidNumber(value) - Check if value is defined and finite
+ *   16. isNumeric(val) - Check if value is a number or parseable numeric string
+ *   17. toFiniteNumber(value, defaultValue) - Convert to finite number with fallback
+ *   18. safeFormat(value, decimals, fallback) - Safely format with fallback
+ *
+ * ===============================================================================
+ */
+// ===============================================================================
+// SECTION 1: ASSET FORMATTING
+// ===============================================================================
+/**
+ * Format asset amounts to 8 decimal places (blockchain standard)
+ * Used for: Asset amounts, order sizes
+ *
+ * @param {number} value - The value to format
+ * @returns {string} Formatted value to 8 decimals
+ */
+function formatAmount8(value) {
+    return safeFormat(value, 8);
+}
+/**
+ * Format asset amounts with custom decimal places
+ *
+ * @param {number} value - The value to format
+ * @param {number} [decimals=8] - Number of decimal places (default 8)
+ * @returns {string} Formatted value
+ */
+function formatAmount(value, decimals = 8) {
+    return safeFormat(value, decimals);
+}
+/**
+ * Format asset amount using an explicit blockchain precision.
+ * Throws if precision is invalid — no silent fallback.
+ *
+ * @param {number} value - The value to format
+ * @param {number} precision - Asset precision to apply
+ * @returns {string} Formatted value
+ */
+function formatAmountByPrecision(value, precision) {
+    if (precision === undefined || !Number.isInteger(precision) || precision < 0) {
+        throw new Error(`Invalid precision for formatAmountByPrecision: ${precision}`);
+    }
+    return safeFormat(value, precision);
+}
+/**
+ * Format an order size using market-side precision.
+ * BUY size is in assetB units, SELL size is in assetA units.
+ * Throws if precision is unavailable — no silent fallback.
+ *
+ * @param {number} value - The value to format
+ * @param {string} orderType - Order side ('buy' or 'sell')
+ * @param {Object} assets - Asset metadata with assetA/assetB precision
+ * @returns {string} Formatted value
+ */
+function formatSizeByOrderType(value, orderType, assets) {
+    const side = String(orderType || '').toLowerCase();
+    const buyPrecision = assets?.assetB?.precision;
+    const sellPrecision = assets?.assetA?.precision;
+    const precision = side === 'buy' ? buyPrecision : side === 'sell' ? sellPrecision : undefined;
+    return formatAmountByPrecision(value, precision);
+}
+/**
+ * Format an amount with strict precision validation.
+ * Returns 'N/A' if value or precision is invalid.
+ *
+ * @param {*} value - Value to format
+ * @param {number} precision - Decimal precision
+ * @returns {string} Formatted amount or 'N/A'
+ */
+function formatAmountStrict(value, precision) {
+    if (!Number.isFinite(Number(value)) || !Number.isFinite(Number(precision)))
+        return 'N/A';
+    return formatAmountByPrecision(value, precision);
+}
+// ===============================================================================
+// SECTION 2: PRICE FORMATTING
+// ===============================================================================
+/**
+ * Format prices to 8 decimal places (maximum precision)
+ * Used for: order prices, market prices
+ *
+ * @param {number} value - The price to format
+ * @returns {string} Formatted price to 8 decimals
+ */
+function formatPrice(value) {
+    return safeFormat(value, 8);
+}
+function formatPrice6(value) {
+    return safeFormat(value, 6);
+}
+function formatPrice4(value) {
+    return safeFormat(value, 4);
+}
+// ===============================================================================
+// SECTION 3: PERCENTAGE FORMATTING
+// ===============================================================================
+/**
+ * Format percentages to 2 decimal places
+ * Used for: spread %, ratios, simple percentages
+ *
+ * @param {number} value - The percentage value (0-100 or decimal 0-1)
+ * @returns {string} Formatted percentage to 2 decimals
+ */
+function formatPercent2(value) {
+    return safeFormat(value, 2);
+}
+function formatPercent(value, decimals = 2) {
+    return safeFormat(value, decimals);
+}
+// ===============================================================================
+// SECTION 4: RATIO/METRIC FORMATTING
+// ===============================================================================
+/**
+ * Format ratios with custom decimal places
+ *
+ * @param {number} value - The ratio value
+ * @param {number} [decimals=5] - Number of decimal places (default 5)
+ * @returns {string} Formatted ratio
+ */
+function formatRatio(value, decimals = 5) {
+    return safeFormat(value, decimals);
+}
+function formatMetric2(value) {
+    return safeFormat(value, 2);
+}
+function formatMetric5(value) {
+    return safeFormat(value, 5);
+}
+// ===============================================================================
+// SECTION 5: HELPER UTILITIES
+// ===============================================================================
+/**
+ * Check if a value is defined and represents a finite number.
+ * @param {*} value - Value to check
+ * @returns {boolean} True if value is defined and finite
+ */
+function isValidNumber(value) {
+    return value !== null && value !== undefined && Number.isFinite(Number(value));
+}
+function isNumeric(val) {
+    return typeof val === 'number' || (typeof val === 'string' && val.trim() !== '' && !Number.isNaN(Number(val)));
+}
+function toFiniteNumber(value, defaultValue = 0) {
+    const num = Number(value);
+    return Number.isFinite(num) ? num : defaultValue;
+}
+/**
+ * Safely format a numeric value with specified decimals and fallback.
+ *
+ * @param {*} value - The value to format
+ * @param {number} decimals - Number of decimal places
+ * @param {string} [fallback='N/A'] - Fallback value if format fails
+ * @returns {string} Formatted value or fallback string
+ */
+function safeFormat(value, decimals, fallback = 'N/A') {
+    try {
+        if (!isValidNumber(value)) {
+            return fallback;
+        }
+        return Number(value).toFixed(decimals);
+    }
+    catch (e) {
+        return fallback;
+    }
+}
+module.exports = {
+    // Asset formatting
+    formatAmount8,
+    formatAmount,
+    formatAmountByPrecision,
+    formatSizeByOrderType,
+    // Price formatting
+    formatPrice,
+    formatPrice6,
+    formatPrice4,
+    // Percentage formatting
+    formatPercent2,
+    formatPercent,
+    // Ratio/Metric formatting
+    formatRatio,
+    formatMetric2,
+    formatMetric5,
+    // Helper utilities
+    isValidNumber,
+    isNumeric,
+    toFiniteNumber,
+    safeFormat,
+};
+//# sourceMappingURL=format.js.map

package/dist/modules/order/format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.js","sourceRoot":"","sources":["../../../modules/order/format.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AAEH,kFAAkF;AAClF,8BAA8B;AAC9B,kFAAkF;AAElF;;;;;;GAMG;AACH,SAAS,aAAa,CAAC,KAAa;IACnC,OAAO,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;AAC7B,CAAC;AAED;;;;;;GAMG;AACH,SAAS,YAAY,CAAC,KAAa,EAAE,WAAmB,CAAC;IACxD,OAAO,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,uBAAuB,CAAC,KAAa,EAAE,SAA6B;IAC5E,IAAI,SAAS,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;QAC9E,MAAM,IAAI,KAAK,CAAC,kDAAkD,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IACD,OAAO,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,qBAAqB,CAAC,KAAa,EAAE,SAAiB,EAAE,MAA4E;IAC5I,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;IACnD,MAAM,YAAY,GAAG,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC;IAC/C,MAAM,aAAa,GAAG,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC;IAChD,MAAM,SAAS,GAAG,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9F,OAAO,uBAAuB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;AAClD,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,kBAAkB,CAAC,KAAU,EAAE,SAAc;IACrD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IACzF,OAAO,uBAAuB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;AAClD,CAAC;AAED,kFAAkF;AAClF,8BAA8B;AAC9B,kFAAkF;AAElF;;;;;;GAMG;AACH,SAAS,WAAW,CAAC,KAAa;IACjC,OAAO,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;AAC7B,CAAC;AAED,SAAS,YAAY,CAAC,KAAa;IAClC,OAAO,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;AAC7B,CAAC;AAED,SAAS,YAAY,CAAC,KAAa;IAClC,OAAO,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;AAC7B,CAAC;AAED,kFAAkF;AAClF,mCAAmC;AACnC,kFAAkF;AAElF;;;;;;GAMG;AACH,SAAS,cAAc,CAAC,KAAa;IACpC,OAAO,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;AAC7B,CAAC;AAED,SAAS,aAAa,CAAC,KAAa,EAAE,WAAmB,CAAC;IACzD,OAAO,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AACpC,CAAC;AAED,kFAAkF;AAClF,qCAAqC;AACrC,kFAAkF;AAElF;;;;;;GAMG;AACH,SAAS,WAAW,CAAC,KAAa,EAAE,WAAmB,CAAC;IACvD,OAAO,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,aAAa,CAAC,KAAa;IACnC,OAAO,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;AAC7B,CAAC;AAED,SAAS,aAAa,CAAC,KAAa;IACnC,OAAO,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;AAC7B,CAAC;AAED,kFAAkF;AAClF,8BAA8B;AAC9B,kFAAkF;AAElF;;;;GAIG;AACH,SAAS,aAAa,CAAC,KAAU;IAChC,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AAChF,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IAC1B,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAChH,CAAC;AAED,SAAS,cAAc,CAAC,KAAU,EAAE,eAAuB,CAAC;IAC3D,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1B,OAAO,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;AAClD,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,UAAU,CAAC,KAAU,EAAE,QAAgB,EAAE,WAAmB,KAAK;IACzE,IAAI,CAAC;QACJ,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO,QAAQ,CAAC;QACjB,CAAC;QACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QACjB,OAAO,QAAQ,CAAC;IACjB,CAAC;AACF,CAAC;AAMD,iBAAS;IACR,mBAAmB;IACnB,aAAa;IACb,YAAY;IACZ,uBAAuB;IACvB,qBAAqB;IAErB,mBAAmB;IACnB,WAAW;IACX,YAAY;IACZ,YAAY;IAEZ,wBAAwB;IACxB,cAAc;IACd,aAAa;IAEb,0BAA0B;IAC1B,WAAW;IACX,aAAa;IACb,aAAa;IAEb,mBAAmB;IACnB,aAAa;IACb,SAAS;IACT,cAAc;IACd,UAAU;CACV,CAAC"}