From my client - Privy docs

The React SDK supports automatically creating embedded wallets for your users when they login to your app. View this guide to learn more and configure automatic wallet creation.

To create a wallet with the React SDK, use the createWallet method from the useCreateWallet hook:

createWallet: async ({walletIndex?: number} | {createAdditional?: boolean}) => Promise<Wallet>

Usage

import {useCreateWallet} from '@privy-io/react-auth';
const {createWallet} = useCreateWallet();

Parameters

opts.createAdditional

boolean

Whether or not to create an additional Ethereum wallet for the user if they already have an existing Ethereum embedded wallet. Must be set to true to create additional wallets. Defaults to false. Learn more

opts.walletIndex

number

HD index to create the Ethereum wallet at. User must have an existing Ethereum embedded wallet in order to use this parameter.

Returns

wallet

Promise<Wallet>

A Promise for the linked account object for the created wallet.

Callbacks

You can optionally register an onSuccess or onError callback on the useCreateWallet hook.

const {createWallet} = useCreateWallet({
    onSuccess: ({wallet}) => {
        console.log('Created wallet ', wallet);
    },
    onError: (error) => {
        console.error('Failed to create wallet with error ', e)
    }
})

onSuccess

({wallet: Wallet}) => void

Optional callback to run after a user successfully creates a wallet.

onError

(error: string) => void

Optional callback to run after there is an error during wallet creation.

To create a wallet with the React SDK, use the createWallet method from the useCreateWallet hook:

createWallet: async ({walletIndex?: number} | {createAdditional?: boolean}) => Promise<Wallet>

Usage

import {useCreateWallet} from '@privy-io/react-auth';
const {createWallet} = useCreateWallet();

Parameters

opts.createAdditional

boolean

opts.walletIndex

number

HD index to create the Ethereum wallet at. User must have an existing Ethereum embedded wallet in order to use this parameter.

Returns

wallet

Promise<Wallet>

A Promise for the linked account object for the created wallet.

Callbacks

You can optionally register an onSuccess or onError callback on the useCreateWallet hook.

const {createWallet} = useCreateWallet({
    onSuccess: ({wallet}) => {
        console.log('Created wallet ', wallet);
    },
    onError: (error) => {
        console.error('Failed to create wallet with error ', e)
    }
})

onSuccess

({wallet: Wallet}) => void

Optional callback to run after a user successfully creates a wallet.

onError

(error: string) => void

Optional callback to run after there is an error during wallet creation.

To create a wallet with the React SDK, use the createWallet method from the useSolanaWallets hook:

createWallet: async ({walletIndex?: number} | {createAdditional?: boolean}) => Promise<Wallet>

Usage

import {useSolanaWallets} from '@privy-io/react-auth/solana';
const {createWallet} = useSolanaWallets();

Parameters

The createWallet method optionally accepts as a parameter an opts object with the following fields:

opts.createAdditional

boolean

Whether or not to create an additional Solana wallet for the user if they already have an existing Solana embedded wallet. Must be set to true to create additional wallets. Defaults to false. Learn more

opts.walletIndex

number

HD index to create the Solana wallet at. User must have an existing Solana embedded wallet in order to use this parameter.

Returns

wallet

Wallet

The linked account object for the created wallet.

The React SDK supports automatically creating embedded wallets for your users when they login to your app. View this guide to learn more and configure automatic wallet creation.

To create a wallet with the React SDK, use the createWallet method from the useCreateWallet hook:

createWallet: async ({walletIndex?: number} | {createAdditional?: boolean}) => Promise<Wallet>

Usage

import {useCreateWallet} from '@privy-io/react-auth';
const {createWallet} = useCreateWallet();

Parameters

opts.createAdditional

boolean

opts.walletIndex

number

HD index to create the Ethereum wallet at. User must have an existing Ethereum embedded wallet in order to use this parameter.

Returns

wallet

Promise<Wallet>

A Promise for the linked account object for the created wallet.

