@fedimint/react

@fedimint/react

Helpful React hooks for building with the Fedimint Web SDK.

@fedimint/react

Install

pnpm install @fedimint/core-web @fedimint/react

Usage

import { FedimintWalletProvider, setupFedimintWallet } from '@fedimint/react'

setupFedimintWallet({
  lazy: false,
  debug: true,
})

// Wrap your app in the FedimintWalletProvider
<FedimintWalletProvider>
  <App />
</FedimintWalletProvider>


// App.tsx


// Balance

import { useBalance } from '@fedimint/react'

const balance = useBalance()

// Wallet

import { useOpenWallet } from '@fedimint/react'

const {
  walletStatus, // 'open' | 'closed' | 'connecting' | 'failed'
  openWallet, // () => Promise<boolean> - Returns true if wallet was opened successfully.
  joinFederation, // () => Promise<boolean> - Returns true if joined federation successfully.
} = useOpenWallet()

// Receive Lightning

import { useReceiveLightning } from '@fedimint/react'

const {
  generateInvoice, // (amount: number) => Promise<void>
  bolt11, // string
  invoiceStatus, // 'pending' | 'confirmed' | 'failed'
  error, // Error | undefined
} = useReceiveLightning()

// Send Lightning

import { useSendLightning } from '@fedimint/react'

const {
  payInvoice, // (bolt11: string) => Promise<void>
  paymentStatus, // 'pending' | 'confirmed' | 'failed'
  paymentError, // Error | undefined
} = useSendLightning()