@privy-io/api-types 0.16.0 → 0.17.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 (112) hide show
  1. package/CHANGELOG.md +59 -0
  2. package/client.d.mts +14 -17
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +14 -17
  5. package/client.d.ts.map +1 -1
  6. package/client.js +0 -3
  7. package/client.js.map +1 -1
  8. package/client.mjs +0 -3
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/client-auth.d.mts +12 -4
  12. package/resources/client-auth.d.mts.map +1 -1
  13. package/resources/client-auth.d.ts +12 -4
  14. package/resources/client-auth.d.ts.map +1 -1
  15. package/resources/embedded-wallets.d.mts +6 -0
  16. package/resources/embedded-wallets.d.mts.map +1 -1
  17. package/resources/embedded-wallets.d.ts +6 -0
  18. package/resources/embedded-wallets.d.ts.map +1 -1
  19. package/resources/index.d.mts +7 -8
  20. package/resources/index.d.mts.map +1 -1
  21. package/resources/index.d.ts +7 -8
  22. package/resources/index.d.ts.map +1 -1
  23. package/resources/index.js +1 -3
  24. package/resources/index.js.map +1 -1
  25. package/resources/index.mjs +0 -1
  26. package/resources/index.mjs.map +1 -1
  27. package/resources/kraken-embed.d.mts +110 -17
  28. package/resources/kraken-embed.d.mts.map +1 -1
  29. package/resources/kraken-embed.d.ts +110 -17
  30. package/resources/kraken-embed.d.ts.map +1 -1
  31. package/resources/policies.d.mts +48 -8
  32. package/resources/policies.d.mts.map +1 -1
  33. package/resources/policies.d.ts +48 -8
  34. package/resources/policies.d.ts.map +1 -1
  35. package/resources/transactions.d.mts +9 -2
  36. package/resources/transactions.d.mts.map +1 -1
  37. package/resources/transactions.d.ts +9 -2
  38. package/resources/transactions.d.ts.map +1 -1
  39. package/resources/users.d.mts +33 -7
  40. package/resources/users.d.mts.map +1 -1
  41. package/resources/users.d.ts +33 -7
  42. package/resources/users.d.ts.map +1 -1
  43. package/resources/{wallet-actions.d.ts → wallets/actions.d.mts} +257 -55
  44. package/resources/wallets/actions.d.mts.map +1 -0
  45. package/resources/{wallet-actions.d.mts → wallets/actions.d.ts} +257 -55
  46. package/resources/wallets/actions.d.ts.map +1 -0
  47. package/resources/wallets/actions.js +9 -0
  48. package/resources/wallets/actions.js.map +1 -0
  49. package/resources/wallets/actions.mjs +5 -0
  50. package/resources/wallets/actions.mjs.map +1 -0
  51. package/resources/wallets/balance.d.mts +7 -4
  52. package/resources/wallets/balance.d.mts.map +1 -1
  53. package/resources/wallets/balance.d.ts +7 -4
  54. package/resources/wallets/balance.d.ts.map +1 -1
  55. package/resources/wallets/index.d.mts +2 -1
  56. package/resources/wallets/index.d.mts.map +1 -1
  57. package/resources/wallets/index.d.ts +2 -1
  58. package/resources/wallets/index.d.ts.map +1 -1
  59. package/resources/wallets/index.js +3 -1
  60. package/resources/wallets/index.js.map +1 -1
  61. package/resources/wallets/index.mjs +1 -0
  62. package/resources/wallets/index.mjs.map +1 -1
  63. package/resources/wallets/transactions.d.mts +10 -3
  64. package/resources/wallets/transactions.d.mts.map +1 -1
  65. package/resources/wallets/transactions.d.ts +10 -3
  66. package/resources/wallets/transactions.d.ts.map +1 -1
  67. package/resources/wallets/transactions.js.map +1 -1
  68. package/resources/wallets/transactions.mjs.map +1 -1
  69. package/resources/wallets/wallets.d.mts +261 -28
  70. package/resources/wallets/wallets.d.mts.map +1 -1
  71. package/resources/wallets/wallets.d.ts +261 -28
  72. package/resources/wallets/wallets.d.ts.map +1 -1
  73. package/resources/wallets/wallets.js +4 -0
  74. package/resources/wallets/wallets.js.map +1 -1
  75. package/resources/wallets/wallets.mjs +4 -0
  76. package/resources/wallets/wallets.mjs.map +1 -1
  77. package/resources/webhooks.d.mts +357 -56
  78. package/resources/webhooks.d.mts.map +1 -1
  79. package/resources/webhooks.d.ts +357 -56
  80. package/resources/webhooks.d.ts.map +1 -1
  81. package/resources/yield.d.mts +4 -3
  82. package/resources/yield.d.mts.map +1 -1
  83. package/resources/yield.d.ts +4 -3
  84. package/resources/yield.d.ts.map +1 -1
  85. package/resources/yield.js.map +1 -1
  86. package/resources/yield.mjs.map +1 -1
  87. package/src/client.ts +84 -83
  88. package/src/resources/client-auth.ts +19 -3
  89. package/src/resources/embedded-wallets.ts +7 -0
  90. package/src/resources/index.ts +42 -40
  91. package/src/resources/kraken-embed.ts +439 -848
  92. package/src/resources/policies.ts +96 -36
  93. package/src/resources/transactions.ts +18 -9
  94. package/src/resources/users.ts +38 -6
  95. package/src/resources/{wallet-actions.ts → wallets/actions.ts} +318 -62
  96. package/src/resources/wallets/balance.ts +20 -62
  97. package/src/resources/wallets/index.ts +59 -0
  98. package/src/resources/wallets/transactions.ts +11 -10
  99. package/src/resources/wallets/wallets.ts +513 -66
  100. package/src/resources/webhooks.ts +436 -61
  101. package/src/resources/yield.ts +4 -11
  102. package/src/version.ts +1 -1
  103. package/version.d.mts +1 -1
  104. package/version.d.ts +1 -1
  105. package/version.js +1 -1
  106. package/version.mjs +1 -1
  107. package/resources/wallet-actions.d.mts.map +0 -1
  108. package/resources/wallet-actions.d.ts.map +0 -1
  109. package/resources/wallet-actions.js +0 -9
  110. package/resources/wallet-actions.js.map +0 -1
  111. package/resources/wallet-actions.mjs +0 -5
  112. package/resources/wallet-actions.mjs.map +0 -1
