Pregenerating wallets

With Privy, you can pregenerate self-custodial Ethereum and Solana embedded wallets for existing users, or create a new user with other login methods, like an email address or phone number, without requiring the user to login. You can even send assets to the wallet before the user logs in to your app for the first time.

Once the user associated with the account logs in, they will be able to access the pregenerated wallet and any assets sent to them.

Pregenerating wallets for new users

To pregenerate embedded wallets for a given user, use the importUser method from PrivyClient.

importUser: ({linkedAccounts: LinkedAccountType[], createEthereumWallet?: boolean, createSolanaWallet?: boolean, createEthereumSmartWallet?: boolean, customMetadata?: CustomMetadataType}) => Promise<User>

Usage

const user = await privy.importUser({
    linkedAccounts: [
        {
        type: 'email',
        address: '[email protected]',
        },
    ],
    createEthereumWallet: true,
    createSolanaWallet: true,
    createEthereumSmartWallet: true,
    customMetadata: {
        username: 'name',
        isVerified: true,
        age: 23,
    },
});

Params

linkedAccounts

LinkedAccountType[]

required

An array of linked accounts to associate with the user.

createEthereumWallet

boolean

(Optional) Whether to create an Ethereum wallet for the user.

createSolanaWallet

boolean

(Optional) Whether to create a Solana wallet for the user.

createEthereumSmartWallet

boolean

(Optional) Whether to create an Ethereum smart wallet for the user.

customMetadata

CustomMetadataType

(Optional) Custom metadata to associate with the user.

Returns

user

User

To pregenerate embedded wallets for a given user, use the importUser method from PrivyClient.

importUser: ({linkedAccounts: LinkedAccountType[], createEthereumWallet?: boolean, createSolanaWallet?: boolean, createEthereumSmartWallet?: boolean, customMetadata?: CustomMetadataType}) => Promise<User>

Usage

const user = await privy.importUser({
    linkedAccounts: [
        {
        type: 'email',
        address: '[email protected]',
        },
    ],
    createEthereumWallet: true,
    createSolanaWallet: true,
    createEthereumSmartWallet: true,
    customMetadata: {
        username: 'name',
        isVerified: true,
        age: 23,
    },
});

Params

linkedAccounts

LinkedAccountType[]

required

An array of linked accounts to associate with the user.

createEthereumWallet

boolean

(Optional) Whether to create an Ethereum wallet for the user.

createSolanaWallet

boolean

(Optional) Whether to create a Solana wallet for the user.

createEthereumSmartWallet

boolean

(Optional) Whether to create an Ethereum smart wallet for the user.

customMetadata

CustomMetadataType

(Optional) Custom metadata to associate with the user.

Returns

user

User

To pregenerate embedded wallets for a given user, make a POST request to https://auth.privy.io/api/v1/users.

Usage

Below is a sample cURL command for generating a new wallet 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_ethereum_wallet": true,
        "linked_accounts": [
            {
                "address": "[email protected]",
                "type": "email"
            }
        ]
    }'

A successful response will include the new user object along with their user ID and embedded wallet address, like below:

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

Parameters

linked_accounts

LinkedAccountType[]

required

An array of linked accounts to associate with the user.

create_ethereum_wallet

boolean

(Optional) Whether to create an Ethereum wallet for the user.

create_solana_wallet

boolean

(Optional) Whether to create a Solana wallet for the user.

create_ethereum_smart_wallet

boolean

(Optional) Whether to create an Ethereum smart wallet for the user.

custom_metadata

CustomMetadataType

(Optional) Custom metadata to associate with the user.

Pregenerating wallets for existing users

To create embedded wallets for an existing user, use the createWallets method from PrivyClient.

createWallets: ({userId: string, createEthereumWallet?: boolean, createSolanaWallet?: boolean, createEthereumSmartWallet?: boolean, numberOfEthereumWalletsToCreate?: number}) => Promise<User>

Usage

