@aztec/wallet-sdk 0.0.1-commit.7d4e6cd → 0.0.1-commit.9372f48
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.
- package/README.md +218 -355
- package/dest/base-wallet/base_wallet.d.ts +33 -10
- package/dest/base-wallet/base_wallet.d.ts.map +1 -1
- package/dest/base-wallet/base_wallet.js +53 -16
- package/dest/crypto.d.ts +73 -27
- package/dest/crypto.d.ts.map +1 -1
- package/dest/crypto.js +219 -41
- package/dest/emoji_alphabet.d.ts +35 -0
- package/dest/emoji_alphabet.d.ts.map +1 -0
- package/dest/emoji_alphabet.js +299 -0
- package/dest/extension/handlers/background_connection_handler.d.ts +158 -0
- package/dest/extension/handlers/background_connection_handler.d.ts.map +1 -0
- package/dest/extension/handlers/background_connection_handler.js +258 -0
- package/dest/extension/handlers/content_script_connection_handler.d.ts +56 -0
- package/dest/extension/handlers/content_script_connection_handler.d.ts.map +1 -0
- package/dest/extension/handlers/content_script_connection_handler.js +174 -0
- package/dest/extension/handlers/index.d.ts +12 -0
- package/dest/extension/handlers/index.d.ts.map +1 -0
- package/dest/extension/handlers/index.js +10 -0
- package/dest/extension/handlers/internal_message_types.d.ts +63 -0
- package/dest/extension/handlers/internal_message_types.d.ts.map +1 -0
- package/dest/extension/handlers/internal_message_types.js +22 -0
- package/dest/extension/provider/extension_provider.d.ts +107 -0
- package/dest/extension/provider/extension_provider.d.ts.map +1 -0
- package/dest/extension/provider/extension_provider.js +160 -0
- package/dest/extension/provider/extension_wallet.d.ts +131 -0
- package/dest/extension/provider/extension_wallet.d.ts.map +1 -0
- package/dest/extension/provider/extension_wallet.js +271 -0
- package/dest/extension/provider/index.d.ts +3 -0
- package/dest/extension/provider/index.d.ts.map +1 -0
- package/dest/{providers/extension → extension/provider}/index.js +0 -1
- package/dest/manager/index.d.ts +2 -7
- package/dest/manager/index.d.ts.map +1 -1
- package/dest/manager/index.js +0 -4
- package/dest/manager/types.d.ts +108 -5
- package/dest/manager/types.d.ts.map +1 -1
- package/dest/manager/types.js +17 -1
- package/dest/manager/wallet_manager.d.ts +50 -7
- package/dest/manager/wallet_manager.d.ts.map +1 -1
- package/dest/manager/wallet_manager.js +178 -29
- package/dest/types.d.ts +55 -15
- package/dest/types.d.ts.map +1 -1
- package/dest/types.js +10 -2
- package/package.json +11 -10
- package/src/base-wallet/base_wallet.ts +74 -28
- package/src/crypto.ts +263 -47
- package/src/emoji_alphabet.ts +317 -0
- package/src/extension/handlers/background_connection_handler.ts +423 -0
- package/src/extension/handlers/content_script_connection_handler.ts +246 -0
- package/src/extension/handlers/index.ts +25 -0
- package/src/extension/handlers/internal_message_types.ts +69 -0
- package/src/extension/provider/extension_provider.ts +233 -0
- package/src/extension/provider/extension_wallet.ts +321 -0
- package/src/extension/provider/index.ts +7 -0
- package/src/manager/index.ts +3 -9
- package/src/manager/types.ts +112 -4
- package/src/manager/wallet_manager.ts +204 -31
- package/src/types.ts +57 -14
- package/dest/providers/extension/extension_provider.d.ts +0 -17
- package/dest/providers/extension/extension_provider.d.ts.map +0 -1
- package/dest/providers/extension/extension_provider.js +0 -56
- package/dest/providers/extension/extension_wallet.d.ts +0 -95
- package/dest/providers/extension/extension_wallet.d.ts.map +0 -1
- package/dest/providers/extension/extension_wallet.js +0 -225
- package/dest/providers/extension/index.d.ts +0 -5
- package/dest/providers/extension/index.d.ts.map +0 -1
- package/src/providers/extension/extension_provider.ts +0 -72
- package/src/providers/extension/extension_wallet.ts +0 -275
- package/src/providers/extension/index.ts +0 -11
|
@@ -1,6 +1,36 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { promiseWithResolvers } from '@aztec/foundation/promise';
|
|
2
|
+
import { ExtensionProvider, ExtensionWallet } from '../extension/provider/index.js';
|
|
3
|
+
import { WalletMessageType } from '../types.js';
|
|
2
4
|
/**
|
|
3
|
-
* Manager for wallet discovery, configuration, and connection
|
|
5
|
+
* Manager for wallet discovery, configuration, and connection.
|
|
6
|
+
*
|
|
7
|
+
* This is the main entry point for dApps to discover and connect to wallets.
|
|
8
|
+
*
|
|
9
|
+
* @example Basic usage with async iterator
|
|
10
|
+
* ```typescript
|
|
11
|
+
* const discovery = WalletManager.configure({ extensions: { enabled: true } })
|
|
12
|
+
* .getAvailableWallets({ chainInfo, appId: 'my-app' });
|
|
13
|
+
*
|
|
14
|
+
* // Iterate over discovered wallets
|
|
15
|
+
* for await (const provider of discovery.wallets) {
|
|
16
|
+
* console.log(`Found wallet: ${provider.name}`);
|
|
17
|
+
* }
|
|
18
|
+
*
|
|
19
|
+
* // Or cancel early when done
|
|
20
|
+
* discovery.cancel();
|
|
21
|
+
* ```
|
|
22
|
+
*
|
|
23
|
+
* @example With callback for discovered wallets
|
|
24
|
+
* ```typescript
|
|
25
|
+
* const discovery = manager.getAvailableWallets({
|
|
26
|
+
* chainInfo,
|
|
27
|
+
* appId: 'my-app',
|
|
28
|
+
* onWalletDiscovered: (provider) => console.log(`Found: ${provider.name}`),
|
|
29
|
+
* });
|
|
30
|
+
*
|
|
31
|
+
* // Wait for discovery to complete or cancel it
|
|
32
|
+
* await discovery.done;
|
|
33
|
+
* ```
|
|
4
34
|
*/ export class WalletManager {
|
|
5
35
|
config = {
|
|
6
36
|
extensions: {
|
|
@@ -28,50 +58,169 @@ import { ExtensionProvider, ExtensionWallet } from '../providers/extension/index
|
|
|
28
58
|
}
|
|
29
59
|
/**
|
|
30
60
|
* Discovers all available wallets for a given chain and version.
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
61
|
+
*
|
|
62
|
+
* Returns a `DiscoverySession` with:
|
|
63
|
+
* - `wallets`: AsyncIterable to iterate over discovered wallets
|
|
64
|
+
* - `done`: Promise that resolves when discovery completes or is cancelled
|
|
65
|
+
* - `cancel()`: Function to stop discovery immediately
|
|
66
|
+
*
|
|
67
|
+
* If `onWalletDiscovered` callback is provided, wallets are also streamed via callback.
|
|
68
|
+
*
|
|
69
|
+
* @param options - Discovery options including chain info, appId, and timeout
|
|
70
|
+
* @returns A cancellable discovery session
|
|
71
|
+
*/ getAvailableWallets(options) {
|
|
72
|
+
const { chainInfo, appId } = options;
|
|
73
|
+
const abortController = new AbortController();
|
|
74
|
+
const pendingProviders = [];
|
|
75
|
+
let pendingResolve = null;
|
|
76
|
+
let completed = false;
|
|
77
|
+
const { promise: donePromise, resolve: resolveDone } = promiseWithResolvers();
|
|
78
|
+
const markComplete = ()=>{
|
|
79
|
+
completed = true;
|
|
80
|
+
resolveDone();
|
|
81
|
+
if (pendingResolve) {
|
|
82
|
+
const resolve = pendingResolve;
|
|
83
|
+
pendingResolve = null;
|
|
84
|
+
resolve({
|
|
85
|
+
value: undefined,
|
|
86
|
+
done: true
|
|
87
|
+
});
|
|
88
|
+
}
|
|
89
|
+
};
|
|
38
90
|
if (this.config.extensions?.enabled) {
|
|
39
|
-
const extensions = await ExtensionProvider.discoverExtensions(chainInfo, options.timeout);
|
|
40
91
|
const extensionConfig = this.config.extensions;
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
92
|
+
void ExtensionProvider.discoverWallets(chainInfo, {
|
|
93
|
+
appId,
|
|
94
|
+
timeout: options.timeout,
|
|
95
|
+
signal: abortController.signal,
|
|
96
|
+
onWalletDiscovered: (discoveredWallet)=>{
|
|
97
|
+
const provider = this.createProviderFromDiscoveredWallet(discoveredWallet, chainInfo, extensionConfig);
|
|
98
|
+
if (!provider) {
|
|
99
|
+
return;
|
|
100
|
+
}
|
|
101
|
+
// Call user's callback if provided
|
|
102
|
+
options.onWalletDiscovered?.(provider);
|
|
103
|
+
// Also queue for async iterator
|
|
104
|
+
if (pendingResolve) {
|
|
105
|
+
const resolve = pendingResolve;
|
|
106
|
+
pendingResolve = null;
|
|
107
|
+
resolve({
|
|
108
|
+
value: provider,
|
|
109
|
+
done: false
|
|
110
|
+
});
|
|
111
|
+
} else {
|
|
112
|
+
pendingProviders.push(provider);
|
|
113
|
+
}
|
|
45
114
|
}
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
115
|
+
}).then(markComplete);
|
|
116
|
+
} else {
|
|
117
|
+
markComplete();
|
|
118
|
+
}
|
|
119
|
+
const wallets = {
|
|
120
|
+
// eslint-disable-next-line jsdoc/require-jsdoc
|
|
121
|
+
[Symbol.asyncIterator] () {
|
|
122
|
+
return {
|
|
123
|
+
// eslint-disable-next-line jsdoc/require-jsdoc
|
|
124
|
+
next () {
|
|
125
|
+
if (pendingProviders.length > 0) {
|
|
126
|
+
return Promise.resolve({
|
|
127
|
+
value: pendingProviders.shift(),
|
|
128
|
+
done: false
|
|
129
|
+
});
|
|
130
|
+
}
|
|
131
|
+
if (completed) {
|
|
132
|
+
return Promise.resolve({
|
|
133
|
+
value: undefined,
|
|
134
|
+
done: true
|
|
135
|
+
});
|
|
136
|
+
}
|
|
137
|
+
return new Promise((resolve)=>{
|
|
138
|
+
pendingResolve = resolve;
|
|
139
|
+
});
|
|
140
|
+
}
|
|
141
|
+
};
|
|
56
142
|
}
|
|
143
|
+
};
|
|
144
|
+
return {
|
|
145
|
+
wallets,
|
|
146
|
+
done: donePromise,
|
|
147
|
+
cancel: ()=>abortController.abort()
|
|
148
|
+
};
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* Creates a WalletProvider from a discovered wallet.
|
|
152
|
+
* Returns null if the wallet is not allowed by config.
|
|
153
|
+
* @param discoveredWallet - The discovered wallet from extension discovery.
|
|
154
|
+
* @param chainInfo - Network information.
|
|
155
|
+
* @param extensionConfig - Extension wallet configuration.
|
|
156
|
+
*/ createProviderFromDiscoveredWallet(discoveredWallet, chainInfo, extensionConfig) {
|
|
157
|
+
const { info } = discoveredWallet;
|
|
158
|
+
if (!this.isExtensionAllowed(info.id, extensionConfig)) {
|
|
159
|
+
return null;
|
|
57
160
|
}
|
|
58
|
-
|
|
59
|
-
|
|
161
|
+
let extensionWallet = null;
|
|
162
|
+
const provider = {
|
|
163
|
+
id: info.id,
|
|
164
|
+
type: 'extension',
|
|
165
|
+
name: info.name,
|
|
166
|
+
icon: info.icon,
|
|
167
|
+
metadata: {
|
|
168
|
+
version: info.version
|
|
169
|
+
},
|
|
170
|
+
establishSecureChannel: async (connectAppId)=>{
|
|
171
|
+
const connection = await discoveredWallet.establishSecureChannel();
|
|
172
|
+
provider.metadata = {
|
|
173
|
+
...provider.metadata,
|
|
174
|
+
verificationHash: connection.info.verificationHash
|
|
175
|
+
};
|
|
176
|
+
return {
|
|
177
|
+
verificationHash: connection.info.verificationHash,
|
|
178
|
+
confirm: ()=>{
|
|
179
|
+
return Promise.resolve(ExtensionWallet.create(connection.info.id, connection.port, connection.sharedKey, chainInfo, connectAppId));
|
|
180
|
+
},
|
|
181
|
+
cancel: ()=>{
|
|
182
|
+
// Send disconnect to terminate the session on the extension side
|
|
183
|
+
// but keep the port open so we can retry key exchange
|
|
184
|
+
connection.port.postMessage({
|
|
185
|
+
type: WalletMessageType.DISCONNECT,
|
|
186
|
+
requestId: discoveredWallet.requestId
|
|
187
|
+
});
|
|
188
|
+
// Don't close the port - allow retry with fresh key exchange
|
|
189
|
+
}
|
|
190
|
+
};
|
|
191
|
+
},
|
|
192
|
+
disconnect: async ()=>{
|
|
193
|
+
if (extensionWallet) {
|
|
194
|
+
await extensionWallet.disconnect();
|
|
195
|
+
extensionWallet = null;
|
|
196
|
+
}
|
|
197
|
+
},
|
|
198
|
+
onDisconnect: (callback)=>{
|
|
199
|
+
if (extensionWallet) {
|
|
200
|
+
return extensionWallet.onDisconnect(callback);
|
|
201
|
+
}
|
|
202
|
+
return ()=>{};
|
|
203
|
+
},
|
|
204
|
+
isDisconnected: ()=>{
|
|
205
|
+
if (extensionWallet) {
|
|
206
|
+
return extensionWallet.isDisconnected();
|
|
207
|
+
}
|
|
208
|
+
return true;
|
|
209
|
+
}
|
|
210
|
+
};
|
|
211
|
+
return provider;
|
|
60
212
|
}
|
|
61
213
|
/**
|
|
62
214
|
* Checks if an extension is allowed based on allow/block lists
|
|
63
215
|
* @param extensionId - The extension ID to check
|
|
64
216
|
* @param config - Extension wallet configuration containing allow/block lists
|
|
65
217
|
*/ isExtensionAllowed(extensionId, config) {
|
|
66
|
-
// Check block list first
|
|
67
218
|
if (config.blockList && config.blockList.includes(extensionId)) {
|
|
68
219
|
return false;
|
|
69
220
|
}
|
|
70
|
-
// If allow list exists, extension must be in it
|
|
71
221
|
if (config.allowList && config.allowList.length > 0) {
|
|
72
222
|
return config.allowList.includes(extensionId);
|
|
73
223
|
}
|
|
74
|
-
// If no allow list, extension is allowed (unless blocked)
|
|
75
224
|
return true;
|
|
76
225
|
}
|
|
77
226
|
}
|
package/dest/types.d.ts
CHANGED
|
@@ -1,7 +1,24 @@
|
|
|
1
1
|
import type { ChainInfo } from '@aztec/aztec.js/account';
|
|
2
2
|
import type { ExportedPublicKey } from './crypto.js';
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* Message types for wallet SDK communication.
|
|
5
|
+
* All types are prefixed with 'aztec-wallet-' for namespacing.
|
|
6
|
+
*/
|
|
7
|
+
export declare enum WalletMessageType {
|
|
8
|
+
/** Discovery request to find installed wallets */
|
|
9
|
+
DISCOVERY = "aztec-wallet-discovery",
|
|
10
|
+
/** Discovery response from a wallet */
|
|
11
|
+
DISCOVERY_RESPONSE = "aztec-wallet-discovery-response",
|
|
12
|
+
/** Disconnect message (unencrypted control message, bidirectional) */
|
|
13
|
+
DISCONNECT = "aztec-wallet-disconnect",
|
|
14
|
+
/** Key exchange request sent over MessageChannel */
|
|
15
|
+
KEY_EXCHANGE_REQUEST = "aztec-wallet-key-exchange-request",
|
|
16
|
+
/** Key exchange response sent over MessageChannel */
|
|
17
|
+
KEY_EXCHANGE_RESPONSE = "aztec-wallet-key-exchange-response"
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Information about an installed Aztec wallet.
|
|
21
|
+
* Used during discovery phase before key exchange.
|
|
5
22
|
*/
|
|
6
23
|
export interface WalletInfo {
|
|
7
24
|
/** Unique identifier for the wallet */
|
|
@@ -12,8 +29,20 @@ export interface WalletInfo {
|
|
|
12
29
|
icon?: string;
|
|
13
30
|
/** Wallet version */
|
|
14
31
|
version: string;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Full information about a connected Aztec wallet including crypto material.
|
|
35
|
+
* Available after key exchange completes.
|
|
36
|
+
*/
|
|
37
|
+
export interface ConnectedWalletInfo extends WalletInfo {
|
|
15
38
|
/** Wallet's ECDH public key for secure channel establishment */
|
|
16
39
|
publicKey: ExportedPublicKey;
|
|
40
|
+
/**
|
|
41
|
+
* Verification hash for verification.
|
|
42
|
+
* Both dApp and wallet independently compute this from the ECDH shared secret.
|
|
43
|
+
* Use {@link hashToEmoji} to convert to a visual representation for user verification.
|
|
44
|
+
*/
|
|
45
|
+
verificationHash?: string;
|
|
17
46
|
}
|
|
18
47
|
/**
|
|
19
48
|
* Message format for wallet communication (internal, before encryption)
|
|
@@ -46,38 +75,49 @@ export interface WalletResponse {
|
|
|
46
75
|
walletId: string;
|
|
47
76
|
}
|
|
48
77
|
/**
|
|
49
|
-
* Discovery message for finding installed wallets (public, unencrypted)
|
|
78
|
+
* Discovery message for finding installed wallets (public, unencrypted).
|
|
50
79
|
*/
|
|
51
80
|
export interface DiscoveryRequest {
|
|
52
81
|
/** Message type for discovery */
|
|
53
|
-
type:
|
|
82
|
+
type: WalletMessageType.DISCOVERY;
|
|
54
83
|
/** Request ID */
|
|
55
84
|
requestId: string;
|
|
85
|
+
/** Application ID making the request */
|
|
86
|
+
appId: string;
|
|
56
87
|
/** Chain information to check if wallet supports this network */
|
|
57
88
|
chainInfo: ChainInfo;
|
|
58
89
|
}
|
|
59
90
|
/**
|
|
60
|
-
* Discovery response from a wallet (public, unencrypted)
|
|
91
|
+
* Discovery response from a wallet (public, unencrypted).
|
|
61
92
|
*/
|
|
62
93
|
export interface DiscoveryResponse {
|
|
63
94
|
/** Message type for discovery response */
|
|
64
|
-
type:
|
|
95
|
+
type: WalletMessageType.DISCOVERY_RESPONSE;
|
|
65
96
|
/** Request ID matching the discovery request */
|
|
66
97
|
requestId: string;
|
|
67
|
-
/**
|
|
98
|
+
/** Basic wallet information */
|
|
68
99
|
walletInfo: WalletInfo;
|
|
69
100
|
}
|
|
70
101
|
/**
|
|
71
|
-
*
|
|
102
|
+
* Key exchange request sent over MessageChannel after discovery approval.
|
|
72
103
|
*/
|
|
73
|
-
export interface
|
|
74
|
-
/** Message type
|
|
75
|
-
type:
|
|
76
|
-
/**
|
|
77
|
-
|
|
78
|
-
/** Application ID */
|
|
79
|
-
appId: string;
|
|
104
|
+
export interface KeyExchangeRequest {
|
|
105
|
+
/** Message type */
|
|
106
|
+
type: WalletMessageType.KEY_EXCHANGE_REQUEST;
|
|
107
|
+
/** Request ID matching the discovery request */
|
|
108
|
+
requestId: string;
|
|
80
109
|
/** dApp's ECDH public key for deriving shared secret */
|
|
81
110
|
publicKey: ExportedPublicKey;
|
|
82
111
|
}
|
|
83
|
-
|
|
112
|
+
/**
|
|
113
|
+
* Key exchange response sent over MessageChannel.
|
|
114
|
+
*/
|
|
115
|
+
export interface KeyExchangeResponse {
|
|
116
|
+
/** Message type */
|
|
117
|
+
type: WalletMessageType.KEY_EXCHANGE_RESPONSE;
|
|
118
|
+
/** Request ID matching the discovery request */
|
|
119
|
+
requestId: string;
|
|
120
|
+
/** Wallet's ECDH public key for deriving shared secret */
|
|
121
|
+
publicKey: ExportedPublicKey;
|
|
122
|
+
}
|
|
123
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy90eXBlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssRUFBRSxTQUFTLEVBQUUsTUFBTSx5QkFBeUIsQ0FBQztBQUV6RCxPQUFPLEtBQUssRUFBRSxpQkFBaUIsRUFBRSxNQUFNLGFBQWEsQ0FBQztBQUVyRDs7O0dBR0c7QUFDSCxvQkFBWSxpQkFBaUI7SUFDM0Isa0RBQWtEO0lBQ2xELFNBQVMsMkJBQTJCO0lBQ3BDLHVDQUF1QztJQUN2QyxrQkFBa0Isb0NBQW9DO0lBQ3RELHNFQUFzRTtJQUN0RSxVQUFVLDRCQUE0QjtJQUN0QyxvREFBb0Q7SUFDcEQsb0JBQW9CLHNDQUFzQztJQUMxRCxxREFBcUQ7SUFDckQscUJBQXFCLHVDQUF1QztDQUM3RDtBQUVEOzs7R0FHRztBQUNILE1BQU0sV0FBVyxVQUFVO0lBQ3pCLHVDQUF1QztJQUN2QyxFQUFFLEVBQUUsTUFBTSxDQUFDO0lBQ1gsaUNBQWlDO0lBQ2pDLElBQUksRUFBRSxNQUFNLENBQUM7SUFDYiwrQkFBK0I7SUFDL0IsSUFBSSxDQUFDLEVBQUUsTUFBTSxDQUFDO0lBQ2QscUJBQXFCO0lBQ3JCLE9BQU8sRUFBRSxNQUFNLENBQUM7Q0FDakI7QUFFRDs7O0dBR0c7QUFDSCxNQUFNLFdBQVcsbUJBQW9CLFNBQVEsVUFBVTtJQUNyRCxnRUFBZ0U7SUFDaEUsU0FBUyxFQUFFLGlCQUFpQixDQUFDO0lBQzdCOzs7O09BSUc7SUFDSCxnQkFBZ0IsQ0FBQyxFQUFFLE1BQU0sQ0FBQztDQUMzQjtBQUVEOztHQUVHO0FBQ0gsTUFBTSxXQUFXLGFBQWE7SUFDNUIsK0NBQStDO0lBQy9DLFNBQVMsRUFBRSxNQUFNLENBQUM7SUFDbEIsZ0NBQWdDO0lBQ2hDLElBQUksRUFBRSxNQUFNLENBQUM7SUFDYiwrQkFBK0I7SUFDL0IsSUFBSSxFQUFFLE9BQU8sRUFBRSxDQUFDO0lBQ2hCLHdCQUF3QjtJQUN4QixTQUFTLEVBQUUsU0FBUyxDQUFDO0lBQ3JCLHdDQUF3QztJQUN4QyxLQUFLLEVBQUUsTUFBTSxDQUFDO0lBQ2QsNENBQTRDO0lBQzVDLFFBQVEsRUFBRSxNQUFNLENBQUM7Q0FDbEI7QUFFRDs7R0FFRztBQUNILE1BQU0sV0FBVyxjQUFjO0lBQzdCLHNDQUFzQztJQUN0QyxTQUFTLEVBQUUsTUFBTSxDQUFDO0lBQ2xCLGtDQUFrQztJQUNsQyxNQUFNLENBQUMsRUFBRSxPQUFPLENBQUM7SUFDakIsNkJBQTZCO0lBQzdCLEtBQUssQ0FBQyxFQUFFLE9BQU8sQ0FBQztJQUNoQix1Q0FBdUM7SUFDdkMsUUFBUSxFQUFFLE1BQU0sQ0FBQztDQUNsQjtBQUVEOztHQUVHO0FBQ0gsTUFBTSxXQUFXLGdCQUFnQjtJQUMvQixpQ0FBaUM7SUFDakMsSUFBSSxFQUFFLGlCQUFpQixDQUFDLFNBQVMsQ0FBQztJQUNsQyxpQkFBaUI7SUFDakIsU0FBUyxFQUFFLE1BQU0sQ0FBQztJQUNsQix3Q0FBd0M7SUFDeEMsS0FBSyxFQUFFLE1BQU0sQ0FBQztJQUNkLGlFQUFpRTtJQUNqRSxTQUFTLEVBQUUsU0FBUyxDQUFDO0NBQ3RCO0FBRUQ7O0dBRUc7QUFDSCxNQUFNLFdBQVcsaUJBQWlCO0lBQ2hDLDBDQUEwQztJQUMxQyxJQUFJLEVBQUUsaUJBQWlCLENBQUMsa0JBQWtCLENBQUM7SUFDM0MsZ0RBQWdEO0lBQ2hELFNBQVMsRUFBRSxNQUFNLENBQUM7SUFDbEIsK0JBQStCO0lBQy9CLFVBQVUsRUFBRSxVQUFVLENBQUM7Q0FDeEI7QUFFRDs7R0FFRztBQUNILE1BQU0sV0FBVyxrQkFBa0I7SUFDakMsbUJBQW1CO0lBQ25CLElBQUksRUFBRSxpQkFBaUIsQ0FBQyxvQkFBb0IsQ0FBQztJQUM3QyxnREFBZ0Q7SUFDaEQsU0FBUyxFQUFFLE1BQU0sQ0FBQztJQUNsQix3REFBd0Q7SUFDeEQsU0FBUyxFQUFFLGlCQUFpQixDQUFDO0NBQzlCO0FBRUQ7O0dBRUc7QUFDSCxNQUFNLFdBQVcsbUJBQW1CO0lBQ2xDLG1CQUFtQjtJQUNuQixJQUFJLEVBQUUsaUJBQWlCLENBQUMscUJBQXFCLENBQUM7SUFDOUMsZ0RBQWdEO0lBQ2hELFNBQVMsRUFBRSxNQUFNLENBQUM7SUFDbEIsMERBQTBEO0lBQzFELFNBQVMsRUFBRSxpQkFBaUIsQ0FBQztDQUM5QiJ9
|
package/dest/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAErD
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAErD;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,kDAAkD;IAClD,SAAS,2BAA2B;IACpC,uCAAuC;IACvC,kBAAkB,oCAAoC;IACtD,sEAAsE;IACtE,UAAU,4BAA4B;IACtC,oDAAoD;IACpD,oBAAoB,sCAAsC;IAC1D,qDAAqD;IACrD,qBAAqB,uCAAuC;CAC7D;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,uCAAuC;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,+BAA+B;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qBAAqB;IACrB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD,gEAAgE;IAChE,SAAS,EAAE,iBAAiB,CAAC;IAC7B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,+CAA+C;IAC/C,SAAS,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,+BAA+B;IAC/B,IAAI,EAAE,OAAO,EAAE,CAAC;IAChB,wBAAwB;IACxB,SAAS,EAAE,SAAS,CAAC;IACrB,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,kCAAkC;IAClC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,6BAA6B;IAC7B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,iCAAiC;IACjC,IAAI,EAAE,iBAAiB,CAAC,SAAS,CAAC;IAClC,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,iEAAiE;IACjE,SAAS,EAAE,SAAS,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,0CAA0C;IAC1C,IAAI,EAAE,iBAAiB,CAAC,kBAAkB,CAAC;IAC3C,gDAAgD;IAChD,SAAS,EAAE,MAAM,CAAC;IAClB,+BAA+B;IAC/B,UAAU,EAAE,UAAU,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,mBAAmB;IACnB,IAAI,EAAE,iBAAiB,CAAC,oBAAoB,CAAC;IAC7C,gDAAgD;IAChD,SAAS,EAAE,MAAM,CAAC;IAClB,wDAAwD;IACxD,SAAS,EAAE,iBAAiB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,mBAAmB;IACnB,IAAI,EAAE,iBAAiB,CAAC,qBAAqB,CAAC;IAC9C,gDAAgD;IAChD,SAAS,EAAE,MAAM,CAAC;IAClB,0DAA0D;IAC1D,SAAS,EAAE,iBAAiB,CAAC;CAC9B"}
|
package/dest/types.js
CHANGED
|
@@ -1,3 +1,11 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
|
|
2
|
+
* Message types for wallet SDK communication.
|
|
3
|
+
* All types are prefixed with 'aztec-wallet-' for namespacing.
|
|
4
|
+
*/ export var WalletMessageType = /*#__PURE__*/ function(WalletMessageType) {
|
|
5
|
+
/** Discovery request to find installed wallets */ WalletMessageType["DISCOVERY"] = "aztec-wallet-discovery";
|
|
6
|
+
/** Discovery response from a wallet */ WalletMessageType["DISCOVERY_RESPONSE"] = "aztec-wallet-discovery-response";
|
|
7
|
+
/** Disconnect message (unencrypted control message, bidirectional) */ WalletMessageType["DISCONNECT"] = "aztec-wallet-disconnect";
|
|
8
|
+
/** Key exchange request sent over MessageChannel */ WalletMessageType["KEY_EXCHANGE_REQUEST"] = "aztec-wallet-key-exchange-request";
|
|
9
|
+
/** Key exchange response sent over MessageChannel */ WalletMessageType["KEY_EXCHANGE_RESPONSE"] = "aztec-wallet-key-exchange-response";
|
|
10
|
+
return WalletMessageType;
|
|
11
|
+
}({});
|
package/package.json
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aztec/wallet-sdk",
|
|
3
3
|
"homepage": "https://github.com/AztecProtocol/aztec-packages/tree/master/yarn-project/wallet-sdk",
|
|
4
|
-
"version": "0.0.1-commit.
|
|
4
|
+
"version": "0.0.1-commit.9372f48",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"exports": {
|
|
7
7
|
"./base-wallet": "./dest/base-wallet/index.js",
|
|
8
|
-
"./
|
|
8
|
+
"./extension/handlers": "./dest/extension/handlers/index.js",
|
|
9
|
+
"./extension/provider": "./dest/extension/provider/index.js",
|
|
9
10
|
"./crypto": "./dest/crypto.js",
|
|
10
11
|
"./types": "./dest/types.js",
|
|
11
12
|
"./manager": "./dest/manager/index.js"
|
|
@@ -64,19 +65,19 @@
|
|
|
64
65
|
]
|
|
65
66
|
},
|
|
66
67
|
"dependencies": {
|
|
67
|
-
"@aztec/aztec.js": "0.0.1-commit.
|
|
68
|
-
"@aztec/constants": "0.0.1-commit.
|
|
69
|
-
"@aztec/entrypoints": "0.0.1-commit.
|
|
70
|
-
"@aztec/foundation": "0.0.1-commit.
|
|
71
|
-
"@aztec/pxe": "0.0.1-commit.
|
|
72
|
-
"@aztec/stdlib": "0.0.1-commit.
|
|
68
|
+
"@aztec/aztec.js": "0.0.1-commit.9372f48",
|
|
69
|
+
"@aztec/constants": "0.0.1-commit.9372f48",
|
|
70
|
+
"@aztec/entrypoints": "0.0.1-commit.9372f48",
|
|
71
|
+
"@aztec/foundation": "0.0.1-commit.9372f48",
|
|
72
|
+
"@aztec/pxe": "0.0.1-commit.9372f48",
|
|
73
|
+
"@aztec/stdlib": "0.0.1-commit.9372f48"
|
|
73
74
|
},
|
|
74
75
|
"devDependencies": {
|
|
75
|
-
"@aztec/noir-contracts.js": "0.0.1-commit.
|
|
76
|
+
"@aztec/noir-contracts.js": "0.0.1-commit.9372f48",
|
|
76
77
|
"@jest/globals": "^30.0.0",
|
|
77
78
|
"@types/jest": "^30.0.0",
|
|
78
79
|
"@types/node": "^22.15.17",
|
|
79
|
-
"@typescript/native-preview": "7.0.0-dev.
|
|
80
|
+
"@typescript/native-preview": "7.0.0-dev.20260113.1",
|
|
80
81
|
"jest": "^30.0.0",
|
|
81
82
|
"jest-mock-extended": "^4.0.0",
|
|
82
83
|
"resolve-typescript-plugin": "^2.0.1",
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import type { Account } from '@aztec/aztec.js/account';
|
|
2
2
|
import type { CallIntent, IntentInnerHash } from '@aztec/aztec.js/authorization';
|
|
3
|
+
import { type InteractionWaitOptions, NO_WAIT, type SendReturn } from '@aztec/aztec.js/contracts';
|
|
3
4
|
import type { FeePaymentMethod } from '@aztec/aztec.js/fee';
|
|
5
|
+
import { waitForTx } from '@aztec/aztec.js/node';
|
|
4
6
|
import type {
|
|
5
7
|
Aliased,
|
|
8
|
+
AppCapabilities,
|
|
6
9
|
BatchResults,
|
|
7
|
-
BatchableMethods,
|
|
8
10
|
BatchedMethod,
|
|
9
11
|
PrivateEvent,
|
|
10
12
|
PrivateEventFilter,
|
|
@@ -12,6 +14,7 @@ import type {
|
|
|
12
14
|
SendOptions,
|
|
13
15
|
SimulateOptions,
|
|
14
16
|
Wallet,
|
|
17
|
+
WalletCapabilities,
|
|
15
18
|
} from '@aztec/aztec.js/wallet';
|
|
16
19
|
import {
|
|
17
20
|
GAS_ESTIMATION_DA_GAS_LIMIT,
|
|
@@ -34,20 +37,17 @@ import {
|
|
|
34
37
|
import type { AuthWitness } from '@aztec/stdlib/auth-witness';
|
|
35
38
|
import type { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
36
39
|
import {
|
|
37
|
-
type ContractClassMetadata,
|
|
38
40
|
type ContractInstanceWithAddress,
|
|
39
|
-
type ContractMetadata,
|
|
40
41
|
computePartialAddress,
|
|
41
42
|
getContractClassFromArtifact,
|
|
42
43
|
} from '@aztec/stdlib/contract';
|
|
43
44
|
import { SimulationError } from '@aztec/stdlib/errors';
|
|
44
45
|
import { Gas, GasSettings } from '@aztec/stdlib/gas';
|
|
46
|
+
import { siloNullifier } from '@aztec/stdlib/hash';
|
|
45
47
|
import type { AztecNode } from '@aztec/stdlib/interfaces/client';
|
|
46
48
|
import type {
|
|
47
49
|
TxExecutionRequest,
|
|
48
|
-
TxHash,
|
|
49
50
|
TxProfileResult,
|
|
50
|
-
TxReceipt,
|
|
51
51
|
TxSimulationResult,
|
|
52
52
|
UtilitySimulationResult,
|
|
53
53
|
} from '@aztec/stdlib/tx';
|
|
@@ -121,20 +121,42 @@ export abstract class BaseWallet implements Wallet {
|
|
|
121
121
|
? mergeExecutionPayloads([feeExecutionPayload, executionPayload])
|
|
122
122
|
: executionPayload;
|
|
123
123
|
const fromAccount = await this.getAccountFromAddress(from);
|
|
124
|
-
|
|
124
|
+
const chainInfo = await this.getChainInfo();
|
|
125
|
+
return fromAccount.createTxExecutionRequest(
|
|
126
|
+
finalExecutionPayload,
|
|
127
|
+
feeOptions.gasSettings,
|
|
128
|
+
chainInfo,
|
|
129
|
+
executionOptions,
|
|
130
|
+
);
|
|
125
131
|
}
|
|
126
132
|
|
|
127
133
|
public async createAuthWit(
|
|
128
134
|
from: AztecAddress,
|
|
129
|
-
messageHashOrIntent:
|
|
135
|
+
messageHashOrIntent: IntentInnerHash | CallIntent,
|
|
130
136
|
): Promise<AuthWitness> {
|
|
131
137
|
const account = await this.getAccountFromAddress(from);
|
|
132
|
-
|
|
138
|
+
const chainInfo = await this.getChainInfo();
|
|
139
|
+
return account.createAuthWit(messageHashOrIntent, chainInfo);
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
/**
|
|
143
|
+
* Request capabilities from the wallet.
|
|
144
|
+
*
|
|
145
|
+
* This method is wallet-implementation-dependent and must be provided by classes extending BaseWallet.
|
|
146
|
+
* Embedded wallets typically don't support capability-based authorization (no user authorization flow),
|
|
147
|
+
* while external wallets (browser extensions, hardware wallets) implement this to reduce authorization
|
|
148
|
+
* friction by allowing apps to request permissions upfront.
|
|
149
|
+
*
|
|
150
|
+
* TODO: Consider making it abstract so implementing it is a conscious decision. Leaving it as-is
|
|
151
|
+
* while the feature stabilizes.
|
|
152
|
+
*
|
|
153
|
+
* @param _manifest - Application capability manifest declaring what operations the app needs
|
|
154
|
+
*/
|
|
155
|
+
public requestCapabilities(_manifest: AppCapabilities): Promise<WalletCapabilities> {
|
|
156
|
+
throw new Error('Not implemented');
|
|
133
157
|
}
|
|
134
158
|
|
|
135
|
-
public async batch<const T extends readonly BatchedMethod
|
|
136
|
-
methods: T,
|
|
137
|
-
): Promise<BatchResults<T>> {
|
|
159
|
+
public async batch<const T extends readonly BatchedMethod[]>(methods: T): Promise<BatchResults<T>> {
|
|
138
160
|
const results: any[] = [];
|
|
139
161
|
for (const method of methods) {
|
|
140
162
|
const { name, args } = method;
|
|
@@ -227,7 +249,7 @@ export abstract class BaseWallet implements Wallet {
|
|
|
227
249
|
artifact?: ContractArtifact,
|
|
228
250
|
secretKey?: Fr,
|
|
229
251
|
): Promise<ContractInstanceWithAddress> {
|
|
230
|
-
const
|
|
252
|
+
const existingInstance = await this.pxe.getContractInstance(instance.address);
|
|
231
253
|
|
|
232
254
|
if (existingInstance) {
|
|
233
255
|
// Instance already registered in the wallet
|
|
@@ -244,13 +266,12 @@ export abstract class BaseWallet implements Wallet {
|
|
|
244
266
|
// Instance not registered yet
|
|
245
267
|
if (!artifact) {
|
|
246
268
|
// Try to get the artifact from the wallet's contract class storage
|
|
247
|
-
|
|
248
|
-
if (!
|
|
269
|
+
artifact = await this.pxe.getContractArtifact(instance.currentContractClassId);
|
|
270
|
+
if (!artifact) {
|
|
249
271
|
throw new Error(
|
|
250
272
|
`Cannot register contract at ${instance.address.toString()}: artifact is required but not provided, and wallet does not have the artifact for contract class ${instance.currentContractClassId.toString()}`,
|
|
251
273
|
);
|
|
252
274
|
}
|
|
253
|
-
artifact = classMetadata.artifact;
|
|
254
275
|
}
|
|
255
276
|
await this.pxe.registerContract({ artifact, instance });
|
|
256
277
|
}
|
|
@@ -280,7 +301,10 @@ export abstract class BaseWallet implements Wallet {
|
|
|
280
301
|
return this.pxe.profileTx(txRequest, opts.profileMode, opts.skipProofGeneration ?? true);
|
|
281
302
|
}
|
|
282
303
|
|
|
283
|
-
async sendTx
|
|
304
|
+
public async sendTx<W extends InteractionWaitOptions = undefined>(
|
|
305
|
+
executionPayload: ExecutionPayload,
|
|
306
|
+
opts: SendOptions<W>,
|
|
307
|
+
): Promise<SendReturn<W>> {
|
|
284
308
|
const feeOptions = await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
|
|
285
309
|
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
|
|
286
310
|
const provenTx = await this.pxe.proveTx(txRequest);
|
|
@@ -294,7 +318,15 @@ export abstract class BaseWallet implements Wallet {
|
|
|
294
318
|
throw this.contextualizeError(err, inspect(tx));
|
|
295
319
|
});
|
|
296
320
|
this.log.info(`Sent transaction ${txHash}`);
|
|
297
|
-
|
|
321
|
+
|
|
322
|
+
// If wait is NO_WAIT, return txHash immediately
|
|
323
|
+
if (opts.wait === NO_WAIT) {
|
|
324
|
+
return txHash as SendReturn<W>;
|
|
325
|
+
}
|
|
326
|
+
|
|
327
|
+
// Otherwise, wait for the full receipt (default behavior on wait: undefined)
|
|
328
|
+
const waitOpts = typeof opts.wait === 'object' ? opts.wait : undefined;
|
|
329
|
+
return (await waitForTx(this.aztecNode, txHash, waitOpts)) as SendReturn<W>;
|
|
298
330
|
}
|
|
299
331
|
|
|
300
332
|
protected contextualizeError(err: Error, ...context: string[]): Error {
|
|
@@ -315,17 +347,6 @@ export abstract class BaseWallet implements Wallet {
|
|
|
315
347
|
return this.pxe.simulateUtility(call, authwits);
|
|
316
348
|
}
|
|
317
349
|
|
|
318
|
-
getContractClassMetadata(id: Fr, includeArtifact: boolean = false): Promise<ContractClassMetadata> {
|
|
319
|
-
return this.pxe.getContractClassMetadata(id, includeArtifact);
|
|
320
|
-
}
|
|
321
|
-
getContractMetadata(address: AztecAddress): Promise<ContractMetadata> {
|
|
322
|
-
return this.pxe.getContractMetadata(address);
|
|
323
|
-
}
|
|
324
|
-
|
|
325
|
-
getTxReceipt(txHash: TxHash): Promise<TxReceipt> {
|
|
326
|
-
return this.aztecNode.getTxReceipt(txHash);
|
|
327
|
-
}
|
|
328
|
-
|
|
329
350
|
async getPrivateEvents<T>(
|
|
330
351
|
eventDef: EventMetadataDefinition,
|
|
331
352
|
eventFilter: PrivateEventFilter,
|
|
@@ -345,4 +366,29 @@ export abstract class BaseWallet implements Wallet {
|
|
|
345
366
|
|
|
346
367
|
return decodedEvents;
|
|
347
368
|
}
|
|
369
|
+
|
|
370
|
+
async getContractMetadata(address: AztecAddress) {
|
|
371
|
+
const instance = await this.pxe.getContractInstance(address);
|
|
372
|
+
const initNullifier = await siloNullifier(address, address.toField());
|
|
373
|
+
const publiclyRegisteredContract = await this.aztecNode.getContract(address);
|
|
374
|
+
const initNullifierMembershipWitness = await this.aztecNode.getNullifierMembershipWitness('latest', initNullifier);
|
|
375
|
+
const isContractUpdated =
|
|
376
|
+
publiclyRegisteredContract &&
|
|
377
|
+
!publiclyRegisteredContract.currentContractClassId.equals(publiclyRegisteredContract.originalContractClassId);
|
|
378
|
+
return {
|
|
379
|
+
instance: instance ?? undefined,
|
|
380
|
+
isContractInitialized: !!initNullifierMembershipWitness,
|
|
381
|
+
isContractPublished: !!publiclyRegisteredContract,
|
|
382
|
+
isContractUpdated: !!isContractUpdated,
|
|
383
|
+
updatedContractClassId: isContractUpdated ? publiclyRegisteredContract.currentContractClassId : undefined,
|
|
384
|
+
};
|
|
385
|
+
}
|
|
386
|
+
|
|
387
|
+
async getContractClassMetadata(id: Fr) {
|
|
388
|
+
const publiclyRegisteredContractClass = await this.aztecNode.getContractClass(id);
|
|
389
|
+
return {
|
|
390
|
+
isArtifactRegistered: !!(await this.pxe.getContractArtifact(id)),
|
|
391
|
+
isContractClassPubliclyRegistered: !!publiclyRegisteredContractClass,
|
|
392
|
+
};
|
|
393
|
+
}
|
|
348
394
|
}
|