@@ -4,6 +4,53 @@ import { APIResource } from '../../core/resource';
4
4
  import * as WalletsAPI from './wallets';
5
5
  import * as AppsAPI from '../apps';
6
6
  import * as SharedAPI from '../shared';
7
+ import * as ActionsAPI from './actions';
8
+ import {
9
+ AaveVaultDetails,
10
+ Actions,
11
+ CustodianTransactionWalletActionStep,
12
+ CustodianTransactionWalletActionStepStatus,
13
+ EarnAsset,
14
+ EarnDepositActionResponse,
15
+ EarnDepositRequestBody,
16
+ EarnFeeCollectActionResponse,
17
+ EarnFeeCollectRequestBody,
18
+ EarnIncentiveClaimActionResponse,
19
+ EarnIncentiveClaimRequestBody,
20
+ EarnIncentiveRewardEntry,
21
+ EarnIncentiveRewardsQuery,
22
+ EarnIncentiveRewardsResponse,
23
+ EarnIncetiveClaimRewardEntry,
24
+ EarnWithdrawActionResponse,
25
+ EarnWithdrawRequestBody,
26
+ EthereumEarnPositionQuery,
27
+ EthereumEarnPositionResponse,
28
+ EthereumEarnProvider,
29
+ EthereumEarnVaultDetailsResponse,
30
+ EvmTransactionWalletActionStep,
31
+ EvmUserOperationEntrypointVersion,
32
+ EvmUserOperationWalletActionStep,
33
+ EvmWalletActionStepStatus,
34
+ ExternalTransactionWalletActionStep,
35
+ ExternalTransactionWalletActionStepStatus,
36
+ FailureReason,
37
+ ListWalletActionsQuery,
38
+ ListWalletActionsResponse,
39
+ MorphoVaultDetails,
40
+ SvmTransactionWalletActionStep,
41
+ SvmWalletActionStepStatus,
42
+ SwapActionResponse,
43
+ TransferActionResponse,
44
+ TvmTransactionWalletActionStep,
45
+ TvmWalletActionStepStatus,
46
+ VedaVaultDetails,
47
+ WalletActionInclude,
48
+ WalletActionResponse,
49
+ WalletActionStatus,
50
+ WalletActionStep,
51
+ WalletActionStepType,
52
+ WalletActionType,
53
+ } from './actions';
7
54
  import * as BalanceAPI from './balance';
8
55
  import { Balance, BalanceGetParams, BalanceGetResponse } from './balance';
9
56
  import * as TransactionsAPI from './transactions';
