@txnlab/use-wallet 2.3.1 → 2.5.0

package/README.md

@@ -23,6 +23,10 @@ UseWallet supports most Algorand wallet providers, including Defly, Pera, Daffi,
 
 Version 2.x introduces [WalletConnect 2.0 support](#walletconnect-20-support).
 
+## Disclaimer
+
+TxnLab provides `@txnlab/use-wallet` as a wallet integration tool and does not endorse or assume responsibility for any external wallet providers' functionality or security.
+
 ## Table of Contents
 
 - [Live Examples](#live-examples)
@@ -58,7 +62,7 @@ Version 2.x introduces [WalletConnect 2.0 support](#walletconnect-20-support).
 
 ## Live Examples
 
-**Storybook demo** - https://txnlab.github.io/use-wallet
+<!-- **Storybook demo** - https://txnlab.github.io/use-wallet -->
 
 **Next.js example**
 
@@ -97,7 +101,7 @@ npm install @blockshake/defly-connect @perawallet/connect @daffiwallet/connect
 
 In the root of your app, initialize the `WalletProvider` with the `useInitializeProviders` hook.
 
-This example initializes Defly, Pera, Daffi and Exodus wallet providers. The default node configuration (mainnet via [AlgoNode](https://algonode.io/api/)) is used. See [Provider Configuration](#provider-configuration) for more options.
+This example initializes Defly, Pera, Daffi, Exodus, Lute and Kibisis wallet providers. The default node configuration (mainnet via [AlgoNode](https://algonode.io/api/)) is used. See [Provider Configuration](#provider-configuration) for more options.
 
 You can initialize your providers in two ways:
 
@@ -117,6 +121,7 @@ import { WalletProvider, useInitializeProviders, PROVIDER_ID } from '@txnlab/use
 import { DeflyWalletConnect } from '@blockshake/defly-connect'
 import { PeraWalletConnect } from '@perawallet/connect'
 import { DaffiWalletConnect } from '@daffiwallet/connect'
+import LuteConnect from 'lute-connect'
 
 export default function App() {
   const providers = useInitializeProviders({
@@ -124,7 +129,13 @@ export default function App() {
       { id: PROVIDER_ID.DEFLY, clientStatic: DeflyWalletConnect },
       { id: PROVIDER_ID.PERA, clientStatic: PeraWalletConnect },
       { id: PROVIDER_ID.DAFFI, clientStatic: DaffiWalletConnect },
-      { id: PROVIDER_ID.EXODUS }
+      { id: PROVIDER_ID.EXODUS },
+      {
+        id: PROVIDER_ID.LUTE,
+        clientStatic: LuteConnect,
+        clientOptions: { siteName: 'YourSiteName' }
+      },
+      { id: PROVIDER_ID.KIBISIS }
     ]
   })
 
@@ -157,13 +168,24 @@ const getDynamicDaffiWalletConnect = async () => {
   return DaffiWalletConnect
 }
 
+const getDynamicLuteConnect = async () => {
+  const LuteConnect = (await import('lute-connect')).default
+  return LuteConnect
+}
+
 export default function App() {
   const providers = useInitializeProviders({
     providers: [
       { id: PROVIDER_ID.DEFLY, getDynamicClient: getDynamicDeflyWalletConnect },
       { id: PROVIDER_ID.PERA, getDynamicClient: getDynamicPeraWalletConnect },
       { id: PROVIDER_ID.DAFFI, getDynamicClient: getDynamicDaffiWalletConnect },
-      { id: PROVIDER_ID.EXODUS }
+      { id: PROVIDER_ID.EXODUS },
+      {
+        id: PROVIDER_ID.LUTE,
+        getDynamicClient: getDynamicLuteConnect,
+        clientOptions: { siteName: 'YourSiteName' }
+      },
+      { id: PROVIDER_ID.KIBISIS }
     ]
   })
 
@@ -477,6 +499,20 @@ useEffect(() => {
 - Website - https://www.exodus.com/
 - Download - https://www.exodus.com/download/
 
+### Lute Wallet
+
+- Website - https://lute.app/
+- Install dependency - `npm install lute-connect`
+
+
+### Kibisis Wallet
+
+***NOTE:** Kibisis is in active development and currently only supports betanet and testnet.*
+
+- Website - https://kibis.is
+- Download - https://kibis.is/#download
+- Support/Issues - https://discord.com/channels/1055863853633785857/1181252381816655952
+
 ### KMD (Algorand Key Management Daemon)
 
 - Documentation - https://developer.algorand.org/docs/rest-apis/kmd
@@ -494,8 +530,9 @@ Support for these wallets will be removed in a future release.
 - GitHub - https://github.com/PureStake/algosigner
 - EOL Press Release - https://www.algorand.foundation/news/algosigner-support-ending
 
-### MyAlgo
+### MyAlgo (deprecation pending: January 30, 2024)
 
+- **DEPRECATION NOTICE** - https://wallet.myalgo.com/access
 - Website - https://wallet.myalgo.com/home
 - FAQ - https://wallet.myalgo.com/home#faq
 - Install dependency - `npm install @randlabs/myalgo-connect`
@@ -617,6 +654,7 @@ import { DeflyWalletConnect } from '@blockshake/defly-connect'
 import { PeraWalletConnect } from '@perawallet/connect'
 import { DaffiWalletConnect } from '@daffiwallet/connect'
 import { WalletConnectModalSign } from '@walletconnect/modal-sign-html'
+import LuteConnect from 'lute-connect'
 
 export default function App() {
   const providers = useInitializeProviders({
@@ -640,7 +678,13 @@ export default function App() {
           }
         }
       },
-      { id: PROVIDER_ID.EXODUS }
+      { id: PROVIDER_ID.EXODUS },
+      {
+        id: PROVIDER_ID.LUTE,
+        clientStatic: LuteConnect,
+        clientOptions: { siteName: 'YourSiteName' }
+      },
+      { id: PROVIDER_ID.KIBISIS }
     ],
     nodeConfig: {
       network: 'mainnet',