@privy-io/js-sdk-core 0.30.4 → 0.32.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. package/dist/cjs/index.js +1 -1
  2. package/dist/dts/EmailApi.d.mts +4 -0
  3. package/dist/dts/EmailApi.d.ts +4 -0
  4. package/dist/dts/EmbeddedWalletApi.d.mts +283 -6
  5. package/dist/dts/EmbeddedWalletApi.d.ts +283 -6
  6. package/dist/dts/FarcasterApi.d.mts +4 -0
  7. package/dist/dts/FarcasterApi.d.ts +4 -0
  8. package/dist/dts/OAuthApi.d.mts +4 -0
  9. package/dist/dts/OAuthApi.d.ts +4 -0
  10. package/dist/dts/PhoneApi.d.mts +4 -0
  11. package/dist/dts/PhoneApi.d.ts +4 -0
  12. package/dist/dts/UserApi.d.mts +2 -0
  13. package/dist/dts/UserApi.d.ts +2 -0
  14. package/dist/dts/embedded/EmbeddedBitcoinWalletProvider.d.mts +39 -0
  15. package/dist/dts/embedded/EmbeddedBitcoinWalletProvider.d.ts +39 -0
  16. package/dist/dts/embedded/types.d.mts +74 -5
  17. package/dist/dts/embedded/types.d.ts +74 -5
  18. package/dist/dts/index.d.mts +2 -0
  19. package/dist/dts/index.d.ts +2 -0
  20. package/dist/dts/types.d.mts +1 -1
  21. package/dist/dts/types.d.ts +1 -1
  22. package/dist/dts/utils/getAllUserEmbeddedBitcoinWallets.d.mts +12 -0
  23. package/dist/dts/utils/getAllUserEmbeddedBitcoinWallets.d.ts +12 -0
  24. package/dist/esm/EmbeddedWalletApi.mjs +1 -1
  25. package/dist/esm/Privy.mjs +1 -1
  26. package/dist/esm/PrivyInternal.mjs +1 -1
  27. package/dist/esm/embedded/EmbeddedBitcoinWalletProvider.mjs +1 -0
  28. package/dist/esm/embedded/methods.mjs +1 -1
  29. package/dist/esm/index.mjs +1 -1
  30. package/dist/esm/utils/getAllUserEmbeddedBitcoinWallets.mjs +1 -0
  31. package/package.json +2 -3
