@aztec/wallet-sdk 0.0.1-commit.f295ac2 → 0.0.1-commit.fc805bf

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 +217 -294
  2. package/dest/base-wallet/base_wallet.d.ts +20 -7
  3. package/dest/base-wallet/base_wallet.d.ts.map +1 -1
  4. package/dest/base-wallet/base_wallet.js +29 -11
  5. package/dest/crypto.d.ts +59 -50
  6. package/dest/crypto.d.ts.map +1 -1
  7. package/dest/crypto.js +202 -108
  8. package/dest/emoji_alphabet.d.ts +35 -0
  9. package/dest/emoji_alphabet.d.ts.map +1 -0
  10. package/dest/emoji_alphabet.js +299 -0
  11. package/dest/extension/handlers/background_connection_handler.d.ts +158 -0
  12. package/dest/extension/handlers/background_connection_handler.d.ts.map +1 -0
  13. package/dest/extension/handlers/background_connection_handler.js +258 -0
  14. package/dest/extension/handlers/content_script_connection_handler.d.ts +56 -0
  15. package/dest/extension/handlers/content_script_connection_handler.d.ts.map +1 -0
  16. package/dest/extension/handlers/content_script_connection_handler.js +174 -0
  17. package/dest/extension/handlers/index.d.ts +12 -0
  18. package/dest/extension/handlers/index.d.ts.map +1 -0
  19. package/dest/extension/handlers/index.js +10 -0
  20. package/dest/extension/handlers/internal_message_types.d.ts +63 -0
  21. package/dest/extension/handlers/internal_message_types.d.ts.map +1 -0
  22. package/dest/extension/handlers/internal_message_types.js +22 -0
  23. package/dest/extension/provider/extension_provider.d.ts +107 -0
  24. package/dest/extension/provider/extension_provider.d.ts.map +1 -0
  25. package/dest/extension/provider/extension_provider.js +160 -0
  26. package/dest/extension/provider/extension_wallet.d.ts +131 -0
  27. package/dest/extension/provider/extension_wallet.d.ts.map +1 -0
  28. package/dest/{providers/extension → extension/provider}/extension_wallet.js +48 -95
  29. package/dest/extension/provider/index.d.ts +3 -0
  30. package/dest/extension/provider/index.d.ts.map +1 -0
  31. package/dest/{providers/extension → extension/provider}/index.js +0 -2
  32. package/dest/manager/index.d.ts +2 -8
  33. package/dest/manager/index.d.ts.map +1 -1
  34. package/dest/manager/index.js +0 -6
  35. package/dest/manager/types.d.ts +88 -6
  36. package/dest/manager/types.d.ts.map +1 -1
  37. package/dest/manager/types.js +17 -1
  38. package/dest/manager/wallet_manager.d.ts +50 -7
  39. package/dest/manager/wallet_manager.d.ts.map +1 -1
  40. package/dest/manager/wallet_manager.js +174 -44
  41. package/dest/types.d.ts +43 -12
  42. package/dest/types.d.ts.map +1 -1
  43. package/dest/types.js +3 -2
  44. package/package.json +10 -9
  45. package/src/base-wallet/base_wallet.ts +45 -20
  46. package/src/crypto.ts +237 -113
  47. package/src/emoji_alphabet.ts +317 -0
  48. package/src/extension/handlers/background_connection_handler.ts +423 -0
  49. package/src/extension/handlers/content_script_connection_handler.ts +246 -0
  50. package/src/extension/handlers/index.ts +25 -0
  51. package/src/extension/handlers/internal_message_types.ts +69 -0
  52. package/src/extension/provider/extension_provider.ts +233 -0
  53. package/src/{providers/extension → extension/provider}/extension_wallet.ts +52 -110
  54. package/src/extension/provider/index.ts +7 -0
  55. package/src/manager/index.ts +2 -10
  56. package/src/manager/types.ts +91 -5
  57. package/src/manager/wallet_manager.ts +192 -46
  58. package/src/types.ts +44 -10
  59. package/dest/providers/extension/extension_provider.d.ts +0 -63
  60. package/dest/providers/extension/extension_provider.d.ts.map +0 -1
  61. package/dest/providers/extension/extension_provider.js +0 -124
  62. package/dest/providers/extension/extension_wallet.d.ts +0 -155
  63. package/dest/providers/extension/extension_wallet.d.ts.map +0 -1
  64. package/dest/providers/extension/index.d.ts +0 -6
  65. package/dest/providers/extension/index.d.ts.map +0 -1
  66. package/src/providers/extension/extension_provider.ts +0 -167
  67. package/src/providers/extension/index.ts +0 -5
