@privy-io/api-types 0.21.0 → 0.22.0

package/src/resources/wallets/wallets.ts

@@ -22,6 +22,8 @@ import {
   EarnIncentiveRewardsQuery,
   EarnIncentiveRewardsResponse,
   EarnIncetiveClaimRewardEntry,
+  EarnPositionApyAllocation,
+  EarnPositionApyType,
   EarnWithdrawActionResponse,
   EarnWithdrawRequestBody,
   EthereumEarnPositionQuery,
@@ -571,6 +573,22 @@ export interface AttachWalletAutomationRequestBody {
   params?: WalletAutomationsAPI.SwapAttachmentParams;
 }
 
+/**
+ * A summary of an automation attached to a wallet.
+ */
+export interface AttachedWalletAutomation {
+  /**
+   * ID of the automation.
+   */
+  id: string;
+
+  /**
+   * Whether this attachment is currently active — true only if both the attachment
+   * and the underlying automation are enabled.
+   */
+  enabled: boolean;
+}
+
 /**
  * Dashboard response for a wallet authorization key (includes role, which is an
  * internal-only concept).
@@ -638,7 +656,7 @@ export interface CreateCryptoDepositAccountWithConfigRequestBody {
  */
 export interface CreateCryptoDepositAccountWithRouteRequestBody {
   /**
-   * An asset on a chain. Uses a human-readable alias (usdc, base) when one is on
+   * An asset on a chain. Uses a human-readable alias (usdc, tempo) when one is on
    * file, otherwise the raw asset address and CAIP-2.
    */
   destination: CryptoDepositAsset;
@@ -652,6 +670,88 @@ export interface CreateCryptoDepositAccountWithRouteRequestBody {
   type: 'inline_route';
 }
 
+/**
+ * EVM CAIP-2 chain identifier (e.g. "eip155:4217" for Tempo, "eip155:1" for
+ * Ethereum).
+ */
+export type CryptoDepositAccountCaip2 = string;
+
+/**
+ * Chain metadata for rendering the crypto deposit-account source picker.
+ */
+export interface CryptoDepositAccountChain {
+  /**
+   * EVM CAIP-2 chain identifier (e.g. "eip155:4217" for Tempo, "eip155:1" for
+   * Ethereum).
+   */
+  caip2: CryptoDepositAccountCaip2;
+
+  /**
+   * Numeric chain id used by some clients as an alias.
+   */
+  chain_id: number;
+
+  display_name: string;
+
+  /**
+   * URL of the chain icon.
+   */
+  icon_url: string;
+
+  /**
+   * Execution VM, e.g. evm or svm.
+   */
+  vm_type: string;
+}
+
+/**
+ * Source-token catalog for crypto deposit accounts. Only automation-sweepable,
+ * gas-sponsored mainnets.
+ */
+export interface CryptoDepositAccountConfigResponse {
+  chains: { [key: string]: CryptoDepositAccountChain };
+
+  currencies: Array<CryptoDepositAccountSourceCurrency>;
+}
+
+/**
+ * A token contract on one source chain in the crypto deposit-account catalog.
+ */
+export interface CryptoDepositAccountSourceChain {
+  /**
+   * Token contract or native asset address on this chain.
+   */
+  address: string;
+
+  /**
+   * EVM CAIP-2 chain identifier (e.g. "eip155:4217" for Tempo, "eip155:1" for
+   * Ethereum).
+   */
+  caip2: CryptoDepositAccountCaip2;
+
+  /**
+   * Token decimals on this chain.
+   */
+  decimals: number;
+}
+
+/**
+ * A source token in the crypto deposit-account catalog, with the chains it can be
+ * sent from.
+ */
+export interface CryptoDepositAccountSourceCurrency {
+  chains: Array<CryptoDepositAccountSourceChain>;
+
+  /**
+   * URL of the token logo.
+   */
+  logo_uri: string;
+
+  name: string;
+
+  symbol: string;
+}
+
 /**
  * One deposit address and the source/destination route it accepts.
  */
@@ -659,7 +759,7 @@ export interface CryptoDepositAddressRoute {
   deposit_address: string;
 
   /**
-   * An asset on a chain. Uses a human-readable alias (usdc, base) when one is on
+   * An asset on a chain. Uses a human-readable alias (usdc, tempo) when one is on
    * file, otherwise the raw asset address and CAIP-2.
    */
   destination: CryptoDepositAsset;
@@ -674,7 +774,7 @@ export interface CryptoDepositAddressRoute {
 }
 
 /**
- * An asset on a chain. Uses a human-readable alias (usdc, base) when one is on
+ * An asset on a chain. Uses a human-readable alias (usdc, tempo) when one is on
  * file, otherwise the raw asset address and CAIP-2.
  */
 export interface CryptoDepositAsset {
@@ -757,9 +857,9 @@ export interface CustodialWallet {
   address: string;
 
   /**
-   * The chain type of the custodial wallet.
+   * The chain of the custodial wallet.
    */
-  chain_type: CustodialWalletChainType;
+  chain: CustodialWalletChain;
 
   /**
    * Information about the custodian managing this wallet.
@@ -776,11 +876,21 @@ export interface CustodialWallet {
    */
   additional_signers?: WalletAdditionalSigner;
 
+  /**
+   * @deprecated The chain type of the custodial wallet (deprecated).
+   */
+  chain_type?: CustodialWalletChainType;
+
   policy_ids?: Array<string>;
 }
 
 /**
- * The chain type of the custodial wallet.
+ * The chain of the custodial wallet.
+ */
+export type CustodialWalletChain = 'base' | 'solana' | 'tempo';
+
+/**
+ * The chain type of the custodial wallet (deprecated).
  */
 export type CustodialWalletChainType = 'ethereum' | 'solana';
 
@@ -788,11 +898,6 @@ export type CustodialWalletChainType = 'ethereum' | 'solana';
  * The input for creating a custodial wallet.
  */
 export interface CustodialWalletCreateInput {
-  /**
-   * The chain type of the custodial wallet.
-   */
-  chain_type: CustodialWalletChainType;
-
   /**
    * The provider of the custodial wallet.
    */
@@ -809,6 +914,16 @@ export interface CustodialWalletCreateInput {
    */
   additional_signers?: AdditionalSignerInput;
 
+  /**
+   * The chain of the custodial wallet.
+   */
+  chain?: CustodialWalletChain;
+
+  /**
+   * @deprecated The chain type of the custodial wallet (deprecated).
+   */
+  chain_type?: CustodialWalletChainType;
+
   /**
    * The owner of the resource, specified as a Privy user ID, a P-256 public key, or
    * null to remove the current owner.
@@ -1679,6 +1794,34 @@ export interface GetByWalletAddressRequestBody {
   include_archived?: boolean;
 }
 
+/**
+ * The next crypto deposit-account sweep into the path wallet after `after`, or
+ * null if none. The order object matches GET order.
+ */
+export interface GetCryptoDepositAccountNextOrderResponse {
+  /**
+   * A crypto deposit-account sweep identified by its wallet action ID. Status is the
+   * wallet-action status.
+   */
+  order: GetCryptoDepositAccountOrderResponse | null;
+}
+
+/**
+ * A crypto deposit-account sweep identified by its wallet action ID. Status is the
+ * wallet-action status.
+ */
+export interface GetCryptoDepositAccountOrderResponse {
+  /**
+   * Wallet action ID of the deposit sweep.
+   */
+  id: string;
+
+  /**
+   * Status of a wallet action.
+   */
+  status: ActionsAPI.WalletActionStatus;
+}
+
 /**
  * The input for HD wallets.
  */
@@ -1813,6 +1956,15 @@ export interface IntentBinding {
   type: 'intent';
 }
 
+/**
+ * A page of active crypto deposit accounts for a destination wallet.
+ */
+export interface ListCryptoDepositAccountsResponse {
+  data: Array<CryptoDepositAddressRoute>;
+
+  next_cursor: string | null;
+}
+
 /**
  * Source for a transfer identified by a named asset (e.g. "usdc", "eth"). Use this
  * variant for first-class assets maintained by Privy.
@@ -3436,6 +3588,7 @@ export type TransactionChainNameInput =
   | 'polygon'
   | 'solana'
   | 'sepolia'
+  | 'arc'
   | (string & {});
 
 /**
@@ -4190,6 +4343,16 @@ export interface Wallet {
    */
   authorization_threshold?: number;
 
+  /**
+   * Automations attached to the wallet, including disabled ones.
+   */
+  automations?: Array<AttachedWalletAutomation>;
+
+  /**
+   * The chain of the custodial wallet.
+   */
+  chain?: CustodialWalletChain;
+
   /**
    * Information about the custodian managing this wallet.
    */
@@ -4303,6 +4466,14 @@ export type WalletAssetChainNameInput =
   | 'tron'
   | 'zksync_era'
   | 'robinhood'
+  | 'unichain'
+  | 'worldchain'
+  | 'ink'
+  | 'soneium'
+  | 'megaeth'
+  | 'hyperevm'
+  | 'hypercore'
+  | 'arc'
   | 'tempo_testnet'
   | 'hoodi'
   | 'sepolia'
@@ -4317,6 +4488,7 @@ export type WalletAssetChainNameInput =
   | 'solana_testnet'
   | 'tron_nile'
   | 'robinhood_testnet'
+  | 'ink_sepolia'
   | (string & {});
 
 /**
@@ -6438,6 +6610,7 @@ export declare namespace Wallets {
     type AptosSignTransactionRpcResponseData as AptosSignTransactionRpcResponseData,
     type AptosSignedTransactionBcsHex as AptosSignedTransactionBcsHex,
     type AttachWalletAutomationRequestBody as AttachWalletAutomationRequestBody,
+    type AttachedWalletAutomation as AttachedWalletAutomation,
     type AuthorizationKeyDashboardResponse as AuthorizationKeyDashboardResponse,
     type AuthorizationKeyResponse as AuthorizationKeyResponse,
     type AuthorizationKeyRole as AuthorizationKeyRole,
@@ -6445,6 +6618,11 @@ export declare namespace Wallets {
     type CreateCryptoDepositAccountResponse as CreateCryptoDepositAccountResponse,
     type CreateCryptoDepositAccountWithConfigRequestBody as CreateCryptoDepositAccountWithConfigRequestBody,
     type CreateCryptoDepositAccountWithRouteRequestBody as CreateCryptoDepositAccountWithRouteRequestBody,
+    type CryptoDepositAccountCaip2 as CryptoDepositAccountCaip2,
+    type CryptoDepositAccountChain as CryptoDepositAccountChain,
+    type CryptoDepositAccountConfigResponse as CryptoDepositAccountConfigResponse,
+    type CryptoDepositAccountSourceChain as CryptoDepositAccountSourceChain,
+    type CryptoDepositAccountSourceCurrency as CryptoDepositAccountSourceCurrency,
     type CryptoDepositAddressRoute as CryptoDepositAddressRoute,
     type CryptoDepositAsset as CryptoDepositAsset,
     type CryptoDepositAssetFilter as CryptoDepositAssetFilter,
@@ -6454,6 +6632,7 @@ export declare namespace Wallets {
     type CurveSigningChainType as CurveSigningChainType,
     type CurveType as CurveType,
     type CustodialWallet as CustodialWallet,
+    type CustodialWalletChain as CustodialWalletChain,
     type CustodialWalletChainType as CustodialWalletChainType,
     type CustodialWalletCreateInput as CustodialWalletCreateInput,
     type CustodialWalletProvider as CustodialWalletProvider,
@@ -6512,6 +6691,8 @@ export declare namespace Wallets {
     type FirstClassChainType as FirstClassChainType,
     type Gas as Gas,
     type GetByWalletAddressRequestBody as GetByWalletAddressRequestBody,
+    type GetCryptoDepositAccountNextOrderResponse as GetCryptoDepositAccountNextOrderResponse,
+    type GetCryptoDepositAccountOrderResponse as GetCryptoDepositAccountOrderResponse,
     type HDInitInput as HDInitInput,
     type HDPath as HDPath,
     type HDSubmitInput as HDSubmitInput,
@@ -6520,6 +6701,7 @@ export declare namespace Wallets {
     type HpkeImportConfig as HpkeImportConfig,
     type Hex as Hex,
     type IntentBinding as IntentBinding,
+    type ListCryptoDepositAccountsResponse as ListCryptoDepositAccountsResponse,
     type NamedTokenTransferSource as NamedTokenTransferSource,
     type NearRpcRequestBody as NearRpcRequestBody,
     type NearRpcResponse as NearRpcResponse,
@@ -6754,6 +6936,8 @@ export declare namespace Wallets {
     type EarnIncentiveRewardsQuery as EarnIncentiveRewardsQuery,
     type EarnIncentiveRewardsResponse as EarnIncentiveRewardsResponse,
     type EarnIncetiveClaimRewardEntry as EarnIncetiveClaimRewardEntry,
+    type EarnPositionApyAllocation as EarnPositionApyAllocation,
+    type EarnPositionApyType as EarnPositionApyType,
     type EarnWithdrawActionResponse as EarnWithdrawActionResponse,
     type EarnWithdrawRequestBody as EarnWithdrawRequestBody,
     type EthereumEarnPositionQuery as EthereumEarnPositionQuery,

package/src/resources/webhooks.ts

@@ -4048,7 +4048,17 @@ export type WalletFundsAsset =
   | WalletFundsErc20Asset
   | WalletFundsSplAsset
   | WalletFundsSacAsset
-  | WalletFundsTrc20Asset;
+  | WalletFundsTrc20Asset
+  | WalletFundsBtknAsset;
+
+/**
+ * A token issued on Spark, identified by its BTKN identifier.
+ */
+export interface WalletFundsBtknAsset {
+  identifier: string;
+
+  type: 'btkn';
+}
 
 /**
  * An ERC-20 token asset.
@@ -4426,6 +4436,7 @@ export declare namespace Webhooks {
     type WalletArchivedWebhookPayload as WalletArchivedWebhookPayload,
     type WalletAutomationSubmittedWebhookPayload as WalletAutomationSubmittedWebhookPayload,
     type WalletFundsAsset as WalletFundsAsset,
+    type WalletFundsBtknAsset as WalletFundsBtknAsset,
     type WalletFundsErc20Asset as WalletFundsErc20Asset,
     type WalletFundsNativeTokenAsset as WalletFundsNativeTokenAsset,
     type WalletFundsSacAsset as WalletFundsSacAsset,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.21.0'; // x-release-please-version
+export const VERSION = '0.22.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.21.0";
+export declare const VERSION = "0.22.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.21.0";
+export declare const VERSION = "0.22.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.21.0'; // x-release-please-version
+exports.VERSION = '0.22.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.21.0'; // x-release-please-version
+export const VERSION = '0.22.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map