@privy-io/api-types 0.14.0 → 0.16.0

package/src/resources/wallet-actions.ts

@@ -1,9 +1,45 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
+import * as WalletsAPI from './wallets/wallets';
 
 export class WalletActions extends APIResource {}
 
+/**
+ * A wallet action step representing a transaction executed by a custodian (e.g.
+ * Bridge).
+ */
+export interface CustodianTransactionWalletActionStep {
+  /**
+   * Identifier of the custodian executing this transaction (e.g. "bridge").
+   */
+  custodian: string;
+
+  /**
+   * Status of a custodian transaction step in a wallet action.
+   */
+  status: CustodianTransactionWalletActionStepStatus;
+
+  type: 'custodian_transaction';
+
+  /**
+   * A description of why a wallet action (or a step within a wallet action) failed.
+   */
+  failure_reason?: FailureReason;
+}
+
+/**
+ * Status of a custodian transaction step in a wallet action.
+ */
+export type CustodianTransactionWalletActionStepStatus =
+  | 'preparing'
+  | 'queued'
+  | 'custodian_reviewing'
+  | 'pending'
+  | 'confirmed'
+  | 'rejected'
+  | 'failed';
+
 /**
  * A wallet action step consisting of an EVM transaction.
  */
@@ -30,6 +66,12 @@ export interface EvmTransactionWalletActionStep {
    * A description of why a wallet action (or a step within a wallet action) failed.
    */
   failure_reason?: FailureReason;
+
+  /**
+   * Whether this step has reached on-chain finality. Absent until finality is
+   * confirmed.
+   */
+  finalized?: boolean;
 }
 
 /**
@@ -69,6 +111,17 @@ export interface EvmUserOperationWalletActionStep {
    * A description of why a wallet action (or a step within a wallet action) failed.
    */
   failure_reason?: FailureReason;
+
+  /**
+   * Whether this step has reached on-chain finality. Absent until finality is
+   * confirmed.
+   */
+  finalized?: boolean;
+
+  /**
+   * Amount charged in USD for gas sponsorship on this step.
+   */
+  gas_credits_charged_usd?: string;
 }
 
 /**
@@ -272,6 +325,57 @@ export interface EarnIncentiveClaimRequestBody {
   chain: string;
 }
 
+/**
+ * A reward token with claimed and unclaimed amounts.
+ */
+export interface EarnIncentiveRewardEntry {
+  /**
+   * Total amount already claimed, in smallest unit.
+   */
+  amount_claimed: string;
+
+  /**
+   * Amount available to claim on-chain but not yet claimed, in smallest unit.
+   */
+  amount_unclaimed: string;
+
+  /**
+   * Address of the reward token.
+   */
+  token_address: string;
+
+  /**
+   * Symbol of the reward token (e.g. "MORPHO").
+   */
+  token_symbol: string;
+
+  /**
+   * Number of decimals for the reward token.
+   */
+  token_decimals?: number;
+}
+
+/**
+ * Query parameters for fetching incentive rewards.
+ */
+export interface EarnIncentiveRewardsQuery {
+  /**
+   * Chain name to fetch rewards for (e.g. "base", "ethereum").
+   */
+  chain: string;
+}
+
+/**
+ * All incentive rewards for a wallet, with claimed and unclaimed amounts per
+ * token.
+ */
+export interface EarnIncentiveRewardsResponse {
+  /**
+   * Reward tokens with their claimed and unclaimed amounts.
+   */
+  rewards: Array<EarnIncentiveRewardEntry>;
+}
+
 /**
  * A specific reward token and amount associated with an earn incentive claim.
  */
@@ -413,6 +517,11 @@ export interface EthereumEarnPositionQuery {
    * The vault ID to get position for.
    */
   vault_id: string;
+
+  /**
+   * Include archived wallets in lookup. Defaults to false.
+   */
+  include_archived?: boolean;
 }
 
 /**
@@ -551,6 +660,29 @@ export interface FailureReason {
   details?: unknown;
 }
 
+/**
+ * Query parameters for listing wallet actions.
+ */
+export interface ListWalletActionsQuery {
+  cursor?: string;
+
+  limit?: number | null;
+
+  /**
+   * Type of wallet action
+   */
+  type?: WalletActionType;
+}
+
+/**
+ * Paginated list of wallet actions.
+ */
+export interface ListWalletActionsResponse {
+  data: Array<WalletActionResponse>;
+
+  next_cursor: string | null;
+}
+
 /**
  * A wallet action step consisting of an SVM (Solana) transaction.
  */
