Hierarchical deterministic (HD) wallets

Privy embedded wallets are hierarchical deterministic (HD) wallets. An HD wallet allows you to generate multiple addresses and private keys from a shared source of entropy: the wallet seed (or equivalently, a BIP-39 mnemonic encoding the seed, known as a seed phrase).

In kind, Privy can be used to provision multiple embedded wallets for a single user. Read more below to learn how!

Creating multiple HD wallets

To create multiple HD wallets for a user, use the createWallet method:

import {useCreateWallet} from '@privy-io/react-auth';

const {createWallet} = useCreateWallet();

import {useCreateWallet} from '@privy-io/react-auth';

const {createWallet} = useCreateWallet();

import {useSolanaWallets} from '@privy-io/react-auth/solana';

const {createWallet} = useSolanaWallets();

Creating the user’s first wallet

If this is the first wallet you are creating for the user (e.g. the 0th index), you may call createWallet with no parameters:

// Creating the first wallet for a user
await createWallet();

Creating additional wallets

There are two approaches to creating additional wallets.

1. Create an additional wallet with the next available index

If the user already has an embedded wallet, and you are creating an additional embedded wallet, call createWallet with createAdditional set to true:

createAdditional

boolean

If true, will allow the user to create a wallet regardless if it is their first wallet or an additional wallet. If false, createWallet will succeed only if the use is creating their first wallet. Defaults to false.

Once invoked, createWallet will return a Promise that resolves to the Wallet created for the user at the specified index, if it was successful. This method will reject with an error if:

the user is not authenticated
the user already has an embedded wallet and createAdditional was not set to true
if there is another error during wallet creation, such as the user exiting prematurely

// Creating additional embedded wallets for the user
// You can also create the first wallet for the user using this syntax
await createWallet({createAdditional: true});

2. Create an additional wallet with a specified HD wallet index

To create a wallet at a specified HD wallet index, call createWallet with the preferred walletIndex. This method will either create a new wallet, or return the existing one if one already exists at the specified index.

walletIndex

number

The specified HD wallet index. Must be a positive number, and must be 0 for the user’s first wallet.

A wallet with HD index 0 must be created before creating a wallet at greater HD indices.

// Create an additional embedded wallet at index 5
await createWallet({walletIndex: 5});

An error can be thrown if:

the user is not authenticated
wallet creation fails or the wallet cannot be added to the user’s account.
an invalid HD wallet index is supplied, i.e. walletIndex is less than 0, or if walletIndex is greater than 0 while user has no wallet with HD index 0.

Using multiple HD wallets

Getting a specific embedded wallet

Once a user has one or more embedded wallets, the wallets are added to both linkedAccounts array of the user object and the array of connected wallets returned by useWallets.

To find a specific embedded wallet for the user, search the useWallets array for a wallet with walletClientType: 'privy' and an address that matches your desired address:

// Ensure the wallet address is checksummed per EIP55
const desiredAddress = 'insert-your-desired-address-in-EIP55-format';
const {wallets} = useWallets();
const desiredWallet = wallets.find(
  (wallet) => wallet.walletClientType === 'privy' && wallet.address === desiredAddress
);

// Ensure the wallet address is checksummed per EIP55
const desiredAddress = 'insert-your-desired-address-in-EIP55-format';
const {wallets} = useWallets();
const desiredWallet = wallets.find(
  (wallet) => wallet.walletClientType === 'privy' && wallet.address === desiredAddress
);

const desiredAddress = 'insert-your-desired-address';
const {wallets} = useSolanaWallets();
const desiredWallet = wallets.find(
  (wallet) => wallet.walletClientType === 'privy' && wallet.address === desiredAddress
);

You can also get a list of all of the user’s embedded wallets by filtering the useWallets array for entries with walletClientType: 'privy':

const embeddedWallets = wallets.filter((wallet) => wallet.walletClientType === 'privy');

Requesting signatures and transactions

Your app can then use Privy’s native signature and transaction methods, the wallet’s EIP1193 provider, or a third-party library like viem or ethers, per the instructions below.

Using Privy’s native signature and transaction methods

To use Privy’s native signMessage, signTypedData, and sendTransaction methods with a specific embedded wallet, simply pass the address for your desired wallet as the final optional parameter to these methods:

`signMessage`

