@aztec/wallet-sdk 0.0.1-commit.96bb3f7 → 0.0.1-commit.993d240

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 (101) hide show
  1. package/README.md +218 -355
  2. package/dest/base-wallet/base_wallet.d.ts +109 -40
  3. package/dest/base-wallet/base_wallet.d.ts.map +1 -1
  4. package/dest/base-wallet/base_wallet.js +286 -71
  5. package/dest/base-wallet/index.d.ts +3 -2
  6. package/dest/base-wallet/index.d.ts.map +1 -1
  7. package/dest/base-wallet/index.js +1 -0
  8. package/dest/base-wallet/utils.d.ts +52 -0
  9. package/dest/base-wallet/utils.d.ts.map +1 -0
  10. package/dest/base-wallet/utils.js +137 -0
  11. package/dest/crypto.d.ts +111 -27
  12. package/dest/crypto.d.ts.map +1 -1
  13. package/dest/crypto.js +307 -41
  14. package/dest/emoji_alphabet.d.ts +35 -0
  15. package/dest/emoji_alphabet.d.ts.map +1 -0
  16. package/dest/emoji_alphabet.js +299 -0
  17. package/dest/extension/handlers/background_connection_handler.d.ts +168 -0
  18. package/dest/extension/handlers/background_connection_handler.d.ts.map +1 -0
  19. package/dest/extension/handlers/background_connection_handler.js +294 -0
  20. package/dest/extension/handlers/content_script_connection_handler.d.ts +57 -0
  21. package/dest/extension/handlers/content_script_connection_handler.d.ts.map +1 -0
  22. package/dest/extension/handlers/content_script_connection_handler.js +193 -0
  23. package/dest/extension/handlers/index.d.ts +12 -0
  24. package/dest/extension/handlers/index.d.ts.map +1 -0
  25. package/dest/extension/handlers/index.js +10 -0
  26. package/dest/extension/handlers/internal_message_types.d.ts +65 -0
  27. package/dest/extension/handlers/internal_message_types.d.ts.map +1 -0
  28. package/dest/extension/handlers/internal_message_types.js +24 -0
  29. package/dest/extension/provider/extension_provider.d.ts +107 -0
  30. package/dest/extension/provider/extension_provider.d.ts.map +1 -0
  31. package/dest/extension/provider/extension_provider.js +160 -0
  32. package/dest/extension/provider/extension_wallet.d.ts +152 -0
  33. package/dest/extension/provider/extension_wallet.d.ts.map +1 -0
  34. package/dest/extension/provider/extension_wallet.js +349 -0
  35. package/dest/extension/provider/index.d.ts +3 -0
  36. package/dest/extension/provider/index.d.ts.map +1 -0
  37. package/dest/{providers/extension → extension/provider}/index.js +0 -1
  38. package/dest/iframe/handlers/iframe_connection_handler.d.ts +122 -0
  39. package/dest/iframe/handlers/iframe_connection_handler.d.ts.map +1 -0
  40. package/dest/iframe/handlers/iframe_connection_handler.js +239 -0
  41. package/dest/iframe/handlers/index.d.ts +2 -0
  42. package/dest/iframe/handlers/index.d.ts.map +1 -0
  43. package/dest/iframe/handlers/index.js +1 -0
  44. package/dest/iframe/provider/iframe_discovery.d.ts +25 -0
  45. package/dest/iframe/provider/iframe_discovery.d.ts.map +1 -0
  46. package/dest/iframe/provider/iframe_discovery.js +167 -0
  47. package/dest/iframe/provider/iframe_provider.d.ts +65 -0
  48. package/dest/iframe/provider/iframe_provider.d.ts.map +1 -0
  49. package/dest/iframe/provider/iframe_provider.js +257 -0
  50. package/dest/iframe/provider/iframe_wallet.d.ts +85 -0
  51. package/dest/iframe/provider/iframe_wallet.d.ts.map +1 -0
  52. package/dest/iframe/provider/iframe_wallet.js +269 -0
  53. package/dest/iframe/provider/index.d.ts +4 -0
  54. package/dest/iframe/provider/index.d.ts.map +1 -0
  55. package/dest/iframe/provider/index.js +3 -0
  56. package/dest/manager/index.d.ts +2 -7
  57. package/dest/manager/index.d.ts.map +1 -1
  58. package/dest/manager/index.js +0 -4
  59. package/dest/manager/types.d.ts +109 -5
  60. package/dest/manager/types.d.ts.map +1 -1
  61. package/dest/manager/types.js +17 -1
  62. package/dest/manager/wallet_manager.d.ts +50 -7
  63. package/dest/manager/wallet_manager.d.ts.map +1 -1
  64. package/dest/manager/wallet_manager.js +208 -29
  65. package/dest/types.d.ts +117 -15
  66. package/dest/types.d.ts.map +1 -1
  67. package/dest/types.js +39 -2
  68. package/package.json +22 -11
  69. package/src/base-wallet/base_wallet.ts +395 -128
  70. package/src/base-wallet/index.ts +7 -1
  71. package/src/base-wallet/utils.ts +248 -0
  72. package/src/crypto.ts +367 -47
  73. package/src/emoji_alphabet.ts +317 -0
  74. package/src/extension/handlers/background_connection_handler.ts +456 -0
  75. package/src/extension/handlers/content_script_connection_handler.ts +264 -0
  76. package/src/extension/handlers/index.ts +25 -0
  77. package/src/extension/handlers/internal_message_types.ts +71 -0
  78. package/src/extension/provider/extension_provider.ts +233 -0
  79. package/src/extension/provider/extension_wallet.ts +410 -0
  80. package/src/extension/provider/index.ts +7 -0
  81. package/src/iframe/handlers/iframe_connection_handler.ts +341 -0
  82. package/src/iframe/handlers/index.ts +7 -0
  83. package/src/iframe/provider/iframe_discovery.ts +185 -0
  84. package/src/iframe/provider/iframe_provider.ts +331 -0
  85. package/src/iframe/provider/iframe_wallet.ts +323 -0
  86. package/src/iframe/provider/index.ts +3 -0
  87. package/src/manager/index.ts +3 -9
  88. package/src/manager/types.ts +113 -4
  89. package/src/manager/wallet_manager.ts +235 -30
  90. package/src/types.ts +129 -14
  91. package/dest/providers/extension/extension_provider.d.ts +0 -17
  92. package/dest/providers/extension/extension_provider.d.ts.map +0 -1
  93. package/dest/providers/extension/extension_provider.js +0 -56
  94. package/dest/providers/extension/extension_wallet.d.ts +0 -95
  95. package/dest/providers/extension/extension_wallet.d.ts.map +0 -1
  96. package/dest/providers/extension/extension_wallet.js +0 -225
  97. package/dest/providers/extension/index.d.ts +0 -5
  98. package/dest/providers/extension/index.d.ts.map +0 -1
  99. package/src/providers/extension/extension_provider.ts +0 -72
  100. package/src/providers/extension/extension_wallet.ts +0 -275
  101. package/src/providers/extension/index.ts +0 -11