Callbacks

You can optionally register an onSuccess or onError callback on the useCreateWallet hook.

const {createWallet} = useCreateWallet({
    onSuccess: ({wallet}) => {
        console.log('Created wallet ', wallet);
    },
    onError: (error) => {
        console.error('Failed to create wallet with error ', e)
    }
})

onSuccess

({wallet: Wallet}) => void

Optional callback to run after a user successfully creates a wallet.

onError

(error: string) => void

Optional callback to run after there is an error during wallet creation.

To create a wallet with the React SDK, use the createWallet method from the useCreateWallet hook:

createWallet: async ({walletIndex?: number} | {createAdditional?: boolean}) => Promise<Wallet>

Usage

import {useCreateWallet} from '@privy-io/react-auth';
const {createWallet} = useCreateWallet();

Parameters

opts.createAdditional

boolean

opts.walletIndex

number

HD index to create the Ethereum wallet at. User must have an existing Ethereum embedded wallet in order to use this parameter.

Returns

wallet

Promise<Wallet>

A Promise for the linked account object for the created wallet.

Callbacks

You can optionally register an onSuccess or onError callback on the useCreateWallet hook.

const {createWallet} = useCreateWallet({
    onSuccess: ({wallet}) => {
        console.log('Created wallet ', wallet);
    },
    onError: (error) => {
        console.error('Failed to create wallet with error ', e)
    }
})

onSuccess

({wallet: Wallet}) => void

Optional callback to run after a user successfully creates a wallet.

onError

(error: string) => void

Optional callback to run after there is an error during wallet creation.

To create a wallet with the React SDK, use the createWallet method from the useSolanaWallets hook:

createWallet: async ({walletIndex?: number} | {createAdditional?: boolean}) => Promise<Wallet>

Usage

import {useSolanaWallets} from '@privy-io/react-auth/solana';
const {createWallet} = useSolanaWallets();

Parameters

The createWallet method optionally accepts as a parameter an opts object with the following fields:

opts.createAdditional

boolean

opts.walletIndex

number

HD index to create the Solana wallet at. User must have an existing Solana embedded wallet in order to use this parameter.

Returns

wallet

Wallet

The linked account object for the created wallet.

The React Native SDK supports automatically creating embedded wallets for your users when they login to your app. View this guide to learn more and configure automatic wallet creation.

To create a wallet with the React Native SDK, use the create method from the useEmbeddedEthereumWallet hook:

create: async ({createAdditional?: boolean}) => Promise<{user: User}>

Usage

import {useEmbeddedEthereumWallet} from '@privy-io/expo';
const {create} = useEmbeddedEthereumWallet();

Parameters

The create method optionally accepts as a parameter an opts object with the following fields:

opts.createAdditional

boolean

Returns

user

Promise<{user: User}>

A Promise for an object containing the updated user object for the user.

To create a wallet with the React Native SDK, use the create method from the useEmbeddedEthereumWallet hook:

create: async ({createAdditional?: boolean}) => Promise<{user: User}>

Usage

import {useEmbeddedEthereumWallet} from '@privy-io/expo';
const {create} = useEmbeddedEthereumWallet();

Parameters

The create method optionally accepts as a parameter an opts object with the following fields:

opts.createAdditional

boolean

Returns

user

Promise<{user: User}>

A Promise for an object containing the updated user object for the user.

To create a wallet with the React Native SDK, use the create method from the useEmbeddedSolanaWallet hook:

create: async ({createAdditional?: boolean}) => Promise<{user: User}>

Usage

import {useEmbeddedSolanaWallet} from '@privy-io/expo';
const {create} = useEmbeddedSolanaWallet();

Parameters

The create method optionally accepts as a parameter an opts object with the following fields:

opts.createAdditional

boolean

Returns

user

Promise<{user: User}>

A Promise for an object containing the updated user object.

To create a wallet with the React Native SDK, use the create method from the useEmbeddedBitcoinWallet hook:

