seed-words

Seed Words is a list of English words to be used in mnemonic seed phrases. There are a total of 256 x 256 = 65536 words. They can be used to represent any arbitrary 2 byte array with a single human-readable word. To represent a 16 byte array, 8 words are required, to represent a 32 byte array, 16 words are required and so on. Seed Words JS SDK provides programmatic access.

Example

Requires Node.js version v20.18.1 or higher

Installation:
npm install seed-words --save

//Adding reference:
var seedwords = require('seed-words');

//Initialize the SDK first before invoking any other function

seedwords.initialize().then((initResult) => {
     if (initResult === false) {
         console.log("error initializing");
     } else {
        console.log("initialized");
     }
}

• seed-words
  • ~initialize() ⇒ Promise.<boolean>
  • ~getAllSeedWords() ⇒ array
  • ~getWordListFromSeedArray(seedArray) ⇒ array
  • ~getSeedArrayFromWordList(wordList) ⇒ array
  • ~doesSeedWordExist(word) ⇒ boolean

seed-words~initialize() ⇒ Promise.<boolean>

The initialize function has to be called before attempting to invoke any other function. This function should be called only once.

Kind: inner method of seed-words
Returns: Promise.<boolean> - Returns a promise of type boolean; true if the initialization succeeded, else false.

seed-words~getAllSeedWords() ⇒ array

The getAllSeedWords function returns all the seed words in an array.

Kind: inner method of seed-words
Returns: array - Returns an array with the list of all seed words.

seed-words~getWordListFromSeedArray(seedArray) ⇒ array

The getWordListFromSeedArray function returns the word list corresponding to a byte array.

Kind: inner method of seed-words
Returns: array - Returns the array of words (string) corresponding to the input seed array. Returns null on failure. This function can fail if the seedArray is invalid or initialize() hasn't been called.

| Param | Type | Description | | --- | --- | --- | | seedArray | array | An array of bytes. This array should have an even number of elements. |

seed-words~getSeedArrayFromWordList(wordList) ⇒ array

The getSeedArrayFromWordList function a byte array that corresponds to the seed word list.

Kind: inner method of seed-words
Returns: array - Returns an array of bytes that correspond to the wordList. Returns null on failure. This function can fail if initialize() function was not called or the word doesn't exist.

| Param | Type | Description | | --- | --- | --- | | wordList | array | An array of seed words. |

seed-words~doesSeedWordExist(word) ⇒ boolean

The doesSeedWordExist function returns the word list corresponding to a byte array.

Kind: inner method of seed-words
Returns: boolean - Returns true if the seed word exists. Returns false if it doesn't exist. Returns null on failure. This function can fail if initialize() function was not called.

| Param | Type | Description | | --- | --- | --- | | word | string | A seed word to find whether it exists in the list or not. |