Skip to main content

Import from keystore

A keystore file is an encrypted version of your private key, often used in web3-enabled applications (e.g. those using ethers.js or web3.js) and in some legacy DEXes or crypto wallets.

ChainGate supports both Web3-compatible keystores (commonly generated via libraries like ethers.js or web3.js) and legacy JSON keystores used in some older crypto applications.

Keep your keystore safe!

If someone gains access to your keystore and the password, they can control your wallet and funds.

No derivation paths

If the keystore's underlying secret is a private key (not a mnemonic phrase), derivation paths are not supported.
These wallets are bound to a single address, and you cannot derive additional accounts from them.

Initialize from a keystore​

Use a keystore file (JSON object) and its password to create a wallet instance:

import { initializeWallet } from 'chaingate'

const wallet = await initializeWallet.fromKeystore({
  apiKey: 'your-api-key-from-dashboard',
  keystore: 'your keystore JSON string',
  password: 'your-keystore-password'
})
info

ChainGate automatically detects the keystore type (Web3-like or legacy) and imports it accordingly.

Accessing wallet​

Once initialized, you can use all standard wallet methods:

import { initializeWallet } from 'chaingate'

const wallet = intializeWallet.fromKeystore({...})
const bitcoin = wallet.currency('bitcoin')
console.log(await bitcoin.getAddress())

Check keystore validity​

Before initializing your wallet, validate the keystore phrase using checkKeystore(). This ensures compatibility and prevents errors during wallet creation:

import { readFileSync } from 'fs'
import { initializeWallet } from 'chaingate'

const keystoreBuffer = readFileSync('keystore.json').toString()

// Check if the keystore is valid
const isValid = await initializeWallet.checkKeystore(keystore)
if (!isValid) {
    throw new Error('Invalid keystore or incorrect password')
}

// Define your password
const password = 'your-keystore-password'

// Proceed with initialization if valid
const wallet = await initializeWallet.fromKeystore({
    apiKey: 'your-api-key-from-dashboard',
    keystore,
    password,
})

Exporting a wallet created from keystore​

Wallets created from a keystore cannot be exported back into a keystore file.
To back up or persist your wallet, you must serialize it instead.

👉 Learn how to serialize your wallet

info

Serialization allows you to securely export and later restore a wallet instance. It is the recommended way to back up wallets.