🔗evm

Description

The isMnemonic function is used to validate the format and correctness of a mnemonic phrase. It accepts a mnemonic phrase as a string and an optional wordlist parameter, which represents the wordlist used to generate the mnemonic (default is the English wordlist). The function returns a boolean value indicating whether the mnemonic is valid or not.

Parameters

Parameter	Data Type	Description
mnemonic	string	The mnemonic phrase to be validated.
wordlist	Wordlist	(Optional) The wordlist used to generate the mnemonic. Default is English.

Response

Field	Data Type	Description
return value	boolean	Indicates whether the mnemonic is valid (true) or not (false).

Example Request and Response

Prerequisites

Before making requests with Volary SDK, you must have it installed.

You can install Volary SDK using either npm or yarn. Use the following commands to install Volary SDK:

npm install @nest25/wallet-lib
OR
yarn add @nest25/wallet-lib

Request

Here is an example of how to make a isMnemonic request using the Volary SDK:

const { Wallet } = require('@nest25/wallet-lib');

const wallet = new Wallet('');

async function main() {
  const response = await wallet.isMnemonic(
    'labor shaft stick degree figure trade outdoor deposit urge clog cattle feed',
  );
  console.log(response);
}

main();

Response

  { true }

Use Cases

• Validating a mnemonic phrase: By invoking this function with a mnemonic phrase, you can check if the provided mnemonic is in the correct format and corresponds to a valid mnemonic phrase.

• Custom wordlist support: You can optionally provide a custom wordlist parameter if the mnemonic was generated using a different wordlist than the default English wordlist.