package/dist/dts/EmailApi.d.mts CHANGED
@@ -143,6 +143,7 @@ export default class EmailApi {
143
143
  } | {
144
144
  type: "wallet";
145
145
  address: string;
146
+ public_key: string;
146
147
  chain_id: string;
147
148
  verified_at: number;
148
149
  first_verified_at: number | null;
@@ -158,6 +159,7 @@ export default class EmailApi {
158
159
  } | {
159
160
  type: "wallet";
160
161
  address: string;
162
+ public_key: string;
161
163
  chain_id: string;
162
164
  verified_at: number;
163
165
  first_verified_at: number | null;
@@ -391,6 +393,7 @@ export default class EmailApi {
391
393
  } | {
392
394
  type: "wallet";
393
395
  address: string;
396
+ public_key: string;
394
397
  chain_id: string;
395
398
  verified_at: number;
396
399
  first_verified_at: number | null;
@@ -406,6 +409,7 @@ export default class EmailApi {
406
409
  } | {
407
410
  type: "wallet";
408
411
  address: string;
412
+ public_key: string;
409
413
  chain_id: string;
410
414
  verified_at: number;
411
415
  first_verified_at: number | null;
package/dist/dts/EmailApi.d.ts CHANGED
@@ -143,6 +143,7 @@ export default class EmailApi {
143
143
  } | {
144
144
  type: "wallet";
145
145
  address: string;
146
+ public_key: string;
146
147
  chain_id: string;
147
148
  verified_at: number;
148
149
  first_verified_at: number | null;
@@ -158,6 +159,7 @@ export default class EmailApi {
158
159
  } | {
159
160
  type: "wallet";
160
161
  address: string;
162
+ public_key: string;
161
163
  chain_id: string;
162
164
  verified_at: number;
163
165
  first_verified_at: number | null;
@@ -391,6 +393,7 @@ export default class EmailApi {
391
393
  } | {
392
394
  type: "wallet";
393
395
  address: string;
396
+ public_key: string;
394
397
  chain_id: string;
395
398
  verified_at: number;
396
399
  first_verified_at: number | null;
@@ -406,6 +409,7 @@ export default class EmailApi {
406
409
  } | {
407
410
  type: "wallet";
408
411
  address: string;
412
+ public_key: string;
409
413
  chain_id: string;
410
414
  verified_at: number;
411
415
  first_verified_at: number | null;
package/dist/dts/EmbeddedWalletApi.d.mts CHANGED
@@ -1,6 +1,7 @@
1
1
  import type { PrivyBitcoinSegwitEmbeddedWalletAccount, PrivyBitcoinTaprootEmbeddedWalletAccount, PrivyEthereumEmbeddedWalletAccount, PrivySolanaEmbeddedWalletAccount, PrivyUser } from '@privy-io/public-api/schemas';
2
2
  import { EmbeddedSolanaWalletProvider, EmbeddedWalletProvider } from './embedded';
3
- import type { EntropyIdVerifier, IEmbeddedWalletRecoveryOptions, PrivyResponseEvent, SetRecoveryInput } from './embedded/types';
3
+ import { EmbeddedBitcoinWalletProvider } from './embedded/EmbeddedBitcoinWalletProvider';
4
+ import type { ChainType, EntropyIdVerifier, IEmbeddedWalletRecoveryOptions, PrivyResponseEvent, SetRecoveryInput, SetRecoveryOutput } from './embedded/types';
4
5
  /** Options for creating the Solana embedded wallet */
5
6
  type CreateSolanaOpts = {
6
7
  /**
@@ -19,6 +20,284 @@ export type LoadWalletParams = {
19
20
  recoverySecretOverride?: string;
20
21
  };
21
22
  export default class EmbeddedWalletApi {
23
+ /**
24
+ * Add a new embedded wallet account.
25
+ *
26
+ * Requires that the user already have created an embedded wallet via `create`.
27
+ *
28
+ * @param o input options
29
+ * @param o.chainType the type of wallet to create
30
+ * @param o.hdWalletIndex the index of the wallet to create
31
+ * @param o.entropyId the key used to look up the existing wallet
32
+ * @param o.entropyIdVerifier the method used to verify the entropy ID
33
+ *
34
+ * @returns the updated user
35
+ */
36
+ add(opts: {
37
+ chainType: ChainType;
38
+ hdWalletIndex: number;
39
+ entropyId: string;
40
+ entropyIdVerifier: EntropyIdVerifier;
41
+ }): Promise<{
42
+ user: {
43
+ id: string;
44
+ mfa_methods: ({
45
+ type: "sms";
46
+ verified_at: number;
47
+ } | {
48
+ type: "totp";
49
+ verified_at: number;
50
+ } | {
51
+ type: "passkey";
52
+ verified_at: number;
53
+ })[];
54
+ linked_accounts: ({
55
+ type: "email";
56
+ address: string;
57
+ verified_at: number;
58
+ first_verified_at: number | null;
59
+ latest_verified_at: number | null;
60
+ } | {
61
+ type: "phone";
62
+ verified_at: number;
63
+ first_verified_at: number | null;
64
+ latest_verified_at: number | null;
65
+ phoneNumber: string;
66
+ } | {
67
+ type: "wallet";
68
+ address: string;
69
+ verified_at: number;
70
+ first_verified_at: number | null;
71
+ latest_verified_at: number | null;
72
+ chain_type: "ethereum";
73
+ wallet_client: "unknown";
74
+ chain_id?: string | undefined;
75
+ wallet_client_type?: string | undefined;
76
+ connector_type?: string | undefined;
77
+ } | {
78
+ type: "smart_wallet";
79
+ address: string;
80
+ smart_wallet_type: "safe" | "kernel" | "biconomy" | "light_account" | "coinbase_smart_wallet";
81
+ verified_at: number;
82
+ first_verified_at: number | null;
83
+ latest_verified_at: number | null;
84
+ } | {
85
+ type: "wallet";
86
+ address: string;
87
+ verified_at: number;
88
+ first_verified_at: number | null;
89
+ latest_verified_at: number | null;
90
+ chain_type: "solana";
91
+ wallet_client: "unknown";
92
+ wallet_client_type?: string | undefined;
93
+ connector_type?: string | undefined;
94
+ } | {
95
+ type: "farcaster";
96
+ fid: number;
97
+ verified_at: number;
98
+ first_verified_at: number | null;
99
+ latest_verified_at: number | null;
100
+ owner_address: string;
101
+ username?: string | undefined;
102
+ display_name?: string | undefined;
103
+ bio?: string | undefined;
104
+ profile_picture?: string | undefined;
105
+ profile_picture_url?: string | undefined;
106
+ homepage_url?: string | undefined;
107
+ signer_public_key?: string | undefined;
108
+ } | {
109
+ type: "passkey";
110
+ verified_at: number;
111
+ first_verified_at: number | null;
112
+ latest_verified_at: number | null;
113
+ credential_id: string;
114
+ enrolled_in_mfa: boolean;
115
+ created_with_browser?: string | undefined;
116
+ created_with_os?: string | undefined;
117
+ created_with_device?: string | undefined;
118
+ authenticator_name?: string | undefined;
119
+ } | {
120
+ telegramUserId: string;
121
+ firstName: string | null | undefined;
122
+ type: "telegram";
123
+ verified_at: number;
124
+ first_verified_at: number | null;
125
+ latest_verified_at: number | null;
126
+ telegram_user_id: string;
127
+ username?: string | null | undefined;
128
+ first_name?: string | null | undefined;
129
+ last_name?: string | null | undefined;
130
+ photo_url?: string | null | undefined;
131
+ } | {
132
+ type: "wallet";
133
+ address: string;
134
+ chain_id: string;
135
+ verified_at: number;
136
+ first_verified_at: number | null;
137
+ latest_verified_at: number | null;
138
+ chain_type: "ethereum";
139
+ wallet_client: "privy";
140
+ wallet_client_type: "privy";
141
+ connector_type: "embedded";
142
+ imported: boolean;
143
+ delegated: boolean;
144
+ wallet_index: number;
145
+ recovery_method: "user-passcode" | "google-drive" | "icloud" | "privy";
146
+ } | {
147
+ type: "wallet";
148
+ address: string;
149
+ public_key: string;
150
+ chain_id: string;
151
+ verified_at: number;
152
+ first_verified_at: number | null;
153
+ latest_verified_at: number | null;
154
+ chain_type: "solana";
155
+ wallet_client: "privy";
156
+ wallet_client_type: "privy";
157
+ connector_type: "embedded";
158
+ imported: boolean;
159
+ delegated: boolean;
160
+ wallet_index: number;
161
+ recovery_method: "user-passcode" | "google-drive" | "icloud" | "privy";
162
+ } | {
163
+ type: "wallet";
164
+ address: string;
165
+ public_key: string;
166
+ chain_id: string;
167
+ verified_at: number;
168
+ first_verified_at: number | null;
169
+ latest_verified_at: number | null;
170
+ chain_type: "bitcoin-segwit";
171
+ wallet_client: "privy";
172
+ wallet_client_type: "privy";
173
+ connector_type: "embedded";
174
+ imported: boolean;
175
+ delegated: boolean;
176
+ wallet_index: number;
177
+ recovery_method: "user-passcode" | "google-drive" | "icloud" | "privy";
178
+ } | {
179
+ type: "wallet";
180
+ address: string;
181
+ public_key: string;
182
+ chain_id: string;
183
+ verified_at: number;
184
+ first_verified_at: number | null;
185
+ latest_verified_at: number | null;
186
+ chain_type: "bitcoin-taproot";
187
+ wallet_client: "privy";
188
+ wallet_client_type: "privy";
189
+ connector_type: "embedded";
190
+ imported: boolean;
191
+ delegated: boolean;
192
+ wallet_index: number;
193
+ recovery_method: "user-passcode" | "google-drive" | "icloud" | "privy";
194
+ } | {
195
+ type: "google_oauth";
196
+ name: string | null;
197
+ email: string;
198
+ verified_at: number;
199
+ first_verified_at: number | null;
200
+ latest_verified_at: number | null;
201
+ subject: string;
202
+ } | {
203
+ type: "twitter_oauth";
204
+ name: string | null;
205
+ username: string | null;
206
+ verified_at: number;
207
+ first_verified_at: number | null;
208
+ latest_verified_at: number | null;
209
+ profile_picture_url: string | null;
210
+ subject: string;
211
+ } | {
212
+ type: "discord_oauth";
213
+ email: string | null;
214
+ username: string | null;
215
+ verified_at: number;
216
+ first_verified_at: number | null;
217
+ latest_verified_at: number | null;
218
+ subject: string;
219
+ } | {
220
+ type: "github_oauth";
221
+ name: string | null;
222
+ email: string | null;
223
+ username: string | null;
224
+ verified_at: number;
225
+ first_verified_at: number | null;
226
+ latest_verified_at: number | null;
227
+ subject: string;
228
+ } | {
229
+ type: "linkedin_oauth";
230
+ email: string | null;
231
+ verified_at: number;
232
+ first_verified_at: number | null;
233
+ latest_verified_at: number | null;
234
+ subject: string;
235
+ name?: string | undefined;
236
+ vanity_name?: string | undefined;
237
+ } | {
238
+ type: "spotify_oauth";
239
+ name: string | null;
240
+ email: string | null;
241
+ verified_at: number;
242
+ first_verified_at: number | null;
243
+ latest_verified_at: number | null;
244
+ subject: string;
245
+ } | {
246
+ type: "instagram_oauth";
247
+ username: string | null;
248
+ verified_at: number;
249
+ first_verified_at: number | null;
250
+ latest_verified_at: number | null;
251
+ subject: string;
252
+ } | {
253
+ type: "tiktok_oauth";
254
+ name: string | null;
255
+ username: string | null;
256
+ verified_at: number;
257
+ first_verified_at: number | null;
258
+ latest_verified_at: number | null;
259
+ subject: string;
260
+ } | {
261
+ type: "apple_oauth";
262
+ email: string | null;
263
+ verified_at: number;
264
+ first_verified_at: number | null;
265
+ latest_verified_at: number | null;
266
+ subject: string;
267
+ } | {
268
+ type: "custom_auth";
269
+ verified_at: number;
270
+ first_verified_at: number | null;
271
+ latest_verified_at: number | null;
272
+ custom_user_id: string;
273
+ } | {
274
+ type: "cross_app";
275
+ provider_app_id: string;
276
+ verified_at: number;
277
+ first_verified_at: number | null;
278
+ latest_verified_at: number | null;
279
+ subject: string;
280
+ embedded_wallets: {
281
+ address: string;
282
+ }[];
283
+ smart_wallets: {
284
+ address: string;
285
+ }[];
286
+ })[];
287
+ created_at: number;
288
+ has_accepted_terms: boolean;
289
+ is_guest: boolean;
290
+ custom_metadata?: Record<string, string | number | boolean> | undefined;
291
+ };
292
+ }>;
293
+ getBitcoinProvider({ wallet, entropyId, entropyIdVerifier, recoveryPassword, recoveryAccessToken, recoverySecretOverride, }: {
294
+ wallet: PrivyBitcoinSegwitEmbeddedWalletAccount | PrivyBitcoinTaprootEmbeddedWalletAccount;
295
+ entropyId: string;
296
+ entropyIdVerifier: EntropyIdVerifier;
297
+ recoveryPassword?: string;
298
+ recoveryAccessToken?: string;
299
+ recoverySecretOverride?: string;
300
+ }): Promise<EmbeddedBitcoinWalletProvider>;
22
301
  /**
23
302
  * Creates an embedded wallet
24
303
  *
@@ -95,12 +374,10 @@ export default class EmbeddedWalletApi {
95
374
  *
96
375
  * @param password New recovery password
97
376
  * @param currentPassword Current recovery password used to recover the embedded wallet
98
- * @returns EmbeddedWalletProvider implementing EIP1193Provider
377
+ * @returns PrivyUser the user object with the updated embedded wallet.
378
+ * @returns EmbeddedWalletProvider implementing EIP1193Provider if the input wallet is an Ethereum wallet.
99
379
  */
100
- setRecovery({ wallet, ...recoveryArgs }: SetRecoveryInput): Promise<{
101
- user: PrivyUser;
102
- provider: EmbeddedWalletProvider;
103
- }>;
380
+ setRecovery(setRecoveryInput: SetRecoveryInput): Promise<SetRecoveryOutput>;
104
381
  /**
105
382
  * @returns URL to load in the embedded wallet iframe
106
383
  */
package/dist/dts/EmbeddedWalletApi.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  import type { PrivyBitcoinSegwitEmbeddedWalletAccount, PrivyBitcoinTaprootEmbeddedWalletAccount, PrivyEthereumEmbeddedWalletAccount, PrivySolanaEmbeddedWalletAccount, PrivyUser } from '@privy-io/public-api/schemas';
2
2
  import { EmbeddedSolanaWalletProvider, EmbeddedWalletProvider } from './embedded';
3
- import type { EntropyIdVerifier, IEmbeddedWalletRecoveryOptions, PrivyResponseEvent, SetRecoveryInput } from './embedded/types';
3
+ import { EmbeddedBitcoinWalletProvider } from './embedded/EmbeddedBitcoinWalletProvider';
4
+ import type { ChainType, EntropyIdVerifier, IEmbeddedWalletRecoveryOptions, PrivyResponseEvent, SetRecoveryInput, SetRecoveryOutput } from './embedded/types';
4
5
  /** Options for creating the Solana embedded wallet */
5
6
  type CreateSolanaOpts = {
6
7
  /**
@@ -19,6 +20,284 @@ export type LoadWalletParams = {
19
20
  recoverySecretOverride?: string;
20
21
  };
21
22
  export default class EmbeddedWalletApi {
23
+ /**
24
+ * Add a new embedded wallet account.
25
+ *
26
+ * Requires that the user already have created an embedded wallet via `create`.
27
+ *
28
+ * @param o input options
29
+ * @param o.chainType the type of wallet to create
30
+ * @param o.hdWalletIndex the index of the wallet to create
31
+ * @param o.entropyId the key used to look up the existing wallet
32
+ * @param o.entropyIdVerifier the method used to verify the entropy ID
33
+ *
34
+ * @returns the updated user
35
+ */
36
+ add(opts: {
37
+ chainType: ChainType;
38
+ hdWalletIndex: number;
39
+ entropyId: string;
40
+ entropyIdVerifier: EntropyIdVerifier;
41
+ }): Promise<{
42
+ user: {
43
+ id: string;
44
+ mfa_methods: ({
45
+ type: "sms";
46
+ verified_at: number;
47
+ } | {
48
+ type: "totp";
49
+ verified_at: number;
50
+ } | {
51
+ type: "passkey";
52
+ verified_at: number;
53
+ })[];
54
+ linked_accounts: ({
55
+ type: "email";
56
+ address: string;
57
+ verified_at: number;
58
+ first_verified_at: number | null;
59
+ latest_verified_at: number | null;
60
+ } | {
61
+ type: "phone";
62
+ verified_at: number;
63
+ first_verified_at: number | null;
64
+ latest_verified_at: number | null;
65
+ phoneNumber: string;
66
+ } | {
67
+ type: "wallet";
68
+ address: string;
69
+ verified_at: number;
70
+ first_verified_at: number | null;
71
+ latest_verified_at: number | null;
72
+ chain_type: "ethereum";
73
+ wallet_client: "unknown";
74
+ chain_id?: string | undefined;
75
+ wallet_client_type?: string | undefined;
76
+ connector_type?: string | undefined;
77
+ } | {
78
+ type: "smart_wallet";
79
+ address: string;
80
+ smart_wallet_type: "safe" | "kernel" | "biconomy" | "light_account" | "coinbase_smart_wallet";
81
+ verified_at: number;
82
+ first_verified_at: number | null;
83
+ latest_verified_at: number | null;
84
+ } | {
85
+ type: "wallet";
86
+ address: string;
87
+ verified_at: number;
88
+ first_verified_at: number | null;
89
+ latest_verified_at: number | null;
90
+ chain_type: "solana";
91
+ wallet_client: "unknown";
92
+ wallet_client_type?: string | undefined;
93
+ connector_type?: string | undefined;
94
+ } | {
95
+ type: "farcaster";
96
+ fid: number;
97
+ verified_at: number;
98
+ first_verified_at: number | null;
99
+ latest_verified_at: number | null;
100
+ owner_address: string;
101
+ username?: string | undefined;
102
+ display_name?: string | undefined;
103
+ bio?: string | undefined;
104
+ profile_picture?: string | undefined;
105
+ profile_picture_url?: string | undefined;
106
+ homepage_url?: string | undefined;
107
+ signer_public_key?: string | undefined;
108
+ } | {
109
+ type: "passkey";
110
+ verified_at: number;
111
+ first_verified_at: number | null;
112
+ latest_verified_at: number | null;
113
+ credential_id: string;
114
+ enrolled_in_mfa: boolean;
115
+ created_with_browser?: string | undefined;
116
+ created_with_os?: string | undefined;
117
+ created_with_device?: string | undefined;
118
+ authenticator_name?: string | undefined;
119
+ } | {
120
+ telegramUserId: string;
121
+ firstName: string | null | undefined;
122
+ type: "telegram";
123
+ verified_at: number;
124
+ first_verified_at: number | null;
125
+ latest_verified_at: number | null;
126
+ telegram_user_id: string;
127
+ username?: string | null | undefined;
128
+ first_name?: string | null | undefined;
129
+ last_name?: string | null | undefined;
130
+ photo_url?: string | null | undefined;
131
+ } | {
132
+ type: "wallet";
133
+ address: string;
134
+ chain_id: string;
135
+ verified_at: number;
136
+ first_verified_at: number | null;
137
+ latest_verified_at: number | null;
138
+ chain_type: "ethereum";
139
+ wallet_client: "privy";
140
+ wallet_client_type: "privy";
141
+ connector_type: "embedded";
142
+ imported: boolean;
143
+ delegated: boolean;
144
+ wallet_index: number;
145
+ recovery_method: "user-passcode" | "google-drive" | "icloud" | "privy";
146
+ } | {
147
+ type: "wallet";
148
+ address: string;
149
+ public_key: string;
150
+ chain_id: string;
151
+ verified_at: number;
152
+ first_verified_at: number | null;
153
+ latest_verified_at: number | null;
154
+ chain_type: "solana";
155
+ wallet_client: "privy";
156
+ wallet_client_type: "privy";
157
+ connector_type: "embedded";
158
+ imported: boolean;
159
+ delegated: boolean;
160
+ wallet_index: number;
161
+ recovery_method: "user-passcode" | "google-drive" | "icloud" | "privy";
162
+ } | {
163
+ type: "wallet";
164
+ address: string;
165
+ public_key: string;
166
+ chain_id: string;
167
+ verified_at: number;
168
+ first_verified_at: number | null;
169
+ latest_verified_at: number | null;
170
+ chain_type: "bitcoin-segwit";
171
+ wallet_client: "privy";
172
+ wallet_client_type: "privy";
173
+ connector_type: "embedded";
174
+ imported: boolean;
175
+ delegated: boolean;
176
+ wallet_index: number;
177
+ recovery_method: "user-passcode" | "google-drive" | "icloud" | "privy";
178
+ } | {
179
+ type: "wallet";
180
+ address: string;
181
+ public_key: string;
182
+ chain_id: string;
183
+ verified_at: number;
184
+ first_verified_at: number | null;
185
+ latest_verified_at: number | null;
186
+ chain_type: "bitcoin-taproot";
187
+ wallet_client: "privy";
188
+ wallet_client_type: "privy";
189
+ connector_type: "embedded";
190
+ imported: boolean;
191
+ delegated: boolean;
192
+ wallet_index: number;
193
+ recovery_method: "user-passcode" | "google-drive" | "icloud" | "privy";
194
+ } | {
195
+ type: "google_oauth";
196
+ name: string | null;
197
+ email: string;
198
+ verified_at: number;
199
+ first_verified_at: number | null;
200
+ latest_verified_at: number | null;
201
+ subject: string;
202
+ } | {
203
+ type: "twitter_oauth";
204
+ name: string | null;
205
+ username: string | null;
206
+ verified_at: number;
207
+ first_verified_at: number | null;
208
+ latest_verified_at: number | null;
209
+ profile_picture_url: string | null;
210
+ subject: string;
211
+ } | {
212
+ type: "discord_oauth";
213
+ email: string | null;
214
+ username: string | null;
215
+ verified_at: number;
216
+ first_verified_at: number | null;
217
+ latest_verified_at: number | null;
218
+ subject: string;
219
+ } | {
220
+ type: "github_oauth";
221
+ name: string | null;
222
+ email: string | null;
223
+ username: string | null;
224
+ verified_at: number;
225
+ first_verified_at: number | null;
226
+ latest_verified_at: number | null;
227
+ subject: string;
228
+ } | {
229
+ type: "linkedin_oauth";
230
+ email: string | null;
231
+ verified_at: number;
232
+ first_verified_at: number | null;
233
+ latest_verified_at: number | null;
234
+ subject: string;
235
+ name?: string | undefined;
236
+ vanity_name?: string | undefined;
237
+ } | {
238
+ type: "spotify_oauth";
239
+ name: string | null;
240
+ email: string | null;
241
+ verified_at: number;
242
+ first_verified_at: number | null;
243
+ latest_verified_at: number | null;
244
+ subject: string;
245
+ } | {
246
+ type: "instagram_oauth";
247
+ username: string | null;
248
+ verified_at: number;
249
+ first_verified_at: number | null;
250
+ latest_verified_at: number | null;
251
+ subject: string;
252
+ } | {
253
+ type: "tiktok_oauth";
254
+ name: string | null;
255
+ username: string | null;
256
+ verified_at: number;
257
+ first_verified_at: number | null;
258
+ latest_verified_at: number | null;
259
+ subject: string;
260
+ } | {
261
+ type: "apple_oauth";
262
+ email: string | null;
263
+ verified_at: number;
264
+ first_verified_at: number | null;
265
+ latest_verified_at: number | null;
266
+ subject: string;
267
+ } | {
268
+ type: "custom_auth";
269
+ verified_at: number;
270
+ first_verified_at: number | null;
271
+ latest_verified_at: number | null;
272
+ custom_user_id: string;
273
+ } | {
274
+ type: "cross_app";
275
+ provider_app_id: string;
276
+ verified_at: number;
277
+ first_verified_at: number | null;
278
+ latest_verified_at: number | null;
279
+ subject: string;
280
+ embedded_wallets: {
281
+ address: string;
282
+ }[];
283
+ smart_wallets: {
284
+ address: string;
285
+ }[];
286
+ })[];
287
+ created_at: number;
288
+ has_accepted_terms: boolean;
289
+ is_guest: boolean;
290
+ custom_metadata?: Record<string, string | number | boolean> | undefined;
291
+ };
292
+ }>;
293
+ getBitcoinProvider({ wallet, entropyId, entropyIdVerifier, recoveryPassword, recoveryAccessToken, recoverySecretOverride, }: {
294
+ wallet: PrivyBitcoinSegwitEmbeddedWalletAccount | PrivyBitcoinTaprootEmbeddedWalletAccount;
295
+ entropyId: string;
296
+ entropyIdVerifier: EntropyIdVerifier;
297
+ recoveryPassword?: string;
298
+ recoveryAccessToken?: string;
299
+ recoverySecretOverride?: string;
300
+ }): Promise<EmbeddedBitcoinWalletProvider>;
22
301
  /**
23
302
  * Creates an embedded wallet
24
303
  *
@@ -95,12 +374,10 @@ export default class EmbeddedWalletApi {
95
374
  *
96
375
  * @param password New recovery password
97
376
  * @param currentPassword Current recovery password used to recover the embedded wallet
98
- * @returns EmbeddedWalletProvider implementing EIP1193Provider
377
+ * @returns PrivyUser the user object with the updated embedded wallet.
378
+ * @returns EmbeddedWalletProvider implementing EIP1193Provider if the input wallet is an Ethereum wallet.
99
379
  */
100
- setRecovery({ wallet, ...recoveryArgs }: SetRecoveryInput): Promise<{
101
- user: PrivyUser;
102
- provider: EmbeddedWalletProvider;
103
- }>;
380
+ setRecovery(setRecoveryInput: SetRecoveryInput): Promise<SetRecoveryOutput>;
104
381
  /**
105
382
  * @returns URL to load in the embedded wallet iframe
106
383
  */