@@ -1,5 +1,33 @@
1
1
  import type { ChainInfo } from '@aztec/aztec.js/account';
2
2
  import type { Wallet } from '@aztec/aztec.js/wallet';
3
+ /**
4
+ * A pending connection that requires user verification before finalizing.
5
+ *
6
+ * After key exchange, both dApp and wallet compute a verification hash independently.
7
+ * The dApp should display this hash (typically as emojis) and let the user confirm
8
+ * it matches what's shown in their wallet before calling `confirm()`.
9
+ *
10
+ * This protects the dApp from connecting to a malicious wallet that might be
11
+ * intercepting the connection (MITM attack).
12
+ */
13
+ export interface PendingConnection {
14
+ /**
15
+ * The verification hash computed from the shared secret.
16
+ * Use `hashToEmoji()` to convert to a visual representation for user verification.
17
+ * The user should confirm this matches what their wallet displays.
18
+ */
19
+ verificationHash: string;
20
+ /**
21
+ * Confirms the connection after user verifies the emojis match.
22
+ * @returns The connected wallet instance
23
+ */
24
+ confirm(): Promise<Wallet>;
25
+ /**
26
+ * Cancels the pending connection.
27
+ * Call this if the user indicates the emojis don't match.
28
+ */
29
+ cancel(): void;
30
+ }
3
31
  /**
4
32
  * Configuration for extension wallets
5
33
  */
@@ -30,7 +58,11 @@ export interface WalletManagerConfig {
30
58
  /**
31
59
  * Type of wallet provider
32
60
  */
33
- export type WalletProviderType = 'extension' | 'web' | 'embedded';
61
+ export type WalletProviderType = 'extension' | 'web';
62
+ /**
63
+ * Callback type for wallet disconnect events at the provider level.
64
+ */
65
+ export type ProviderDisconnectionCallback = () => void;
34
66
  /**
35
67
  * A wallet provider that can connect to create a wallet instance.
36
68
  * Chain information is already baked in from the discovery process.
@@ -47,10 +79,47 @@ export interface WalletProvider {
47
79
  /** Additional metadata */
48
80
  metadata?: Record<string, unknown>;
49
81
  /**
50
- * Connect to this wallet provider with an application ID
82
+ * Establishes a secure channel with this wallet provider.
83
+ *
84
+ * This performs the ECDH key exchange and returns a pending connection with the
85
+ * verification hash. The channel is encrypted but NOT yet verified - the dApp
86
+ * should display the hash (as emojis) to the user and let them confirm it
87
+ * matches their wallet before calling `confirm()`.
88
+ *
51
89
  * @param appId - Application identifier for the requesting dapp
90
+ * @param options - Optional provider-specific options (e.g. container element for iframe wallets)
91
+ * @returns A pending connection with verification hash and confirm/cancel methods
92
+ *
93
+ * @example
94
+ * ```typescript
95
+ * const pending = await provider.establishSecureChannel('my-app');
96
+ *
97
+ * // Show emojis to user for verification
98
+ * const emojis = hashToEmoji(pending.verificationHash);
99
+ * showDialog(`Verify these match your wallet: ${emojis}`);
100
+ *
101
+ * // User confirms emojis match
102
+ * const wallet = await pending.confirm();
103
+ * ```
52
104
  */
53
- connect(appId: string): Promise<Wallet>;
105
+ establishSecureChannel(appId: string, options?: Record<string, unknown>): Promise<PendingConnection>;
106
+ /**
107
+ * Disconnects the current wallet and cleans up resources.
108
+ * After calling this, the wallet returned from confirm() should no longer be used.
109
+ * @returns A promise that resolves when disconnection is complete
110
+ */
111
+ disconnect(): Promise<void>;
112
+ /**
113
+ * Registers a callback to be invoked when the wallet disconnects unexpectedly.
114
+ * @param callback - Function to call when wallet disconnects
115
+ * @returns A function to unregister the callback
116
+ */
117
+ onDisconnect(callback: ProviderDisconnectionCallback): () => void;
118
+ /**
119
+ * Returns whether the provider's wallet connection has been disconnected.
120
+ * @returns true if the wallet is no longer connected
121
+ */
122
+ isDisconnected(): boolean;
54
123
  }