create: async ({chainType: 'bitcoin-taproot' | 'bitcoin-segtwit', createAdditional?: boolean}) => Promise<{user: User}>

Usage

import {useEmbeddedBitcoinWallet} from '@privy-io/expo';

const {create} = useEmbeddedBitcoinWallet();

Parameters

The create method optionally accepts as a parameter an opts object with the following fields:

opts.chainType

'bitcoin-taproot' | 'bitcoin-segtwit'

required

The type of Bitcoin wallet to create.

opts.createAdditional

boolean

Whether or not to create an additional Bitcoin wallet for the user if they already have an existing Bitcoin embedded wallet. Must be set to true to create additional wallets. Defaults to false. Learn more

Returns

user

Promise<{user: User}>

A Promise for an object containing the updated user object.

To create a wallet with the Swift SDK, use the createEthereumWallet method from the PrivyUser instance:

func createEthereumWallet(allowAdditional: Bool) async throws -> EmbeddedEthereumWallet

Parameters

The createEthereumWallet method optionally accepts the following parameters:

allowAdditional

Boolean

Whether or not to create an additional Ethereum wallet for the user if they already have an existing Ethereum embedded wallet. Must be set to true to create additional wallets. Defaults to false.

Returns

wallet

EmbeddedEthereumWallet

The newly created EmbeddedEthereumWallet.

To create a wallet with the Swift SDK, use the createEthereumWallet method from the PrivyUser instance:

func createEthereumWallet(allowAdditional: Bool) async throws -> EmbeddedEthereumWallet

Parameters

The createEthereumWallet method optionally accepts the following parameters:

allowAdditional

Boolean

Whether or not to create an additional Ethereum wallet for the user if they already have an existing Ethereum embedded wallet. Must be set to true to create additional wallets. Defaults to false.

Returns

wallet

EmbeddedEthereumWallet

The newly created EmbeddedEthereumWallet.

To create a wallet with the Swift SDK, use the createSolanaWallet method from the PrivyUser instance:

func createSolanaWallet() async throws -> EmbeddedSolanaWallet

Returns

wallet

EmbeddedSolanaWallet

The newly created EmbeddedSolanaWallet.

To create a wallet with the Android SDK, use the createEthereumWallet method from the PrivyUser instance:

public suspend fun createEthereumWallet: (allowAdditional?: Boolean) => Result<EmbeddedEthereumWallet>

Parameters

The createEthereumWallet method optionally accepts the following parameters:

allowAdditional

Boolean

Whether or not to create an additional Ethereum wallet for the user if they already have an existing Ethereum embedded wallet. Must be set to true to create additional wallets. Defaults to false.

Returns

wallet

Result<EmbeddedEthereumWallet>

A Result containing the EmbeddedEthereumWallet for the user.

To create a wallet with the Android SDK, use the createEthereumWallet method from the PrivyUser instance:

public suspend fun createEthereumWallet: (allowAdditional?: Boolean) => Result<EmbeddedEthereumWallet>

Parameters

The createEthereumWallet method optionally accepts the following parameters:

allowAdditional

Boolean

Whether or not to create an additional Ethereum wallet for the user if they already have an existing Ethereum embedded wallet. Must be set to true to create additional wallets. Defaults to false.

Returns

wallet

Result<EmbeddedEthereumWallet>

A Result containing the EmbeddedEthereumWallet for the user.

To create a wallet with the Android SDK, use the createSolanaWallet method from the PrivyUser instance:

public suspend fun createEthereumWallet: (allowAdditional?: Boolean) => Result<EmbeddedSolanaWallet>

Returns

wallet

Result<EmbeddedSolanaWallet>

A Result containing the EmbeddedSolanaWallet for the user.

To create a wallet with the Unity SDK, use the CreateWallet method on your PrivyUser instance:

Task<IEmbeddedEthereumWallet> CreateWallet(bool allowAdditional)

Parameters

The CreateWallet method accepts the following parameter:

