@ravenite/ravencoin-mnemonic
v1.5.0
Published
![Ravenite Mnemonic Banner](https://github.com/Ravenites/ravencoin-mnemonic/raw/main/media/repo-banner.png)
Downloads
14
Readme
Ravenite - Ravencoin Mnemonic
A Ravenite module for ravencoin that implements Mnemonic code for generating deterministic keys.
Getting Started
# Using npm
npm install @ravenite/ravencoin-mnemonic
# Using yarn
yarn add @ravenite/ravencoin-mnemonic
Usage
import { Mnemonic } from '@ravenite/ravencoin-mnemonic';
const code = new Mnemonic({ network: 'mainnet' });
code.toString();
Parameters
| Name | Type | Default Value | Description | | ---------- | ------ | ------------- | --------------------------------------------------------------------------------- | | mnemonic | string | undefined | Seed phrase (e.g. job shop small, etc...) | | network | string | testnet | Blockchain network you are generating for | | passphrase | string | undefined | String to strengthen encryption with the seed phrase | | language | string | english | Language to generate seed phrase in | | account | number | undefined | If you would like to start the receive and change path from a number other than 0 |
Examples
See EXAMPLES.md for developer guides.
Available Mnemonic Languages
- chinese_simplified
- chinese_traditional
- czech
- english
- french
- italian
- japanese
- korean
- portuguese
- spanish
Contributing
See CONTRIBUTING.md at base of repo for information about how to contribute.
License
Code released under the MIT license.