Feat/1381 notifications fiat

src/common/utils/__tests__/currencyConvert.test.ts

@@ -6,7 +6,7 @@ describe("Currency coversion utils", () => {
   test("getFiatValue", async () => {
     const result = await getFiatValue({
       amount: 123456789,
-      rate: 29991.836,
+      rate: 0.00029991836,
       currency: CURRENCIES["USD"],
     });
 

src/common/utils/currencyConvert.ts

@@ -3,14 +3,8 @@
  */
 import type { CURRENCIES } from "../constants";
 
-const numSatsInBtc = 100_000_000;
-
-const bitcoinToFiat = async (amountInBtc: number | string, rate: number) => {
-  return Number(amountInBtc) * Number(rate);
-};
-
-const satoshisToBitcoin = (amountInSatoshis: number | string) => {
-  return Number(amountInSatoshis) / numSatsInBtc;
+const satsToFiat = async (amount: number | string, rate: number) => {
+  return Number(amount) * rate;
 };
 
 const satoshisToFiat = async ({
@@ -20,8 +14,7 @@ const satoshisToFiat = async ({
   amountInSats: number | string;
   rate: number;
 }) => {
-  const btc = satoshisToBitcoin(amountInSats);
-  const fiat = await bitcoinToFiat(btc, rate);
+  const fiat = await satsToFiat(amountInSats, rate);
   return fiat;
 };
 

src/extension/background-script/actions/cache/__tests__/getCurrencyRate.test.ts

@@ -32,7 +32,7 @@ describe("currencyRate", () => {
   test("storing rate for the first time", async () => {
     (chrome.storage.local.get as jest.Mock).mockResolvedValue({});
     const result = await getCurrencyRate(message);
-    expect(result.data.rate).toBe(29991.836);
+    expect(result.data.rate).toBe(0.00029991836);
   });
 
   test("storing rate if it is outdated", async () => {
@@ -46,9 +46,9 @@ describe("currencyRate", () => {
     const result = await getCurrencyRate(message);
     expect(chrome.storage.local.set).toHaveBeenCalledWith({
       currencyRate:
-        '{"currency":"USD","rate":29991.836,"timestamp":1577836800000}',
+        '{"currency":"USD","rate":0.00029991836,"timestamp":1577836800000}',
     });
-    expect(result.data.rate).toBe(29991.836);
+    expect(result.data.rate).toBe(0.00029991836);
   });
 
   test("returning rate if still valid", async () => {
@@ -75,7 +75,7 @@ describe("currencyRate", () => {
     await getCurrencyRate(message);
     expect(chrome.storage.local.set).toHaveBeenCalledWith({
       currencyRate:
-        '{"currency":"USD","rate":29991.836,"timestamp":1577836800000}',
+        '{"currency":"USD","rate":0.00029991836,"timestamp":1577836800000}',
     });
   });
 });

src/extension/background-script/actions/cache/getCurrencyRate.ts

@@ -14,6 +14,8 @@ interface CurrencyRate {
   timestamp?: number;
 }
 
+export const numSatsInBtc = 100_000_000;
+
 const storeCurrencyRate = async ({ rate, currency }: CurrencyRate) => {
   const currencyRate: CurrencyRate = {
     currency,
@@ -37,25 +39,26 @@ const getFiatBtcRate = async (currency: CURRENCIES): Promise<number> => {
       `https://api.yadio.io/exrates/${currency.toLowerCase()}`
     );
     const data = await response?.data;
-    return data.BTC;
+    return data.BTC / numSatsInBtc;
   }
 
   if (exchange === "coindesk") {
     response = await axios.get(
       `https://api.coindesk.com/v1/bpi/currentprice/${currency.toLowerCase()}.json`
     );
     const data = await response?.data;
-    return data.bpi[currency].rate_float;
+    return data.bpi[currency].rate_float / numSatsInBtc;
   }
 
   response = await axios.get(
     `https://getalby.com/api/rates/${currency.toLowerCase()}.json`
   );
   const data = await response?.data;
-  return data[currency].rate_float;
+
+  return data[currency].rate_float / numSatsInBtc;
 };
 
-const getCurrencyRateFromCache = async (currency: CURRENCIES) => {
+export const getCurrencyRateFromCache = async (currency: CURRENCIES) => {
   let currencyRateCache: CurrencyRate = {};
   const result = await browser.storage.local.get(["currencyRate"]);
 
@@ -67,13 +70,12 @@ const getCurrencyRateFromCache = async (currency: CURRENCIES) => {
         dayjs(currencyRateCache?.timestamp).add(10, "minute")
       );
 
-      if (isRateNewEnough) {
+      if (isRateNewEnough && currencyRateCache.rate) {
         return currencyRateCache.rate;
       }
 
       const rate = await getFiatBtcRate(currency);
       await storeCurrencyRate({ rate, currency });
-      // switch rate to be SATS not BTC
       return rate;
     }
   }

src/extension/background-script/events/__test__/notifications.test.ts

@@ -1,11 +1,42 @@
+import { CURRENCIES } from "~/common/constants";
 import utils from "~/common/lib/utils";
-import type { PaymentNotificationData, AuthNotificationData } from "~/types";
+import state from "~/extension/background-script/state";
+import type {
+  PaymentNotificationData,
+  AuthNotificationData,
+  SettingsStorage,
+} from "~/types";
 
 import {
   paymentSuccessNotification,
   lnurlAuthSuccessNotification,
 } from "../notifications";
 
+jest.mock("~/extension/background-script/actions/cache/getCurrencyRate", () => {
+  return {
+    getCurrencyRateFromCache: jest.fn(() => Promise.resolve(0.00019233)),
+  };
+});
+
+const settings: SettingsStorage = {
+  browserNotifications: true,
+  currency: CURRENCIES["USD"],
+  debug: false,
+  exchange: "coindesk",
+  isUsingLegacyLnurlAuthKey: false,
+  legacyLnurlAuth: false,
+  locale: "",
+  showFiat: true,
+  theme: "",
+  userEmail: "",
+  userName: "",
+  websiteEnhancements: true,
+};
+
+const mockState = {
+  settings,
+};
+
 describe("Payment notifications", () => {
   afterEach(() => {
     jest.clearAllMocks();
@@ -91,24 +122,61 @@ describe("Payment notifications", () => {
   };
 
   test("success via lnaddress from popup", async () => {
+    state.getState = jest.fn().mockReturnValue(mockState);
+    const notifySpy = jest.spyOn(utils, "notify");
+    await paymentSuccessNotification("ln.sendPayment.success", data);
+
+    expect(notifySpy).toHaveBeenCalledWith({
+      message: "Amount: 1 sat ($0.00)\nFee: 0 sats",
+      title: "✅ Successfully paid to »escapedcat@getalby.com«",
+    });
+  });
+
+  test("success via lnaddress from popup without fiat-conversion turned off", async () => {
+    const mockStateNoFiat = {
+      settings: { ...settings, showFiat: false },
+    };
+
+    state.getState = jest.fn().mockReturnValue(mockStateNoFiat);
+
+    const notifySpy = jest.spyOn(utils, "notify");
+    await paymentSuccessNotification("ln.sendPayment.success", data);
+
+    expect(notifySpy).toHaveBeenCalledWith({
+      message: "Amount: 1 sat\nFee: 0 sats",
+      title: "✅ Successfully paid to »escapedcat@getalby.com«",
+    });
+  });
+
+  test("success via lnaddress from popup without fiat-conversion turned on", async () => {
+    const mockStateNoFiat = {
+      settings: { ...settings },
+    };
+
+    state.getState = jest.fn().mockReturnValue(mockStateNoFiat);
+
     const notifySpy = jest.spyOn(utils, "notify");
-    paymentSuccessNotification("ln.sendPayment.success", data);
+    await paymentSuccessNotification("ln.sendPayment.success", data);
 
     expect(notifySpy).toHaveBeenCalledWith({
-      title: "✅ Successfully paid 1 sat to »escapedcat@getalby.com«",
-      message: "Fee: 0 sats",
+      message: "Amount: 1 sat ($0.00)\nFee: 0 sats",
+      title: "✅ Successfully paid to »escapedcat@getalby.com«",
     });
   });
 
   test("success without origin skips receiver", async () => {
+    state.getState = jest.fn().mockReturnValue(mockState);
     const notifySpy = jest.spyOn(utils, "notify");
     const dataWitouthOrigin = { ...data };
     delete dataWitouthOrigin.origin;
-    paymentSuccessNotification("ln.sendPayment.success", dataWitouthOrigin);
+    await paymentSuccessNotification(
+      "ln.sendPayment.success",
+      dataWitouthOrigin
+    );
 
     expect(notifySpy).toHaveBeenCalledWith({
-      title: "✅ Successfully paid 1 sat",
-      message: "Fee: 0 sats",
+      message: "Amount: 1 sat ($0.00)\nFee: 0 sats",
+      title: "✅ Successfully paid",
     });
   });
 });

src/extension/background-script/events/notifications.ts

@@ -1,7 +1,10 @@
 import utils from "~/common/lib/utils";
+import { getFiatValue } from "~/common/utils/currencyConvert";
+import { getCurrencyRateFromCache } from "~/extension/background-script/actions/cache/getCurrencyRate";
+import state from "~/extension/background-script/state";
 import type { PaymentNotificationData, AuthNotificationData } from "~/types";
 
-const paymentSuccessNotification = (
+const paymentSuccessNotification = async (
   message: "ln.sendPayment.success",
   data: PaymentNotificationData
 ) => {
@@ -11,6 +14,7 @@ const paymentSuccessNotification = (
 
   const recipient = data?.origin?.name;
   const paymentResponseData = data.response;
+  let paymentAmountFiatLocale;
 
   if ("error" in paymentResponseData) {
     return;
@@ -20,13 +24,34 @@ const paymentSuccessNotification = (
   const { total_amt, total_fees } = route;
   const paymentAmount = total_amt - total_fees;
 
-  let notificationTitle = `✅ Successfully paid ${formatAmount(paymentAmount)}`;
+  const { settings } = state.getState();
+  const { showFiat, currency } = settings;
+
+  if (showFiat) {
+    const rate = await getCurrencyRateFromCache(currency);
+
+    paymentAmountFiatLocale = await getFiatValue({
+      amount: paymentAmount,
+      rate,
+      currency,
+    });
+  }
+
+  let notificationTitle = "✅ Successfully paid";
 
   if (recipient) {
     notificationTitle = `${notificationTitle} to »${recipient}«`;
   }
 
-  const notificationMessage = `Fee: ${formatAmount(total_fees)}`;
+  let notificationMessage = `Amount: ${formatAmount(paymentAmount)}`;
+
+  if (showFiat) {
+    notificationMessage = `${notificationMessage} (${paymentAmountFiatLocale})`;
+  }
+
+  notificationMessage = `${notificationMessage}\nFee: ${formatAmount(
+    total_fees
+  )}`;
 
   return utils.notify({
     title: notificationTitle,