@@ -1,124 +0,0 @@
1
- import { jsonStringify } from '@aztec/foundation/json-rpc';
2
- import { promiseWithResolvers } from '@aztec/foundation/promise';
3
- import { deriveSharedKey, exportPublicKey, generateKeyPair, hashSharedSecret, importPublicKey } from '../../crypto.js';
4
- import { WalletMessageType } from '../../types.js';
5
- /**
6
- * Provider for discovering Aztec wallet extensions.
7
- *
8
- * This class handles the discovery phase of wallet communication:
9
- * 1. Broadcasts a discovery request with the dApp's public key
10
- * 2. Receives responses from installed wallets with their public keys
11
- * 3. Derives shared secrets and computes verification hashes
12
- * 4. Returns discovered wallets with their secure channel components
13
- *
14
- * @example
15
- * ```typescript
16
- * const wallets = await ExtensionProvider.discoverExtensions(chainInfo);
17
- * // Display wallets to user with optional emoji verification
18
- * for (const wallet of wallets) {
19
- * const emoji = hashToEmoji(wallet.info.verificationHash!);
20
- * console.log(`${wallet.info.name}: ${emoji}`);
21
- * }
22
- * // User selects a wallet after verifying
23
- * const wallet = await ExtensionWallet.create(wallets[0], chainInfo, 'my-app');
24
- * ```
25
- */ export class ExtensionProvider {
26
- static discoveryInProgress = false;
27
- /**
28
- * Discovers all installed Aztec wallet extensions and establishes secure channel components.
29
- *
30
- * This method:
31
- * 1. Generates an ECDH key pair for this discovery session
32
- * 2. Broadcasts a discovery request with the dApp's public key
33
- * 3. Receives responses from wallets with their public keys and MessagePorts
34
- * 4. Derives shared secrets and computes verification hashes
35
- *
36
- * @param chainInfo - Chain information to check if extensions support this network
37
- * @param timeout - How long to wait for extensions to respond (ms)
38
- * @returns Array of discovered wallets with their secure channel components
39
- *
40
- * @example
41
- * ```typescript
42
- * const wallets = await ExtensionProvider.discoverExtensions({
43
- * chainId: Fr(31337),
44
- * version: Fr(0)
45
- * });
46
- * // Access wallet info and secure channel
47
- * const { info, port, sharedKey } = wallets[0];
48
- * ```
49
- */ static async discoverExtensions(chainInfo, timeout = 1000) {
50
- // If discovery is already in progress, wait and return empty
51
- // (caller should retry or handle appropriately)
52
- if (this.discoveryInProgress) {
53
- await new Promise((resolve)=>setTimeout(resolve, timeout));
54
- return [];
55
- }
56
- this.discoveryInProgress = true;
57
- // Generate key pair for this discovery session
58
- const keyPair = await generateKeyPair();
59
- const exportedPublicKey = await exportPublicKey(keyPair.publicKey);
60
- const { promise, resolve } = promiseWithResolvers();
61
- const requestId = globalThis.crypto.randomUUID();
62
- const responses = [];
63
- // Set up listener for discovery responses
64
- const handleMessage = (event)=>{
65
- if (event.source !== window) {
66
- return;
67
- }
68
- let data;
69
- try {
70
- data = JSON.parse(event.data);
71
- } catch {
72
- return;
73
- }
74
- if (data.type === WalletMessageType.DISCOVERY_RESPONSE && data.requestId === requestId) {
75
- // Get the MessagePort from the event
76
- const port = event.ports?.[0];
77
- if (!port) {
78
- return;
79
- }
80
- // Derive shared key from wallet's public key
81
- const walletPublicKey = data.walletInfo.publicKey;
82
- if (!walletPublicKey) {
83
- return;
84
- }
85
- void (async ()=>{
86
- try {
87
- const importedWalletKey = await importPublicKey(walletPublicKey);
88
- const sharedKey = await deriveSharedKey(keyPair.privateKey, importedWalletKey);
89
- // Compute verification hash
90
- const verificationHash = await hashSharedSecret(sharedKey);
91
- // Create wallet info with verification hash
92
- const walletInfo = {
93
- ...data.walletInfo,
94
- verificationHash
95
- };
96
- responses.push({
97
- info: walletInfo,
98
- port,
99
- sharedKey
100
- });
101
- } catch {
102
- // Failed to derive key, skip this wallet
103
- }
104
- })();
105
- }
106
- };
107
- window.addEventListener('message', handleMessage);
108
- // Send discovery message with our public key
109
- const discoveryMessage = {
110
- type: WalletMessageType.DISCOVERY,
111
- requestId,
112
- chainInfo,
113
- publicKey: exportedPublicKey
114
- };
115
- window.postMessage(jsonStringify(discoveryMessage), '*');
116
- // Wait for responses
117
- setTimeout(()=>{
118
- window.removeEventListener('message', handleMessage);
119
- this.discoveryInProgress = false;
120
- resolve(responses);
121
- }, timeout);
122
- return promise;
123
- }
124
- }
@@ -1,155 +0,0 @@
1
- import type { ChainInfo } from '@aztec/aztec.js/account';
2
- import { type Wallet } from '@aztec/aztec.js/wallet';
3
- import { type WalletInfo } from '../../types.js';
4
- /**
5
- * Callback type for wallet disconnect events.
6
- */
7
- export type DisconnectCallback = () => void;
8
- /**
9
- * A wallet implementation that communicates with browser extension wallets
10
- * using a secure encrypted MessageChannel.
11
- *
12
- * This class uses a pre-established secure channel from the discovery phase:
13
- *
14
- * 1. **MessageChannel**: A private communication channel created during discovery,
15
- * not visible to other scripts on the page (unlike window.postMessage).
16
- *
17
- * 2. **ECDH Key Exchange**: The shared secret was derived during discovery using
18
- * Elliptic Curve Diffie-Hellman key exchange.
19
- *
20
- * 3. **AES-GCM Encryption**: All messages are encrypted using AES-256-GCM,
21
- * providing both confidentiality and authenticity.
22
- *
23
- * @example
24
- * ```typescript
25
- * // Discovery returns wallets with secure channel components
26
- * const wallets = await ExtensionProvider.discoverExtensions(chainInfo);
27
- * const { info, port, sharedKey } = wallets[0];
28
- *
29
- * // User can verify emoji if desired
30
- * console.log('Verify:', hashToEmoji(info.verificationHash!));
31
- *
32
- * // Create wallet using the discovered components
33
- * const wallet = await ExtensionWallet.create(info, chainInfo, port, sharedKey, 'my-dapp');
34
- *
35
- * // All subsequent calls are encrypted
36
- * const accounts = await wallet.getAccounts();
37
- * ```
38
- */
39
- export declare class ExtensionWallet {
40
- private chainInfo;
41
- private appId;
42
- private extensionId;
43
- private port;
44
- private sharedKey;
45
- /** Map of pending requests awaiting responses, keyed by message ID */
46
- private inFlight;
47
- private disconnected;
48
- private disconnectCallbacks;
49
- /**
50
- * Private constructor - use {@link ExtensionWallet.create} to instantiate.
51
- * @param chainInfo - The chain information (chainId and version)
52
- * @param appId - Application identifier for the requesting dApp
53
- * @param extensionId - The unique identifier of the target wallet extension
54
- * @param port - The MessagePort for private communication with the wallet
55
- * @param sharedKey - The derived AES-256-GCM shared key for encryption
56
- */
57
- private constructor();
58
- /** Cached Wallet proxy instance */
59
- private walletProxy;
60
- /**
61
- * Creates an ExtensionWallet instance that communicates with a browser extension
62
- * over a secure encrypted MessageChannel.
63
- *
64
- * @param walletInfo - The wallet info from ExtensionProvider.discoverExtensions()
65
- * @param chainInfo - The chain information (chainId and version) for request context
66
- * @param port - The MessagePort for private communication with the wallet
67
- * @param sharedKey - The derived AES-256-GCM shared key for encryption
68
- * @param appId - Application identifier used to identify the requesting dApp to the wallet
69
- * @returns The ExtensionWallet instance. Use {@link getWallet} to get the Wallet interface.
70
- *
71
- * @example
72
- * ```typescript
73
- * const wallets = await ExtensionProvider.discoverExtensions(chainInfo);
74
- * const { info, port, sharedKey } = wallets[0];
75
- * const extensionWallet = ExtensionWallet.create(
76
- * info,
77
- * { chainId: Fr(31337), version: Fr(0) },
78
- * port,
79
- * sharedKey,
80
- * 'my-defi-app'
81
- * );
82
- *
83
- * // Register disconnect handler
84
- * extensionWallet.onDisconnect(() => console.log('Disconnected!'));
85
- *
86
- * // Get the Wallet interface for dApp usage
87
- * const wallet = extensionWallet.getWallet();
88
- * const accounts = await wallet.getAccounts();
89
- * ```
90
- */
91
- static create(walletInfo: WalletInfo, chainInfo: ChainInfo, port: MessagePort, sharedKey: CryptoKey, appId: string): ExtensionWallet;
92
- /**
93
- * Returns a Wallet interface that proxies all method calls through the secure channel.
94
- *
95
- * The returned Wallet can be used directly by dApps - all method calls are automatically
96
- * encrypted and sent to the wallet extension.
97
- *
98
- * @returns A Wallet implementation that encrypts all communication
99
- *
100
- * @example
101
- * ```typescript
102
- * const extensionWallet = ExtensionWallet.create(info, chainInfo, port, sharedKey, 'my-app');
103
- * const wallet = extensionWallet.getWallet();
104
- * const accounts = await wallet.getAccounts();
105
- * ```
106
- */
107
- getWallet(): Wallet;
108
- private handleEncryptedResponse;
109
- private postMessage;
110
- /**
111
- * Handles wallet disconnection.
112
- * Rejects all pending requests and notifies registered callbacks.
113
- * @internal
114
- */
115
- private handleDisconnect;
116
- /**
117
- * Registers a callback to be invoked when the wallet disconnects.
118
- *
119
- * @param callback - Function to call when wallet disconnects
120
- * @returns A function to unregister the callback
121
- *
122
- * @example
123
- * ```typescript
124
- * const wallet = await ExtensionWallet.create(...);
125
- * const unsubscribe = wallet.onDisconnect(() => {
126
- * console.log('Wallet disconnected! Please reconnect.');
127
- * // Clean up UI, prompt user to reconnect, etc.
128
- * });
129
- * // Later: unsubscribe(); to stop receiving notifications
130
- * ```
131
- */
132
- onDisconnect(callback: DisconnectCallback): () => void;
133
- /**
134
- * Returns whether the wallet has been disconnected.
135
- *
136
- * @returns true if the wallet is no longer connected
137
- */
138
- isDisconnected(): boolean;
139
- /**
140
- * Disconnects from the wallet and cleans up resources.
141
- *
142
- * This method notifies the wallet extension that the session is ending,
143
- * allowing it to clean up its state. After calling this method, the wallet
144
- * instance can no longer be used and any pending requests will be rejected.
145
- *
146
- * @example
147
- * ```typescript
148
- * const wallet = await provider.connect('my-app');
149
- * // ... use wallet ...
150
- * await wallet.disconnect(); // Clean disconnect when done
151
- * ```
152
- */
153
- disconnect(): Promise<void>;
154
- }
155
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXh0ZW5zaW9uX3dhbGxldC5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3Byb3ZpZGVycy9leHRlbnNpb24vZXh0ZW5zaW9uX3dhbGxldC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssRUFBRSxTQUFTLEVBQUUsTUFBTSx5QkFBeUIsQ0FBQztBQUN6RCxPQUFPLEVBQUUsS0FBSyxNQUFNLEVBQWdCLE1BQU0sd0JBQXdCLENBQUM7QUFPbkUsT0FBTyxFQUFFLEtBQUssVUFBVSxFQUE4RCxNQUFNLGdCQUFnQixDQUFDO0FBYTdHOztHQUVHO0FBQ0gsTUFBTSxNQUFNLGtCQUFrQixHQUFHLE1BQU0sSUFBSSxDQUFDO0FBRTVDOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0E4Qkc7QUFDSCxxQkFBYSxlQUFlO0lBZXhCLE9BQU8sQ0FBQyxTQUFTO0lBQ2pCLE9BQU8sQ0FBQyxLQUFLO0lBQ2IsT0FBTyxDQUFDLFdBQVc7SUFDbkIsT0FBTyxDQUFDLElBQUk7SUFDWixPQUFPLENBQUMsU0FBUztJQWxCbkIsc0VBQXNFO0lBQ3RFLE9BQU8sQ0FBQyxRQUFRLENBQW9EO0lBQ3BFLE9BQU8sQ0FBQyxZQUFZLENBQVM7SUFDN0IsT0FBTyxDQUFDLG1CQUFtQixDQUE0QjtJQUV2RDs7Ozs7OztPQU9HO0lBQ0gsT0FBTyxlQU1IO0lBRUosbUNBQW1DO0lBQ25DLE9BQU8sQ0FBQyxXQUFXLENBQXVCO0lBRTFDOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7T0E4Qkc7SUFDSCxNQUFNLENBQUMsTUFBTSxDQUNYLFVBQVUsRUFBRSxVQUFVLEVBQ3RCLFNBQVMsRUFBRSxTQUFTLEVBQ3BCLElBQUksRUFBRSxXQUFXLEVBQ2pCLFNBQVMsRUFBRSxTQUFTLEVBQ3BCLEtBQUssRUFBRSxNQUFNLEdBQ1osZUFBZSxDQVdqQjtJQUVEOzs7Ozs7Ozs7Ozs7OztPQWNHO0lBQ0gsU0FBUyxJQUFJLE1BQU0sQ0F1QmxCO1lBVWEsdUJBQXVCO1lBMER2QixXQUFXO0lBMkJ6Qjs7OztPQUlHO0lBQ0gsT0FBTyxDQUFDLGdCQUFnQjtJQStCeEI7Ozs7Ozs7Ozs7Ozs7OztPQWVHO0lBQ0gsWUFBWSxDQUFDLFFBQVEsRUFBRSxrQkFBa0IsR0FBRyxNQUFNLElBQUksQ0FRckQ7SUFFRDs7OztPQUlHO0lBQ0gsY0FBYyxJQUFJLE9BQU8sQ0FFeEI7SUFFRDs7Ozs7Ozs7Ozs7OztPQWFHO0lBQ0csVUFBVSxJQUFJLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0EyQmhDO0NBQ0YifQ==
@@ -1 +0,0 @@
1
- {"version":3,"file":"extension_wallet.d.ts","sourceRoot":"","sources":["../../../src/providers/extension/extension_wallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,wBAAwB,CAAC;AAOnE,OAAO,EAAE,KAAK,UAAU,EAA8D,MAAM,gBAAgB,CAAC;AAa7G;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,eAAe;IAexB,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,SAAS;IAlBnB,sEAAsE;IACtE,OAAO,CAAC,QAAQ,CAAoD;IACpE,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,mBAAmB,CAA4B;IAEvD;;;;;;;OAOG;IACH,OAAO,eAMH;IAEJ,mCAAmC;IACnC,OAAO,CAAC,WAAW,CAAuB;IAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CAAC,MAAM,CACX,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,WAAW,EACjB,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,MAAM,GACZ,eAAe,CAWjB;IAED;;;;;;;;;;;;;;OAcG;IACH,SAAS,IAAI,MAAM,CAuBlB;YAUa,uBAAuB;YA0DvB,WAAW;IA2BzB;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IA+BxB;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CAAC,QAAQ,EAAE,kBAAkB,GAAG,MAAM,IAAI,CAQrD;IAED;;;;OAIG;IACH,cAAc,IAAI,OAAO,CAExB;IAED;;;;;;;;;;;;;OAaG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CA2BhC;CACF"}
@@ -1,6 +0,0 @@
1
- export { ExtensionWallet, type DisconnectCallback } from './extension_wallet.js';
2
- export { ExtensionProvider, type DiscoveredWallet } from './extension_provider.js';
3
- export * from '../../crypto.js';
4
- export { WalletMessageType } from '../../types.js';
5
- export type { WalletInfo, WalletMessage, WalletResponse, DiscoveryRequest, DiscoveryResponse } from '../../types.js';
6
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9wcm92aWRlcnMvZXh0ZW5zaW9uL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxlQUFlLEVBQUUsS0FBSyxrQkFBa0IsRUFBRSxNQUFNLHVCQUF1QixDQUFDO0FBQ2pGLE9BQU8sRUFBRSxpQkFBaUIsRUFBRSxLQUFLLGdCQUFnQixFQUFFLE1BQU0seUJBQXlCLENBQUM7QUFDbkYsY0FBYyxpQkFBaUIsQ0FBQztBQUNoQyxPQUFPLEVBQUUsaUJBQWlCLEVBQUUsTUFBTSxnQkFBZ0IsQ0FBQztBQUNuRCxZQUFZLEVBQUUsVUFBVSxFQUFFLGFBQWEsRUFBRSxjQUFjLEVBQUUsZ0JBQWdCLEVBQUUsaUJBQWlCLEVBQUUsTUFBTSxnQkFBZ0IsQ0FBQyJ9
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/extension/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,KAAK,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AACjF,OAAO,EAAE,iBAAiB,EAAE,KAAK,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AACnF,cAAc,iBAAiB,CAAC;AAChC,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnD,YAAY,EAAE,UAAU,EAAE,aAAa,EAAE,cAAc,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC"}
@@ -1,167 +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 { deriveSharedKey, exportPublicKey, generateKeyPair, hashSharedSecret, importPublicKey } from '../../crypto.js';
6
- import { type DiscoveryRequest, type DiscoveryResponse, type WalletInfo, WalletMessageType } from '../../types.js';
7
-
8
- /**
9
- * A discovered wallet with its secure channel components.
10
- * Returned by {@link ExtensionProvider.discoverExtensions}.
11
- */
12
- export interface DiscoveredWallet {
13
- /** Basic wallet information (id, name, icon, version, publicKey, verificationHash) */
14
- info: WalletInfo;
15
- /** The MessagePort for private communication with the wallet */
16
- port: MessagePort;
17
- /** The derived AES-256-GCM shared key for encryption */
18
- sharedKey: CryptoKey;
19
- }
20
-
21
- /**
22
- * Internal type for discovery response with MessagePort
23
- * @internal
24
- */
25
- interface DiscoveryResponseWithPort extends DiscoveryResponse {
26
- /** The MessagePort transferred from the wallet */
27
- port?: MessagePort;
28
- }
29
-
30
- /**
31
- * Provider for discovering Aztec wallet extensions.
32
- *
33
- * This class handles the discovery phase of wallet communication:
34
- * 1. Broadcasts a discovery request with the dApp's public key
35
- * 2. Receives responses from installed wallets with their public keys
36
- * 3. Derives shared secrets and computes verification hashes
37
- * 4. Returns discovered wallets with their secure channel components
38
- *
39
- * @example
40
- * ```typescript
41
- * const wallets = await ExtensionProvider.discoverExtensions(chainInfo);
42
- * // Display wallets to user with optional emoji verification
43
- * for (const wallet of wallets) {
44
- * const emoji = hashToEmoji(wallet.info.verificationHash!);
45
- * console.log(`${wallet.info.name}: ${emoji}`);
46
- * }
47
- * // User selects a wallet after verifying
48
- * const wallet = await ExtensionWallet.create(wallets[0], chainInfo, 'my-app');
49
- * ```
50
- */
51
- export class ExtensionProvider {
52
- private static discoveryInProgress = false;
53
-
54
- /**
55
- * Discovers all installed Aztec wallet extensions and establishes secure channel components.
56
- *
57
- * This method:
58
- * 1. Generates an ECDH key pair for this discovery session
59
- * 2. Broadcasts a discovery request with the dApp's public key
60
- * 3. Receives responses from wallets with their public keys and MessagePorts
61
- * 4. Derives shared secrets and computes verification hashes
62
- *
63
- * @param chainInfo - Chain information to check if extensions support this network
64
- * @param timeout - How long to wait for extensions to respond (ms)
65
- * @returns Array of discovered wallets with their secure channel components
66
- *
67
- * @example
68
- * ```typescript
69
- * const wallets = await ExtensionProvider.discoverExtensions({
70
- * chainId: Fr(31337),
71
- * version: Fr(0)
72
- * });
73
- * // Access wallet info and secure channel
74
- * const { info, port, sharedKey } = wallets[0];
75
- * ```
76
- */
77
- static async discoverExtensions(chainInfo: ChainInfo, timeout: number = 1000): Promise<DiscoveredWallet[]> {
78
- // If discovery is already in progress, wait and return empty
79
- // (caller should retry or handle appropriately)
80
- if (this.discoveryInProgress) {
81
- await new Promise(resolve => setTimeout(resolve, timeout));
82
- return [];
83
- }
84
-
85
- this.discoveryInProgress = true;
86
-
87
- // Generate key pair for this discovery session
88
- const keyPair = await generateKeyPair();
89
- const exportedPublicKey = await exportPublicKey(keyPair.publicKey);
90
-
91
- const { promise, resolve } = promiseWithResolvers<DiscoveredWallet[]>();
92
- const requestId = globalThis.crypto.randomUUID();
93
- const responses: DiscoveredWallet[] = [];
94
-
95
- // Set up listener for discovery responses
96
- const handleMessage = (event: MessageEvent) => {
97
- if (event.source !== window) {
98
- return;
99
- }
100
-
101
- let data: DiscoveryResponseWithPort;
102
- try {
103
- data = JSON.parse(event.data);
104
- } catch {
105
- return;
106
- }
107
-
108
- if (data.type === WalletMessageType.DISCOVERY_RESPONSE && data.requestId === requestId) {
109
- // Get the MessagePort from the event
110
- const port = event.ports?.[0];
111
- if (!port) {
112
- return;
113
- }
114
-
115
- // Derive shared key from wallet's public key
116
- const walletPublicKey = data.walletInfo.publicKey;
117
- if (!walletPublicKey) {
118
- return;
119
- }
120
-
121
- void (async () => {
122
- try {
123
- const importedWalletKey = await importPublicKey(walletPublicKey);
124
- const sharedKey = await deriveSharedKey(keyPair.privateKey, importedWalletKey);
125
-
126
- // Compute verification hash
127
- const verificationHash = await hashSharedSecret(sharedKey);
128
-
129
- // Create wallet info with verification hash
130
- const walletInfo: WalletInfo = {
131
- ...data.walletInfo,
132
- verificationHash,
133
- };
134
-
135
- responses.push({
136
- info: walletInfo,
137
- port,
138
- sharedKey,
139
- });
140
- } catch {
141
- // Failed to derive key, skip this wallet
142
- }
143
- })();
144
- }
145
- };
146
-
147
- window.addEventListener('message', handleMessage);
148
-
149
- // Send discovery message with our public key
150
- const discoveryMessage: DiscoveryRequest = {
151
- type: WalletMessageType.DISCOVERY,
152
- requestId,
153
- chainInfo,
154
- publicKey: exportedPublicKey,
155
- };
156
- window.postMessage(jsonStringify(discoveryMessage), '*');
157
-
158
- // Wait for responses
159
- setTimeout(() => {
160
- window.removeEventListener('message', handleMessage);
161
- this.discoveryInProgress = false;
162
- resolve(responses);
163
- }, timeout);
164
-
165
- return promise;
166
- }
167
- }
@@ -1,5 +0,0 @@
1
- export { ExtensionWallet, type DisconnectCallback } from './extension_wallet.js';
2
- export { ExtensionProvider, type DiscoveredWallet } from './extension_provider.js';
3
- export * from '../../crypto.js';
4
- export { WalletMessageType } from '../../types.js';
5
- export type { WalletInfo, WalletMessage, WalletResponse, DiscoveryRequest, DiscoveryResponse } from '../../types.js';