ethers.js/lib.esm/wallet/wallet.js

141 lines
5.4 KiB
JavaScript
Raw Normal View History

2022-11-10 12:05:51 +03:00
import { SigningKey } from "../crypto/index.js";
import { assertArgument } from "../utils/index.js";
2022-09-05 23:57:11 +03:00
import { BaseWallet } from "./base-wallet.js";
import { HDNodeWallet } from "./hdwallet.js";
import { decryptCrowdsaleJson, isCrowdsaleJson } from "./json-crowdsale.js";
2022-11-30 23:44:23 +03:00
import { decryptKeystoreJson, decryptKeystoreJsonSync, encryptKeystoreJson, encryptKeystoreJsonSync, isKeystoreJson } from "./json-keystore.js";
2022-09-05 23:57:11 +03:00
import { Mnemonic } from "./mnemonic.js";
function stall(duration) {
return new Promise((resolve) => { setTimeout(() => { resolve(); }, duration); });
}
2022-11-30 23:44:23 +03:00
/**
* A **Wallet** manages a single private key which is used to sign
* transactions, messages and other common payloads.
*
* This class is generally the main entry point for developers
* that wish to use a private key directly, as it can create
* instances from a large variety of common sources, including
* raw private key, [[link-bip-39]] mnemonics and encrypte JSON
* wallets.
*/
2022-09-05 23:57:11 +03:00
export class Wallet extends BaseWallet {
2022-12-03 05:27:06 +03:00
/**
* Create a new wallet for the %%privateKey%%, optionally connected
* to %%provider%%.
*/
2022-09-05 23:57:11 +03:00
constructor(key, provider) {
2022-11-10 12:05:51 +03:00
let signingKey = (typeof (key) === "string") ? new SigningKey(key) : key;
2022-09-05 23:57:11 +03:00
super(signingKey, provider);
}
connect(provider) {
2022-11-10 12:05:51 +03:00
return new Wallet(this.signingKey, provider);
2022-09-05 23:57:11 +03:00
}
2022-11-30 23:44:23 +03:00
/**
* Resolves to a [JSON Keystore Wallet](json-wallets) encrypted with
* %%password%%.
*
* If %%progressCallback%% is specified, it will receive periodic
* updates as the encryption process progreses.
*/
async encrypt(password, progressCallback) {
const account = { address: this.address, privateKey: this.privateKey };
return await encryptKeystoreJson(account, password, { progressCallback });
}
/**
* Returns a [JSON Keystore Wallet](json-wallets) encryped with
* %%password%%.
*
* It is preferred to use the [async version](encrypt) instead,
* which allows a [[ProgressCallback]] to keep the user informed.
*
* This method will block the event loop (freezing all UI) until
* it is complete, which may be a non-trivial duration.
*/
encryptSync(password) {
const account = { address: this.address, privateKey: this.privateKey };
return encryptKeystoreJsonSync(account, password);
}
2022-11-10 12:05:51 +03:00
static #fromAccount(account) {
assertArgument(account, "invalid JSON wallet", "json", "[ REDACTED ]");
if ("mnemonic" in account && account.mnemonic && account.mnemonic.locale === "en") {
const mnemonic = Mnemonic.fromEntropy(account.mnemonic.entropy);
const wallet = HDNodeWallet.fromMnemonic(mnemonic, account.mnemonic.path);
if (wallet.address === account.address && wallet.privateKey === account.privateKey) {
return wallet;
}
console.log("WARNING: JSON mismatch address/privateKey != mnemonic; fallback onto private key");
}
const wallet = new Wallet(account.privateKey);
assertArgument(wallet.address === account.address, "address/privateKey mismatch", "json", "[ REDACTED ]");
return wallet;
2022-09-05 23:57:11 +03:00
}
2022-12-03 05:27:06 +03:00
/**
* Creates (asynchronously) a **Wallet** by decrypting the %%json%%
* with %%password%%.
*
* If %%progress%% is provided, it is called periodically during
* decryption so that any UI can be updated.
*/
2022-09-05 23:57:11 +03:00
static async fromEncryptedJson(json, password, progress) {
let account = null;
if (isKeystoreJson(json)) {
account = await decryptKeystoreJson(json, password, progress);
}
else if (isCrowdsaleJson(json)) {
if (progress) {
progress(0);
await stall(0);
}
account = decryptCrowdsaleJson(json, password);
if (progress) {
progress(1);
await stall(0);
}
}
2022-11-10 12:05:51 +03:00
return Wallet.#fromAccount(account);
2022-09-05 23:57:11 +03:00
}
2022-12-03 05:27:06 +03:00
/**
* Creates a **Wallet** by decrypting the %%json%% with %%password%%.
*
* The [[fromEncryptedJson]] method is preferred, as this method
* will lock up and freeze the UI during decryption, which may take
* some time.
*/
2022-09-05 23:57:11 +03:00
static fromEncryptedJsonSync(json, password) {
let account = null;
if (isKeystoreJson(json)) {
account = decryptKeystoreJsonSync(json, password);
}
else if (isCrowdsaleJson(json)) {
account = decryptCrowdsaleJson(json, password);
}
else {
2022-11-09 10:57:02 +03:00
assertArgument(false, "invalid JSON wallet", "json", "[ REDACTED ]");
2022-09-05 23:57:11 +03:00
}
2022-11-10 12:05:51 +03:00
return Wallet.#fromAccount(account);
2022-09-05 23:57:11 +03:00
}
2022-12-03 05:27:06 +03:00
/**
* Creates a new random [[HDNodeWallet]] using the avavilable
* [cryptographic random source](randomBytes).
*
* If there is no crytographic random source, this will throw.
*/
2022-11-10 12:05:51 +03:00
static createRandom(provider) {
const wallet = HDNodeWallet.createRandom();
if (provider) {
return wallet.connect(provider);
}
return wallet;
2022-09-05 23:57:11 +03:00
}
2022-12-03 05:27:06 +03:00
/**
* Creates a [[HDNodeWallet]] for %%phrase%%.
*/
2022-11-10 12:05:51 +03:00
static fromPhrase(phrase, provider) {
const wallet = HDNodeWallet.fromPhrase(phrase);
if (provider) {
return wallet.connect(provider);
2022-09-16 05:58:45 +03:00
}
2022-11-10 12:05:51 +03:00
return wallet;
2022-09-05 23:57:11 +03:00
}
}
//# sourceMappingURL=wallet.js.map