Documentation

Embedded Wallets

embedded_wallets

Domain types

AlchemyPaymasterContext = { policy_id }

The Alchemy paymaster context for a smart wallet network configuration.

EmbeddedWalletCreationInput = { wallets }

The fields describing embedded wallet creation, used for user import and embedded wallet generation.

ICloudClientType = "web" | "expo-ios"

The client type for iCloud recovery operations.

OAuthAuthenticateRecoveryResponse = { access_token }

The response from authenticating with OAuth for recovery.

OAuthCallbackICloudExpoInput = { ckWebAuthToken }

The input for the iCloud Expo OAuth callback.

OAuthInitICloudRecoveryInput = { client_type }

The input for initiating an iCloud OAuth recovery flow.

OAuthInitRecoveryInput = { redirect_to, token, code_challenge, 1 more... }

The input for initiating an OAuth recovery flow.

RecoveryConfigurationICloudInput = { client_type }

The input for getting the iCloud recovery configuration.

RecoveryConfigurationICloudResponse = { api_token, container_identifier, environment }

The response containing the iCloud recovery configuration.

RecoveryKeyMaterialInput = { chain_type }

The input for getting the recovery key material.

RecoveryKeyMaterialResponse = { file_id, icloud_record_name, recovery_code, 3 more... }

The response containing the recovery key material.

RecoveryType = "user_passcode_derived_recovery_key" | "privy_passcode_derived_recovery_key" | "privy_generated_recovery_key" | 2 more...

The type of recovery mechanism used for wallet recovery.

SmartWalletConfiguration =
SmartWalletConfigurationDisabled
|
SmartWalletConfigurationEnabled

The configuration object for smart wallets.

SmartWalletConfigurationDisabled = { enabled }

A disabled smart wallet configuration.

SmartWalletConfigurationEnabled = { configured_networks, enabled, smart_wallet_type, 1 more... }

An enabled smart wallet configuration.

SmartWalletConfigurationInput =
SmartWalletConfigurationDisabled
|
SmartWalletConfigurationInputEnabled

The input configuration object for smart wallets.

SmartWalletConfigurationInputEnabled = { configured_networks, enabled, smart_wallet_type, 1 more... }

An enabled smart wallet configuration input.

SmartWalletNetworkConfiguration = { bundler_url, chain_id, chain_name, 3 more... }

Network configuration for a smart wallet.

SmartWalletNetworkConfigurationInput = { chain_id, bundler_url, chain_name, 3 more... }

Input for network configuration for a smart wallet.

SmartWalletType = "safe" | "kernel" | "light_account" | 4 more...

The supported smart wallet providers.

WalletCreationAdditionalSignerItem = { signer_id, override_policy_ids }

An additional signer configuration for a wallet.

WalletCreationInput = { chain_type, additional_signers, create_smart_wallet, 1 more... }

The fields on wallet creation that can be specified when creating a user-controlled embedded server wallet.