@fedimint/react 0.0.0-canary-20241023092328

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 fedimint
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,30 @@
+# React + TypeScript + Vite
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+
+## Expanding the ESLint configuration
+
+If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+
+- Configure the top-level `parserOptions` property like this:
+
+```js
+export default {
+  // other rules...
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    project: ['./tsconfig.json', './tsconfig.node.json'],
+    tsconfigRootDir: __dirname,
+  },
+}
+```
+
+- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
+- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
+- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list

package/dist/contexts/FedimintWalletContext.d.ts

@@ -0,0 +1,15 @@
+import { FedimintWallet } from '@fedimint/core-web';
+type FedimintWalletConfig = {
+    lazy?: boolean;
+    debug?: boolean;
+};
+export declare const setupFedimintWallet: (config: FedimintWalletConfig) => void;
+export declare const FedimintWalletContext: import('react').Context<{
+    wallet: FedimintWallet;
+} | undefined>;
+export type FedimintWalletProviderProps = {};
+export declare const FedimintWalletProvider: (parameters: React.PropsWithChildren<FedimintWalletProviderProps>) => import('react').FunctionComponentElement<import('react').ProviderProps<{
+    wallet: FedimintWallet;
+} | undefined>>;
+export {};
+//# sourceMappingURL=FedimintWalletContext.d.ts.map

package/dist/contexts/FedimintWalletContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FedimintWalletContext.d.ts","sourceRoot":"","sources":["../../lib/contexts/FedimintWalletContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAKnD,KAAK,oBAAoB,GAAG;IAC1B,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,eAAO,MAAM,mBAAmB,WAAY,oBAAoB,SAK/D,CAAA;AAED,eAAO,MAAM,qBAAqB;YACtB,cAAc;cACd,CAAA;AAEZ,MAAM,MAAM,2BAA2B,GAAG,EAAE,CAAA;AAE5C,eAAO,MAAM,sBAAsB,eACrB,KAAK,CAAC,iBAAiB,CAAC,2BAA2B,CAAC;YANtD,cAAc;eAkBzB,CAAA"}

package/dist/contexts/index.d.ts

@@ -0,0 +1,3 @@
+import { FedimintWalletContext, FedimintWalletProvider, setupFedimintWallet } from './FedimintWalletContext';
+export { FedimintWalletContext, FedimintWalletProvider, setupFedimintWallet };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/contexts/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,mBAAmB,EACpB,MAAM,yBAAyB,CAAA;AAEhC,OAAO,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,CAAA"}

package/dist/hooks/index.d.ts

@@ -0,0 +1,6 @@
+export { useBalance } from './useBalance';
+export { useOpenWallet } from './useOpenWallet';
+export { useFedimintWallet } from './useFedimintWallet';
+export { useReceiveLightning } from './useReceiveLightning';
+export { useSendLightning } from './useSendLightning';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA"}

package/dist/hooks/useBalance.d.ts

@@ -0,0 +1,2 @@
+export declare const useBalance: () => number | undefined;
+//# sourceMappingURL=useBalance.d.ts.map

package/dist/hooks/useBalance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useBalance.d.ts","sourceRoot":"","sources":["../../lib/hooks/useBalance.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,UAAU,0BAkBtB,CAAA"}

package/dist/hooks/useFedimintWallet.d.ts

@@ -0,0 +1,2 @@
+export declare const useFedimintWallet: () => import('@fedimint/core-web').FedimintWallet;
+//# sourceMappingURL=useFedimintWallet.d.ts.map

package/dist/hooks/useFedimintWallet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFedimintWallet.d.ts","sourceRoot":"","sources":["../../lib/hooks/useFedimintWallet.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,iBAAiB,mDAQ7B,CAAA"}

package/dist/hooks/useOpenWallet.d.ts

@@ -0,0 +1,8 @@
+type WalletStatus = 'open' | 'closed' | 'opening';
+export declare const useOpenWallet: () => {
+    walletStatus: WalletStatus | undefined;
+    openWallet: () => void;
+    joinFederation: (invite: string) => Promise<void>;
+};
+export {};
+//# sourceMappingURL=useOpenWallet.d.ts.map

package/dist/hooks/useOpenWallet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useOpenWallet.d.ts","sourceRoot":"","sources":["../../lib/hooks/useOpenWallet.ts"],"names":[],"mappings":"AAGA,KAAK,YAAY,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAA;AAEjD,eAAO,MAAM,aAAa;;;6BAcP,MAAM;CAsBxB,CAAA"}

package/dist/hooks/useReceiveLightning.d.ts

@@ -0,0 +1,8 @@
+import { LnReceiveState } from '@fedimint/core-web';
+export declare const useReceiveLightning: () => {
+    generateInvoice: (amount: number, description: string) => Promise<string>;
+    bolt11: string | undefined;
+    invoiceStatus: LnReceiveState | undefined;
+    error: string | undefined;
+};
+//# sourceMappingURL=useReceiveLightning.d.ts.map

