# arweave-mnemonic-keys

> Utilities for generating Arweave Keys without keyfiles

Latest version **0.0.9** (published 2021-02-10) · 0 weekly downloads

## Install

```sh
npm install arweave-mnemonic-keys
pnpm add arweave-mnemonic-keys
yarn add arweave-mnemonic-keys
bun add arweave-mnemonic-keys
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.9 |
| Published | 2021-02-10 |
| First published | 2020-11-08 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 15.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | acolytec3 |
| Maintainers | acolytec3 |
| Keywords | typescript, arweave, mnemonic |

## Links

- npm: https://www.npmjs.com/package/arweave-mnemonic-keys
- Repository: https://github.com/acolytec3/arweave-mnemonic-keys
- Homepage: https://github.com/acolytec3/arweave-mnemonic-keys#readme
- Issues: https://github.com/acolytec3/arweave-mnemonic-keys/issues
- npm.io page: https://npm.io/package/arweave-mnemonic-keys

## Dependencies (2)

- [libp2p-crypto](https://npm.io/package/libp2p-crypto.md) ^0.19.0
- [human-crypto-keys](https://npm.io/package/human-crypto-keys.md) ^0.1.4

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.0.9 (latest) — 2021-02-10
- 0.0.8 — 2021-02-10
- 0.0.7 — 2021-02-10
- 0.0.6 — 2021-02-10
- 0.0.5 — 2021-02-08
- 0.0.4 — 2021-02-08
- 0.0.3 — 2020-12-21
- 0.0.2 — 2020-11-08
- 0.0.1 — 2020-11-08

## README

Arweave Mnemonic Keys
===========================

This library allows Arweave wallets/keys to be generated/loaded from BIP39-compliant 12 word mnemonics.  This is as an alternative to the current default Arweave dapp behavior of requiring a JSON keyfile to be provided to sign transactions and interact with Arweave dapps.

See [ArMob 2.0](https://acolytec3.github.io/armob-2.0) for an example use case

This package is also served through OpenBits (http://openbits.world)

Note: It takes anywhere from 30 seconds to 2 minutes to generate an RSA key using this library cuz well...Javascript can be slow.

# 🎉 Features

- Generate BIP39 compliant 12 word mnemonics
- Generate Arweave compliant wallets from 12 word mnemonics
# ⚙ Install

```bash
# npm
npm install arweave-mnemonic-keys

# openbits
openbits install arweave-mnemonic-keys
```

# 📖 Usage

### Functions

* [generateMnemonic](README.md#generatemnemonic)
* [getKeyFromMnemonic](README.md#getkeyfrommnemonic)

## Functions

###  generateMnemonic

▸ **generateMnemonic**(): *Promise‹any›*

Defined in arweaveMnemonicKeys.ts:8

Generate a 12 word mnemonic for an Arweave key

**Returns:** *Promise‹any›*

- a promise resolving to a 12 word mnemonic seed phrase

___

###  getKeyFromMnemonic

▸ **getKeyFromMnemonic**(`mnemonic`: string): *Promise‹any›*

Defined in arweaveMnemonicKeys.ts:30

Generates a JWK object representation of an Arweave key

**`example`** <caption>Generate an Arweave key and get its public address</caption>
let key = getKeyFromMnemonic('jewel cave spy act loyal solid night manual joy select mystery unhappy')
arweave.wallets.jwkToAddress(key)
//returns qe741op_rt-iwBazAqJipTc15X8INlDCoPz6S40RBdg

**Parameters:**

Name | Type | Description |
------ | ------ | ------ |
`mnemonic` | string | a 12 word mnemonic represented as a string |

**Returns:** *Promise‹any›*

- returns a Javascript object that conforms to the JWKInterface required by Arweave-js

---
_Source: https://npm.io/package/arweave-mnemonic-keys · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._