https://github.com/jovijovi/ether-keystore

A keystore toolkit for Ethereum ecosystem.
https://github.com/jovijovi/ether-keystore

ether ethereum keystore tookit typescript

Last synced: about 1 month ago
JSON representation

A keystore toolkit for Ethereum ecosystem.

• Host: GitHub
• URL: https://github.com/jovijovi/ether-keystore
• Owner: jovijovi
• License: mit
• Created: 2022-04-15T02:55:43.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-12-05T07:08:17.000Z (over 3 years ago)
• Last Synced: 2025-02-24T09:33:31.209Z (over 1 year ago)
• Topics: ether, ethereum, keystore, tookit, typescript
• Language: TypeScript
• Homepage:
• Size: 540 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Ether Keystore

[![npm](https://img.shields.io/npm/v/@jovijovi/ether-keystore.svg)](https://www.npmjs.com/package/@jovijovi/ether-keystore)

[![GitHub Actions](https://github.com/jovijovi/ether-keystore/workflows/Test/badge.svg)](https://github.com/jovijovi/ether-keystore)

[![Coverage](https://img.shields.io/codecov/c/github/jovijovi/ether-keystore?label=\&logo=codecov\&logoColor=fff)](https://codecov.io/gh/jovijovi/ether-keystore)

A keystore toolkit for Ethereum ecosystem.

## Philosophy

*:kiss: KISS. Keep it small and simple.*

## Features

- Retrieves wallet or private key from encrypted JSON wallet with password

- Keystore cache

## Development Environment

- typescript `4.9.3`

- node `v18.12.1`

- ts-node `v10.9.1`

- yarn `v1.22.19`

## Install

```shell

npm install @jovijovi/ether-keystore

```

or

```shell

yarn add @jovijovi/ether-keystore

```

## Usage

```typescript

import {keystore} from '@jovijovi/ether-keystore';

const pk = await keystore.InspectKeystorePK(

    '0x7a1bdd1481e5713e36f501a8cca4a9eaa423d547',   // Wallet address

    keystore.types.KeystoreTypeMiner,               // Keystore type

    'MTIzNDU2'                                      // Passphrase in BASE64

);

console.log("PK=", pk);

const wallet = await keystore.InspectKeystoreWallet(

    '0x7a1bdd1481e5713e36f501a8cca4a9eaa423d547',   // Wallet address

    keystore.types.KeystoreTypeFee,                 // Keystore type

    'MTIzNDU2'                                      // Passphrase in BASE64

);

console.debug("Wallet address=", wallet.address);

```

## Roadmap

- Documents

- Security keystore in memory

## License

[MIT](LICENSE)