55
124
  /**
56
125
  * Options for discovering wallets
@@ -58,7 +127,42 @@ export interface WalletProvider {
58
127
  export interface DiscoverWalletsOptions {
59
128
  /** Chain information to filter by */
60
129
  chainInfo: ChainInfo;
61
- /** Discovery timeout in milliseconds */
130
+ /** Application ID making the request */
131
+ appId: string;
132
+ /** Discovery timeout in milliseconds. Default: 60000 (60s) */
62
133
  timeout?: number;
134
+ /**
135
+ * Callback invoked when a wallet provider is discovered.
136
+ * Use this to show wallets to users as they approve them, rather than
137
+ * waiting for the full timeout.
138
+ */
139
+ onWalletDiscovered?: (provider: WalletProvider) => void;
140
+ }
141
+ /**
142
+ * A cancellable discovery session.
143
+ *
144
+ * Returned by `WalletManager.getAvailableWallets()` to allow consumers to
145
+ * cancel discovery when no longer needed (e.g., network changes, user navigates away).
146
+ *
147
+ * @example
148
+ * ```typescript
149
+ * const discovery = WalletManager.configure({...}).getAvailableWallets({...});
150
+ *
151
+ * // Iterate over discovered wallets
152
+ * for await (const wallet of discovery.wallets) {
153
+ * console.log(`Found: ${wallet.name}`);
154
+ * }
155
+ *
156
+ * // Cancel discovery when no longer needed
157
+ * discovery.cancel();
158
+ * ```
159
+ */
160
+ export interface DiscoverySession {
161
+ /** Async iterator that yields wallet providers as they're discovered */
162
+ wallets: AsyncIterable<WalletProvider>;
163
+ /** Promise that resolves when discovery completes or is cancelled */
164
+ done: Promise<void>;
165
+ /** Cancel discovery immediately and clean up resources */
166
+ cancel: () => void;
63
167
  }
