@miden-sdk/miden-wallet-adapter-react 0.13.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/MidenFiSignerProvider.tsx +732 -0
  2. package/WalletProvider.tsx +443 -0
  3. package/__tests__/MidenFiSignerProvider.test.tsx +426 -0
  4. package/dist/MidenFiSignerProvider.d.ts +113 -0
  5. package/dist/MidenFiSignerProvider.js +501 -0
  6. package/dist/MidenFiSignerProvider.js.map +1 -0
  7. package/dist/WalletProvider.d.ts +13 -0
  8. package/dist/WalletProvider.js +302 -0
  9. package/dist/WalletProvider.js.map +1 -0
  10. package/dist/index.d.ts +4 -0
  11. package/dist/index.js +7 -0
  12. package/dist/index.js.map +1 -0
  13. package/dist/useLocalStorage.d.ts +2 -0
  14. package/dist/useLocalStorage.js +39 -0
  15. package/dist/useLocalStorage.js.map +1 -0
  16. package/dist/useWallet.d.ts +30 -0
  17. package/dist/useWallet.js +81 -0
  18. package/dist/useWallet.js.map +1 -0
  19. package/dist/vitest.config.d.ts +2 -0
  20. package/dist/vitest.config.js +8 -0
  21. package/dist/vitest.config.js.map +1 -0
  22. package/docs/README.md +30 -0
  23. package/docs/functions/useLocalStorage.md +29 -0
  24. package/docs/functions/useMidenFiWallet.md +28 -0
  25. package/docs/functions/useWallet.md +13 -0
  26. package/docs/interfaces/MidenFiSignerProviderProps.md +87 -0
  27. package/docs/interfaces/Wallet.md +19 -0
  28. package/docs/interfaces/WalletContextState.md +235 -0
  29. package/docs/interfaces/WalletProviderProps.md +65 -0
  30. package/docs/variables/MidenFiSignerProvider.md +54 -0
  31. package/docs/variables/WalletContext.md +9 -0
  32. package/docs/variables/WalletProvider.md +9 -0
  33. package/index.ts +15 -0
  34. package/package.json +42 -0
  35. package/tsconfig.json +16 -0
  36. package/useLocalStorage.ts +39 -0
  37. package/useWallet.ts +197 -0
  38. package/vitest.config.ts +8 -0
package/useWallet.ts ADDED
@@ -0,0 +1,197 @@
1
+ import { createContext, useContext } from 'react';
2
+ import {
3
+ Adapter,
4
+ AllowedPrivateData,
5
+ MidenTransaction,
6
+ MessageSignerWalletAdapterProps,
7
+ PrivateDataPermission,
8
+ SignKind,
9
+ WalletAdapterNetwork,
10
+ WalletName,
11
+ WalletReadyState,
12
+ } from '@miden-sdk/miden-wallet-adapter-base';
13
+ import type { NoteFilterTypes } from '@miden-sdk/miden-sdk';
14
+
15
+ export interface Wallet {
16
+ adapter: Adapter;
17
+ readyState: WalletReadyState;
18
+ }
19
+
20
+ export interface WalletContextState {
21
+ autoConnect: boolean;
22
+ wallets: Wallet[];
23
+ wallet: Wallet | null;
24
+ address: string | null;
25
+ publicKey: Uint8Array | null;
26
+ connecting: boolean;
27
+ connected: boolean;
28
+ disconnecting: boolean;
29
+ privateDataPermission?: PrivateDataPermission;
30
+
31
+ select(walletName: WalletName): void;
32
+ connect(
33
+ privateDataPermission: PrivateDataPermission,
34
+ network: WalletAdapterNetwork,
35
+ allowedPrivateData?: AllowedPrivateData
36
+ ): Promise<void>;
37
+ disconnect(): Promise<void>;
38
+
39
+ requestTransaction:
40
+ | MessageSignerWalletAdapterProps['requestTransaction']
41
+ | undefined;
42
+
43
+ requestSend: MessageSignerWalletAdapterProps['requestSend'] | undefined;
44
+
45
+ requestConsume: MessageSignerWalletAdapterProps['requestConsume'] | undefined;
46
+
47
+ requestAssets: MessageSignerWalletAdapterProps['requestAssets'] | undefined;
48
+
49
+ requestPrivateNotes:
50
+ | MessageSignerWalletAdapterProps['requestPrivateNotes']
51
+ | undefined;
52
+
53
+ signBytes: MessageSignerWalletAdapterProps['signBytes'] | undefined;
54
+
55
+ importPrivateNote:
56
+ | MessageSignerWalletAdapterProps['importPrivateNote']
57
+ | undefined;
58
+
59
+ requestConsumableNotes:
60
+ | MessageSignerWalletAdapterProps['requestConsumableNotes']
61
+ | undefined;
62
+
63
+ waitForTransaction:
64
+ | MessageSignerWalletAdapterProps['waitForTransaction']
65
+ | undefined;
66
+ }
67
+
68
+ const EMPTY_ARRAY: never[] = [];
69
+
70
+ const DEFAULT_CONTEXT = {
71
+ autoConnect: false,
72
+ connecting: false,
73
+ connected: false,
74
+ disconnecting: false,
75
+ select(_name: WalletName) {
76
+ console.error(constructMissingProviderErrorMessage('get', 'select'));
77
+ },
78
+ connect(
79
+ _privateDataPermission: PrivateDataPermission,
80
+ _network: WalletAdapterNetwork,
81
+ _allowedPrivateData?: AllowedPrivateData
82
+ ) {
83
+ return Promise.reject(
84
+ console.error(constructMissingProviderErrorMessage('get', 'connect'))
85
+ );
86
+ },
87
+ disconnect() {
88
+ return Promise.reject(
89
+ console.error(constructMissingProviderErrorMessage('get', 'disconnect'))
90
+ );
91
+ },
92
+ requestTransaction(_transaction: MidenTransaction) {
93
+ return Promise.reject(
94
+ console.error(
95
+ constructMissingProviderErrorMessage('get', 'requestTransaction')
96
+ )
97
+ );
98
+ },
99
+ requestAssets() {
100
+ return Promise.reject(
101
+ console.error(
102
+ constructMissingProviderErrorMessage('get', 'requestAssets')
103
+ )
104
+ );
105
+ },
106
+ requestPrivateNotes(_noteFilterType: NoteFilterTypes, _noteIds?: string[]) {
107
+ return Promise.reject(
108
+ console.error(
109
+ constructMissingProviderErrorMessage('get', 'requestPrivateNotes')
110
+ )
111
+ );
112
+ },
113
+ signBytes(_message: Uint8Array, _kind: SignKind) {
114
+ return Promise.reject(
115
+ console.error(constructMissingProviderErrorMessage('get', 'signBytes'))
116
+ );
117
+ },
118
+ importPrivateNote(_note: Uint8Array) {
119
+ return Promise.reject(
120
+ console.error(
121
+ constructMissingProviderErrorMessage('get', 'importPrivateNote')
122
+ )
123
+ );
124
+ },
125
+ requestConsumableNotes() {
126
+ return Promise.reject(
127
+ console.error(
128
+ constructMissingProviderErrorMessage('get', 'requestConsumableNotes')
129
+ )
130
+ );
131
+ },
132
+ waitForTransaction(_txId: string, _timeout?: number) {
133
+ return Promise.reject(
134
+ console.error(
135
+ constructMissingProviderErrorMessage('get', 'waitForTransaction')
136
+ )
137
+ );
138
+ },
139
+ requestSend(_transaction) {
140
+ return Promise.reject(
141
+ console.error(constructMissingProviderErrorMessage('get', 'requestSend'))
142
+ );
143
+ },
144
+ requestConsume(_transaction) {
145
+ return Promise.reject(
146
+ console.error(
147
+ constructMissingProviderErrorMessage('get', 'requestConsume')
148
+ )
149
+ );
150
+ },
151
+ } as WalletContextState;
152
+ Object.defineProperty(DEFAULT_CONTEXT, 'wallets', {
153
+ get() {
154
+ console.error(constructMissingProviderErrorMessage('read', 'wallets'));
155
+ return EMPTY_ARRAY;
156
+ },
157
+ });
158
+ Object.defineProperty(DEFAULT_CONTEXT, 'wallet', {
159
+ get() {
160
+ console.error(constructMissingProviderErrorMessage('read', 'wallet'));
161
+ return null;
162
+ },
163
+ });
164
+ Object.defineProperty(DEFAULT_CONTEXT, 'address', {
165
+ get() {
166
+ console.error(constructMissingProviderErrorMessage('read', 'address'));
167
+ return null;
168
+ },
169
+ });
170
+ Object.defineProperty(DEFAULT_CONTEXT, 'publicKey', {
171
+ get() {
172
+ console.error(constructMissingProviderErrorMessage('read', 'publicKey'));
173
+ return null;
174
+ },
175
+ });
176
+
177
+ function constructMissingProviderErrorMessage(
178
+ action: string,
179
+ valueName: string
180
+ ) {
181
+ return (
182
+ 'You have tried to ' +
183
+ ` ${action} "${valueName}"` +
184
+ ' on a WalletContext without providing one.' +
185
+ ' Make sure to render a WalletProvider' +
186
+ ' as an ancestor of the component that uses ' +
187
+ 'WalletContext'
188
+ );
189
+ }
190
+
191
+ export const WalletContext = createContext<WalletContextState>(
192
+ DEFAULT_CONTEXT as WalletContextState
193
+ );
194
+
195
+ export function useWallet(): WalletContextState {
196
+ return useContext(WalletContext);
197
+ }
@@ -0,0 +1,8 @@
1
+ import { defineConfig } from 'vitest/config';
2
+
3
+ export default defineConfig({
4
+ test: {
5
+ environment: 'jsdom',
6
+ globals: true,
7
+ },
8
+ });