importPrivateKey()

Imports a private key from an encrypted bundle.

This function imports a private key using the provided encrypted bundle.
If a userId is provided, the private key will be imported for that specific user; otherwise, it uses the current session’s userId.
Requires address formats to
Automatically infers the cryptographic curve used to generate the private key based on the address format (can be optionally overriden if needed).
The encrypted bundle MUST be encrypted to ensure security.
Automatically ensures an active session exists before making the request.
Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).

Package: core

Defined in: core.ts:3427

params

object

required

Show params details

params.addressFormats

v1AddressFormat[]

required

params.curve

v1Curve

required

the cryptographic curve used to generate a given private key

params.encryptedBundle

string

required

encrypted bundle containing the private key key material and metadata.

params.privateKeyName

string

required

name of the private key to create upon import.

params.stampWith

StamperType

parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).

params.userId

string

user ID to import the wallet for a specific user (defaults to the current session’s userId).

A successful response returns the following fields:

returns

string

required

A promise that resolves to the ID of the imported wallet.