64
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9tYW5hZ2VyL3R5cGVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxFQUFFLFNBQVMsRUFBRSxNQUFNLHlCQUF5QixDQUFDO0FBQ3pELE9BQU8sS0FBSyxFQUFFLE1BQU0sRUFBRSxNQUFNLHdCQUF3QixDQUFDO0FBRXJEOztHQUVHO0FBQ0gsTUFBTSxXQUFXLHFCQUFxQjtJQUNwQyw0Q0FBNEM7SUFDNUMsT0FBTyxFQUFFLE9BQU8sQ0FBQztJQUNqQix5REFBeUQ7SUFDekQsU0FBUyxDQUFDLEVBQUUsTUFBTSxFQUFFLENBQUM7SUFDckIseURBQXlEO0lBQ3pELFNBQVMsQ0FBQyxFQUFFLE1BQU0sRUFBRSxDQUFDO0NBQ3RCO0FBRUQ7O0dBRUc7QUFDSCxNQUFNLFdBQVcsZUFBZTtJQUM5QixrQ0FBa0M7SUFDbEMsSUFBSSxFQUFFLE1BQU0sRUFBRSxDQUFDO0NBQ2hCO0FBRUQ7O0dBRUc7QUFDSCxNQUFNLFdBQVcsbUJBQW1CO0lBQ2xDLHFDQUFxQztJQUNyQyxVQUFVLENBQUMsRUFBRSxxQkFBcUIsQ0FBQztJQUNuQywrQkFBK0I7SUFDL0IsVUFBVSxDQUFDLEVBQUUsZUFBZSxDQUFDO0NBQzlCO0FBRUQ7O0dBRUc7QUFDSCxNQUFNLE1BQU0sa0JBQWtCLEdBQUcsV0FBVyxHQUFHLEtBQUssR0FBRyxVQUFVLENBQUM7QUFFbEU7OztHQUdHO0FBQ0gsTUFBTSxXQUFXLGNBQWM7SUFDN0IseUNBQXlDO0lBQ3pDLEVBQUUsRUFBRSxNQUFNLENBQUM7SUFDWCw4QkFBOEI7SUFDOUIsSUFBSSxFQUFFLGtCQUFrQixDQUFDO0lBQ3pCLG1CQUFtQjtJQUNuQixJQUFJLEVBQUUsTUFBTSxDQUFDO0lBQ2IsZUFBZTtJQUNmLElBQUksQ0FBQyxFQUFFLE1BQU0sQ0FBQztJQUNkLDBCQUEwQjtJQUMxQixRQUFRLENBQUMsRUFBRSxNQUFNLENBQUMsTUFBTSxFQUFFLE9BQU8sQ0FBQyxDQUFDO0lBQ25DOzs7T0FHRztJQUNILE9BQU8sQ0FBQyxLQUFLLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQztDQUN6QztBQUVEOztHQUVHO0FBQ0gsTUFBTSxXQUFXLHNCQUFzQjtJQUNyQyxxQ0FBcUM7SUFDckMsU0FBUyxFQUFFLFNBQVMsQ0FBQztJQUNyQix3Q0FBd0M7SUFDeEMsT0FBTyxDQUFDLEVBQUUsTUFBTSxDQUFDO0NBQ2xCIn0=
168
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9tYW5hZ2VyL3R5cGVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxFQUFFLFNBQVMsRUFBRSxNQUFNLHlCQUF5QixDQUFDO0FBQ3pELE9BQU8sS0FBSyxFQUFFLE1BQU0sRUFBRSxNQUFNLHdCQUF3QixDQUFDO0FBRXJEOzs7Ozs7Ozs7R0FTRztBQUNILE1BQU0sV0FBVyxpQkFBaUI7SUFDaEM7Ozs7T0FJRztJQUNILGdCQUFnQixFQUFFLE1BQU0sQ0FBQztJQUV6Qjs7O09BR0c7SUFDSCxPQUFPLElBQUksT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFDO0lBRTNCOzs7T0FHRztJQUNILE1BQU0sSUFBSSxJQUFJLENBQUM7Q0FDaEI7QUFFRDs7R0FFRztBQUNILE1BQU0sV0FBVyxxQkFBcUI7SUFDcEMsNENBQTRDO0lBQzVDLE9BQU8sRUFBRSxPQUFPLENBQUM7SUFDakIseURBQXlEO0lBQ3pELFNBQVMsQ0FBQyxFQUFFLE1BQU0sRUFBRSxDQUFDO0lBQ3JCLHlEQUF5RDtJQUN6RCxTQUFTLENBQUMsRUFBRSxNQUFNLEVBQUUsQ0FBQztDQUN0QjtBQUVEOztHQUVHO0FBQ0gsTUFBTSxXQUFXLGVBQWU7SUFDOUIsa0NBQWtDO0lBQ2xDLElBQUksRUFBRSxNQUFNLEVBQUUsQ0FBQztDQUNoQjtBQUVEOztHQUVHO0FBQ0gsTUFBTSxXQUFXLG1CQUFtQjtJQUNsQyxxQ0FBcUM7SUFDckMsVUFBVSxDQUFDLEVBQUUscUJBQXFCLENBQUM7SUFDbkMsK0JBQStCO0lBQy9CLFVBQVUsQ0FBQyxFQUFFLGVBQWUsQ0FBQztDQUM5QjtBQUVEOztHQUVHO0FBQ0gsTUFBTSxNQUFNLGtCQUFrQixHQUFHLFdBQVcsR0FBRyxLQUFLLENBQUM7QUFFckQ7O0dBRUc7QUFDSCxNQUFNLE1BQU0sNkJBQTZCLEdBQUcsTUFBTSxJQUFJLENBQUM7QUFFdkQ7OztHQUdHO0FBQ0gsTUFBTSxXQUFXLGNBQWM7SUFDN0IseUNBQXlDO0lBQ3pDLEVBQUUsRUFBRSxNQUFNLENBQUM7SUFDWCw4QkFBOEI7SUFDOUIsSUFBSSxFQUFFLGtCQUFrQixDQUFDO0lBQ3pCLG1CQUFtQjtJQUNuQixJQUFJLEVBQUUsTUFBTSxDQUFDO0lBQ2IsZUFBZTtJQUNmLElBQUksQ0FBQyxFQUFFLE1BQU0sQ0FBQztJQUNkLDBCQUEwQjtJQUMxQixRQUFRLENBQUMsRUFBRSxNQUFNLENBQUMsTUFBTSxFQUFFLE9BQU8sQ0FBQyxDQUFDO0lBQ25DOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztPQXVCRztJQUNILHNCQUFzQixDQUFDLEtBQUssRUFBRSxNQUFNLEVBQUUsT0FBTyxDQUFDLEVBQUUsTUFBTSxDQUFDLE1BQU0sRUFBRSxPQUFPLENBQUMsR0FBRyxPQUFPLENBQUMsaUJBQWlCLENBQUMsQ0FBQztJQUNyRzs7OztPQUlHO0lBQ0gsVUFBVSxJQUFJLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUM1Qjs7OztPQUlHO0lBQ0gsWUFBWSxDQUFDLFFBQVEsRUFBRSw2QkFBNkIsR0FBRyxNQUFNLElBQUksQ0FBQztJQUNsRTs7O09BR0c7SUFDSCxjQUFjLElBQUksT0FBTyxDQUFDO0NBQzNCO0FBRUQ7O0dBRUc7QUFDSCxNQUFNLFdBQVcsc0JBQXNCO0lBQ3JDLHFDQUFxQztJQUNyQyxTQUFTLEVBQUUsU0FBUyxDQUFDO0lBQ3JCLHdDQUF3QztJQUN4QyxLQUFLLEVBQUUsTUFBTSxDQUFDO0lBQ2QsOERBQThEO0lBQzlELE9BQU8sQ0FBQyxFQUFFLE1BQU0sQ0FBQztJQUNqQjs7OztPQUlHO0lBQ0gsa0JBQWtCLENBQUMsRUFBRSxDQUFDLFFBQVEsRUFBRSxjQUFjLEtBQUssSUFBSSxDQUFDO0NBQ3pEO0FBRUQ7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQWtCRztBQUNILE1BQU0sV0FBVyxnQkFBZ0I7SUFDL0Isd0VBQXdFO0lBQ3hFLE9BQU8sRUFBRSxhQUFhLENBQUMsY0FBYyxDQUFDLENBQUM7SUFDdkMscUVBQXFFO0lBQ3JFLElBQUksRUFBRSxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDcEIsMERBQTBEO0lBQzFELE1BQU0sRUFBRSxNQUFNLElBQUksQ0FBQztDQUNwQiJ9
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/manager/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,4CAA4C;IAC5C,OAAO,EAAE,OAAO,CAAC;IACjB,yDAAyD;IACzD,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,yDAAyD;IACzD,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,kCAAkC;IAClC,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,qCAAqC;IACrC,UAAU,CAAC,EAAE,qBAAqB,CAAC;IACnC,+BAA+B;IAC/B,UAAU,CAAC,EAAE,eAAe,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG,KAAK,GAAG,UAAU,CAAC;AAElE;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,yCAAyC;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,8BAA8B;IAC9B,IAAI,EAAE,kBAAkB,CAAC;IACzB,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,eAAe;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,qCAAqC;IACrC,SAAS,EAAE,SAAS,CAAC;IACrB,wCAAwC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/manager/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAErD;;;;;;;;;GASG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3B;;;OAGG;IACH,MAAM,IAAI,IAAI,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,4CAA4C;IAC5C,OAAO,EAAE,OAAO,CAAC;IACjB,yDAAyD;IACzD,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,yDAAyD;IACzD,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,kCAAkC;IAClC,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,qCAAqC;IACrC,UAAU,CAAC,EAAE,qBAAqB,CAAC;IACnC,+BAA+B;IAC/B,UAAU,CAAC,EAAE,eAAe,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG,KAAK,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,MAAM,IAAI,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,yCAAyC;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,8BAA8B;IAC9B,IAAI,EAAE,kBAAkB,CAAC;IACzB,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,eAAe;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACrG;;;;OAIG;IACH,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B;;;;OAIG;IACH,YAAY,CAAC,QAAQ,EAAE,6BAA6B,GAAG,MAAM,IAAI,CAAC;IAClE;;;OAGG;IACH,cAAc,IAAI,OAAO,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,qCAAqC;IACrC,SAAS,EAAE,SAAS,CAAC;IACrB,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,8DAA8D;IAC9D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC;CACzD;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,gBAAgB;IAC/B,wEAAwE;IACxE,OAAO,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IACvC,qEAAqE;IACrE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACpB,0DAA0D;IAC1D,MAAM,EAAE,MAAM,IAAI,CAAC;CACpB"}
@@ -1,3 +1,19 @@
1
1
  /**
2
- * Options for discovering wallets
2
+ * A cancellable discovery session.
3
+ *
4
+ * Returned by `WalletManager.getAvailableWallets()` to allow consumers to
5
+ * cancel discovery when no longer needed (e.g., network changes, user navigates away).
6
+ *
7
+ * @example
8
+ * ```typescript
9
+ * const discovery = WalletManager.configure({...}).getAvailableWallets({...});
10
+ *
11
+ * // Iterate over discovered wallets
12
+ * for await (const wallet of discovery.wallets) {
13
+ * console.log(`Found: ${wallet.name}`);
14
+ * }
15
+ *
16
+ * // Cancel discovery when no longer needed
17
+ * discovery.cancel();
18
+ * ```
3
19
  */ export { };
@@ -1,6 +1,34 @@
1
- import type { DiscoverWalletsOptions, WalletManagerConfig, WalletProvider } from './types.js';
1
+ import type { DiscoverWalletsOptions, DiscoverySession, WalletManagerConfig } from './types.js';
2
2
  /**
3
- * Manager for wallet discovery, configuration, and connection
3
+ * Manager for wallet discovery, configuration, and connection.
4
+ *
5
+ * This is the main entry point for dApps to discover and connect to wallets.
6
+ *
7
+ * @example Basic usage with async iterator
8
+ * ```typescript
9
+ * const discovery = WalletManager.configure({ extensions: { enabled: true } })
10
+ * .getAvailableWallets({ chainInfo, appId: 'my-app' });
11
+ *
12
+ * // Iterate over discovered wallets
13
+ * for await (const provider of discovery.wallets) {
14
+ * console.log(`Found wallet: ${provider.name}`);
15
+ * }
16
+ *
17
+ * // Or cancel early when done
18
+ * discovery.cancel();
19
+ * ```
20
+ *
21
+ * @example With callback for discovered wallets
22
+ * ```typescript
23
+ * const discovery = manager.getAvailableWallets({
24
+ * chainInfo,
25
+ * appId: 'my-app',
26
+ * onWalletDiscovered: (provider) => console.log(`Found: ${provider.name}`),
27
+ * });
28
+ *
29
+ * // Wait for discovery to complete or cancel it
30
+ * await discovery.done;
31
+ * ```
4
32
  */
5
33
  export declare class WalletManager {
6
34
  private config;
@@ -12,11 +40,26 @@ export declare class WalletManager {
12
40
  static configure(config: WalletManagerConfig): WalletManager;
13
41
  /**
14
42
  * Discovers all available wallets for a given chain and version.
15
- * Only returns wallets that support the requested chain and version.
16
- * @param options - Discovery options including chain info and timeout
17
- * @returns Array of wallet providers with baked-in chain info
43
+ *
44
+ * Returns a `DiscoverySession` with:
45
+ * - `wallets`: AsyncIterable to iterate over discovered wallets
46
+ * - `done`: Promise that resolves when discovery completes or is cancelled
47
+ * - `cancel()`: Function to stop discovery immediately
48
+ *
49
+ * If `onWalletDiscovered` callback is provided, wallets are also streamed via callback.
50
+ *
51
+ * @param options - Discovery options including chain info, appId, and timeout
52
+ * @returns A cancellable discovery session
18
53
  */
19
- getAvailableWallets(options: DiscoverWalletsOptions): Promise<WalletProvider[]>;
54
+ getAvailableWallets(options: DiscoverWalletsOptions): DiscoverySession;
55
+ /**
56
+ * Creates a WalletProvider from a discovered wallet.
57
+ * Returns null if the wallet is not allowed by config.
58
+ * @param discoveredWallet - The discovered wallet from extension discovery.
59
+ * @param chainInfo - Network information.
60
+ * @param extensionConfig - Extension wallet configuration.
61
+ */
62
+ private createProviderFromDiscoveredWallet;
20
63
  /**
21
64
  * Checks if an extension is allowed based on allow/block lists
22
65
  * @param extensionId - The extension ID to check
@@ -24,4 +67,4 @@ export declare class WalletManager {
24
67
  */
25
68
  private isExtensionAllowed;
26
69
  }
27
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid2FsbGV0X21hbmFnZXIuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9tYW5hZ2VyL3dhbGxldF9tYW5hZ2VyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sS0FBSyxFQUFFLHNCQUFzQixFQUF5QixtQkFBbUIsRUFBRSxjQUFjLEVBQUUsTUFBTSxZQUFZLENBQUM7QUFFckg7O0dBRUc7QUFDSCxxQkFBYSxhQUFhO0lBQ3hCLE9BQU8sQ0FBQyxNQUFNLENBR1o7SUFFRixPQUFPLGVBQWlCO0lBRXhCOzs7T0FHRztJQUNILE1BQU0sQ0FBQyxTQUFTLENBQUMsTUFBTSxFQUFFLG1CQUFtQixHQUFHLGFBQWEsQ0FPM0Q7SUFFRDs7Ozs7T0FLRztJQUNHLG1CQUFtQixDQUFDLE9BQU8sRUFBRSxzQkFBc0IsR0FBRyxPQUFPLENBQUMsY0FBYyxFQUFFLENBQUMsQ0ErQnBGO0lBRUQ7Ozs7T0FJRztJQUNILE9BQU8sQ0FBQyxrQkFBa0I7Q0FjM0IifQ==
70
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid2FsbGV0X21hbmFnZXIuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9tYW5hZ2VyL3dhbGxldF9tYW5hZ2VyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQU1BLE9BQU8sS0FBSyxFQUNWLHNCQUFzQixFQUN0QixnQkFBZ0IsRUFJaEIsbUJBQW1CLEVBRXBCLE1BQU0sWUFBWSxDQUFDO0FBRXBCOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0E4Qkc7QUFDSCxxQkFBYSxhQUFhO0lBQ3hCLE9BQU8sQ0FBQyxNQUFNLENBR1o7SUFFRixPQUFPLGVBQWlCO0lBRXhCOzs7T0FHRztJQUNILE1BQU0sQ0FBQyxTQUFTLENBQUMsTUFBTSxFQUFFLG1CQUFtQixHQUFHLGFBQWEsQ0FPM0Q7SUFFRDs7Ozs7Ozs7Ozs7O09BWUc7SUFDSCxtQkFBbUIsQ0FBQyxPQUFPLEVBQUUsc0JBQXNCLEdBQUcsZ0JBQWdCLENBOEdyRTtJQUVEOzs7Ozs7T0FNRztJQUNILE9BQU8sQ0FBQyxrQ0FBa0M7SUEwRTFDOzs7O09BSUc7SUFDSCxPQUFPLENBQUMsa0JBQWtCO0NBVzNCIn0=
@@ -1 +1 @@
1
- {"version":3,"file":"wallet_manager.d.ts","sourceRoot":"","sources":["../../src/manager/wallet_manager.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAyB,mBAAmB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAErH;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAGZ;IAEF,OAAO,eAAiB;IAExB;;;OAGG;IACH,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,mBAAmB,GAAG,aAAa,CAO3D;IAED;;;;;OAKG;IACG,mBAAmB,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CA+BpF;IAED;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;CAc3B"}
1
+ {"version":3,"file":"wallet_manager.d.ts","sourceRoot":"","sources":["../../src/manager/wallet_manager.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACV,sBAAsB,EACtB,gBAAgB,EAIhB,mBAAmB,EAEpB,MAAM,YAAY,CAAC;AAEpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAGZ;IAEF,OAAO,eAAiB;IAExB;;;OAGG;IACH,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,mBAAmB,GAAG,aAAa,CAO3D;IAED;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,OAAO,EAAE,sBAAsB,GAAG,gBAAgB,CA8GrE;IAED;;;;;;OAMG;IACH,OAAO,CAAC,kCAAkC;IA0E1C;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;CAW3B"}
@@ -1,6 +1,37 @@
1
- import { ExtensionProvider, ExtensionWallet } from '../providers/extension/index.js';
1
+ import { promiseWithResolvers } from '@aztec/foundation/promise';
2
+ import { ExtensionProvider, ExtensionWallet } from '../extension/provider/index.js';
3
+ import { discoverWebWallets } from '../iframe/provider/iframe_discovery.js';
4
+ import { WalletMessageType } from '../types.js';
2
5
  /**
3
- * Manager for wallet discovery, configuration, and connection
6
+ * Manager for wallet discovery, configuration, and connection.
7
+ *
8
+ * This is the main entry point for dApps to discover and connect to wallets.
9
+ *
10
+ * @example Basic usage with async iterator
11
+ * ```typescript
12
+ * const discovery = WalletManager.configure({ extensions: { enabled: true } })
13
+ * .getAvailableWallets({ chainInfo, appId: 'my-app' });
14
+ *
15
+ * // Iterate over discovered wallets
16
+ * for await (const provider of discovery.wallets) {
17
+ * console.log(`Found wallet: ${provider.name}`);
18
+ * }
19
+ *
20
+ * // Or cancel early when done
21
+ * discovery.cancel();
22
+ * ```
23
+ *
24
+ * @example With callback for discovered wallets
25
+ * ```typescript
26
+ * const discovery = manager.getAvailableWallets({
27
+ * chainInfo,
28
+ * appId: 'my-app',
29
+ * onWalletDiscovered: (provider) => console.log(`Found: ${provider.name}`),
30
+ * });
31
+ *
32
+ * // Wait for discovery to complete or cancel it
33
+ * await discovery.done;
34
+ * ```
4
35
  */ export class WalletManager {
5
36
  config = {
6
37
  extensions: {
@@ -28,50 +59,198 @@ import { ExtensionProvider, ExtensionWallet } from '../providers/extension/index
28
59
  }
29
60
  /**
30
61
  * Discovers all available wallets for a given chain and version.
31
- * Only returns wallets that support the requested chain and version.
32
- * @param options - Discovery options including chain info and timeout
33
- * @returns Array of wallet providers with baked-in chain info
34
- */ async getAvailableWallets(options) {
35
- const providers = [];
36
- const { chainInfo } = options;
37
- // Discover extension wallets
62
+ *
63
+ * Returns a `DiscoverySession` with:
64
+ * - `wallets`: AsyncIterable to iterate over discovered wallets
65
+ * - `done`: Promise that resolves when discovery completes or is cancelled
66
+ * - `cancel()`: Function to stop discovery immediately
67
+ *
68
+ * If `onWalletDiscovered` callback is provided, wallets are also streamed via callback.
69
+ *
70
+ * @param options - Discovery options including chain info, appId, and timeout
71
+ * @returns A cancellable discovery session
72
+ */ getAvailableWallets(options) {
73
+ const { chainInfo, appId } = options;
74
+ const abortController = new AbortController();
75
+ const pendingProviders = [];
76
+ let pendingResolve = null;
77
+ let completed = false;
78
+ const { promise: donePromise, resolve: resolveDone } = promiseWithResolvers();
79
+ const pendingSources = new Set();
80
+ const emit = (provider)=>{
81
+ options.onWalletDiscovered?.(provider);
82
+ if (pendingResolve) {
83
+ const resolve = pendingResolve;
84
+ pendingResolve = null;
85
+ resolve({
86
+ value: provider,
87
+ done: false
88
+ });
89
+ } else {
90
+ pendingProviders.push(provider);
91
+ }
92
+ };
93
+ const markComplete = ()=>{
94
+ completed = true;
95
+ resolveDone();
96
+ if (pendingResolve) {
97
+ const resolve = pendingResolve;
98
+ pendingResolve = null;
99
+ resolve({
100
+ value: undefined,
101
+ done: true
102
+ });
103
+ }
104
+ };
105
+ const sourceComplete = (source)=>{
106
+ pendingSources.delete(source);
107
+ if (pendingSources.size === 0) {
108
+ markComplete();
109
+ }
110
+ };
38
111
  if (this.config.extensions?.enabled) {
39
- const extensions = await ExtensionProvider.discoverExtensions(chainInfo, options.timeout);
112
+ pendingSources.add('extensions');
40
113
  const extensionConfig = this.config.extensions;
41
- for (const ext of extensions){
42
- // Apply allow/block lists
43
- if (!this.isExtensionAllowed(ext.id, extensionConfig)) {
44
- continue;
114
+ void ExtensionProvider.discoverWallets(chainInfo, {
115
+ appId,
116
+ timeout: options.timeout,
117
+ signal: abortController.signal,
118
+ onWalletDiscovered: (discoveredWallet)=>{
119
+ const provider = this.createProviderFromDiscoveredWallet(discoveredWallet, chainInfo, extensionConfig);
120
+ if (provider) {
121
+ emit(provider);
122
+ }
45
123
  }
46
- providers.push({
47
- id: ext.id,
48
- type: 'extension',
49
- name: ext.name,
50
- icon: ext.icon,
51
- metadata: {
52
- version: ext.version
53
- },
54
- connect: (appId)=>ExtensionWallet.create(ext, chainInfo, appId)
55
- });
124
+ }).then(()=>sourceComplete('extensions'));
125
+ }
126
+ if (this.config.webWallets?.urls && this.config.webWallets.urls.length > 0) {
127
+ pendingSources.add('webWallets');
128
+ const webSession = discoverWebWallets(this.config.webWallets.urls, chainInfo);
129
+ // Forward discovered web wallets into the shared iterator
130
+ void (async ()=>{
131
+ try {
132
+ for await (const provider of webSession.wallets){
133
+ if (abortController.signal.aborted) {
134
+ break;
135
+ }
136
+ emit(provider);
137
+ }
138
+ } finally{
139
+ sourceComplete('webWallets');
140
+ }
141
+ })();
142
+ abortController.signal.addEventListener('abort', ()=>webSession.cancel(), {
143
+ once: true
144
+ });
145
+ }
146
+ if (pendingSources.size === 0) {
147
+ markComplete();
148
+ }
149
+ const wallets = {
150
+ // eslint-disable-next-line jsdoc/require-jsdoc
151
+ [Symbol.asyncIterator] () {
152
+ return {
153
+ // eslint-disable-next-line jsdoc/require-jsdoc
154
+ next () {
155
+ if (pendingProviders.length > 0) {
156
+ return Promise.resolve({
157
+ value: pendingProviders.shift(),
158
+ done: false
159
+ });
160
+ }
161
+ if (completed) {
162
+ return Promise.resolve({
163
+ value: undefined,
164
+ done: true
165
+ });
166
+ }
167
+ return new Promise((resolve)=>{
168
+ pendingResolve = resolve;
169
+ });
170
+ }
171
+ };
56
172
  }
173
+ };
174
+ return {
175
+ wallets,
176
+ done: donePromise,
177
+ cancel: ()=>abortController.abort()
178
+ };
179
+ }
180
+ /**
181
+ * Creates a WalletProvider from a discovered wallet.
182
+ * Returns null if the wallet is not allowed by config.
183
+ * @param discoveredWallet - The discovered wallet from extension discovery.
184
+ * @param chainInfo - Network information.
185
+ * @param extensionConfig - Extension wallet configuration.
186
+ */ createProviderFromDiscoveredWallet(discoveredWallet, chainInfo, extensionConfig) {
187
+ const { info } = discoveredWallet;
188
+ if (!this.isExtensionAllowed(info.id, extensionConfig)) {
189
+ return null;
57
190
  }
58
- // TODO: Add web wallet discovery when implemented
59
- return providers;
191
+ let extensionWallet = null;
192
+ const provider = {
193
+ id: info.id,
194
+ type: 'extension',
195
+ name: info.name,
196
+ icon: info.icon,
197
+ metadata: {
198
+ version: info.version
199
+ },
200
+ establishSecureChannel: async (connectAppId)=>{
201
+ const connection = await discoveredWallet.establishSecureChannel();
202
+ provider.metadata = {
203
+ ...provider.metadata,
204
+ verificationHash: connection.info.verificationHash
205
+ };
206
+ return {
207
+ verificationHash: connection.info.verificationHash,
208
+ confirm: ()=>{
209
+ extensionWallet = ExtensionWallet.create(connection.info.id, connection.port, connection.sharedKey, chainInfo, connectAppId);
210
+ return Promise.resolve(extensionWallet.asWallet());
211
+ },
212
+ cancel: ()=>{
213
+ // Send disconnect to terminate the session on the extension side
214
+ // but keep the port open so we can retry key exchange
215
+ connection.port.postMessage({
216
+ type: WalletMessageType.DISCONNECT,
217
+ requestId: discoveredWallet.requestId
218
+ });
219
+ }
220
+ };
221
+ },
222
+ disconnect: async ()=>{
223
+ if (extensionWallet) {
224
+ await extensionWallet.disconnect();
225
+ extensionWallet = null;
226
+ }
227
+ },
228
+ onDisconnect: (callback)=>{
229
+ if (extensionWallet) {
230
+ return extensionWallet.onDisconnect(callback);
231
+ }
232
+ return ()=>{};
233
+ },
234
+ isDisconnected: ()=>{
235
+ if (extensionWallet) {
236
+ return extensionWallet.isDisconnected();
237
+ }
238
+ return true;
239
+ }
240
+ };
241
+ return provider;
60
242
  }
61
243
  /**
62
244
  * Checks if an extension is allowed based on allow/block lists
63
245
  * @param extensionId - The extension ID to check
64
246
  * @param config - Extension wallet configuration containing allow/block lists
65
247
  */ isExtensionAllowed(extensionId, config) {
66
- // Check block list first
67
248
  if (config.blockList && config.blockList.includes(extensionId)) {
68
249
  return false;
69
250
  }
70
- // If allow list exists, extension must be in it
71
251
  if (config.allowList && config.allowList.length > 0) {
72
252
  return config.allowList.includes(extensionId);
73
253
  }
74
- // If no allow list, extension is allowed (unless blocked)
75
254
  return true;
76
255
  }
77
256
  }