@@ -20,6 +67,7 @@ import { path } from '../../internal/utils/path';
20
67
  export class Wallets extends APIResource {
21
68
  balance: BalanceAPI.Balance = new BalanceAPI.Balance(this._client);
22
69
  transactions: TransactionsAPI.Transactions = new TransactionsAPI.Transactions(this._client);
70
+ actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
23
71
 
24
72
  /**
25
73
  * Creates a new wallet on the requested chain and for the requested owner.
@@ -281,7 +329,9 @@ export interface AdditionalSignerItemInput {
281
329
  }
282
330
 
283
331
  /**
284
- * A blockchain wallet address (Ethereum or Solana).
332
+ * A blockchain wallet address. Ethereum addresses are normalized to EIP-55
333
+ * checksum format. Solana addresses are validated as base58. All other chain
334
+ * addresses (Stellar, Tron, Sui, Aptos, etc.) are accepted as-is.
285
335
  */
286
336
  export type Address = string;
287
337
 
@@ -567,14 +617,6 @@ export type CustodialWalletProvider = 'bridge';
567
617
  * address (Solana). Use this variant for tokens that are not first-class assets.
568
618
  */
569
619
  export interface CustomTokenTransferSource {
570
- /**
571
- * @deprecated Amount as a decimal string in the token's standard unit (e.g. "1.5"
572
- * for 1.5 USDC, "0.01" for 0.01 ETH). For exact_input, specifies the amount to
573
- * send. Not in the smallest on-chain unit (wei, lamports, etc.). Maximum 100
574
- * characters.
575
- */
576
- amount: string;
577
-
578
620
  /**
579
621
  * The token contract address (EVM) or mint address (Solana) of the asset to
580
622
  * transfer.
@@ -587,6 +629,14 @@ export interface CustomTokenTransferSource {
587
629
  * respective testnets.
588
630
  */
589
631
  chain: string;
632
+
633
+ /**
634
+ * @deprecated Amount as a decimal string in the token's standard unit (e.g. "1.5"
635
+ * for 1.5 USDC, "0.01" for 0.01 ETH). For exact_input, specifies the amount to
636
+ * send. Not in the smallest on-chain unit (wei, lamports, etc.). Maximum 100
637
+ * characters. Deprecated: use the top-level `amount` field instead.
638
+ */
639
+ amount?: string;
590
640
  }
591
641
 
592
642
  /**
@@ -1370,7 +1420,9 @@ export interface Gas {
1370
1420
  */
1371
1421
  export interface GetByWalletAddressRequestBody {
1372
1422
  /**
1373
- * A blockchain wallet address (Ethereum or Solana).
1423
+ * A blockchain wallet address. Ethereum addresses are normalized to EIP-55
1424
+ * checksum format. Solana addresses are validated as base58. All other chain
1425
+ * addresses (Stellar, Tron, Sui, Aptos, etc.) are accepted as-is.
1374
1426
  */
1375
1427
  address: Address;
1376
1428
 
@@ -1520,14 +1572,6 @@ export interface IntentBinding {
1520
1572
  * variant for first-class assets maintained by Privy.
1521
1573
  */
1522
1574
  export interface NamedTokenTransferSource {
1523
- /**
1524
- * @deprecated Amount as a decimal string in the token's standard unit (e.g. "1.5"
1525
- * for 1.5 USDC, "0.01" for 0.01 ETH). For exact_input, specifies the amount to
1526
- * send. Not in the smallest on-chain unit (wei, lamports, etc.). Maximum 100
1527
- * characters.
1528
- */
1529
- amount: string;
1530
-
1531
1575
  /**
1532
1576
  * The asset to transfer. Supported: 'usdc', 'usdb', 'usdt' (stablecoins), 'eth'
1533
1577
  * (native Ethereum), 'sol' (native Solana).
@@ -1540,6 +1584,14 @@ export interface NamedTokenTransferSource {
1540
1584
  * respective testnets.
1541
1585
  */
1542
1586
  chain: string;
1587
+
1588
+ /**
1589
+ * @deprecated Amount as a decimal string in the token's standard unit (e.g. "1.5"
1590
+ * for 1.5 USDC, "0.01" for 0.01 ETH). For exact_input, specifies the amount to
1591
+ * send. Not in the smallest on-chain unit (wei, lamports, etc.). Maximum 100
1592
+ * characters. Deprecated: use the top-level `amount` field instead.
1593
+ */
1594
+ amount?: string;
1543
1595
  }
1544
1596
 
1545
1597
  /**
@@ -2123,6 +2175,92 @@ export interface SparkClaimStaticDepositRpcResponseData {
2123
2175
  transfer_id: string;
2124
2176
  }
2125
2177
 
2178
+ /**
2179
+ * A fee quote for a cooperative exit from Spark to Bitcoin L1.
2180
+ */
2181
+ export interface SparkCoopExitFeeQuote {
2182
+ id: string;
2183
+
2184
+ created_at: string;
2185
+
2186
+ expires_at: string;
2187
+
2188
+ /**
2189
+ * A currency amount with its original value and unit.
2190
+ */
2191
+ l1_broadcast_fee_fast: SparkCurrencyAmount;
2192
+
2193
+ /**
2194
+ * A currency amount with its original value and unit.
2195
+ */
2196
+ l1_broadcast_fee_medium: SparkCurrencyAmount;
2197
+
2198
+ /**
2199
+ * A currency amount with its original value and unit.
2200
+ */
2201
+ l1_broadcast_fee_slow: SparkCurrencyAmount;
2202
+
2203
+ network: string;
2204
+
2205
+ /**
2206
+ * A currency amount with its original value and unit.
2207
+ */
2208
+ total_amount: SparkCurrencyAmount;
2209
+
2210
+ updated_at: string;
2211
+
2212
+ /**
2213
+ * A currency amount with its original value and unit.
2214
+ */
2215
+ user_fee_fast: SparkCurrencyAmount;
2216
+
2217
+ /**
2218
+ * A currency amount with its original value and unit.
2219
+ */
2220
+ user_fee_medium: SparkCurrencyAmount;
2221
+
2222
+ /**
2223
+ * A currency amount with its original value and unit.
2224
+ */
2225
+ user_fee_slow: SparkCurrencyAmount;
2226
+ }
2227
+
2228
+ /**
2229
+ * A cooperative exit request from Spark to Bitcoin L1.
2230
+ */
2231
+ export interface SparkCoopExitRequest {
2232
+ id: string;
2233
+
2234
+ coop_exit_txid: string;
2235
+
2236
+ created_at: string;
2237
+
2238
+ expires_at: string;
2239
+
2240
+ /**
2241
+ * A currency amount with its original value and unit.
2242
+ */
2243
+ fee: SparkCurrencyAmount;
2244
+
2245
+ /**
2246
+ * A currency amount with its original value and unit.
2247
+ */
2248
+ l1_broadcast_fee: SparkCurrencyAmount;
2249
+
2250
+ network: string;
2251
+
2252
+ status: string;
2253
+
2254
+ updated_at: string;
2255
+
2256
+ /**
2257
+ * The exit speed for a cooperative withdrawal from Spark to L1.
2258
+ */
2259
+ exit_speed?: SparkExitSpeed;
2260
+
2261
+ fee_quote_id?: string;
2262
+ }
2263
+
2126
2264
  /**
2127
2265
  * Creates a Lightning invoice for the Spark wallet.
2128
2266
  */
@@ -2169,6 +2307,20 @@ export interface SparkCreateLightningInvoiceRpcResponse {
2169
2307
  data?: SparkLightningReceiveRequest;
2170
2308
  }
2171
2309
 
2310
+ /**
2311
+ * A currency amount with its original value and unit.
2312
+ */
2313
+ export interface SparkCurrencyAmount {
2314
+ original_unit: string;
2315
+
2316
+ original_value: number;
2317
+ }
2318
+
2319
+ /**
2320
+ * The exit speed for a cooperative withdrawal from Spark to L1.
2321
+ */
2322
+ export type SparkExitSpeed = 'FAST' | 'MEDIUM' | 'SLOW';
2323
+
2172
2324
  /**
2173
2325
  * Gets the balance of the Spark wallet.
2174
2326
  */
@@ -2277,6 +2429,44 @@ export interface SparkGetStaticDepositAddressRpcResponseData {
2277
2429
  address: string;
2278
2430
  }
2279
2431
 
2432
+ /**
2433
+ * Gets a fee quote for withdrawing from Spark to a Bitcoin L1 address.
2434
+ */
2435
+ export interface SparkGetWithdrawalFeeQuoteRpcInput {
2436
+ method: 'getWithdrawalFeeQuote';
2437
+
2438
+ /**
2439
+ * Parameters for the Spark `getWithdrawalFeeQuote` RPC.
2440
+ */
2441
+ params: SparkGetWithdrawalFeeQuoteRpcInputParams;
2442
+
2443
+ /**
2444
+ * The Spark network.
2445
+ */
2446
+ network?: SparkNetwork;
2447
+ }
2448
+
2449
+ /**
2450
+ * Parameters for the Spark `getWithdrawalFeeQuote` RPC.
2451
+ */
2452
+ export interface SparkGetWithdrawalFeeQuoteRpcInputParams {
2453
+ amount_sats: number;
2454
+
2455
+ onchain_address: string;
2456
+ }
2457
+
2458
+ /**
2459
+ * Response to the Spark `getWithdrawalFeeQuote` RPC.
2460
+ */
2461
+ export interface SparkGetWithdrawalFeeQuoteRpcResponse {
2462
+ method: 'getWithdrawalFeeQuote';
2463
+
2464
+ /**
2465
+ * A fee quote for a cooperative exit from Spark to Bitcoin L1.
2466
+ */
2467
+ data?: SparkCoopExitFeeQuote;
2468
+ }
2469
+
2280
2470
  /**
2281
2471
  * The fee for a Spark Lightning payment.
2282
2472
  */
@@ -2405,7 +2595,9 @@ export type SparkRpcInput =
2405
2595
  | SparkClaimStaticDepositRpcInput
2406
2596
  | SparkCreateLightningInvoiceRpcInput
2407
2597
  | SparkPayLightningInvoiceRpcInput
2408
- | SparkSignMessageWithIdentityKeyRpcInput;
2598
+ | SparkSignMessageWithIdentityKeyRpcInput
2599
+ | SparkWithdrawRpcInput
2600
+ | SparkGetWithdrawalFeeQuoteRpcInput;
2409
2601
 
2410
2602
  /**
2411
2603
  * Response body for Spark wallet RPC operations, discriminated by method.
@@ -2419,7 +2611,9 @@ export type SparkRpcResponse =
2419
2611
  | SparkClaimStaticDepositRpcResponse
2420
2612
  | SparkCreateLightningInvoiceRpcResponse
2421
2613
  | SparkPayLightningInvoiceRpcResponse
2422
- | SparkSignMessageWithIdentityKeyRpcResponse;
2614
+ | SparkSignMessageWithIdentityKeyRpcResponse
2615
+ | SparkWithdrawRpcResponse
2616
+ | SparkGetWithdrawalFeeQuoteRpcResponse;
2423
2617
 
2424
2618
  /**
2425
2619
  * Signs a message with the Spark identity key.
@@ -2680,6 +2874,55 @@ export interface SparkWalletLeaf {
2680
2874
  signing_keyshare?: SparkSigningKeyshare;
2681
2875
  }
2682
2876
 
2877
+ /**
2878
+ * Withdraws from Spark to a Bitcoin L1 address (cooperative exit).
2879
+ */
2880
+ export interface SparkWithdrawRpcInput {
2881
+ method: 'withdraw';
2882
+
2883
+ /**
2884
+ * Parameters for the Spark `withdraw` RPC.
2885
+ */
2886
+ params: SparkWithdrawRpcInputParams;
2887
+
2888
+ /**
2889
+ * The Spark network.
2890
+ */
2891
+ network?: SparkNetwork;
2892
+ }
2893
+
2894
+ /**
2895
+ * Parameters for the Spark `withdraw` RPC.
2896
+ */
2897
+ export interface SparkWithdrawRpcInputParams {
2898
+ /**
2899
+ * The exit speed for a cooperative withdrawal from Spark to L1.
2900
+ */
2901
+ exit_speed: SparkExitSpeed;
2902
+
2903
+ onchain_address: string;
2904
+
2905
+ amount_sats?: number;
2906
+
2907
+ deduct_fee_from_withdrawal_amount?: boolean;
2908
+
2909
+ fee_amount_sats?: number;
2910
+
2911
+ fee_quote_id?: string;
2912
+ }
2913
+
2914
+ /**
2915
+ * Response to the Spark `withdraw` RPC.
2916
+ */
2917
+ export interface SparkWithdrawRpcResponse {
2918
+ method: 'withdraw';
2919
+
2920
+ /**
2921
+ * A cooperative exit request from Spark to Bitcoin L1.
2922
+ */
2923
+ data?: SparkCoopExitRequest;
2924
+ }
2925
+
2683
2926
  /**
2684
2927
  * SUI transaction commands allowlist for raw_sign endpoint policy evaluation
2685
2928
  */
@@ -2819,6 +3062,22 @@ export interface TotalFeeConfigurationBps {
2819
3062
  value: number;
2820
3063
  }
2821
3064
 
3065
+ /**
3066
+ * Chains supported for transaction history queries.
3067
+ */
3068
+ export type TransactionChainNameInput =
3069
+ | 'ethereum'
3070
+ | 'arbitrum'
3071
+ | 'avalanche'
3072
+ | 'base'
3073
+ | 'bsc'
3074
+ | 'tempo'
3075
+ | 'linea'
3076
+ | 'optimism'
3077
+ | 'polygon'
3078
+ | 'solana'
3079
+ | 'sepolia';
3080
+
2822
3081
  /**
2823
3082
  * Details of a wallet transaction, varying by transaction type.
2824
3083
  */
@@ -2926,28 +3185,24 @@ export interface TransferQuoteResponse {
2926
3185
  * Details for a received transfer transaction.
2927
3186
  */
2928
3187
  export interface TransferReceivedTransactionDetail {
2929
- asset: 'usdc' | 'usdc.e' | 'eth' | 'avax' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol' | (string & {});
2930
-
2931
- chain:
2932
- | 'ethereum'
2933
- | 'arbitrum'
2934
- | 'avalanche'
2935
- | 'base'
2936
- | 'tempo'
2937
- | 'linea'
2938
- | 'optimism'
2939
- | 'polygon'
2940
- | 'solana'
2941
- | 'zksync_era'
2942
- | 'sepolia'
2943
- | 'arbitrum_sepolia'
2944
- | 'avalanche_fuji'
2945
- | 'base_sepolia'
2946
- | 'linea_testnet'
2947
- | 'optimism_sepolia'
2948
- | 'polygon_amoy'
2949
- | 'solana_devnet'
2950
- | 'solana_testnet';
3188
+ asset:
3189
+ | 'usdc'
3190
+ | 'usdc.e'
3191
+ | 'eth'
3192
+ | 'avax'
3193
+ | 'pol'
3194
+ | 'bnb'
3195
+ | 'usdt'
3196
+ | 'eurc'
3197
+ | 'usdb'
3198
+ | 'sol'
3199
+ | 'trx'
3200
+ | (string & {});
3201
+
3202
+ /**
3203
+ * Supported blockchain network names for wallet balance and transaction queries.
3204
+ */
3205
+ chain: WalletAssetChainNameInput;
2951
3206
 
2952
3207
  display_values: { [key: string]: string };
2953
3208
 
@@ -3010,28 +3265,24 @@ export interface TransferRequestBody {
3010
3265
  * Details for a sent transfer transaction.
3011
3266
  */
3012
3267
  export interface TransferSentTransactionDetail {
3013
- asset: 'usdc' | 'usdc.e' | 'eth' | 'avax' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol' | (string & {});
3014
-
3015
- chain:
3016
- | 'ethereum'
3017
- | 'arbitrum'
3018
- | 'avalanche'
3019
- | 'base'
3020
- | 'tempo'
3021
- | 'linea'
3022
- | 'optimism'
3023
- | 'polygon'
3024
- | 'solana'
3025
- | 'zksync_era'
3026
- | 'sepolia'
3027
- | 'arbitrum_sepolia'
3028
- | 'avalanche_fuji'
3029
- | 'base_sepolia'
3030
- | 'linea_testnet'
3031
- | 'optimism_sepolia'
3032
- | 'polygon_amoy'
3033
- | 'solana_devnet'
3034
- | 'solana_testnet';
3268
+ asset:
3269
+ | 'usdc'
3270
+ | 'usdc.e'
3271
+ | 'eth'
3272
+ | 'avax'
3273
+ | 'pol'
3274
+ | 'bnb'
3275
+ | 'usdt'
3276
+ | 'eurc'
3277
+ | 'usdb'
3278
+ | 'sol'
3279
+ | 'trx'
3280
+ | (string & {});
3281
+
3282
+ /**
3283
+ * Supported blockchain network names for wallet balance and transaction queries.
3284
+ */
3285
+ chain: WalletAssetChainNameInput;
3035
3286
 
3036
3287
  display_values: { [key: string]: string };
3037
3288
 
@@ -3625,7 +3876,45 @@ export interface WalletAPIRevokeAuthorizationKeyInput {
3625
3876
  /**
3626
3877
  * A named asset supported across all chains.
3627
3878
  */
3628
- export type WalletAsset = 'usdc' | 'usdc.e' | 'eth' | 'avax' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol';
3879
+ export type WalletAsset =
3880
+ | 'usdc'
3881
+ | 'usdc.e'
3882
+ | 'eth'
3883
+ | 'avax'
3884
+ | 'pol'
3885
+ | 'bnb'
3886
+ | 'usdt'
3887
+ | 'eurc'
3888
+ | 'usdb'
3889
+ | 'sol'
3890
+ | 'trx';
3891
+
3892
+ /**
3893
+ * Supported blockchain network names for wallet balance and transaction queries.
3894
+ */
3895
+ export type WalletAssetChainNameInput =
3896
+ | 'ethereum'
3897
+ | 'arbitrum'
3898
+ | 'avalanche'
3899
+ | 'base'
3900
+ | 'tempo'
3901
+ | 'linea'
3902
+ | 'optimism'
3903
+ | 'polygon'
3904
+ | 'bsc'
3905
+ | 'solana'
3906
+ | 'tron'
3907
+ | 'zksync_era'
3908
+ | 'sepolia'
3909
+ | 'arbitrum_sepolia'
3910
+ | 'avalanche_fuji'
3911
+ | 'base_sepolia'
3912
+ | 'linea_testnet'
3913
+ | 'optimism_sepolia'
3914
+ | 'polygon_amoy'
3915
+ | 'solana_devnet'
3916
+ | 'solana_testnet'
3917
+ | 'tron_nile';
3629
3918
 
3630
3919
  /**
3631
3920
  * Request body for creating an encrypted, bound user signing key.
@@ -3896,7 +4185,16 @@ export type WalletEntropyType = 'hd' | 'private-key';
3896
4185
  /**
3897
4186
  * A named asset on Ethereum-compatible chains.
3898
4187
  */
3899
- export type WalletEthereumAsset = 'usdc' | 'usdc.e' | 'eth' | 'avax' | 'pol' | 'usdt' | 'eurc' | 'usdb';
4188
+ export type WalletEthereumAsset =
4189
+ | 'usdc'
4190
+ | 'usdc.e'
4191
+ | 'eth'
4192
+ | 'avax'
4193
+ | 'pol'
4194
+ | 'bnb'
4195
+ | 'usdt'
4196
+ | 'eurc'
4197
+ | 'usdb';
3900
4198
 
3901
4199
  /**
3902
4200
  * Request body for exporting a wallet private key.
@@ -3994,6 +4292,8 @@ export type WalletRpcRequestBody =
3994
4292
  | SparkCreateLightningInvoiceRpcInput
3995
4293
  | SparkPayLightningInvoiceRpcInput
3996
4294
  | SparkSignMessageWithIdentityKeyRpcInput
4295
+ | SparkWithdrawRpcInput
4296
+ | SparkGetWithdrawalFeeQuoteRpcInput
3997
4297
  | TronSignTransactionRpcInput
3998
4298
  | TronSendTransactionRpcInput
3999
4299
  | ExportPrivateKeyRpcInput
@@ -4023,6 +4323,8 @@ export type WalletRpcResponse =
4023
4323
  | SparkCreateLightningInvoiceRpcResponse
4024
4324
  | SparkPayLightningInvoiceRpcResponse
4025
4325
  | SparkSignMessageWithIdentityKeyRpcResponse
4326
+ | SparkWithdrawRpcResponse
4327
+ | SparkGetWithdrawalFeeQuoteRpcResponse
4026
4328
  | TronSignTransactionRpcResponse
4027
4329
  | TronSendTransactionRpcResponse
4028
4330
  | ExportPrivateKeyRpcResponse
@@ -4033,6 +4335,11 @@ export type WalletRpcResponse =
4033
4335
  */
4034
4336
  export type WalletSolanaAsset = 'sol' | 'usdc' | 'eurc' | 'usdb';
4035
4337
 
4338
+ /**
4339
+ * A named asset on Tron.
4340
+ */
4341
+ export type WalletTronAsset = 'trx' | 'usdt' | 'usdc';
4342
+
4036
4343
  /**
4037
4344
  * Request body for updating a wallet. `owner` and `owner_id` are mutually
4038
4345
  * exclusive.
@@ -4157,6 +4464,13 @@ export interface WalletUpdateParams {
4157
4464
  }
4158
4465
 
4159
4466
  export interface WalletListParams extends CursorParams {
4467
+ /**
4468
+ * A blockchain wallet address. Ethereum addresses are normalized to EIP-55
4469
+ * checksum format. Solana addresses are validated as base58. All other chain
4470
+ * addresses (Stellar, Tron, Sui, Aptos, etc.) are accepted as-is.
4471
+ */
4472
+ address?: Address;
4473
+
4160
4474
  /**
4161
4475
  * Filter wallets by authorization public key. Returns wallets owned by key quorums
4162
4476
  * that include the specified P-256 public key (base64-encoded DER format). Cannot
@@ -4269,6 +4583,8 @@ export type WalletRpcParams =
4269
4583
  | WalletRpcParams.SparkCreateLightningInvoiceRpcInput
4270
4584
  | WalletRpcParams.SparkPayLightningInvoiceRpcInput
4271
4585
  | WalletRpcParams.SparkSignMessageWithIdentityKeyRpcInput
4586
+ | WalletRpcParams.SparkWithdrawRpcInput
4587
+ | WalletRpcParams.SparkGetWithdrawalFeeQuoteRpcInput
4272
4588
  | WalletRpcParams.TronSignTransactionRpcInput
4273
4589
  | WalletRpcParams.TronSendTransactionRpcInput
4274
4590
  | WalletRpcParams.ExportPrivateKeyRpcInput
@@ -5154,6 +5470,76 @@ export declare namespace WalletRpcParams {
5154
5470
  'privy-request-expiry'?: string;
5155
5471
  }
5156
5472
 
5473
+ export interface SparkWithdrawRpcInput {
5474
+ /**
5475
+ * Body param
5476
+ */
5477
+ method: 'withdraw';
5478
+
5479
+ /**
5480
+ * Body param: Parameters for the Spark `withdraw` RPC.
5481
+ */
5482
+ params: SparkWithdrawRpcInputParams;
5483
+
5484
+ /**
5485
+ * Body param: The Spark network.
5486
+ */
5487
+ network?: SparkNetwork;
5488
+
5489
+ /**
5490
+ * Header param: Request authorization signature. If multiple signatures are
5491
+ * required, they should be comma separated.
5492
+ */
5493
+ 'privy-authorization-signature'?: string;
5494
+
5495
+ /**
5496
+ * Header param: Idempotency keys ensure API requests are executed only once within
5497
+ * a 24-hour window.
5498
+ */
5499
+ 'privy-idempotency-key'?: string;
5500
+
5501
+ /**
5502
+ * Header param: Request expiry. Value is a Unix timestamp in milliseconds
5503
+ * representing the deadline by which the request must be processed.
5504
+ */
5505
+ 'privy-request-expiry'?: string;
5506
+ }
5507
+
5508
+ export interface SparkGetWithdrawalFeeQuoteRpcInput {
5509
+ /**
5510
+ * Body param
5511
+ */
5512
+ method: 'getWithdrawalFeeQuote';
5513
+
5514
+ /**
5515
+ * Body param: Parameters for the Spark `getWithdrawalFeeQuote` RPC.
5516
+ */
5517
+ params: SparkGetWithdrawalFeeQuoteRpcInputParams;
5518
+
5519
+ /**
5520
+ * Body param: The Spark network.
5521
+ */
5522
+ network?: SparkNetwork;
5523
+
5524
+ /**
5525
+ * Header param: Request authorization signature. If multiple signatures are
5526
+ * required, they should be comma separated.
5527
+ */
5528
+ 'privy-authorization-signature'?: string;
5529
+
5530
+ /**
5531
+ * Header param: Idempotency keys ensure API requests are executed only once within
5532
+ * a 24-hour window.
5533
+ */
5534
+ 'privy-idempotency-key'?: string;
5535
+
5536
+ /**
5537
+ * Header param: Request expiry. Value is a Unix timestamp in milliseconds
5538
+ * representing the deadline by which the request must be processed.
5539
+ */
5540
+ 'privy-request-expiry'?: string;
5541
+ }
5542
+
5157
5543
  export interface TronSignTransactionRpcInput {
5158
5544
  /**
5159
5545
  * Body param
@@ -5294,6 +5680,7 @@ export declare namespace WalletRpcParams {
5294
5680
 
5295
5681
  Wallets.Balance = Balance;
5296
5682
  Wallets.Transactions = Transactions;
5683
+ Wallets.Actions = Actions;
5297
5684
 
5298
5685
  export declare namespace Wallets {
5299
5686
  export {
@@ -5421,9 +5808,13 @@ export declare namespace Wallets {
5421
5808
  type SparkClaimStaticDepositRpcInputParams as SparkClaimStaticDepositRpcInputParams,
5422
5809
  type SparkClaimStaticDepositRpcResponse as SparkClaimStaticDepositRpcResponse,
5423
5810
  type SparkClaimStaticDepositRpcResponseData as SparkClaimStaticDepositRpcResponseData,
5811
+ type SparkCoopExitFeeQuote as SparkCoopExitFeeQuote,
5812
+ type SparkCoopExitRequest as SparkCoopExitRequest,
5424
5813
  type SparkCreateLightningInvoiceRpcInput as SparkCreateLightningInvoiceRpcInput,
5425
5814
  type SparkCreateLightningInvoiceRpcInputParams as SparkCreateLightningInvoiceRpcInputParams,
5426
5815
  type SparkCreateLightningInvoiceRpcResponse as SparkCreateLightningInvoiceRpcResponse,
5816
+ type SparkCurrencyAmount as SparkCurrencyAmount,
5817
+ type SparkExitSpeed as SparkExitSpeed,
5427
5818
  type SparkGetBalanceRpcInput as SparkGetBalanceRpcInput,
5428
5819
  type SparkGetBalanceRpcResponse as SparkGetBalanceRpcResponse,
5429
5820
  type SparkGetClaimStaticDepositQuoteRpcInput as SparkGetClaimStaticDepositQuoteRpcInput,
@@ -5433,6 +5824,9 @@ export declare namespace Wallets {
5433
5824
  type SparkGetStaticDepositAddressRpcInput as SparkGetStaticDepositAddressRpcInput,
5434
5825
  type SparkGetStaticDepositAddressRpcResponse as SparkGetStaticDepositAddressRpcResponse,
5435
5826
  type SparkGetStaticDepositAddressRpcResponseData as SparkGetStaticDepositAddressRpcResponseData,
5827
+ type SparkGetWithdrawalFeeQuoteRpcInput as SparkGetWithdrawalFeeQuoteRpcInput,
5828
+ type SparkGetWithdrawalFeeQuoteRpcInputParams as SparkGetWithdrawalFeeQuoteRpcInputParams,
5829
+ type SparkGetWithdrawalFeeQuoteRpcResponse as SparkGetWithdrawalFeeQuoteRpcResponse,
5436
5830
  type SparkLightningFee as SparkLightningFee,
5437
5831
  type SparkLightningReceiveRequest as SparkLightningReceiveRequest,
5438
5832
  type SparkLightningSendRequest as SparkLightningSendRequest,
@@ -5460,6 +5854,9 @@ export declare namespace Wallets {
5460
5854
  type SparkTransferTokensRpcResponseData as SparkTransferTokensRpcResponseData,
5461
5855
  type SparkUserTokenMetadata as SparkUserTokenMetadata,
5462
5856
  type SparkWalletLeaf as SparkWalletLeaf,
5857
+ type SparkWithdrawRpcInput as SparkWithdrawRpcInput,
5858
+ type SparkWithdrawRpcInputParams as SparkWithdrawRpcInputParams,
5859
+ type SparkWithdrawRpcResponse as SparkWithdrawRpcResponse,
5463
5860
  type SuiCommandName as SuiCommandName,
5464
5861
  type SwapSubmissionStatus as SwapSubmissionStatus,
5465
5862
  type TempoAaAuthorization as TempoAaAuthorization,
@@ -5469,6 +5866,7 @@ export declare namespace Wallets {
5469
5866
  type TokenTransferDestination as TokenTransferDestination,
5470
5867
  type TokenTransferSource as TokenTransferSource,
5471
5868
  type TotalFeeConfigurationBps as TotalFeeConfigurationBps,
5869
+ type TransactionChainNameInput as TransactionChainNameInput,
5472
5870
  type TransactionDetail as TransactionDetail,
5473
5871
  type TransactionTokenAddressInput as TransactionTokenAddressInput,
5474
5872
  type TransferQuoteRequestBody as TransferQuoteRequestBody,
@@ -5505,6 +5903,7 @@ export declare namespace Wallets {
5505
5903
  type WalletAPIRegisterAuthorizationKeyInput as WalletAPIRegisterAuthorizationKeyInput,
5506
5904
  type WalletAPIRevokeAuthorizationKeyInput as WalletAPIRevokeAuthorizationKeyInput,
5507
5905
  type WalletAsset as WalletAsset,
5906
+ type WalletAssetChainNameInput as WalletAssetChainNameInput,
5508
5907
  type WalletAuthenticateBoundEncryptedRequestBody as WalletAuthenticateBoundEncryptedRequestBody,
5509
5908
  type WalletAuthenticateBoundRequestBody as WalletAuthenticateBoundRequestBody,
5510
5909
  type WalletAuthenticateBoundUnencryptedRequestBody as WalletAuthenticateBoundUnencryptedRequestBody,
@@ -5530,6 +5929,7 @@ export declare namespace Wallets {
5530
5929
  type WalletRpcRequestBody as WalletRpcRequestBody,
5531
5930
  type WalletRpcResponse as WalletRpcResponse,
5532
5931
  type WalletSolanaAsset as WalletSolanaAsset,
5932
+ type WalletTronAsset as WalletTronAsset,
5533
5933
  type WalletUpdateRequestBody as WalletUpdateRequestBody,
5534
5934
  type WalletsCursor as WalletsCursor,
5535
5935
  type WalletCreateParams as WalletCreateParams,
@@ -5552,4 +5952,51 @@ export declare namespace Wallets {
5552
5952
  type TransactionGetResponse as TransactionGetResponse,
5553
5953
  type TransactionGetParams as TransactionGetParams,
5554
5954
  };
5955
+
5956
+ export {
5957
+ Actions as Actions,
5958
+ type AaveVaultDetails as AaveVaultDetails,
5959
+ type CustodianTransactionWalletActionStep as CustodianTransactionWalletActionStep,
5960
+ type CustodianTransactionWalletActionStepStatus as CustodianTransactionWalletActionStepStatus,
5961
+ type EvmTransactionWalletActionStep as EvmTransactionWalletActionStep,
5962
+ type EvmUserOperationEntrypointVersion as EvmUserOperationEntrypointVersion,
5963
+ type EvmUserOperationWalletActionStep as EvmUserOperationWalletActionStep,
5964
+ type EvmWalletActionStepStatus as EvmWalletActionStepStatus,
5965
+ type EarnAsset as EarnAsset,
5966
+ type EarnDepositActionResponse as EarnDepositActionResponse,
5967
+ type EarnDepositRequestBody as EarnDepositRequestBody,
5968
+ type EarnFeeCollectActionResponse as EarnFeeCollectActionResponse,
5969
+ type EarnFeeCollectRequestBody as EarnFeeCollectRequestBody,
5970
+ type EarnIncentiveClaimActionResponse as EarnIncentiveClaimActionResponse,
5971
+ type EarnIncentiveClaimRequestBody as EarnIncentiveClaimRequestBody,
5972
+ type EarnIncentiveRewardEntry as EarnIncentiveRewardEntry,
5973
+ type EarnIncentiveRewardsQuery as EarnIncentiveRewardsQuery,
5974
+ type EarnIncentiveRewardsResponse as EarnIncentiveRewardsResponse,
5975
+ type EarnIncetiveClaimRewardEntry as EarnIncetiveClaimRewardEntry,
5976
+ type EarnWithdrawActionResponse as EarnWithdrawActionResponse,
5977
+ type EarnWithdrawRequestBody as EarnWithdrawRequestBody,
5978
+ type EthereumEarnPositionQuery as EthereumEarnPositionQuery,
5979
+ type EthereumEarnPositionResponse as EthereumEarnPositionResponse,
5980
+ type EthereumEarnProvider as EthereumEarnProvider,
5981
+ type EthereumEarnVaultDetailsResponse as EthereumEarnVaultDetailsResponse,
5982
+ type ExternalTransactionWalletActionStep as ExternalTransactionWalletActionStep,
5983
+ type ExternalTransactionWalletActionStepStatus as ExternalTransactionWalletActionStepStatus,
5984
+ type FailureReason as FailureReason,
5985
+ type ListWalletActionsQuery as ListWalletActionsQuery,
5986
+ type ListWalletActionsResponse as ListWalletActionsResponse,
5987
+ type MorphoVaultDetails as MorphoVaultDetails,
5988
+ type SvmTransactionWalletActionStep as SvmTransactionWalletActionStep,
5989
+ type SvmWalletActionStepStatus as SvmWalletActionStepStatus,
5990
+ type SwapActionResponse as SwapActionResponse,
5991
+ type TvmTransactionWalletActionStep as TvmTransactionWalletActionStep,
5992
+ type TvmWalletActionStepStatus as TvmWalletActionStepStatus,
5993
+ type TransferActionResponse as TransferActionResponse,
5994
+ type VedaVaultDetails as VedaVaultDetails,
5995
+ type WalletActionInclude as WalletActionInclude,
5996
+ type WalletActionResponse as WalletActionResponse,
5997
+ type WalletActionStatus as WalletActionStatus,
5998
+ type WalletActionStep as WalletActionStep,
5999
+ type WalletActionStepType as WalletActionStepType,
6000
+ type WalletActionType as WalletActionType,
6001
+ };
5555
6002
  }