const {signMessage} = usePrivy();
const signature = await signMessage(
  {message: 'insert-message-to-sign'},
  {
    uiOptions: insertOptionalUIConfigOrUndefined,
    address: desiredWallet.address // Replace with the address of the desired embedded wallet
  }
);

`signTypedData`

const {signTypedData} = usePrivy();
const signature = await signTypedData(insertTypedDataObject, {
  uiOptions: insertOptionalUIConfigOrUndefined,
  address: desiredWallet.address // Replace with the address of the desired embedded wallet
});

`sendTransaction`

const {sendTransaction} = usePrivy();
const signature = await sendTransaction(insertTransactionRequest, {
  uiOptions: insertOptionalUIConfigOrUndefined,
  fundingConfig: insertOptionalUIConfigOrUndefined,
  address: desiredWallet.address // Replace with the address of the desired embedded wallet
});

`signMessage`

const {signMessage} = usePrivy();
const signature = await signMessage(
  {message: 'insert-message-to-sign'},
  {
    uiOptions: insertOptionalUIConfigOrUndefined,
    address: desiredWallet.address // Replace with the address of the desired embedded wallet
  }
);

`signTypedData`

const {signTypedData} = usePrivy();
const signature = await signTypedData(insertTypedDataObject, {
  uiOptions: insertOptionalUIConfigOrUndefined,
  address: desiredWallet.address // Replace with the address of the desired embedded wallet
});

`sendTransaction`

const {sendTransaction} = usePrivy();
const signature = await sendTransaction(insertTransactionRequest, {
  uiOptions: insertOptionalUIConfigOrUndefined,
  fundingConfig: insertOptionalUIConfigOrUndefined,
  address: desiredWallet.address // Replace with the address of the desired embedded wallet
});

`signMessage`

import {useSignMessage} from '@privy-io/react-auth/solana';

const {signMessage} = useSignMessage();
const signature = await signMessage(
  {message: new TextEncoder().encode('insert-message-to-sign')},
  {
    uiOptions: insertOptionalUIConfigOrUndefined,
    address: desiredWallet.address // Replace with the address of the desired embedded wallet
  }
);

`sendTransaction`

import {useSendTransaction} from '@privy-io/react-auth/solana';

const {sendTransaction} = useSendTransaction();
const signature = await sendTransaction({
  transaction,
  uiOptions: insertOptionalUIConfigOrUndefined,
  fundWalletConfig: insertOptionalUIConfigOrUndefined,
  address: desiredWallet.address // Replace with the address of the desired embedded wallet
});

Using the EIP1193 provider, viem, and ethers (EVM only)

You can also request signatures and transactions from a specific embedded wallet using the wallet’s EIP1193 provider or a library like viem or ethers.

To get the EIP1193 provider for a specific embedded wallet, first find the corresponding ConnectedWallet object from the useWallets array:

// Ensure the wallet address is checksummed per EIP55
const address = 'insert-your-desired-address-in-EIP55-format';
const {wallets} = useWallets();
const wallet = wallets.find(
  (wallet) => wallet.walletClientType === 'privy' && wallet.address === address
);

Then, call the object’s getEthereumProvider method to get an EIP1193 provider for that wallet:

const provider = await wallet.getEthereumProvider();

You can then easily pass that EIP1193 provider to a library like viem or ethers to use those libraries’ interfaces to send requests to the wallet.

Exporting HD wallets

To export the private key for a specific HD wallet, simply pass the address of the wallet you’d like to export as an address parameter to the exportWallet method:

const {exportWallet} = usePrivy();
await exportWallet({address: 'insert-your-desired-address'});

const {exportWallet} = usePrivy();
await exportWallet({address: 'insert-your-desired-address'});

const {exportWallet} = useSolanaWallets();
await exportWallet({address: 'insert-your-desired-address'});

If no address is passed to exportWallet, Privy will default to exporting the non-imported wallet at walletIndex: 0.

Pregenerating multiple HD wallets (EVM only)

Privy supports pregenerating multiple HD wallets in Ethereum when creating new users. With our user import endpoint, you can create a user with up to 10 pregenerated HD wallets. Simply call the import endpoint with create_n_ethereum_wallets set to the number of embedded wallets you want to generate for your user.

Pregeneration endpoints have heavier rate limit of 240 users per minute. If you are being rate limited, responses will have status code 429. We suggest you setup exponential back-offs starting at 1 second to seamlessly recover.

Below is a sample cURL command for pregenerating two new wallets for a user with Privy:

$ curl --request POST https://auth.privy.io/api/v1/users \
-u "<your-privy-app-id>:<your-privy-app-secret>" \
-H "privy-app-id: <your-privy-app-id>" \
-H 'Content-Type: application/json' \
-d '{
  "create_n_ethereum_wallets": 2,
  "linked_accounts": [
    {
      "address": "[email protected]",
      "type": "email"
    }
  ]
}'

A successful response will include the new user object along with their Privy user ID and embedded wallet addresses, like below. The generated wallets will be available to the user upon sign in.

Below is a sample successful response for generating two new wallets for a user with Privy:

{
  "id": "did:privy:clddy332f002tyqpq3b3lv327",
  "created_at": 1674788927,
  "linked_accounts": [
    {
      "address": "[email protected]",
      "type": "email"
    },
    {
      "address": "0x3DAF84b3f09A0E2092302F7560888dBc0952b7B7",
      "type": "wallet",
      "wallet_index": 0,
      "walletClient": "privy",
      "chain_type": "ethereum"
    },
    {
      "address": "0x1a235d54C58d0B5E339c784Fd98d4D71125fEb1c",
      "type": "wallet",
      "wallet_index": 1,
      "walletClient": "privy",
      "chain_type": "ethereum"
    }
  ]
}

Creating multiple HD wallets

To create multiple HD wallets for a user, use the createWallet method:

import {useCreateWallet} from '@privy-io/react-auth';

const {createWallet} = useCreateWallet();

import {useCreateWallet} from '@privy-io/react-auth';

const {createWallet} = useCreateWallet();

import {useSolanaWallets} from '@privy-io/react-auth/solana';

const {createWallet} = useSolanaWallets();

Creating the user’s first wallet

If this is the first wallet you are creating for the user (e.g. the 0th index), you may call createWallet with no parameters:

// Creating the first wallet for a user
await createWallet();

Creating additional wallets

There are two approaches to creating additional wallets.

1. Create an additional wallet with the next available index

If the user already has an embedded wallet, and you are creating an additional embedded wallet, call createWallet with createAdditional set to true:

createAdditional

boolean

Once invoked, createWallet will return a Promise that resolves to the Wallet created for the user at the specified index, if it was successful. This method will reject with an error if:

the user is not authenticated
the user already has an embedded wallet and createAdditional was not set to true
if there is another error during wallet creation, such as the user exiting prematurely

// Creating additional embedded wallets for the user
// You can also create the first wallet for the user using this syntax
await createWallet({createAdditional: true});

2. Create an additional wallet with a specified HD wallet index

walletIndex

number

The specified HD wallet index. Must be a positive number, and must be 0 for the user’s first wallet.

A wallet with HD index 0 must be created before creating a wallet at greater HD indices.

// Create an additional embedded wallet at index 5
await createWallet({walletIndex: 5});

An error can be thrown if:

the user is not authenticated
wallet creation fails or the wallet cannot be added to the user’s account.
an invalid HD wallet index is supplied, i.e. walletIndex is less than 0, or if walletIndex is greater than 0 while user has no wallet with HD index 0.

Using multiple HD wallets

Getting a specific embedded wallet

Once a user has one or more embedded wallets, the wallets are added to both linkedAccounts array of the user object and the array of connected wallets returned by useWallets.

To find a specific embedded wallet for the user, search the useWallets array for a wallet with walletClientType: 'privy' and an address that matches your desired address:

// Ensure the wallet address is checksummed per EIP55
const desiredAddress = 'insert-your-desired-address-in-EIP55-format';
const {wallets} = useWallets();
const desiredWallet = wallets.find(
  (wallet) => wallet.walletClientType === 'privy' && wallet.address === desiredAddress
);

// Ensure the wallet address is checksummed per EIP55
const desiredAddress = 'insert-your-desired-address-in-EIP55-format';
const {wallets} = useWallets();
const desiredWallet = wallets.find(
  (wallet) => wallet.walletClientType === 'privy' && wallet.address === desiredAddress
);

const desiredAddress = 'insert-your-desired-address';
const {wallets} = useSolanaWallets();
const desiredWallet = wallets.find(
  (wallet) => wallet.walletClientType === 'privy' && wallet.address === desiredAddress
);

You can also get a list of all of the user’s embedded wallets by filtering the useWallets array for entries with walletClientType: 'privy':