@@ -576,6 +708,17 @@ export interface SvmTransactionWalletActionStep {
    * A description of why a wallet action (or a step within a wallet action) failed.
    */
   failure_reason?: FailureReason;
+
+  /**
+   * Whether this step has reached on-chain finality. Absent until finality is
+   * confirmed.
+   */
+  finalized?: boolean;
+
+  /**
+   * Amount charged in USD for gas sponsorship on this step.
+   */
+  gas_credits_charged_usd?: string;
 }
 
 /**
@@ -586,7 +729,6 @@ export type SvmWalletActionStepStatus =
   | 'queued'
   | 'pending'
   | 'confirmed'
-  | 'finalized'
   | 'rejected'
   | 'reverted'
   | 'failed';
@@ -642,17 +784,92 @@ export interface SwapActionResponse {
    */
   wallet_id: string;
 
+  /**
+   * Recipient address on the destination chain. Present for cross-chain swaps. May
+   * differ from the source wallet address when swapping between chain types (e.g.
+   * EVM to Solana).
+   */
+  destination_address?: string;
+
+  /**
+   * Destination chain CAIP-2 identifier. Present for cross-chain swaps.
+   */
+  destination_caip2?: string;
+
+  /**
+   * Estimated fee breakdown from the provider quote. Only present for cross-chain
+   * swaps. Populated after on-chain confirmation.
+   */
+  estimated_fees?: Array<WalletsAPI.FeeLineItem> | null;
+
+  /**
+   * Gas cost for a blockchain action. Includes both raw base-unit amount and a
+   * human-readable decimal string, plus the gas token symbol.
+   */
+  estimated_gas?: WalletsAPI.Gas | null;
+
   /**
    * A description of why a wallet action (or a step within a wallet action) failed.
    */
   failure_reason?: FailureReason;
 
+  /**
+   * Actual fees paid for the swap. Populated after on-chain confirmation. Only
+   * present for cross-chain swaps.
+   */
+  fees?: Array<WalletsAPI.FeeLineItem> | null;
+
+  /**
+   * Gas cost for a blockchain action. Includes both raw base-unit amount and a
+   * human-readable decimal string, plus the gas token symbol.
+   */
+  gas?: WalletsAPI.Gas | null;
+
   /**
    * The steps of the wallet action. Only returned if `?include=steps` is provided.
    */
   steps?: Array<WalletActionStep>;
 }
 
+/**
+ * A wallet action step consisting of a TVM (Tron) transaction.
+ */
+export interface TvmTransactionWalletActionStep {
+  /**
+   * CAIP-2 chain identifier for the Tron network.
+   */
+  caip2: string;
+
+  /**
+   * Status of a TVM (Tron) step in a wallet action.
+   */
+  status: TvmWalletActionStepStatus;
+
+  /**
+   * The Tron transaction ID. Null until broadcast.
+   */
+  transaction_id: string | null;
+
+  type: 'tvm_transaction';
+
+  /**
+   * A description of why a wallet action (or a step within a wallet action) failed.
+   */
+  failure_reason?: FailureReason;
+}
+
+/**
+ * Status of a TVM (Tron) step in a wallet action.
+ */
+export type TvmWalletActionStepStatus =
+  | 'preparing'
+  | 'queued'
+  | 'pending'
+  | 'confirmed'
+  | 'rejected'
+  | 'reverted'
+  | 'failed';
+
 /**
  * Response for a transfer action.
  */
