wallet

Create new wallet from existing mnemonic seed

Creates a wallet from a mnemonic the caller already has (e.g. one previously returned by /wallet/init, or generated elsewhere). The mnemonic is converted to a BIP-32 seed (optionally salted with mnemonicPass) and the resulting secret is encrypted on disk with pass. Note the usePre1627KeyDerivation flag — see its field description.

post/wallet/restore

Request

Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
URL: /wallet/restore
Auth: API key in header api_key

Request body

passstring required

Spending password used to encrypt the wallet secret storage on disk. Required on every /wallet/unlock afterwards. Not recoverable — losing it means restoring from the mnemonic.

mnemonicstring required

BIP-39 mnemonic seed phrase (space-separated words) the wallet will be restored from.

mnemonicPassstring

Optional BIP-39 passphrase (a.k.a. 25th word) mixed into the seed derivation. Distinct from pass and not stored by the node. Must match the value used when the mnemonic was originally generated, otherwise a different wallet will be restored silently.

usePre1627KeyDerivationboolean required

Use the legacy (pre-EIP-3) BIP-32 key derivation that was the default before node v4.0.105. Set true only when restoring a wallet originally created on an older node; new wallets should use false. See https://github.com/ergoplatform/ergo/issues/1627 for details.

Response

Wallet restored successfully

Changes

No recorded changes to this operation across all 9 revisions of this API.