const embeddedWallets = wallets.filter((wallet) => wallet.walletClientType === 'privy');

Requesting signatures and transactions

Your app can then use Privy’s native signature and transaction methods, the wallet’s EIP1193 provider, or a third-party library like viem or ethers, per the instructions below.

Using Privy’s native signature and transaction methods

`signMessage`

const {signMessage} = usePrivy();
const signature = await signMessage(
  {message: 'insert-message-to-sign'},
  {
    uiOptions: insertOptionalUIConfigOrUndefined,
    address: desiredWallet.address // Replace with the address of the desired embedded wallet
  }
);

`signTypedData`

const {signTypedData} = usePrivy();
const signature = await signTypedData(insertTypedDataObject, {
  uiOptions: insertOptionalUIConfigOrUndefined,
  address: desiredWallet.address // Replace with the address of the desired embedded wallet
});

`sendTransaction`

const {sendTransaction} = usePrivy();
const signature = await sendTransaction(insertTransactionRequest, {
  uiOptions: insertOptionalUIConfigOrUndefined,
  fundingConfig: insertOptionalUIConfigOrUndefined,
  address: desiredWallet.address // Replace with the address of the desired embedded wallet
});

`signMessage`

const {signMessage} = usePrivy();
const signature = await signMessage(
  {message: 'insert-message-to-sign'},
  {
    uiOptions: insertOptionalUIConfigOrUndefined,
    address: desiredWallet.address // Replace with the address of the desired embedded wallet
  }
);

`signTypedData`

const {signTypedData} = usePrivy();
const signature = await signTypedData(insertTypedDataObject, {
  uiOptions: insertOptionalUIConfigOrUndefined,
  address: desiredWallet.address // Replace with the address of the desired embedded wallet
});

`sendTransaction`

const {sendTransaction} = usePrivy();
const signature = await sendTransaction(insertTransactionRequest, {
  uiOptions: insertOptionalUIConfigOrUndefined,
  fundingConfig: insertOptionalUIConfigOrUndefined,
  address: desiredWallet.address // Replace with the address of the desired embedded wallet
});

`signMessage`

import {useSignMessage} from '@privy-io/react-auth/solana';

const {signMessage} = useSignMessage();
const signature = await signMessage(
  {message: new TextEncoder().encode('insert-message-to-sign')},
  {
    uiOptions: insertOptionalUIConfigOrUndefined,
    address: desiredWallet.address // Replace with the address of the desired embedded wallet
  }
);

`sendTransaction`

import {useSendTransaction} from '@privy-io/react-auth/solana';

const {sendTransaction} = useSendTransaction();
const signature = await sendTransaction({
  transaction,
  uiOptions: insertOptionalUIConfigOrUndefined,
  fundWalletConfig: insertOptionalUIConfigOrUndefined,
  address: desiredWallet.address // Replace with the address of the desired embedded wallet
});

Using the EIP1193 provider, viem, and ethers (EVM only)

You can also request signatures and transactions from a specific embedded wallet using the wallet’s EIP1193 provider or a library like viem or ethers.

To get the EIP1193 provider for a specific embedded wallet, first find the corresponding ConnectedWallet object from the useWallets array:

// Ensure the wallet address is checksummed per EIP55
const address = 'insert-your-desired-address-in-EIP55-format';
const {wallets} = useWallets();
const wallet = wallets.find(
  (wallet) => wallet.walletClientType === 'privy' && wallet.address === address
);

Then, call the object’s getEthereumProvider method to get an EIP1193 provider for that wallet:

const provider = await wallet.getEthereumProvider();

You can then easily pass that EIP1193 provider to a library like viem or ethers to use those libraries’ interfaces to send requests to the wallet.

Exporting HD wallets

To export the private key for a specific HD wallet, simply pass the address of the wallet you’d like to export as an address parameter to the exportWallet method:

const {exportWallet} = usePrivy();
await exportWallet({address: 'insert-your-desired-address'});

const {exportWallet} = usePrivy();
await exportWallet({address: 'insert-your-desired-address'});

const {exportWallet} = useSolanaWallets();
await exportWallet({address: 'insert-your-desired-address'});

If no address is passed to exportWallet, Privy will default to exporting the non-imported wallet at walletIndex: 0.

Pregenerating multiple HD wallets (EVM only)

Below is a sample cURL command for pregenerating two new wallets for a user with Privy:

$ curl --request POST https://auth.privy.io/api/v1/users \
-u "<your-privy-app-id>:<your-privy-app-secret>" \
-H "privy-app-id: <your-privy-app-id>" \
-H 'Content-Type: application/json' \
-d '{
  "create_n_ethereum_wallets": 2,
  "linked_accounts": [
    {
      "address": "[email protected]",
      "type": "email"
    }
  ]
}'

A successful response will include the new user object along with their Privy user ID and embedded wallet addresses, like below. The generated wallets will be available to the user upon sign in.

Below is a sample successful response for generating two new wallets for a user with Privy:

{
  "id": "did:privy:clddy332f002tyqpq3b3lv327",
  "created_at": 1674788927,
  "linked_accounts": [
    {
      "address": "[email protected]",
      "type": "email"
    },
    {
      "address": "0x3DAF84b3f09A0E2092302F7560888dBc0952b7B7",
      "type": "wallet",
      "wallet_index": 0,
      "walletClient": "privy",
      "chain_type": "ethereum"
    },
    {
      "address": "0x1a235d54C58d0B5E339c784Fd98d4D71125fEb1c",
      "type": "wallet",
      "wallet_index": 1,
      "walletClient": "privy",
      "chain_type": "ethereum"
    }
  ]
}

Creating multiple HD wallets

To create multiple Ethereum wallets for a user, use the create method from the useEmbeddedEthereumWallet hook:

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

const {create} = useEmbeddedEthereumWallet();

As a parameter to create, pass an object containing a createAdditional boolean specifying if you would like to create an additional wallet, even if the user has an existing one.

createAdditional

boolean

If true, will allow the user to create a Ethereum wallet regardless if it is their first wallet or an additional wallet. If false, createWallet will succeed only if the use is creating their first wallet. Defaults to false.

Once invoked, create will return a Promise that resolves to the newly created wallet, if it was successful. This method will reject with an error if:

the user is not authenticated.
the user already has an embedded Ethereum wallet and createAdditional was not set to true.
if there is another error during wallet creation, such as the user exiting prematurely.

// Creating additional embedded wallets for the user
// You can also create the first wallet for the user using this syntax
await create({createAdditional: true});

Using multiple HD wallets

Once a user has one or more embedded wallets, the wallets are added to the wallets array returned by useEmbeddedEthereumWallet:

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

Refer to the requests section to learn how to interact with the wallets you create.

Getting a specific embedded wallet

To find a specific embedded wallet for the user, search the wallets array for a wallet with the address that matches your desired address:

const desiredAddress = 'insert-your-desired-wallet-address';
const {wallets} = useEmbeddedEthereumWallet();
const desiredWallet = wallets.find((wallet) => wallet.address === desiredAddress);

You can alternatively search the wallets array by your desired HD index:

// Replace this with your desired HD index
const desiredHdIndex = 0;
const {wallets} = useEmbeddedEthereumWallet();
const desiredWallet = wallets.find((wallet) => wallet.walletIndex === desiredHdIndex);

Creating multiple HD wallets

To create multiple Ethereum wallets for a user, use the create method from the useEmbeddedEthereumWallet hook:

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

const {create} = useEmbeddedEthereumWallet();

As a parameter to create, pass an object containing a createAdditional boolean specifying if you would like to create an additional wallet, even if the user has an existing one.

createAdditional

boolean

Once invoked, create will return a Promise that resolves to the newly created wallet, if it was successful. This method will reject with an error if:

the user is not authenticated.
the user already has an embedded Ethereum wallet and createAdditional was not set to true.
if there is another error during wallet creation, such as the user exiting prematurely.

// Creating additional embedded wallets for the user
// You can also create the first wallet for the user using this syntax
await create({createAdditional: true});

Using multiple HD wallets

Once a user has one or more embedded wallets, the wallets are added to the wallets array returned by useEmbeddedEthereumWallet:

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

Refer to the requests section to learn how to interact with the wallets you create.

Getting a specific embedded wallet

To find a specific embedded wallet for the user, search the wallets array for a wallet with the address that matches your desired address:

const desiredAddress = 'insert-your-desired-wallet-address';
const {wallets} = useEmbeddedEthereumWallet();
const desiredWallet = wallets.find((wallet) => wallet.address === desiredAddress);

You can alternatively search the wallets array by your desired HD index:

// Replace this with your desired HD index
const desiredHdIndex = 0;
const {wallets} = useEmbeddedEthereumWallet();
const desiredWallet = wallets.find((wallet) => wallet.walletIndex === desiredHdIndex);

Creating multiple HD wallets

To create multiple Solana wallets for a user, use the create method from the useEmbeddedSolanaWallet hook:

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

As an optional parameter to create, you may pass an object containing the following fields:

createAdditional

boolean

If true, will allow the user to create a Solana wallet regardless if it is their first wallet or an additional wallet. If false, createWallet will succeed only if the use is creating their first wallet. Defaults to false.

Once invoked, create will return a Promise that resolves to the provider for the wallet created for the user, if it was successful. This method will reject with an error if:

the user is not authenticated
the user already has an embedded Solana wallet and createAdditional was not set to true
if there is another error during wallet creation, such as the user exiting prematurely

Creating the user’s first wallet

If this is the first wallet you are creating for the user (e.g. the 0th index), you may call create with no parameters:

// Creating the first wallet for a user
const provider = await create();

Creating additional wallets

If the user already has an embedded wallet, and you are creating an additional embedded wallet, you must call create with createAdditional set to true:

// Creating additional embedded wallets for the user
// You can also create the first wallet for the user using this syntax
const provider = await create({createAdditional: true});

Using multiple HD wallets

Once a user has one or more embedded wallets, the wallets are added to the wallets array returned by useEmbeddedSolanaWallet:

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

Each entry in the wallets array is an object with the following fields:

address

string

The address (base58-encoded public key) for the wallet.

publicKey

string

The address (base58-encoded public key) for the wallet.

walletIndex

number

The HD index for the wallet.

getProvider

() => Promise<PrivyEmbeddedSolanaWalletProvider>

Method to get a provider for the wallet for requesting signatures and transactions.

Getting a specific embedded wallet

To find a specific embedded wallet for the user, search the wallets array for a wallet with the address that matches your desired address:

const desiredAddress = 'insert-your-desired-wallet-address';
const {wallets} = useEmbeddedSolanaWallet();
const desiredWallet = wallets.find((wallet) => wallet.address === desiredAddress);

You can alternatively search the wallets array by your desired HD index:

// Replace this with your desired HD index
const desiredHdIndex = 0;
const {wallets} = useEmbeddedSolanaWallet();
const desiredWallet = wallets.find((wallet) => wallet.walletIndex === desiredHdIndex);

Requesting signatures and transactions

To request a signature or transaction from a specific embedded wallet, first find the corresponding wallet object from the wallets array:

const desiredAddress = 'insert-your-desired-wallet-address';
const {wallets} = useEmbeddedSolanaWallet();
const wallet = wallets.find((wallet) => wallet.address === desiredAddress);

Then, call the object’s getProvider method to get a provider for the wallet:

const provider = await wallet.getProvider();

You can then easily request signatures from the provider using its request method, like so:

const message = 'Hello world';
const {signature} = await provider.request({
  method: 'signMessage',
  params: {
    message: message
  }
});

Creating multiple HD wallets

To create multiple Bitcoin wallets for a user, use the create method from the useEmbeddedBitcoinWallet hook:

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

const {create} = useEmbeddedBitcoinWallet();

As a parameter to create, pass an object containing a chainType field specifying the type of wallet to create and a createAdditional boolean specifying if you would like to create an additional wallet of that chainType, even if the user has an existing wallet of that chainType.

chainType

'bitcoin-taproot' | 'bitcoin-segtwit'

The type of Bitcoin wallet to create.

createAdditional

boolean

If true, will allow the user to create a Bitcoin wallet regardless if it is their first Bitcoin wallet or an additional Bitcoin wallet. If false, createWallet will succeed only if the user is creating their first wallet. Defaults to false.

Once invoked, create will return a Promise that resolves to the newly created wallet, if it was successful. This method will reject with an error if:

the user is not authenticated
the user already has an embedded Bitcoin wallet of the provided chainType and createAdditional was not set to true
if there is another error during wallet creation, such as the user exiting prematurely

Creating additional wallets

If the user already has an embedded wallet, and you are creating an additional embedded wallet, you must call create with createAdditional set to true:

// Creating additional embedded wallets for the user
// You can also create the first wallet for the user using this syntax
const provider = await create({createAdditional: true});

Using multiple HD wallets

Once a user has one or more embedded wallets, the wallets are added to the wallets array returned by useEmbeddedBitcoinWallet:

