bip39

  • Version 3.1.0
  • Published
  • 331 kB
  • 1 dependency
  • ISC license

Install

npm i bip39
yarn add bip39
pnpm add bip39

Overview

Bitcoin BIP39: Mnemonic code for generating deterministic keys

Index

Variables

variable wordlists

const wordlists: { [index: string]: string[] };

    Functions

    function entropyToMnemonic

    entropyToMnemonic: (entropy: Buffer | string, wordlist?: string[]) => string;

      function generateMnemonic

      generateMnemonic: (
      strength?: number,
      rng?: (size: number) => Buffer,
      wordlist?: string[]
      ) => string;

        function getDefaultWordlist

        getDefaultWordlist: () => string;

          function mnemonicToEntropy

          mnemonicToEntropy: (mnemonic: string, wordlist?: string[]) => string;

            function mnemonicToSeed

            mnemonicToSeed: (mnemonic: string, password?: string) => Promise<Buffer>;

              function mnemonicToSeedSync

              mnemonicToSeedSync: (mnemonic: string, password?: string) => Buffer;

                function setDefaultWordlist

                setDefaultWordlist: (language: string) => void;

                  function validateMnemonic

                  validateMnemonic: (mnemonic: string, wordlist?: string[]) => boolean;

                    Package Files (2)

                    Dependencies (1)

                    Dev Dependencies (8)

                    Peer Dependencies (0)

                    No peer dependencies.

                    Badge

                    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/bip39.

                    • Markdown
                      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/bip39)
                    • HTML
                      <a href="https://www.jsdocs.io/package/bip39"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>