@aztec/wallet-sdk 0.0.1-commit.d1f2d6c → 0.0.1-commit.d431d1c

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 (67) hide show
  1. package/README.md +294 -217
  2. package/dest/base-wallet/base_wallet.d.ts +4 -4
  3. package/dest/base-wallet/base_wallet.d.ts.map +1 -1
  4. package/dest/base-wallet/base_wallet.js +4 -9
  5. package/dest/crypto.d.ts +50 -59
  6. package/dest/crypto.d.ts.map +1 -1
  7. package/dest/crypto.js +108 -202
  8. package/dest/manager/index.d.ts +8 -2
  9. package/dest/manager/index.d.ts.map +1 -1
  10. package/dest/manager/index.js +6 -0
  11. package/dest/manager/types.d.ts +6 -88
  12. package/dest/manager/types.d.ts.map +1 -1
  13. package/dest/manager/types.js +1 -17
  14. package/dest/manager/wallet_manager.d.ts +7 -50
  15. package/dest/manager/wallet_manager.d.ts.map +1 -1
  16. package/dest/manager/wallet_manager.js +44 -174
  17. package/dest/providers/extension/extension_provider.d.ts +63 -0
  18. package/dest/providers/extension/extension_provider.d.ts.map +1 -0
  19. package/dest/providers/extension/extension_provider.js +124 -0
  20. package/dest/providers/extension/extension_wallet.d.ts +155 -0
  21. package/dest/providers/extension/extension_wallet.d.ts.map +1 -0
  22. package/dest/{extension/provider → providers/extension}/extension_wallet.js +95 -48
  23. package/dest/providers/extension/index.d.ts +6 -0
  24. package/dest/providers/extension/index.d.ts.map +1 -0
  25. package/dest/{extension/provider → providers/extension}/index.js +2 -0
  26. package/dest/types.d.ts +12 -43
  27. package/dest/types.d.ts.map +1 -1
  28. package/dest/types.js +2 -3
  29. package/package.json +9 -10
  30. package/src/base-wallet/base_wallet.ts +8 -15
  31. package/src/crypto.ts +113 -237
  32. package/src/manager/index.ts +10 -2
  33. package/src/manager/types.ts +5 -91
  34. package/src/manager/wallet_manager.ts +46 -192
  35. package/src/providers/extension/extension_provider.ts +167 -0
  36. package/src/{extension/provider → providers/extension}/extension_wallet.ts +110 -52
  37. package/src/providers/extension/index.ts +5 -0
  38. package/src/types.ts +10 -44
  39. package/dest/emoji_alphabet.d.ts +0 -35
  40. package/dest/emoji_alphabet.d.ts.map +0 -1
  41. package/dest/emoji_alphabet.js +0 -299
  42. package/dest/extension/handlers/background_connection_handler.d.ts +0 -158
  43. package/dest/extension/handlers/background_connection_handler.d.ts.map +0 -1
  44. package/dest/extension/handlers/background_connection_handler.js +0 -258
  45. package/dest/extension/handlers/content_script_connection_handler.d.ts +0 -56
  46. package/dest/extension/handlers/content_script_connection_handler.d.ts.map +0 -1
  47. package/dest/extension/handlers/content_script_connection_handler.js +0 -174
  48. package/dest/extension/handlers/index.d.ts +0 -12
  49. package/dest/extension/handlers/index.d.ts.map +0 -1
  50. package/dest/extension/handlers/index.js +0 -10
  51. package/dest/extension/handlers/internal_message_types.d.ts +0 -63
  52. package/dest/extension/handlers/internal_message_types.d.ts.map +0 -1
  53. package/dest/extension/handlers/internal_message_types.js +0 -22
  54. package/dest/extension/provider/extension_provider.d.ts +0 -107
  55. package/dest/extension/provider/extension_provider.d.ts.map +0 -1
  56. package/dest/extension/provider/extension_provider.js +0 -160
  57. package/dest/extension/provider/extension_wallet.d.ts +0 -131
  58. package/dest/extension/provider/extension_wallet.d.ts.map +0 -1
  59. package/dest/extension/provider/index.d.ts +0 -3
  60. package/dest/extension/provider/index.d.ts.map +0 -1
  61. package/src/emoji_alphabet.ts +0 -317
  62. package/src/extension/handlers/background_connection_handler.ts +0 -423
  63. package/src/extension/handlers/content_script_connection_handler.ts +0 -246
  64. package/src/extension/handlers/index.ts +0 -25
  65. package/src/extension/handlers/internal_message_types.ts +0 -69
  66. package/src/extension/provider/extension_provider.ts +0 -233
  67. package/src/extension/provider/index.ts +0 -7