allowAdditional

Boolean

Whether or not to create an additional wallet for the user if they already have an existing ethereum wallet. Must be set to true to create additional wallets. Defaults to false.

Returns

wallet

Task<IEmbeddedEthereumWallet>

A Task for the created ethereum wallet object.

To create a wallet with the Unity SDK, use the CreateWallet method on your PrivyUser instance:

Task<IEmbeddedEthereumWallet> CreateWallet(bool allowAdditional)

Parameters

The CreateWallet method accepts the following parameter:

allowAdditional

Boolean

Whether or not to create an additional wallet for the user if they already have an existing ethereum wallet. Must be set to true to create additional wallets. Defaults to false.

Returns

wallet

Task<IEmbeddedEthereumWallet>

A Task for the created ethereum wallet object.

To create a wallet with the Unity SDK, use the CreateSolanaWallet method on your PrivyUser instance:

Task<IEmbeddedSolanaWallet> CreateSolanaWallet(bool allowAdditional)

Parameters

The CreateSolanaWallet method accepts the following parameter:

allowAdditional

Boolean

Whether or not to create an additional wallet for the user if they already have an existing solana wallet. Must be set to true to create additional wallets. Defaults to false.

Returns

wallet

Task<IEmbeddedSolanaWallet>

A Task for the created solana wallet object.

To create a wallet with the Flutter SDK, use the createEthereumWallet method from the PrivyUser instance:

Future<Result<EmbeddedEthereumWallet>> createEthereumWallet({bool allowAdditional = false});

Parameters

The createEthereumWallet method optionally accepts as a parameter an opts object with the following fields:

allowAdditional

bool

Whether or not to create an additional Ethereum wallet for the user if they already have an existing Ethereum embedded wallet. Must be set to true to create additional wallets. Defaults to false.

Returns

wallet

Future<Result<EmbeddedEthereumWallet>>

A Result containing the EmbeddedEthereumWallet for the user.

To create a wallet with the Flutter SDK, use the createEthereumWallet method from the PrivyUser instance:

Future<Result<EmbeddedEthereumWallet>> createEthereumWallet({bool allowAdditional = false});

Parameters

The createEthereumWallet method optionally accepts as a parameter an opts object with the following fields:

allowAdditional

bool

Whether or not to create an additional Ethereum wallet for the user if they already have an existing Ethereum embedded wallet. Must be set to true to create additional wallets. Defaults to false.

Returns

wallet

Future<Result<EmbeddedEthereumWallet>>

A Result containing the EmbeddedEthereumWallet for the user.

To create a wallet with the Android SDK, use the createSolanaWallet method from the PrivyUser instance:

Future<Result<EmbeddedSolanaWallet>> createSolanaWallet()

Parameters

The createSolanaWallet method optionally accepts the following parameters:

allowAdditional

Boolean

Whether or not to create an additional Solana wallet for the user if they already have an existing Solana embedded wallet. Must be set to true to create additional wallets. Defaults to false.

Returns

wallet

Future<Result<EmbeddedSolanaWallet>>

A Result containing the EmbeddedSolanaWallet for the user.

Embedded wallets

Using embedded wallets

Funding

Gas and asset management

Server sessions

Global wallets

Advanced Topics

​Usage

​Parameters

​Returns

​Callbacks

​Usage

​Parameters

​Returns

​Callbacks

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Callbacks

​Usage

​Parameters

​Returns

​Callbacks

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Parameters

​Returns

​Parameters

​Returns

​Returns

​Parameters

​Returns

​Parameters

​Returns

​Returns

​Parameters

​Returns

​Parameters

​Returns

​Parameters

​Returns

​Parameters

​Returns

​Parameters

​Returns

​Parameters

​Returns

Usage

Parameters

Returns

Callbacks

Usage

Parameters

Returns

Callbacks

Usage

Parameters

Returns

Usage

Parameters

Returns

Callbacks

Usage

Parameters

Returns

Callbacks

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns