History

Richard Moore 3396846a30 Added TypeScript declaration maps (#401 ).		2021-01-19 05:22:54 -05:00
..
lib	Added TypeScript declaration maps (#401 ).	2021-01-19 05:22:54 -05:00
lib.esm	Added TypeScript declaration maps (#401 ).	2021-01-19 05:22:54 -05:00
src.ts	Updated dist files.	2021-01-08 03:32:59 -05:00
.npmignore	Refactoring dist build process.	2020-11-14 17:42:36 -05:00
LICENSE.md	Initial v5 branch commit.	2019-05-14 18:25:46 -04:00
package.json	Lock package versions for the ESM builds (#1009 ).	2020-12-14 01:25:31 -05:00
README.md	Updated docs for all packages on npm pages (#1013 ).	2020-08-25 01:09:48 -04:00
thirdparty.d.ts	Removed UUID dependency from json-wallets (#966 ).	2020-07-20 01:33:15 -04:00
tsconfig.json	Updated dist files.	2020-09-22 23:18:45 -04:00

README.md

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