@@ -1,69 +0,0 @@
1
- /**
2
- * Internal message types for content script ↔ background communication.
3
- * These are NOT part of the public wallet protocol - they are implementation
4
- * details for coordinating between extension components.
5
- */
6
- export const InternalMessageType = {
7
- // Content script → Background
8
- DISCOVERY_REQUEST: 'discovery-request',
9
- KEY_EXCHANGE_REQUEST: 'key-exchange-request',
10
- SECURE_MESSAGE: 'secure-message',
11
- DISCONNECT_REQUEST: 'disconnect-request',
12
- // Background → Content script
13
- DISCOVERY_APPROVED: 'discovery-approved',
14
- KEY_EXCHANGE_RESPONSE: 'key-exchange-response',
15
- SECURE_RESPONSE: 'secure-response',
16
- SESSION_DISCONNECTED: 'session-disconnected',
17
- } as const;
18
-
19
- /**
20
- * Message origins for internal extension communication.
21
- */
22
- export const MessageOrigin = {
23
- BACKGROUND: 'background',
24
- CONTENT_SCRIPT: 'content-script',
25
- } as const;
26
-
27
- /** Union type of message origins. */
28
- export type MessageOriginType = (typeof MessageOrigin)[keyof typeof MessageOrigin];
29
-
30
- /**
31
- * Message sent from content script to background.
32
- */
33
- export interface ContentScriptMessage {
34
- /** Message source identifier. */
35
- origin: typeof MessageOrigin.CONTENT_SCRIPT;
36
- /** Message type. */
37
- type: string;
38
- /** Optional session identifier. */
39
- sessionId?: string;
40
- /** Optional message payload. */
41
- content?: unknown;
42
- }
43
-
44
- /**
45
- * Message sent from background to content script.
46
- */
47
- export interface BackgroundMessage {
48
- /** Message source identifier. */
49
- origin: typeof MessageOrigin.BACKGROUND;
50
- /** Message type. */
51
- type: string;
52
- /** Session identifier. */
53
- sessionId: string;
54
- /** Optional message payload. */
55
- content?: unknown;
56
- }
57
-
58
- /**
59
- * Sender information for messages from browser runtime.
60
- */
61
- export interface MessageSender {
62
- /** Tab information if available. */
63
- tab?: {
64
- /** Tab identifier. */
65
- id?: number;
66
- /** Tab URL. */
67
- url?: string;
68
- };
69
- }
@@ -1,233 +0,0 @@
1
- import type { ChainInfo } from '@aztec/aztec.js/account';
2
- import { jsonStringify } from '@aztec/foundation/json-rpc';
3
- import { promiseWithResolvers } from '@aztec/foundation/promise';
4
-
5
- import { deriveSessionKeys, exportPublicKey, generateKeyPair, importPublicKey } from '../../crypto.js';
6
- import {
7
- type ConnectedWalletInfo,
8
- type DiscoveryRequest,
9
- type DiscoveryResponse,
10
- type KeyExchangeRequest,
11
- type KeyExchangeResponse,
12
- type WalletInfo,
13
- WalletMessageType,
14
- } from '../../types.js';
15
-
16
- /** Default discovery timeout - long to give users time to approve */
17
- const DEFAULT_DISCOVERY_TIMEOUT_MS = 60000; // 60 seconds
18
-
19
- /** Key exchange timeout - short, wallet should respond quickly after discovery approval */
20
- const KEY_EXCHANGE_TIMEOUT_MS = 2000; // 2 seconds
21
-
22
- /**
23
- * A discovered wallet before key exchange.
24
- * Has basic info and MessagePort, but no shared key yet.
25
- *
26
- * Call {@link establishSecureChannel} to perform key exchange and get a connected wallet.
27
- */
28
- export class DiscoveredWallet {
29
- constructor(
30
- /** Basic wallet information (id, name, icon, version) */
31
- public readonly info: WalletInfo,
32
- /** The MessagePort for private communication with the wallet */
33
- public readonly port: MessagePort,
34
- /** Request ID for correlation */
35
- public readonly requestId: string,
36
- ) {}
37
-
38
- /**
39
- * Establishes a secure connection with this wallet.
40
- *
41
- * This method:
42
- * 1. Generates an ECDH key pair
43
- * 2. Sends public key to wallet over the MessagePort
44
- * 3. Receives wallet's public key
45
- * 4. Derives shared secret and computes verification hash locally
46
- *
47
- * **IMPORTANT**: Has a 2 second timeout for MITM defense.
48
- * Both parties must exchange keys relatively quickly.
49
- *
50
- * The verification hash is computed independently by both parties
51
- * and should be displayed to the user for visual comparison.
52
- *
53
- * @returns Connected wallet with shared key and verification hash
54
- * @throws Error if key exchange fails or times out
55
- */
56
- async establishSecureChannel(): Promise<ConnectedWallet> {
57
- const keyPair = await generateKeyPair();
58
- const exportedPublicKey = await exportPublicKey(keyPair.publicKey);
59
-
60
- const { promise, resolve, reject } = promiseWithResolvers<ConnectedWallet>();
61
-
62
- const timeoutId = setTimeout(() => {
63
- reject(new Error('Key exchange timeout'));
64
- }, KEY_EXCHANGE_TIMEOUT_MS);
65
-
66
- this.port.onmessage = async (event: MessageEvent) => {
67
- const data = event.data as KeyExchangeResponse;
68
-
69
- if (data.type === WalletMessageType.KEY_EXCHANGE_RESPONSE && data.requestId === this.requestId) {
70
- clearTimeout(timeoutId);
71
-
72
- try {
73
- const walletPublicKey = await importPublicKey(data.publicKey);
74
- const session = await deriveSessionKeys(keyPair, walletPublicKey, true);
75
-
76
- const connectedInfo: ConnectedWalletInfo = {
77
- ...this.info,
78
- publicKey: data.publicKey,
79
- verificationHash: session.verificationHash,
80
- };
81
-
82
- resolve({
83
- info: connectedInfo,
84
- port: this.port,
85
- sharedKey: session.encryptionKey,
86
- });
87
- } catch (err) {
88
- reject(new Error(`Key exchange failed: ${err}`));
89
- }
90
- }
91
- };
92
-
93
- this.port.start();
94
-
95
- const keyExchangeRequest: KeyExchangeRequest = {
96
- type: WalletMessageType.KEY_EXCHANGE_REQUEST,
97
- requestId: this.requestId,
98
- publicKey: exportedPublicKey,
99
- };
100
- this.port.postMessage(keyExchangeRequest);
101
-
102
- return promise;
103
- }
104
- }
105
-
106
- /**
107
- * A fully connected wallet with secure channel established.
108
- * Available after key exchange completes.
109
- */
110
- export interface ConnectedWallet {
111
- /** Full wallet info including public key and verification hash */
112
- info: ConnectedWalletInfo;
113
- /** The MessagePort for encrypted communication */
114
- port: MessagePort;
115
- /** The derived AES-256-GCM shared key for encryption */
116
- sharedKey: CryptoKey;
117
- }
118
-
119
- /**
120
- * Options for wallet discovery.
121
- */
122
- export interface DiscoveryOptions {
123
- /** Application ID making the request */
124
- appId: string;
125
- /** How long to wait for user approval (ms). Default: 60000 (60s) */
126
- timeout?: number;
127
- /**
128
- * Callback invoked when a wallet is discovered.
129
- * Wallets are streamed as users approve them.
130
- */
131
- onWalletDiscovered?: (wallet: DiscoveredWallet) => void;
132
- /**
133
- * AbortSignal for cancelling discovery early.
134
- * When aborted, cleanup happens immediately instead of waiting for timeout.
135
- */
136
- signal?: AbortSignal;
137
- }
138
-
139
- /**
140
- * Provider for discovering Aztec wallet extensions.
141
- *
142
- * NOTE: Most users should use WalletManager instead of this class directly.
143
- * WalletManager provides a higher-level API with streaming support.
144
- *
145
- * The connection flow is split into two phases for security:
146
- *
147
- * 1. **Discovery Phase** ({@link discoverWallets}):
148
- * - Broadcasts a discovery request (NO public keys)
149
- * - Wallet shows pending request to user
150
- * - User must approve before wallet reveals itself
151
- * - Wallets are streamed via callback as they're approved
152
- *
153
- * 2. **Secure Channel Phase** ({@link DiscoveredWallet.establishSecureChannel}):
154
- * - Performs ECDH key exchange over private MessageChannel
155
- * - Both parties compute verification hash locally
156
- * - Has a 2s timeout for MITM defense
157
- * - Returns connected wallet with shared key and verification hash
158
- */
159
- export class ExtensionProvider {
160
- /**
161
- * Discovers wallet extensions that user has approved.
162
- *
163
- * Wallets are streamed via the `onWalletDiscovered` callback as users approve them.
164
- * The promise resolves when the timeout expires or signal is aborted.
165
- *
166
- * @param chainInfo - Chain information to check if extensions support this network
167
- * @param options - Discovery options including appId, appName, timeout, and callback
168
- * @returns Promise that resolves when discovery completes
169
- */
170
- static discoverWallets(chainInfo: ChainInfo, options: DiscoveryOptions): Promise<void> {
171
- if (options.signal?.aborted) {
172
- return Promise.resolve();
173
- }
174
- const timeout = options.timeout ?? DEFAULT_DISCOVERY_TIMEOUT_MS;
175
-
176
- return new Promise(resolve => {
177
- const requestId = globalThis.crypto.randomUUID();
178
- let timeoutId: ReturnType<typeof setTimeout> | null = null;
179
- let completed = false;
180
-
181
- const finish = () => {
182
- if (completed) {
183
- return;
184
- }
185
- completed = true;
186
-
187
- if (timeoutId !== null) {
188
- clearTimeout(timeoutId);
189
- }
190
- window.removeEventListener('message', onMessage);
191
- options.signal?.removeEventListener('abort', onAbort);
192
- resolve();
193
- };
194
-
195
- const onAbort = () => finish();
196
-
197
- const onMessage = (event: MessageEvent) => {
198
- if (completed || event.source !== window) {
199
- return;
200
- }
201
-
202
- let data: DiscoveryResponse;
203
- try {
204
- data = JSON.parse(event.data);
205
- } catch {
206
- return;
207
- }
208
-
209
- if (data.type !== WalletMessageType.DISCOVERY_RESPONSE || data.requestId !== requestId) {
210
- return;
211
- }
212
-
213
- const port = event.ports?.[0];
214
- if (port) {
215
- options.onWalletDiscovered?.(new DiscoveredWallet(data.walletInfo, port, requestId));
216
- }
217
- };
218
-
219
- options.signal?.addEventListener('abort', onAbort, { once: true });
220
- window.addEventListener('message', onMessage);
221
-
222
- const discoveryMessage: DiscoveryRequest = {
223
- type: WalletMessageType.DISCOVERY,
224
- requestId,
225
- appId: options.appId,
226
- chainInfo,
227
- };
228
- window.postMessage(jsonStringify(discoveryMessage), '*');
229
-
230
- timeoutId = setTimeout(finish, timeout);
231
- });
232
- }
233
- }
@@ -1,7 +0,0 @@
1
- export { ExtensionWallet, type DisconnectCallback } from './extension_wallet.js';
2
- export {
3
- ExtensionProvider,
4
- type DiscoveredWallet,
5
- type ConnectedWallet,
6
- type DiscoveryOptions,
7
- } from './extension_provider.js';