ethers.js/packages/wallet/lib/index.js

248 lines
12 KiB
JavaScript
Raw Permalink Normal View History

2019-05-14 18:48:48 -04:00
"use strict";
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
2021-03-07 18:24:04 -05:00
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
2019-05-14 18:48:48 -04:00
return extendStatics(d, b);
};
return function (d, b) {
2021-03-07 18:24:04 -05:00
if (typeof b !== "function" && b !== null)
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
2019-05-14 18:48:48 -04:00
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
2020-10-18 23:19:16 -04:00
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
2019-05-14 18:48:48 -04:00
Object.defineProperty(exports, "__esModule", { value: true });
2021-03-07 18:24:04 -05:00
exports.verifyTypedData = exports.verifyMessage = exports.Wallet = void 0;
2019-05-14 18:48:48 -04:00
var address_1 = require("@ethersproject/address");
var abstract_provider_1 = require("@ethersproject/abstract-provider");
var abstract_signer_1 = require("@ethersproject/abstract-signer");
var bytes_1 = require("@ethersproject/bytes");
var hash_1 = require("@ethersproject/hash");
var hdnode_1 = require("@ethersproject/hdnode");
var keccak256_1 = require("@ethersproject/keccak256");
var properties_1 = require("@ethersproject/properties");
var random_1 = require("@ethersproject/random");
var signing_key_1 = require("@ethersproject/signing-key");
var json_wallets_1 = require("@ethersproject/json-wallets");
var transactions_1 = require("@ethersproject/transactions");
2019-08-02 02:10:58 -04:00
var logger_1 = require("@ethersproject/logger");
var _version_1 = require("./_version");
var logger = new logger_1.Logger(_version_1.version);
2019-05-14 18:48:48 -04:00
function isAccount(value) {
2021-10-16 02:29:27 -04:00
return (value != null && (0, bytes_1.isHexString)(value.privateKey, 32) && value.address != null);
2019-05-14 18:48:48 -04:00
}
2020-01-18 21:48:12 -05:00
function hasMnemonic(value) {
var mnemonic = value.mnemonic;
return (mnemonic && mnemonic.phrase);
}
2019-05-14 18:48:48 -04:00
var Wallet = /** @class */ (function (_super) {
__extends(Wallet, _super);
function Wallet(privateKey, provider) {
2022-05-12 17:30:28 -04:00
var _this = _super.call(this) || this;
2019-05-14 18:48:48 -04:00
if (isAccount(privateKey)) {
var signingKey_1 = new signing_key_1.SigningKey(privateKey.privateKey);
2021-10-16 02:29:27 -04:00
(0, properties_1.defineReadOnly)(_this, "_signingKey", function () { return signingKey_1; });
(0, properties_1.defineReadOnly)(_this, "address", (0, transactions_1.computeAddress)(_this.publicKey));
if (_this.address !== (0, address_1.getAddress)(privateKey.address)) {
2020-04-23 23:35:39 -04:00
logger.throwArgumentError("privateKey/address mismatch", "privateKey", "[REDACTED]");
2019-05-14 18:48:48 -04:00
}
2020-01-18 21:48:12 -05:00
if (hasMnemonic(privateKey)) {
var srcMnemonic_1 = privateKey.mnemonic;
2021-10-16 02:29:27 -04:00
(0, properties_1.defineReadOnly)(_this, "_mnemonic", function () { return ({
2020-01-18 21:48:12 -05:00
phrase: srcMnemonic_1.phrase,
path: srcMnemonic_1.path || hdnode_1.defaultPath,
locale: srcMnemonic_1.locale || "en"
}); });
var mnemonic = _this.mnemonic;
var node = hdnode_1.HDNode.fromMnemonic(mnemonic.phrase, null, mnemonic.locale).derivePath(mnemonic.path);
2021-10-16 02:29:27 -04:00
if ((0, transactions_1.computeAddress)(node.privateKey) !== _this.address) {
2020-04-23 23:35:39 -04:00
logger.throwArgumentError("mnemonic/address mismatch", "privateKey", "[REDACTED]");
2019-05-14 18:48:48 -04:00
}
}
else {
2021-10-16 02:29:27 -04:00
(0, properties_1.defineReadOnly)(_this, "_mnemonic", function () { return null; });
2019-05-14 18:48:48 -04:00
}
}
else {
2019-06-11 17:57:04 -04:00
if (signing_key_1.SigningKey.isSigningKey(privateKey)) {
2020-07-13 08:03:56 -04:00
/* istanbul ignore if */
2019-06-11 17:57:04 -04:00
if (privateKey.curve !== "secp256k1") {
2019-08-02 02:10:58 -04:00
logger.throwArgumentError("unsupported curve; must be secp256k1", "privateKey", "[REDACTED]");
2019-06-11 17:57:04 -04:00
}
2021-10-16 02:29:27 -04:00
(0, properties_1.defineReadOnly)(_this, "_signingKey", function () { return privateKey; });
2019-05-14 18:48:48 -04:00
}
else {
2020-11-22 22:44:33 -05:00
// A lot of common tools do not prefix private keys with a 0x (see: #1166)
if (typeof (privateKey) === "string") {
if (privateKey.match(/^[0-9a-f]*$/i) && privateKey.length === 64) {
privateKey = "0x" + privateKey;
}
}
2019-05-14 18:48:48 -04:00
var signingKey_2 = new signing_key_1.SigningKey(privateKey);
2021-10-16 02:29:27 -04:00
(0, properties_1.defineReadOnly)(_this, "_signingKey", function () { return signingKey_2; });
2019-05-14 18:48:48 -04:00
}
2021-10-16 02:29:27 -04:00
(0, properties_1.defineReadOnly)(_this, "_mnemonic", function () { return null; });
(0, properties_1.defineReadOnly)(_this, "address", (0, transactions_1.computeAddress)(_this.publicKey));
2019-05-14 18:48:48 -04:00
}
2020-07-13 08:03:56 -04:00
/* istanbul ignore if */
2019-06-11 17:57:04 -04:00
if (provider && !abstract_provider_1.Provider.isProvider(provider)) {
2019-08-02 02:10:58 -04:00
logger.throwArgumentError("invalid provider", "provider", provider);
2019-05-14 18:48:48 -04:00
}
2021-10-16 02:29:27 -04:00
(0, properties_1.defineReadOnly)(_this, "provider", provider || null);
2019-05-14 18:48:48 -04:00
return _this;
}
Object.defineProperty(Wallet.prototype, "mnemonic", {
get: function () { return this._mnemonic(); },
2021-03-07 18:24:04 -05:00
enumerable: false,
2019-05-14 18:48:48 -04:00
configurable: true
});
Object.defineProperty(Wallet.prototype, "privateKey", {
get: function () { return this._signingKey().privateKey; },
2021-03-07 18:24:04 -05:00
enumerable: false,
2019-05-14 18:48:48 -04:00
configurable: true
});
Object.defineProperty(Wallet.prototype, "publicKey", {
get: function () { return this._signingKey().publicKey; },
2021-03-07 18:24:04 -05:00
enumerable: false,
2019-05-14 18:48:48 -04:00
configurable: true
});
Wallet.prototype.getAddress = function () {
return Promise.resolve(this.address);
};
Wallet.prototype.connect = function (provider) {
return new Wallet(this, provider);
};
Wallet.prototype.signTransaction = function (transaction) {
var _this = this;
2021-10-16 02:29:27 -04:00
return (0, properties_1.resolveProperties)(transaction).then(function (tx) {
2019-05-14 18:48:48 -04:00
if (tx.from != null) {
2021-10-16 02:29:27 -04:00
if ((0, address_1.getAddress)(tx.from) !== _this.address) {
2020-07-13 08:03:56 -04:00
logger.throwArgumentError("transaction from address mismatch", "transaction.from", transaction.from);
2019-05-14 18:48:48 -04:00
}
delete tx.from;
}
2021-10-16 02:29:27 -04:00
var signature = _this._signingKey().signDigest((0, keccak256_1.keccak256)((0, transactions_1.serialize)(tx)));
return (0, transactions_1.serialize)(tx, signature);
2019-05-14 18:48:48 -04:00
});
};
Wallet.prototype.signMessage = function (message) {
2020-10-18 23:19:16 -04:00
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
2021-10-16 02:29:27 -04:00
return [2 /*return*/, (0, bytes_1.joinSignature)(this._signingKey().signDigest((0, hash_1.hashMessage)(message)))];
2020-10-18 23:19:16 -04:00
});
});
};
Wallet.prototype._signTypedData = function (domain, types, value) {
return __awaiter(this, void 0, void 0, function () {
var populated;
var _this = this;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, hash_1._TypedDataEncoder.resolveNames(domain, types, value, function (name) {
if (_this.provider == null) {
logger.throwError("cannot resolve ENS names without a provider", logger_1.Logger.errors.UNSUPPORTED_OPERATION, {
2020-11-16 23:07:24 -05:00
operation: "resolveName",
value: name
2020-10-18 23:19:16 -04:00
});
}
return _this.provider.resolveName(name);
})];
case 1:
populated = _a.sent();
2021-10-16 02:29:27 -04:00
return [2 /*return*/, (0, bytes_1.joinSignature)(this._signingKey().signDigest(hash_1._TypedDataEncoder.hash(populated.domain, types, populated.value)))];
2020-10-18 23:19:16 -04:00
}
});
});
2019-05-14 18:48:48 -04:00
};
Wallet.prototype.encrypt = function (password, options, progressCallback) {
if (typeof (options) === "function" && !progressCallback) {
progressCallback = options;
options = {};
}
if (progressCallback && typeof (progressCallback) !== "function") {
throw new Error("invalid callback");
}
if (!options) {
options = {};
}
2021-10-16 02:29:27 -04:00
return (0, json_wallets_1.encryptKeystore)(this, password, options, progressCallback);
2019-05-14 18:48:48 -04:00
};
/**
* Static methods to create Wallet instances.
*/
Wallet.createRandom = function (options) {
2021-10-16 02:29:27 -04:00
var entropy = (0, random_1.randomBytes)(16);
2019-05-14 18:48:48 -04:00
if (!options) {
options = {};
}
if (options.extraEntropy) {
2021-10-16 02:29:27 -04:00
entropy = (0, bytes_1.arrayify)((0, bytes_1.hexDataSlice)((0, keccak256_1.keccak256)((0, bytes_1.concat)([entropy, options.extraEntropy])), 0, 16));
2019-05-14 18:48:48 -04:00
}
2021-10-16 02:29:27 -04:00
var mnemonic = (0, hdnode_1.entropyToMnemonic)(entropy, options.locale);
2019-05-14 18:48:48 -04:00
return Wallet.fromMnemonic(mnemonic, options.path, options.locale);
};
Wallet.fromEncryptedJson = function (json, password, progressCallback) {
2021-10-16 02:29:27 -04:00
return (0, json_wallets_1.decryptJsonWallet)(json, password, progressCallback).then(function (account) {
2019-05-14 18:48:48 -04:00
return new Wallet(account);
});
};
2020-02-27 19:58:05 +00:00
Wallet.fromEncryptedJsonSync = function (json, password) {
2021-10-16 02:29:27 -04:00
return new Wallet((0, json_wallets_1.decryptJsonWalletSync)(json, password));
2020-02-27 19:58:05 +00:00
};
2019-05-14 18:48:48 -04:00
Wallet.fromMnemonic = function (mnemonic, path, wordlist) {
if (!path) {
path = hdnode_1.defaultPath;
}
return new Wallet(hdnode_1.HDNode.fromMnemonic(mnemonic, null, wordlist).derivePath(path));
};
return Wallet;
}(abstract_signer_1.Signer));
exports.Wallet = Wallet;
function verifyMessage(message, signature) {
2021-10-16 02:29:27 -04:00
return (0, transactions_1.recoverAddress)((0, hash_1.hashMessage)(message), signature);
2019-05-14 18:48:48 -04:00
}
exports.verifyMessage = verifyMessage;
2020-10-22 20:01:18 -04:00
function verifyTypedData(domain, types, value, signature) {
2021-10-16 02:29:27 -04:00
return (0, transactions_1.recoverAddress)(hash_1._TypedDataEncoder.hash(domain, types, value), signature);
2020-10-22 20:01:18 -04:00
}
exports.verifyTypedData = verifyTypedData;
2020-07-13 08:03:56 -04:00
//# sourceMappingURL=index.js.map