ethers.js/packages/json-wallets/README.md
2020-08-25 01:09:48 -04:00

48 lines
908 B
Markdown

Secret Storage JSON Wallet Utilities
====================================
This sub-module is part of the [ethers project](https://github.com/ethers-io/ethers.js).
It is responsible for encoding, decoding, encrypting and decrypting JSON wallet
formats.
For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/).
Importing
---------
Most users will prefer to use the [umbrella package](https://www.npmjs.com/package/ethers),
but for those with more specific needs, individual components can be imported.
```javascript
const {
isCrowdsaleWallet,
decryptCrowdsale,
isKeystoreWallet,
decryptKeystore,
decryptKeystoreSync,
encryptKeystore,
getJsonWalletAddress,
decryptJsonWallet,
decryptJsonWalletSync,
// Types
ProgressCallback,
EncryptOptions
} = require("@ethersproject/json-wallets");
```
License
-------
MIT License