# Mnemonic

Ox's mnemonic API and its Node.js BIP-39 seed engine primitive.

## Examples

```ts twoslash
// @noErrors
import { Engine } from 'ox'
import { Mnemonic } from 'ox/node'

await Engine.install({ Mnemonic: Mnemonic.engine() })

Mnemonic.toSeed(
  'test test test test test test test test test test test junk'
)
```

## Functions

| Name                | Description                         |
| ------------------- | ----------------------------------- |
| [`Mnemonic.engine`](/node/crypto/Mnemonic/engine) | Creates a Node.js implementation of the [`Mnemonic`](/api/Mnemonic) engine slot, without installing it. |
| [`Mnemonic.path`](/node/crypto/Mnemonic/path) | Creates an Ethereum-based BIP-44 HD path. |
| [`Mnemonic.random`](/node/crypto/Mnemonic/random) | Generates a random mnemonic. |
| [`Mnemonic.toHdKey`](/node/crypto/Mnemonic/toHdKey) | Converts a mnemonic to a HD Key. |
| [`Mnemonic.toPrivateKey`](/node/crypto/Mnemonic/toPrivateKey) | Converts a mnemonic to a private key. |
| [`Mnemonic.toSeed`](/node/crypto/Mnemonic/toSeed) | Converts a mnemonic to a master seed. |
| [`Mnemonic.validate`](/node/crypto/Mnemonic/validate) | Checks if a mnemonic is valid, given a wordlist. |