import {useEmbeddedBitcoinWallet} from '@privy-io/expo';
...
const {wallets} = useEmbeddedBitcoinWallet();

Refer to the usage section to learn how to interact with the wallets you create.

Getting a specific embedded wallet

To find a specific embedded wallet for the user, search the wallets array for a wallet with the address that matches your desired address:

const desiredAddress = 'insert-your-desired-wallet-address';
const {wallets} = useEmbeddedBitcoinWallet();
const desiredWallet = wallets.find((wallet) => wallet.address === desiredAddress);

You can alternatively search the wallets array by your desired HD index:

// Replace this with your desired HD index
const desiredHdIndex = 0;
const {wallets} = useEmbeddedBitcoinWallet();
const desiredWallet = wallets.find(
  (wallet) => wallet.chainType === 'bitcoin-taproot' && wallet.walletIndex === desiredHdIndex
);

Recipes

​Creating multiple HD wallets

​Creating the user’s first wallet

​Creating additional wallets

​1. Create an additional wallet with the next available index

​2. Create an additional wallet with a specified HD wallet index

​Using multiple HD wallets

​Getting a specific embedded wallet

​Requesting signatures and transactions

​Using Privy’s native signature and transaction methods

​signMessage

​signTypedData

​sendTransaction

​signMessage

​signTypedData

​sendTransaction

​signMessage

​sendTransaction

​Using the EIP1193 provider, viem, and ethers (EVM only)

​Exporting HD wallets

​Pregenerating multiple HD wallets (EVM only)

​Creating multiple HD wallets

​Creating the user’s first wallet

​Creating additional wallets

​1. Create an additional wallet with the next available index

​2. Create an additional wallet with a specified HD wallet index

​Using multiple HD wallets

​Getting a specific embedded wallet

​Requesting signatures and transactions

​Using Privy’s native signature and transaction methods

​signMessage

​signTypedData

​sendTransaction

​signMessage

​signTypedData

​sendTransaction

​signMessage

​sendTransaction

​Using the EIP1193 provider, viem, and ethers (EVM only)

​Exporting HD wallets

​Pregenerating multiple HD wallets (EVM only)

​Creating multiple HD wallets

​Using multiple HD wallets

​Getting a specific embedded wallet

​Creating multiple HD wallets

​Using multiple HD wallets

​Getting a specific embedded wallet

​Creating multiple HD wallets

​Creating the user’s first wallet

​Creating additional wallets

​Using multiple HD wallets

​Getting a specific embedded wallet

​Requesting signatures and transactions

​Creating multiple HD wallets

​Creating additional wallets

​Using multiple HD wallets

​Getting a specific embedded wallet

Creating multiple HD wallets

Creating the user’s first wallet

Creating additional wallets

1. Create an additional wallet with the next available index

2. Create an additional wallet with a specified HD wallet index

Using multiple HD wallets

Getting a specific embedded wallet

Requesting signatures and transactions

Using Privy’s native signature and transaction methods

`signMessage`

`signTypedData`

`sendTransaction`

`signMessage`

`signTypedData`

`sendTransaction`

`signMessage`

`sendTransaction`

Using the EIP1193 provider, viem, and ethers (EVM only)

Exporting HD wallets

Pregenerating multiple HD wallets (EVM only)

Creating multiple HD wallets

Creating the user’s first wallet

Creating additional wallets

1. Create an additional wallet with the next available index

2. Create an additional wallet with a specified HD wallet index

Using multiple HD wallets

Getting a specific embedded wallet

Requesting signatures and transactions

Using Privy’s native signature and transaction methods

`signMessage`

`signTypedData`

`sendTransaction`

`signMessage`

`signTypedData`

`sendTransaction`

`signMessage`

`sendTransaction`

Using the EIP1193 provider, viem, and ethers (EVM only)

Exporting HD wallets

Pregenerating multiple HD wallets (EVM only)

Creating multiple HD wallets

Using multiple HD wallets

Getting a specific embedded wallet

Creating multiple HD wallets

Using multiple HD wallets

Getting a specific embedded wallet

Creating multiple HD wallets

Creating the user’s first wallet

Creating additional wallets

Using multiple HD wallets

Getting a specific embedded wallet

Requesting signatures and transactions

Creating multiple HD wallets

Creating additional wallets

Using multiple HD wallets

Getting a specific embedded wallet