package/dist/hooks/useReceiveLightning.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useReceiveLightning.d.ts","sourceRoot":"","sources":["../../lib/hooks/useReceiveLightning.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAA6B,MAAM,oBAAoB,CAAA;AAE9E,eAAO,MAAM,mBAAmB;8BASb,MAAM,eAAe,MAAM;;;;CAgC7C,CAAA"}

package/dist/hooks/useSendLightning.d.ts

@@ -0,0 +1,8 @@
+import { LnPayState, OutgoingLightningPayment } from '@fedimint/core-web';
+export declare const useSendLightning: () => {
+    payInvoice: (bolt11: string) => Promise<OutgoingLightningPayment>;
+    payment: OutgoingLightningPayment | undefined;
+    paymentStatus: LnPayState | undefined;
+    paymentError: string | undefined;
+};
+//# sourceMappingURL=useSendLightning.d.ts.map

package/dist/hooks/useSendLightning.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSendLightning.d.ts","sourceRoot":"","sources":["../../lib/hooks/useSendLightning.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,UAAU,EACf,KAAK,wBAAwB,EAC9B,MAAM,oBAAoB,CAAA;AAE3B,eAAO,MAAM,gBAAgB;yBAQV,MAAM;;;;CAiCxB,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './hooks';
+export * from './contexts';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA"}

package/dist/index.js

@@ -0,0 +1,121 @@
+import { useState as s, useEffect as d, useCallback as u, createContext as y, createElement as f, useContext as S } from "react";
+import { FedimintWallet as W } from "@fedimint/core-web";
+const I = () => {
+  const e = w(), { walletStatus: n } = b(), [t, i] = s();
+  return d(() => {
+    if (n !== "open") return;
+    const a = e.balance.subscribeBalance((r) => {
+      i(r);
+    });
+    return () => {
+      a();
+    };
+  }, [n]), t;
+}, b = () => {
+  const e = w(), [n, t] = s(), i = u(() => {
+    n !== "open" && (t("opening"), e.open().then((r) => {
+      t(r ? "open" : "closed");
+    }));
+  }, [e]), a = u(
+    async (r) => {
+      if (n === "open") return;
+      t("opening");
+      const l = await e.joinFederation(r);
+      t(l ? "open" : "closed");
+    },
+    [e]
+  );
+  return d(() => (e.waitForOpen().then(() => {
+    t("open");
+  }), () => {
+    t("closed");
+  }), [e]), { walletStatus: n, openWallet: i, joinFederation: a };
+};
+let p;
+const L = (e) => {
+  p = new W(!!e.lazy), e.debug && p.setLogLevel("debug");
+}, h = y(void 0), P = (e) => {
+  const { children: n } = e;
+  if (!p)
+    throw new Error(
+      "You must call setupFedimintWallet() first. See the getting started guide."
+    );
+  const t = { value: { wallet: p } };
+  return f(h.Provider, t, n);
+}, w = () => {
+  const e = S(h);
+  if (!(e != null && e.wallet))
+    throw new Error(
+      "useFedimintWallet must be used within a FedimintWalletProvider"
+    );
+  return e.wallet;
+}, x = () => {
+  const e = w(), { walletStatus: n } = b(), [t, i] = s(), [a, r] = s(), [l, g] = s(), m = u(
+    async (c, o) => {
+      if (n !== "open") throw new Error("Wallet is not open");
+      const v = await e.lightning.createInvoice(c, o);
+      return i(v), v.invoice;
+    },
+    [e, n]
+  );
+  return d(() => {
+    if (n !== "open" || !t) return;
+    const c = e.lightning.subscribeLnReceive(
+      t.operation_id,
+      (o) => {
+        r(o);
+      },
+      (o) => {
+        g(o);
+      }
+    );
+    return () => {
+      c();
+    };
+  }, [n, t]), {
+    generateInvoice: m,
+    bolt11: t == null ? void 0 : t.invoice,
+    invoiceStatus: a,
+    error: l
+  };
+}, C = () => {
+  const e = w(), { walletStatus: n } = b(), [t, i] = s(), [a, r] = s(), [l, g] = s(), m = u(
+    async (c) => {
+      if (n !== "open") throw new Error("Wallet is not open");
+      const o = await e.lightning.payInvoice(c);
+      return i(o), o;
+    },
+    [e, n]
+  );
+  return d(() => {
+    if (n !== "open" || !t) return;
+    const c = e.lightning.subscribeLnPay(
+      // @ts-ignore
+      t.payment_type.lightning,
+      (o) => {
+        r(o);
+      },
+      (o) => {
+        g(o);
+      }
+    );
+    return () => {
+      c();
+    };
+  }, [n, t]), {
+    payInvoice: m,
+    payment: t,
+    paymentStatus: a,
+    paymentError: l
+  };
+};
+export {
+  h as FedimintWalletContext,
+  P as FedimintWalletProvider,
+  L as setupFedimintWallet,
+  I as useBalance,
+  w as useFedimintWallet,
+  b as useOpenWallet,
+  x as useReceiveLightning,
+  C as useSendLightning
+};

package/dist/init.d.ts

@@ -0,0 +1,2 @@
+export declare const initFedimintReact: (lazy?: boolean) => {};
+//# sourceMappingURL=init.d.ts.map

package/dist/init.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../lib/init.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,iBAAiB,UAAU,OAAO,OAM9C,CAAA"}

package/lib/contexts/FedimintWalletContext.ts

@@ -0,0 +1,37 @@
+import { FedimintWallet } from '@fedimint/core-web'
+import { createContext, createElement } from 'react'
+
+let wallet: FedimintWallet
+
+type FedimintWalletConfig = {
+  lazy?: boolean
+  debug?: boolean
+}
+
+export const setupFedimintWallet = (config: FedimintWalletConfig) => {
+  wallet = new FedimintWallet(!!config.lazy)
+  if (config.debug) {
+    wallet.setLogLevel('debug')
+  }
+}
+
+export const FedimintWalletContext = createContext<
+  { wallet: FedimintWallet } | undefined
+>(undefined)
+
+export type FedimintWalletProviderProps = {}
+
+export const FedimintWalletProvider = (
+  parameters: React.PropsWithChildren<FedimintWalletProviderProps>,
+) => {
+  const { children } = parameters
+
+  if (!wallet)
+    throw new Error(
+      'You must call setupFedimintWallet() first. See the getting started guide.',
+    )
+
+  const props = { value: { wallet } }
+
+  return createElement(FedimintWalletContext.Provider, props, children)
+}

package/lib/contexts/index.ts

@@ -0,0 +1,7 @@
+import {
+  FedimintWalletContext,
+  FedimintWalletProvider,
+  setupFedimintWallet,
+} from './FedimintWalletContext'
+
+export { FedimintWalletContext, FedimintWalletProvider, setupFedimintWallet }

package/lib/hooks/index.ts

@@ -0,0 +1,5 @@
+export { useBalance } from './useBalance'
+export { useOpenWallet } from './useOpenWallet'
+export { useFedimintWallet } from './useFedimintWallet'
+export { useReceiveLightning } from './useReceiveLightning'
+export { useSendLightning } from './useSendLightning'

package/lib/hooks/useBalance.ts

@@ -0,0 +1,22 @@
+import { useEffect, useState } from 'react'
+import { useFedimintWallet, useOpenWallet } from '.'
+
+export const useBalance = () => {
+  const wallet = useFedimintWallet()
+  const { walletStatus } = useOpenWallet()
+  const [balance, setBalance] = useState<number>()
+
+  useEffect(() => {
+    if (walletStatus !== 'open') return
+
+    const unsubscribe = wallet.balance.subscribeBalance((balance) => {
+      setBalance(balance)
+    })
+
+    return () => {
+      unsubscribe()
+    }
+  }, [walletStatus])
+
+  return balance
+}

package/lib/hooks/useFedimintWallet.ts

@@ -0,0 +1,12 @@
+import { useContext } from 'react'
+import { FedimintWalletContext } from '../contexts'
+
+export const useFedimintWallet = () => {
+  const value = useContext(FedimintWalletContext)
+  if (!value?.wallet) {
+    throw new Error(
+      'useFedimintWallet must be used within a FedimintWalletProvider',
+    )
+  }
+  return value.wallet
+}

package/lib/hooks/useOpenWallet.ts

@@ -0,0 +1,42 @@
+import { useCallback, useEffect, useState } from 'react'
+import { useFedimintWallet } from '.'
+
+type WalletStatus = 'open' | 'closed' | 'opening'
+
+export const useOpenWallet = () => {
+  const wallet = useFedimintWallet()
+  const [walletStatus, setWalletStatus] = useState<WalletStatus>()
+
+  const openWallet = useCallback(() => {
+    if (walletStatus === 'open') return
+
+    setWalletStatus('opening')
+    wallet.open().then((res) => {
+      setWalletStatus(res ? 'open' : 'closed')
+    })
+  }, [wallet])
+
+  const joinFederation = useCallback(
+    async (invite: string) => {
+      if (walletStatus === 'open') return
+
+      setWalletStatus('opening')
+
+      const res = await wallet.joinFederation(invite)
+      setWalletStatus(res ? 'open' : 'closed')
+    },
+    [wallet],
+  )
+
+  useEffect(() => {
+    wallet.waitForOpen().then(() => {
+      setWalletStatus('open')
+    })
+
+    return () => {
+      setWalletStatus('closed')
+    }
+  }, [wallet])
+
+  return { walletStatus, openWallet, joinFederation }
+}