const user = await privy.createWallets({
    userId: 'did:privy:clddy332f002tyqpq3b3lv327',
    createEthereumWallet: true,
    createSolanaWallet: true,
    createEthereumSmartWallet: true,
    numberOfEthereumWalletsToCreate: 2,
});

Params

userId

string

required

The Privy user ID to create wallets for.

createEthereumWallet

boolean

(Optional) Whether to create an Ethereum wallet for the user.

createSolanaWallet

boolean

(Optional) Whether to create a Solana wallet for the user.

createEthereumSmartWallet

boolean

(Optional) Whether to create an Ethereum smart wallet for the user.

numberOfEthereumWalletsToCreate

number

(Optional) The number of Ethereum wallets to pregenerate for the user. Defaults to 1.

Returns

user

User

To create embedded wallets for an existing user, use the createWallets method from PrivyClient.

createWallets: ({userId: string, createEthereumWallet?: boolean, createSolanaWallet?: boolean, createEthereumSmartWallet?: boolean, numberOfEthereumWalletsToCreate?: number}) => Promise<User>

Usage

const user = await privy.createWallets({
    userId: 'did:privy:clddy332f002tyqpq3b3lv327',
    createEthereumWallet: true,
    createSolanaWallet: true,
    createEthereumSmartWallet: true,
    numberOfEthereumWalletsToCreate: 2,
});

Params

userId

string

required

The Privy user ID to create wallets for.

createEthereumWallet

boolean

(Optional) Whether to create an Ethereum wallet for the user.

createSolanaWallet

boolean

(Optional) Whether to create a Solana wallet for the user.

createEthereumSmartWallet

boolean

(Optional) Whether to create an Ethereum smart wallet for the user.

numberOfEthereumWalletsToCreate

number

(Optional) The number of Ethereum wallets to pregenerate for the user. Defaults to 1.

Returns

user

User

To pregenerate embedded wallets for a given user, make a POST request to https://auth.privy.io/api/v1/apps/<your-app-id>/users/wallet.

Usage

Below is a sample cURL command for generating a new wallet for a user with Privy:

$ curl --request POST https://auth.privy.io/api/v1/apps/<your-privy-app-id>/users/wallet \
-u "<your-privy-app-id>:<your-privy-app-secret>" \
-H "privy-app-id: <your-privy-app-id>" \
-H "Content-Type: application/json" \
-d '{
"user_id": "did:privy:clddy332f002tyqpq3b3lv327",
"create_ethereum_wallet": true
}'

A successful response will include the new user object along with their user ID and embedded wallet address, like below:

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

Parameters

userId

string

required

The Privy user ID to create wallets for.

createEthereumWallet

boolean

(Optional) Whether to create an Ethereum wallet for the user.

createSolanaWallet

boolean

(Optional) Whether to create a Solana wallet for the user.

createEthereumSmartWallet

boolean

(Optional) Whether to create an Ethereum smart wallet for the user.

numberOfEthereumWalletsToCreate

number

(Optional) The number of Ethereum wallets to pregenerate for the user. Defaults to 1.

Embedded wallets

Using embedded wallets

Funding

Gas and asset management

User signers

Session signers

Global wallets

Advanced Topics

Pregenerating wallets

Pregenerating wallets for new users

Usage

Params

Returns

Usage

Params

Returns

Usage

Parameters

Pregenerating wallets for existing users

Usage

Params

Returns

Usage

Params

Returns

Usage

Parameters

Embedded wallets

Using embedded wallets

Funding

Gas and asset management

User signers

Session signers

Global wallets

Advanced Topics

​Pregenerating wallets for new users

​Usage

​Params

​Returns

​Usage

​Params

​Returns

​Usage

​Parameters

​Pregenerating wallets for existing users

​Usage

​Params

​Returns

​Usage

​Params

​Returns

​Usage

​Parameters

Pregenerating wallets for new users

Usage

Params

Returns

Usage

Params

Returns

Usage

Parameters

Pregenerating wallets for existing users

Usage

Params

Returns

Usage

Params

Returns

Usage

Parameters