@@ -672,6 +889,13 @@ export interface TransferActionResponse {
    */
   destination_address: string;
 
+  /**
+   * Amount received on the destination chain. For exact_output cross-chain
+   * transfers, set at creation (the guaranteed exact amount). For exact_input
+   * cross-chain transfers, null until fill confirmation.
+   */
+  destination_amount: string | null;
+
   /**
    * Chain name (e.g. "base", "ethereum").
    */
@@ -690,10 +914,9 @@ export interface TransferActionResponse {
   wallet_id: string;
 
   /**
-   * Amount received on the destination chain. Populated immediately for exact_output
-   * transfers, or after fill confirmation for exact_input transfers.
+   * Whether the amount refers to the input token or output token.
    */
-  destination_amount?: string;
+  amount_type?: WalletsAPI.AmountType;
 
   /**
    * Destination asset for cross-asset transfers. Omitted for same-asset transfers.
@@ -705,14 +928,38 @@ export interface TransferActionResponse {
    */
   destination_chain?: string;
 
+  /**
+   * Estimated fee breakdown from the provider quote. Only present for cross-chain or
+   * cross-asset transfers. Populated after on-chain confirmation.
+   */
+  estimated_fees?: Array<WalletsAPI.FeeLineItem> | null;
+
+  /**
+   * Gas cost for a blockchain action. Includes both raw base-unit amount and a
+   * human-readable decimal string, plus the gas token symbol.
+   */
+  estimated_gas?: WalletsAPI.Gas | null;
+
   /**
    * A description of why a wallet action (or a step within a wallet action) failed.
    */
   failure_reason?: FailureReason;
 
   /**
-   * Decimal amount sent on the source chain (e.g. "1.5"). Omitted for exact_output
-   * cross-chain transfers until the source amount is determined.
+   * Actual fees paid for the transfer. Populated after on-chain confirmation. Only
+   * present for cross-chain transfers.
+   */
+  fees?: Array<WalletsAPI.FeeLineItem> | null;
+
+  /**
+   * Gas cost for a blockchain action. Includes both raw base-unit amount and a
+   * human-readable decimal string, plus the gas token symbol.
+   */
+  gas?: WalletsAPI.Gas | null;
+
+  /**
+   * Decimal amount sent on the source chain (e.g. "1.5"). For exact_output
+   * cross-chain transfers, null until fill confirmation.
    */
   source_amount?: string;
 
@@ -740,6 +987,11 @@ export interface TransferActionResponse {
   steps?: Array<WalletActionStep>;
 }
 
+/**
+ * Expandable relations to include on a wallet action response.
+ */
+export type WalletActionInclude = 'steps';
+
 /**
  * Response for a wallet action, discriminated on type.
  */
@@ -762,7 +1014,9 @@ export type WalletActionStep =
   | EvmTransactionWalletActionStep
   | EvmUserOperationWalletActionStep
   | SvmTransactionWalletActionStep
-  | ExternalTransactionWalletActionStep;
+  | TvmTransactionWalletActionStep
+  | ExternalTransactionWalletActionStep
+  | CustodianTransactionWalletActionStep;
 
 /**
  * Type of a wallet action step.
@@ -771,7 +1025,9 @@ export type WalletActionStepType =
   | 'evm_transaction'
   | 'evm_user_operation'
   | 'svm_transaction'
-  | 'external_transaction';
+  | 'tvm_transaction'
+  | 'external_transaction'
+  | 'custodian_transaction';
 
 /**
  * Type of wallet action
@@ -785,6 +1041,8 @@ export type WalletActionType =
 
 export declare namespace WalletActions {
   export {
+    type CustodianTransactionWalletActionStep as CustodianTransactionWalletActionStep,
+    type CustodianTransactionWalletActionStepStatus as CustodianTransactionWalletActionStepStatus,
     type EvmTransactionWalletActionStep as EvmTransactionWalletActionStep,
     type EvmUserOperationWalletActionStep as EvmUserOperationWalletActionStep,
     type EvmWalletActionStepStatus as EvmWalletActionStepStatus,
@@ -793,6 +1051,9 @@ export declare namespace WalletActions {
     type EarnDepositRequestBody as EarnDepositRequestBody,
     type EarnIncentiveClaimActionResponse as EarnIncentiveClaimActionResponse,
     type EarnIncentiveClaimRequestBody as EarnIncentiveClaimRequestBody,
+    type EarnIncentiveRewardEntry as EarnIncentiveRewardEntry,
+    type EarnIncentiveRewardsQuery as EarnIncentiveRewardsQuery,
+    type EarnIncentiveRewardsResponse as EarnIncentiveRewardsResponse,
     type EarnIncetiveClaimRewardEntry as EarnIncetiveClaimRewardEntry,
     type EarnWithdrawActionResponse as EarnWithdrawActionResponse,
     type EarnWithdrawRequestBody as EarnWithdrawRequestBody,
@@ -803,10 +1064,15 @@ export declare namespace WalletActions {
     type ExternalTransactionWalletActionStep as ExternalTransactionWalletActionStep,
     type ExternalTransactionWalletActionStepStatus as ExternalTransactionWalletActionStepStatus,
     type FailureReason as FailureReason,
+    type ListWalletActionsQuery as ListWalletActionsQuery,
+    type ListWalletActionsResponse as ListWalletActionsResponse,
     type SvmTransactionWalletActionStep as SvmTransactionWalletActionStep,
     type SvmWalletActionStepStatus as SvmWalletActionStepStatus,
     type SwapActionResponse as SwapActionResponse,
+    type TvmTransactionWalletActionStep as TvmTransactionWalletActionStep,
+    type TvmWalletActionStepStatus as TvmWalletActionStepStatus,
     type TransferActionResponse as TransferActionResponse,
+    type WalletActionInclude as WalletActionInclude,
     type WalletActionResponse as WalletActionResponse,
     type WalletActionStatus as WalletActionStatus,
     type WalletActionStep as WalletActionStep,

package/src/resources/wallets/balance.ts

@@ -35,11 +35,12 @@ export interface BalanceGetResponse {
 
 export namespace BalanceGetResponse {
   export interface Balance {
-    asset: 'usdc' | 'usdc.e' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol' | (string & {});
+    asset: 'usdc' | 'usdc.e' | 'eth' | 'avax' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol' | (string & {});
 
     chain:
       | 'ethereum'
       | 'arbitrum'
+      | 'avalanche'
       | 'base'
       | 'tempo'
       | 'linea'
@@ -49,6 +50,7 @@ export namespace BalanceGetResponse {
       | 'zksync_era'
       | 'sepolia'
       | 'arbitrum_sepolia'
+      | 'avalanche_fuji'
       | 'base_sepolia'
       | 'linea_testnet'
       | 'optimism_sepolia'
@@ -81,6 +83,7 @@ export interface BalanceGetParams {
     | 'usdc'
     | 'usdc.e'
     | 'eth'
+    | 'avax'
     | 'pol'
     | 'usdt'
     | 'eurc'
@@ -95,6 +98,7 @@ export interface BalanceGetParams {
   chain?:
     | 'ethereum'
     | 'arbitrum'
+    | 'avalanche'
     | 'base'
     | 'tempo'
     | 'linea'
@@ -104,6 +108,7 @@ export interface BalanceGetParams {
     | 'zksync_era'
     | 'sepolia'
     | 'arbitrum_sepolia'
+    | 'avalanche_fuji'
     | 'base_sepolia'
     | 'linea_testnet'
     | 'optimism_sepolia'
@@ -113,6 +118,7 @@ export interface BalanceGetParams {
     | Array<
         | 'ethereum'
         | 'arbitrum'
+        | 'avalanche'
         | 'base'
         | 'tempo'
         | 'linea'
@@ -122,6 +128,7 @@ export interface BalanceGetParams {
         | 'zksync_era'
         | 'sepolia'
         | 'arbitrum_sepolia'
+        | 'avalanche_fuji'
         | 'base_sepolia'
         | 'linea_testnet'
         | 'optimism_sepolia'
@@ -130,6 +137,11 @@ export interface BalanceGetParams {
         | 'solana_testnet'
       >;
 
+  /**
+   * Include archived wallets in lookup. Defaults to false.
+   */
+  include_archived?: boolean;
+
   /**
    * If set, balances are converted to the specified fiat currency. Not supported
    * when `token` is provided.

package/src/resources/wallets/index.ts

@@ -4,9 +4,13 @@ export { Balance, type BalanceGetResponse, type BalanceGetParams } from './balan
 export { Transactions, type TransactionGetResponse, type TransactionGetParams } from './transactions';
 export {
   Wallets,
+  type AccessListEntry,
   type AdditionalSignerInput,
   type AdditionalSignerItemInput,
   type Address,
+  type AdvancedSwapPlatformFee,
+  type AdvancedSwapRequestBody,
+  type AdvancedSwapResponse,
   type AmountType,
   type AuthorizationKeyDashboardResponse,
   type AuthorizationKeyResponse,
@@ -18,6 +22,10 @@ export {
   type CustodialWalletCreateInput,
   type CustodialWalletProvider,
   type CustomTokenTransferSource,
+  type DeveloperFee,
+  type EncryptedAuthorizationKey,
+  type EncryptedBoundAuthenticateResponse,
+  type EncryptedWalletAuthenticateResponse,
   type EthereumPersonalSignRpcInput,
   type EthereumPersonalSignRpcInputParams,
   type EthereumPersonalSignRpcResponse,
@@ -61,7 +69,10 @@ export {
   type ExportSeedPhraseRpcResponse,
   type ExportType,
   type ExtendedChainType,
+  type FeeConfiguration,
+  type FeeLineItem,
   type FirstClassChainType,
+  type Gas,
   type GetByWalletAddressRequestBody,
   type HDInitInput,
   type HDPath,
@@ -70,6 +81,7 @@ export {
   type HpkeEncryption,
   type HpkeImportConfig,
   type Hex,
+  type IntentBinding,
   type NamedTokenTransferSource,
   type OutputWithPreviousTransactionData,
   type PolicyInput,
@@ -77,7 +89,9 @@ export {
   type PrivateKeyExportResponse,
   type PrivateKeyInitInput,
   type PrivateKeySubmitInput,
+  type PrivyFee,
   type Quantity,
+  type RawBoundAuthenticateResponse,
   type RawSignBytesEncoding,
   type RawSignBytesHashFunction,
   type RawSignBytesParams,
@@ -86,9 +100,13 @@ export {
   type RawSignInputParams,
   type RawSignResponse,
   type RawSignResponseData,
+  type RawWalletAuthenticateResponse,
   type RecipientPublicKey,
+  type RelayerFee,
   type SeedPhraseExportInput,
   type SeedPhraseExportResponse,
+  type SignatureOptions,
+  type SignatureType,
   type SigningAlgorithm,
   type SolanaRpcInput,
   type SolanaRpcResponse,
@@ -150,17 +168,36 @@ export {
   type SparkUserTokenMetadata,
   type SparkWalletLeaf,
   type SuiCommandName,
+  type SwapSubmissionStatus,
   type TempoAaAuthorization,
   type TempoCall,
   type TempoFeePayerSignature,
   type TokenOutput,
   type TokenTransferDestination,
   type TokenTransferSource,
+  type TotalFeeConfigurationBps,
   type TransactionDetail,
   type TransactionTokenAddressInput,
+  type TransferQuoteRequestBody,
+  type TransferQuoteResponse,
   type TransferReceivedTransactionDetail,
   type TransferRequestBody,
   type TransferSentTransactionDetail,
+  type TronContract,
+  type TronRawDataForSend,
+  type TronRawDataForSign,
+  type TronRpcInput,
+  type TronRpcResponse,
+  type TronSendTransactionRpcInput,
+  type TronSendTransactionRpcInputParams,
+  type TronSendTransactionRpcResponse,
+  type TronSendTransactionRpcResponseData,
+  type TronSignTransactionRpcInput,
+  type TronSignTransactionRpcInputParams,
+  type TronSignTransactionRpcResponse,
+  type TronSignTransactionRpcResponseData,
+  type TronTransferContract,
+  type TronTriggerSmartContract,
   type TypedDataDomainInputParams,
   type TypedDataTypeFieldInput,
   type TypedDataTypesInputParams,
@@ -168,12 +205,17 @@ export {
   type UnsignedStandardEthereumTransaction,
   type UnsignedTempoTransaction,
   type UserOperationInput,
+  type UserSigningKeyBinding,
   type Wallet,
   type WalletAdditionalSigner,
   type WalletAdditionalSignerItem,
   type WalletAPIRegisterAuthorizationKeyInput,
   type WalletAPIRevokeAuthorizationKeyInput,
   type WalletAsset,
+  type WalletAuthenticateBoundEncryptedRequestBody,
+  type WalletAuthenticateBoundRequestBody,
+  type WalletAuthenticateBoundUnencryptedRequestBody,
+  type WalletAuthenticateIntentsResponse,
   type WalletAuthenticateRequestBody,
   type WalletAuthenticateWithJwtResponse,
   type WalletAuthorizationHeaders,
@@ -200,6 +242,7 @@ export {
   type WalletUpdateParams,
   type WalletListParams,
   type WalletExportParams,
+  type WalletGetParams,
   type WalletRawSignParams,
   type WalletRpcParams,
   type WalletsCursor,

package/src/resources/wallets/transactions.ts

@@ -93,6 +93,7 @@ export interface TransactionGetParams {
     | 'usdc'
     | 'usdc.e'
     | 'eth'
+    | 'avax'
     | 'pol'
     | 'usdt'
     | 'eurc'
@@ -102,6 +103,11 @@ export interface TransactionGetParams {
 
   cursor?: string;
 
+  /**
+   * Include archived wallets in lookup. Defaults to false.
+   */
+  include_archived?: boolean;
+
   limit?: number | null;
 
   tx_hash?: string;