@txnlab/use-wallet 2.4.0 → 2.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/README.md +35 -6
  2. package/dist/cjs/index.js +591 -29
  3. package/dist/cjs/index.js.map +1 -1
  4. package/dist/cjs/src/clients/base/base.d.ts +1 -1
  5. package/dist/cjs/src/clients/index.d.ts +4 -2
  6. package/dist/cjs/src/clients/kibisis/client.d.ts +73 -0
  7. package/dist/cjs/src/clients/kibisis/constants.d.ts +37 -0
  8. package/dist/cjs/src/clients/kibisis/index.d.ts +2 -0
  9. package/dist/cjs/src/clients/kibisis/types.d.ts +86 -0
  10. package/dist/cjs/src/clients/kibisis/utils.d.ts +9 -0
  11. package/dist/cjs/src/clients/kibisis/utils.test.d.ts +1 -0
  12. package/dist/cjs/src/clients/magic/client.d.ts +35 -0
  13. package/dist/cjs/src/clients/magic/constants.d.ts +1 -0
  14. package/dist/cjs/src/clients/magic/index.d.ts +2 -0
  15. package/dist/cjs/src/clients/magic/types.d.ts +27 -0
  16. package/dist/cjs/src/constants/constants.d.ts +3 -1
  17. package/dist/cjs/src/testUtils/mockClients.d.ts +6 -0
  18. package/dist/cjs/src/types/providers.d.ts +19 -2
  19. package/dist/cjs/src/types/wallet.d.ts +2 -1
  20. package/dist/esm/index.js +590 -30
  21. package/dist/esm/src/clients/base/base.d.ts +1 -1
  22. package/dist/esm/src/clients/index.d.ts +4 -2
  23. package/dist/esm/src/clients/kibisis/client.d.ts +73 -0
  24. package/dist/esm/src/clients/kibisis/constants.d.ts +37 -0
  25. package/dist/esm/src/clients/kibisis/index.d.ts +2 -0
  26. package/dist/esm/src/clients/kibisis/types.d.ts +86 -0
  27. package/dist/esm/src/clients/kibisis/utils.d.ts +9 -0
  28. package/dist/esm/src/clients/kibisis/utils.test.d.ts +1 -0
  29. package/dist/esm/src/clients/magic/client.d.ts +35 -0
  30. package/dist/esm/src/clients/magic/constants.d.ts +1 -0
  31. package/dist/esm/src/clients/magic/index.d.ts +2 -0
  32. package/dist/esm/src/clients/magic/types.d.ts +27 -0
  33. package/dist/esm/src/constants/constants.d.ts +3 -1
  34. package/dist/esm/src/testUtils/mockClients.d.ts +6 -0
  35. package/dist/esm/src/types/providers.d.ts +19 -2
  36. package/dist/esm/src/types/wallet.d.ts +2 -1
  37. package/dist/index.d.ts +160 -6
  38. package/package.json +20 -7
package/README.md CHANGED
@@ -23,6 +23,10 @@ UseWallet supports most Algorand wallet providers, including Defly, Pera, Daffi,
23
23
 