package/lib/hooks/useReceiveLightning.ts

@@ -0,0 +1,46 @@
+import { useCallback, useEffect, useState } from 'react'
+import { useFedimintWallet, useOpenWallet } from '.'
+import { LnReceiveState, type CreateBolt11Response } from '@fedimint/core-web'
+
+export const useReceiveLightning = () => {
+  const wallet = useFedimintWallet()
+  const { walletStatus } = useOpenWallet()
+  const [invoice, setInvoice] = useState<CreateBolt11Response>()
+  const [invoiceReceiveState, setInvoiceReceiveState] =
+    useState<LnReceiveState>()
+  const [error, setError] = useState<string>()
+
+  const generateInvoice = useCallback(
+    async (amount: number, description: string) => {
+      if (walletStatus !== 'open') throw new Error('Wallet is not open')
+      const response = await wallet.lightning.createInvoice(amount, description)
+      setInvoice(response)
+      return response.invoice
+    },
+    [wallet, walletStatus],
+  )
+
+  useEffect(() => {
+    if (walletStatus !== 'open' || !invoice) return
+    const unsubscribe = wallet.lightning.subscribeLnReceive(
+      invoice.operation_id,
+      (state) => {
+        setInvoiceReceiveState(state)
+      },
+      (error) => {
+        setError(error)
+      },
+    )
+
+    return () => {
+      unsubscribe()
+    }
+  }, [walletStatus, invoice])
+
+  return {
+    generateInvoice,
+    bolt11: invoice?.invoice,
+    invoiceStatus: invoiceReceiveState,
+    error,
+  }
+}

package/lib/hooks/useSendLightning.ts

@@ -0,0 +1,49 @@
+import { useCallback, useEffect, useState } from 'react'
+import { useFedimintWallet, useOpenWallet } from '.'
+import {
+  type LnPayState,
+  type OutgoingLightningPayment,
+} from '@fedimint/core-web'
+
+export const useSendLightning = () => {
+  const wallet = useFedimintWallet()
+  const { walletStatus } = useOpenWallet()
+  const [payment, setPayment] = useState<OutgoingLightningPayment>()
+  const [paymentState, setPaymentState] = useState<LnPayState>()
+  const [error, setError] = useState<string>()
+
+  const payInvoice = useCallback(
+    async (bolt11: string) => {
+      if (walletStatus !== 'open') throw new Error('Wallet is not open')
+      const response = await wallet.lightning.payInvoice(bolt11)
+      setPayment(response)
+      return response
+    },
+    [wallet, walletStatus],
+  )
+
+  useEffect(() => {
+    if (walletStatus !== 'open' || !payment) return
+    const unsubscribe = wallet.lightning.subscribeLnPay(
+      // @ts-ignore
+      payment.payment_type.lightning,
+      (state) => {
+        setPaymentState(state)
+      },
+      (error) => {
+        setError(error)
+      },
+    )
+
+    return () => {
+      unsubscribe()
+    }
+  }, [walletStatus, payment])
+
+  return {
+    payInvoice,
+    payment,
+    paymentStatus: paymentState,
+    paymentError: error,
+  }
+}

package/lib/index.ts

@@ -0,0 +1,2 @@
+export * from './hooks'
+export * from './contexts'

package/lib/init.ts

@@ -0,0 +1,11 @@
+import { FedimintWallet } from '@fedimint/core-web'
+
+let wallet: FedimintWallet | undefined
+
+export const initFedimintReact = (lazy: boolean = false) => {
+  if (!lazy) {
+    wallet = new FedimintWallet(lazy)
+  }
+
+  return {}
+}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@fedimint/react",
+  "version": "0.0.0-canary-20241023092328",
+  "type": "module",
+  "files": [
+    "dist",
+    "lib"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "peerDependencies": {
+    "react": "^18.3.1",
+    "@fedimint/core-web": "0.0.0-canary-20241023092328"
+  },
+  "devDependencies": {
+    "@types/react": ">=18.3.11",
+    "@types/react-dom": "^18.3.0",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
+    "@vitejs/plugin-react": "^4.3.2",
+    "eslint": "^9.11.1",
+    "eslint-plugin-react-hooks": "^4.6.2",
+    "eslint-plugin-react-refresh": "^0.4.12",
+    "react-dom": ">=18.3.1",
+    "typescript": "^5.6.2",
+    "vite": "^5.4.8",
+    "vite-plugin-dts": "^4.2.4",
+    "vite-plugin-wasm": "^3.3.0"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc --p ./tsconfig.build.json && vite build",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "preview": "vite preview"
+  }
+}