feat: use satcomma to format notification amounts

BoltzExchange · Oct 10, 2023 · 06c9f6d · 06c9f6d
1 parent 0c38daf
commit 06c9f6d
Show file tree

Hide file tree

Showing 11 changed files with 232 additions and 205 deletions.
diff --git a/lib/DenominationConverter.ts b/lib/DenominationConverter.ts
@@ -1,22 +1,41 @@
-const decimals = 100_000_000;
+const decimals = 8;
+const satFactor = 100_000_000;
+
+/**
+ * Round a number to a specific amount of decimals
+ */
+const roundToDecimals = (number: number, decimals: number): number => {
+  return Number(number.toFixed(decimals));
+};
 
 /**
  * Convert whole coins to satoshis
  */
 export const coinsToSatoshis = (coins: number): number => {
-  return coins * decimals;
+  return coins * satFactor;
 };
 
 /**
  * Convert satoshis to whole coins and remove trailing zeros
  */
 export const satoshisToCoins = (satoshis: number): number => {
-  return roundToDecimals(satoshis / decimals, 8);
+  return roundToDecimals(satoshis / satFactor, decimals);
 };
 
 /**
- * Round a number to a specific amount of decimals
+ * Convert satoshis to whole coins with trailing zeros
  */
-const roundToDecimals = (number: number, decimals: number): number => {
-  return Number(number.toFixed(decimals));
+export const satoshisToPaddedCoins = (satoshis: number): string => {
+  return (satoshis / satFactor).toFixed(decimals);
+};
+
+export const satoshisToSatcomma = (satoshis: number): string => {
+  let coins = (satoshis / satFactor).toFixed(decimals);
+  for (const [num, index] of [3, 6].entries()) {
+    coins = `${coins.substring(
+      0,
+      coins.length - index - num,
+    )},${coins.substring(coins.length - index - num)}`;
+  }
+  return coins;
 };
diff --git a/lib/data/Stats.ts b/lib/data/Stats.ts
@@ -1,5 +1,5 @@
 import { getNestedObject } from './Utils';
-import { satoshisToCoins } from '../DenominationConverter';
+import { satoshisToPaddedCoins } from '../DenominationConverter';
 import StatsRepository, { StatsDate } from '../db/repositories/StatsRepository';
 
 type MonthStats = {
@@ -32,7 +32,7 @@ class Stats {
 
     volumes.forEach((volume) => {
       const obj = getNestedObject(getMonthObj(volume), 'volume');
-      obj[volume.pair || Stats.totalString] = satoshisToCoins(volume.sum);
+      obj[volume.pair || Stats.totalString] = satoshisToPaddedCoins(volume.sum);
     });
 
     tradeCounts.forEach((counts) => {

diff --git a/lib/notifications/BalanceChecker.ts b/lib/notifications/BalanceChecker.ts
@@ -4,8 +4,8 @@ import Service from '../service/Service';
 import DiscordClient from './DiscordClient';
 import { Balances } from '../proto/boltzrpc_pb';
 import { liquidSymbol } from '../consts/LiquidTypes';
-import { satoshisToCoins } from '../DenominationConverter';
 import { BaseCurrencyConfig, TokenConfig } from '../Config';
+import { satoshisToSatcomma } from '../DenominationConverter';
 
 enum BalanceType {
   Wallet,
@@ -152,16 +152,16 @@ class BalanceChecker {
       if (type === BalanceType.Wallet) {
         message = `${
           Emojis.Checkmark
-        } ${name} wallet balance of ${satoshisToCoins(
+        } ${name} wallet balance of ${satoshisToSatcomma(
           balance,
         )} is in bounds again ${Emojis.Checkmark}`;
       } else {
         message =
           `${Emojis.Checkmark} ${name} ${
             type === BalanceType.ChannelLocal ? 'local' : 'remote'
           } channel balance ` +
-          `of ${satoshisToCoins(balance)} is more than expected ` +
-          `${satoshisToCoins(
+          `of ${satoshisToSatcomma(balance)} is more than expected ` +
+          `${satoshisToSatcomma(
             type === BalanceType.ChannelLocal
               ? currency.minLocalBalance!
               : currency.minRemoteBalance!,
@@ -171,20 +171,20 @@ class BalanceChecker {
       if (type === BalanceType.Wallet) {
         message =
           `${Emojis.RotatingLight} **${name} wallet balance is out of bounds** ${Emojis.RotatingLight}\n` +
-          `  Balance: ${satoshisToCoins(balance)}\n` +
+          `  Balance: ${satoshisToSatcomma(balance)}\n` +
           `${
             currency.maxWalletBalance
-              ? `    Max: ${satoshisToCoins(currency.maxWalletBalance)}\n`
+              ? `    Max: ${satoshisToSatcomma(currency.maxWalletBalance)}\n`
               : ''
           }` +
-          `    Min: ${satoshisToCoins(currency.minWalletBalance)}`;
+          `    Min: ${satoshisToSatcomma(currency.minWalletBalance)}`;
       } else {
         message =
           `${Emojis.RotatingLight} **${name} ${
             type === BalanceType.ChannelLocal ? 'local' : 'remote'
           } channel balance ` +
-          `of ${satoshisToCoins(balance)} is less than expected ` +
-          `${satoshisToCoins(
+          `of ${satoshisToSatcomma(balance)} is less than expected ` +
+          `${satoshisToSatcomma(
             type === BalanceType.ChannelLocal
               ? currency.minLocalBalance!
               : currency.minRemoteBalance!,

diff --git a/lib/notifications/CommandHandler.ts b/lib/notifications/CommandHandler.ts
@@ -14,8 +14,8 @@ import BackupScheduler from '../backup/BackupScheduler';
 import ChannelCreation from '../db/models/ChannelCreation';
 import FeeRepository from '../db/repositories/FeeRepository';
 import SwapRepository from '../db/repositories/SwapRepository';
-import { coinsToSatoshis, satoshisToCoins } from '../DenominationConverter';
 import ReverseSwapRepository from '../db/repositories/ReverseSwapRepository';
+import { coinsToSatoshis, satoshisToSatcomma } from '../DenominationConverter';
 import ChannelCreationRepository from '../db/repositories/ChannelCreationRepository';
 import {
   stringify,
@@ -257,7 +257,7 @@ class CommandHandler {
   private getFees = async () => {
     let message = 'Fees:\n';
     (await FeeRepository.getFees()).forEach(({ asset, sum }) => {
-      message += `\n**${asset}**: ${satoshisToCoins(sum)} ${asset}`;
+      message += `\n**${asset}**: ${satoshisToSatcomma(sum)} ${asset}`;
     });
 
     await this.discord.sendMessage(message);
@@ -350,7 +350,7 @@ class CommandHandler {
       message += `\n\n**${symbol}**\n`;
 
       bals.walletsMap.forEach(([service, walletBals]) => {
-        message += `\n${service} Wallet: ${satoshisToCoins(
+        message += `\n${service} Wallet: ${satoshisToSatcomma(
           walletBals.confirmed + walletBals.unconfirmed,
         )} ${symbol}`;
       });
@@ -362,8 +362,8 @@ class CommandHandler {
       bals.lightningMap.forEach(([service, lightningBals]) => {
         message +=
           `\n${service}:\n` +
-          `  Local: ${satoshisToCoins(lightningBals.local)} ${symbol}\n` +
-          `  Remote: ${satoshisToCoins(lightningBals.remote)} ${symbol}`;
+          `  Local: ${satoshisToSatcomma(lightningBals.local)} ${symbol}\n` +
+          `  Remote: ${satoshisToSatcomma(lightningBals.remote)} ${symbol}`;
       });
     });
 
@@ -410,12 +410,12 @@ class CommandHandler {
 
       for (const pendingReverseSwap of chainArray) {
         symbolTotal += pendingReverseSwap.onchainAmount;
-        message += `\n  - \`${pendingReverseSwap.id}\`: ${satoshisToCoins(
+        message += `\n  - \`${pendingReverseSwap.id}\`: ${satoshisToSatcomma(
           pendingReverseSwap.onchainAmount,
         )}`;
       }
 
-      message += `\n\nTotal: ${satoshisToCoins(symbolTotal)}\n`;
+      message += `\n\nTotal: ${satoshisToSatcomma(symbolTotal)}\n`;
     }
 
     await this.discord.sendMessage(message);

diff --git a/lib/notifications/NotificationProvider.ts b/lib/notifications/NotificationProvider.ts
@@ -11,7 +11,7 @@ import DiskUsageChecker from './DiskUsageChecker';
 import ReverseSwap from '../db/models/ReverseSwap';
 import BackupScheduler from '../backup/BackupScheduler';
 import { CurrencyType, OrderSide } from '../consts/Enums';
-import { satoshisToCoins } from '../DenominationConverter';
+import { satoshisToSatcomma } from '../DenominationConverter';
 import { ChainInfo, LightningInfo } from '../proto/boltzrpc_pb';
 import { TokenConfig, BaseCurrencyConfig, NotificationConfig } from '../Config';
 import {
@@ -192,12 +192,12 @@ class NotificationProvider {
         message +=
           `${
             swap.onchainAmount
-              ? `\nOnchain amount: ${satoshisToCoins(
+              ? `\nOnchain amount: ${satoshisToSatcomma(
                   swap.onchainAmount,
                 )} ${onchainSymbol}`
               : ''
           }` +
-          `\nLightning amount: ${satoshisToCoins(
+          `\nLightning amount: ${satoshisToSatcomma(
             lightningAmount,
           )} ${lightningSymbol}`;
       }
@@ -250,12 +250,10 @@ class NotificationProvider {
             hasChannelCreation ? ' :construction_site:' : ''
           }**\n` +
           `${getBasicSwapInfo(swap, onchainSymbol, lightningSymbol)}\n` +
-          `Fees earned: ${this.numberToDecimal(
-            satoshisToCoins(swap.fee!),
-          )} ${onchainSymbol}\n` +
-          `Miner fees: ${satoshisToCoins(swap.minerFee!)} ${getMinerFeeSymbol(
-            onchainSymbol,
-          )}`;
+          `Fees earned: ${satoshisToSatcomma(swap.fee!)} ${onchainSymbol}\n` +
+          `Miner fees: ${satoshisToSatcomma(
+            swap.minerFee!,
+          )} ${getMinerFeeSymbol(onchainSymbol)}`;
 
         if (!isReverse) {
           // The routing fees are denominated in millisatoshi
@@ -300,7 +298,7 @@ class NotificationProvider {
 
         if (isReverse) {
           if (swap.minerFee) {
-            message += `\nMiner fees: ${satoshisToCoins(
+            message += `\nMiner fees: ${satoshisToSatcomma(
               swap.minerFee,
             )} ${onchainSymbol}`;
           }
@@ -350,24 +348,6 @@ class NotificationProvider {
         return 'satoshi';
     }
   };
-
-  private numberToDecimal = (toFormat: number) => {
-    // Numbers smaller 1e-6 are formatted in the scientific notation when converted to a string
-    if (toFormat < 1e-6) {
-      let format = toFormat.toFixed(8);
-
-      // Trim the trailing zeros if they exist
-      const lastZero = format.lastIndexOf('0');
-
-      if (lastZero === format.length - 1) {
-        format = format.slice(0, format.length - 1);
-      }
-
-      return format;
-    } else {
-      return toFormat.toString();
-    }
-  };
 }
 
 export default NotificationProvider;