@ethersproject/json-wallets

What is @ethersproject/json-wallets?

@ethersproject/json-wallets is a part of the ethers.js library, which provides utilities for handling JSON wallets. JSON wallets are a common format for storing Ethereum private keys in a secure, encrypted manner. This package allows you to create, encrypt, decrypt, and manage these wallets.

What are @ethersproject/json-wallets's main functionalities?

Creating a JSON Wallet

This feature allows you to create a new Ethereum wallet and encrypt it into a JSON format using a password.

const { Wallet } = require('@ethersproject/wallet');
const { save } = require('@ethersproject/json-wallets');

async function createJsonWallet(password) {
  const wallet = Wallet.createRandom();
  const json = await wallet.encrypt(password);
  console.log(json);
}

createJsonWallet('your-password');

Decrypting a JSON Wallet

This feature allows you to decrypt an existing JSON wallet using the password it was encrypted with, and access the wallet's address and other properties.

const { Wallet } = require('@ethersproject/wallet');
const { fromEncryptedJson } = require('@ethersproject/json-wallets');

async function decryptJsonWallet(json, password) {
  const wallet = await Wallet.fromEncryptedJson(json, password);
  console.log(wallet.address);
}

decryptJsonWallet('your-json-wallet', 'your-password');

Saving a JSON Wallet to a File

This feature allows you to create a new JSON wallet and save it to a file for later use.

const { Wallet } = require('@ethersproject/wallet');
const { save } = require('@ethersproject/json-wallets');
const fs = require('fs');

async function saveJsonWalletToFile(password, filePath) {
  const wallet = Wallet.createRandom();
  const json = await wallet.encrypt(password);
  fs.writeFileSync(filePath, json);
}

saveJsonWalletToFile('your-password', 'wallet.json');

Other packages similar to @ethersproject/json-wallets

web3

web3.js is a collection of libraries that allow you to interact with a local or remote Ethereum node using HTTP, IPC, or WebSocket. It provides similar functionalities for handling wallets, including creating, encrypting, and decrypting JSON wallets. However, web3.js is a more comprehensive library that includes many other features for interacting with the Ethereum blockchain.

eth-lightwallet

eth-lightwallet is a lightweight JavaScript library for managing Ethereum wallets. It provides functionalities for creating, encrypting, and decrypting JSON wallets, similar to @ethersproject/json-wallets. However, it is designed to be more lightweight and focused specifically on wallet management.

ethereumjs-wallet

ethereumjs-wallet is a simple library for creating and managing Ethereum wallets. It supports creating, encrypting, and decrypting JSON wallets, similar to @ethersproject/json-wallets. It is part of the larger ethereumjs suite of libraries, which provide various tools for interacting with Ethereum.

README

Secret Storage JSON Wallet Utilities

This sub-module is part of the ethers project.

It is responsible for encoding, decoding, encrypting and decrypting JSON wallet formats.

For more information, see the documentation.

Importing

Most users will prefer to use the umbrella package, but for those with more specific needs, individual components can be imported.

const {

    isCrowdsaleWallet,
    decryptCrowdsale,

    isKeystoreWallet,
    decryptKeystore,
    decryptKeystoreSync,
    encryptKeystore,

    getJsonWalletAddress,

    decryptJsonWallet,
    decryptJsonWalletSync,

    // Types

    ProgressCallback,

    EncryptOptions

} = require("@ethersproject/json-wallets");

License

MIT License