24
24
  Version 2.x introduces [WalletConnect 2.0 support](#walletconnect-20-support).
25
25
 
26
+ ## Disclaimer
27
+
28
+ 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.
29
+
26
30
  ## Table of Contents
27
31
 
28
32
  - [Live Examples](#live-examples)
@@ -58,7 +62,7 @@ Version 2.x introduces [WalletConnect 2.0 support](#walletconnect-20-support).
58
62
 
59
63
  ## Live Examples
60
64
 
61
- **Storybook demo** - https://txnlab.github.io/use-wallet
65
+ <!-- **Storybook demo** - https://txnlab.github.io/use-wallet -->
62
66
 
63
67
  **Next.js example**
64
68
 
@@ -97,7 +101,7 @@ npm install @blockshake/defly-connect @perawallet/connect @daffiwallet/connect
97
101
 
98
102
  In the root of your app, initialize the `WalletProvider` with the `useInitializeProviders` hook.
99
103
 
100
- This example initializes Defly, Pera, Daffi, Exodus, and Lute wallet providers. The default node configuration (mainnet via [AlgoNode](https://algonode.io/api/)) is used. See [Provider Configuration](#provider-configuration) for more options.
104
+ 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.
101
105
 
102
106
  You can initialize your providers in two ways:
103
107
 
@@ -130,7 +134,8 @@ export default function App() {
130
134
  id: PROVIDER_ID.LUTE,
131
135
  clientStatic: LuteConnect,
132
136
  clientOptions: { siteName: 'YourSiteName' }
133
- }
137
+ },
138
+ { id: PROVIDER_ID.KIBISIS }
134
139
  ]
135
140
  })
136
141
 
@@ -179,7 +184,8 @@ export default function App() {
179
184
  id: PROVIDER_ID.LUTE,
180
185
  getDynamicClient: getDynamicLuteConnect,
181
186
  clientOptions: { siteName: 'YourSiteName' }
182
- }
187
+ },
188
+ { id: PROVIDER_ID.KIBISIS }
183
189
  ]
184
190
  })
185
191
 
@@ -498,6 +504,20 @@ useEffect(() => {
498
504
  - Website - https://lute.app/
499
505
  - Install dependency - `npm install lute-connect`
500
506
 
507
+
508
+ ### Kibisis Wallet
509
+
510
+ ***NOTE:** Kibisis is in active development and currently only supports betanet and testnet.*
511
+
512
+ - Website - https://kibis.is
513
+ - Download - https://kibis.is/#download
514
+ - Support/Issues - https://discord.com/channels/1055863853633785857/1181252381816655952
515
+
516
+ ### Magic Auth
517
+
518
+ - Website - https://magic.link/
519
+ - Install dependency - `npm install magic-sdk @magic-ext/algorand`
520
+
501
521
  ### KMD (Algorand Key Management Daemon)
502
522
 
503
523
  - Documentation - https://developer.algorand.org/docs/rest-apis/kmd
@@ -515,8 +535,9 @@ Support for these wallets will be removed in a future release.
515
535
  - GitHub - https://github.com/PureStake/algosigner
516
536
  - EOL Press Release - https://www.algorand.foundation/news/algosigner-support-ending
517
537
 
518
- ### MyAlgo
538
+ ### MyAlgo (deprecation pending: January 30, 2024)
519
539
 
540
+ - **DEPRECATION NOTICE** - https://wallet.myalgo.com/access
520
541
  - Website - https://wallet.myalgo.com/home
521
542
  - FAQ - https://wallet.myalgo.com/home#faq
522
543
  - Install dependency - `npm install @randlabs/myalgo-connect`
@@ -639,6 +660,7 @@ import { PeraWalletConnect } from '@perawallet/connect'
639
660
  import { DaffiWalletConnect } from '@daffiwallet/connect'
640
661
  import { WalletConnectModalSign } from '@walletconnect/modal-sign-html'
641
662
  import LuteConnect from 'lute-connect'
663
+ import { Magic } from 'magic-sdk';
642
664
 
643
665
  export default function App() {
644
666
  const providers = useInitializeProviders({
@@ -667,7 +689,14 @@ export default function App() {
667
689
  id: PROVIDER_ID.LUTE,
668
690
  clientStatic: LuteConnect,
669
691
  clientOptions: { siteName: 'YourSiteName' }
670
- }
692
+ },
693
+ { id: PROVIDER_ID.KIBISIS }
694
+ },
695
+ {
696
+ id: PROVIDER_ID.MAGIC,
697
+ getDynamicClient: Magic,
698
+ clientOptions: { apiKey: 'API_KEY' },
699
+ },
671
700
  ],
672
701
  nodeConfig: {
673
702
  network: 'mainnet',