Wallet

The wallet system provides BIP39 mnemonic generation with SLIP-0010 ed25519 hierarchical deterministic key derivation. All signing happens client-side — private keys never leave the device.

Wallet

Static methods

Wallet.generate()

Create a new wallet with a cryptographically random 12-word BIP39 mnemonic.

const wallet = Wallet.generate()
console.log(wallet.getMnemonic())
// → "abandon badge civil damage enforce fabric ghost ..."

Wallet.fromMnemonic(mnemonic, password?)

Restore a wallet from an existing mnemonic. Optional BIP39 passphrase for additional entropy.

const wallet = Wallet.fromMnemonic('abandon badge civil ...')
const wallet = Wallet.fromMnemonic('abandon badge civil ...', 'optional-passphrase')

Wallet.fromPrivateKey(privateKey)

Create a standalone WalletAccount from a raw ed25519 private key (32 bytes, hex-encoded). No mnemonic, no HD derivation.

const account = Wallet.fromPrivateKey('a1b2c3d4...')

Returns a WalletAccount, not a Wallet.

Instance methods

getMnemonic(): string

Returns the BIP39 mnemonic phrase.

wallet.getMnemonic() // "abandon badge civil ..."

getMnemonicWords(): string[]

Returns the mnemonic as an array of words.

wallet.getMnemonicWords() // ["abandon", "badge", "civil", ...]

getAccount(index?: number): WalletAccount

Derive an account at the given BIP-44 index. Default index is 0.

const primary = wallet.getAccount()     // index 0
const second = wallet.getAccount(1)     // index 1

Derivation path: m/44'/60'/0'/0/{index} (all hardened, per SLIP-0010).

getAccounts(count, startIndex?): WalletAccount[]

Derive multiple accounts in a batch.

const accounts = wallet.getAccounts(5)       // indices 0–4
const accounts = wallet.getAccounts(3, 10)   // indices 10–12

get address: string

Shorthand for the primary account’s address (getAccount(0).address).

wallet.address // "omne1a3f7c..."

signTransaction(transaction, accountIndex?): SignedTransaction

Sign a transaction using the account at the given index.

const signed = wallet.signTransaction(tx)       // signs with account 0
const signed = wallet.signTransaction(tx, 2)    // signs with account 2

exportWallet(password): Promise<ExportedWallet>

Export the wallet’s mnemonic and all derived accounts as encrypted keystores.

const exported = await wallet.exportWallet('strong-password')
// { mnemonic: "...", accounts: [Keystore, ...] }

WalletAccount

Represents a single keypair with signing capabilities.

Properties

Methods

signTransaction(transaction): SignedTransaction

Sign a transaction with this account’s private key. Returns the transaction with an attached signature field.

const signed = account.signTransaction({
  from: account.address,
  to: 'omne1recipient...',
  value: '1000000000000000000',
  gasLimit: 21000,
  gasPrice: '1000',
  nonce: 0,
})
 
console.log(signed.signature) // ed25519 signature, hex-encoded

Signing process:

1. Canonical transaction message is constructed (little-endian numeric encoding)
2. SHA-256 hash of the message
3. ed25519 signature over the hash
4. Signature (64 bytes) concatenated with public key (32 bytes)

signMessage(message): string

Sign an arbitrary string message. Returns the signature + public key concatenated (hex-encoded).

const sig = account.signMessage('Hello, Omne!')

toKeystore(password): Promise<Keystore>

Export this account to an encrypted JSON keystore (PBKDF2 + AES-256-GCM).

const ks = await account.toKeystore('my-password')

WalletAccount.fromKeystore(keystore, password): Promise<WalletAccount>

Restore an account from an encrypted keystore.

const restored = await WalletAccount.fromKeystore(ks, 'my-password')

WalletAccount.fromPrivateKey(privateKey): WalletAccount

Create an account from a raw private key.

const account = WalletAccount.fromPrivateKey('a1b2c3...')

WalletManager

Manages multiple wallets and standalone accounts.

import { WalletManager } from '@omne/sdk'
 
const manager = new WalletManager()
 
// Create wallets
const w1 = manager.createWallet('main')
const w2 = manager.importWallet('abandon badge ...', 'backup')
 
// Import a standalone account
manager.importAccount('a1b2c3...', 'hot-key')
 
// List
manager.listWallets()   // ['main', 'backup']
manager.listAccounts()  // ['hot-key']
 
// Retrieve
const wallet = manager.getWallet('main')
const account = manager.getAccount('hot-key')
 
// Clean up
manager.removeWallet('backup')
manager.clear() // Remove everything

Cryptographic details