@metamask/eth-simple-keyring 5.0.0 → 5.1.1

package/CHANGELOG.md

@@ -6,6 +6,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [5.1.1]
+### Fixed
+- Treat `undefined` and `null` as empty array in deserialize function ([#166](https://github.com/MetaMask/eth-simple-keyring/pull/166))
+
+## [5.1.0]
+### Changed
+- Export TypeScript interfaces ([#140](https://github.com/MetaMask/eth-simple-keyring/pull/140))
+- Update all dependencies ([#140](https://github.com/MetaMask/eth-simple-keyring/pull/140)) ([#149](https://github.com/MetaMask/eth-simple-keyring/pull/149))
+
+### Fixed
+- Add `validateMessage` option to `signMessage` to configure if runtime-validation should be done that input string is hex (default: `true`) ([#148](https://github.com/MetaMask/eth-simple-keyring/pull/148))
+
 ## [5.0.0]
 ### Changed
 - **BREAKING:** Makes version-specific `signTypedData` methods private ([#84](https://github.com/MetaMask/eth-simple-keyring/pull/84))
@@ -14,12 +26,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - Consumers should not use this property as it is intended for internal use only.
 - **BREAKING:** Makes `getPrivateKeyFor` a private method ([#83](https://github.com/MetaMask/eth-simple-keyring/pull/83))
     - Consumers who wish to get the private key for a given account should use the `exportAccount` method.
-- **BREAKING:** Set the minimum Node.js version to 12 ([#68](https://github.com/MetaMask/eth-simple-keyring/pull/68))
+- **BREAKING:** Set the minimum Node.js version to 14 ([#68](https://github.com/MetaMask/eth-simple-keyring/pull/68)) ([#109](https://github.com/MetaMask/eth-simple-keyring/pull/109))
 - Always return rejected Promise upon failure ([#85](https://github.com/MetaMask/eth-simple-keyring/pull/85))
 
 ### Removed
 - **BREAKING:** Remove redundant `newGethSignMessage` method ([#72](https://github.com/MetaMask/eth-simple-keyring/pull/72))
-    - Consumers can use `signPersonalMessage` method as a replacement for `newGethSignMessage`. 
+    - Consumers can use `signPersonalMessage` method as a replacement for `newGethSignMessage`.
 
-[Unreleased]: https://github.com/MetaMask/eth-simple-keyring/compare/v5.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/eth-simple-keyring/compare/v5.1.1...HEAD
+[5.1.1]: https://github.com/MetaMask/eth-simple-keyring/compare/v5.1.0...v5.1.1
+[5.1.0]: https://github.com/MetaMask/eth-simple-keyring/compare/v5.0.0...v5.1.0
 [5.0.0]: https://github.com/MetaMask/eth-simple-keyring/releases/tag/v5.0.0

package/README.md

@@ -81,11 +81,13 @@ removes the specified account from the list of accounts.
 
 ### Setup
 
-- Install [Node.js](https://nodejs.org) version 12
+- Install [Node.js](https://nodejs.org) version 14 or greater
   - If you are using [nvm](https://github.com/creationix/nvm#installation) (recommended) running `nvm use` will automatically choose the right node version for you.
 - Install [Yarn v3](https://yarnpkg.com/getting-started/install)
 - Run `yarn install` to install dependencies and run any required post-install scripts
 
+-- This package implicitly relies on Buffer to be present (meaning that if someone wants to use this in a browser context, they need to supply a polyfill for Buffer or use the `buffer` package)
+
 ### Testing and Linting
 
 Run `yarn test` to run the tests once. To run tests on file changes, run `yarn test:watch`.

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { default } from './simple-keyring';

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = void 0;
+var simple_keyring_1 = require("./simple-keyring");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(simple_keyring_1).default; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,mDAA2C;AAAlC,0HAAA,OAAO,OAAA","sourcesContent":["export { default } from './simple-keyring';\n"]}

package/dist/simple-keyring.d.ts

@@ -0,0 +1,34 @@
+import { TypedTransaction } from '@ethereumjs/tx';
+import { SignTypedDataVersion } from '@metamask/eth-sig-util';
+import { Eip1024EncryptedData, Hex, Keyring } from '@metamask/utils';
+declare type KeyringOpt = {
+    withAppKeyOrigin?: string;
+    version?: SignTypedDataVersion | string;
+};
+export default class SimpleKeyring implements Keyring<string[]> {
+    #private;
+    readonly type: string;
+    static type: string;
+    constructor(privateKeys?: string[]);
+    serialize(): Promise<string[]>;
+    deserialize(privateKeys?: string[]): Promise<void>;
+    addAccounts(numAccounts?: number): Promise<`0x${string}`[]>;
+    getAccounts(): Promise<`0x${string}`[]>;
+    signTransaction(address: Hex, transaction: TypedTransaction, opts?: KeyringOpt): Promise<TypedTransaction>;
+    signMessage(address: Hex, data: string, opts?: {
+        withAppKeyOrigin: string;
+        validateMessage: boolean;
+    }): Promise<string>;
+    signPersonalMessage(address: Hex, msgHex: Hex, opts?: {
+        withAppKeyOrigin: string;
+    }): Promise<string>;
+    decryptMessage(withAccount: Hex, encryptedData: Eip1024EncryptedData): Promise<string>;
+    signTypedData(address: Hex, typedData: any, opts?: KeyringOpt): Promise<string>;
+    getEncryptionPublicKey(withAccount: Hex, opts?: KeyringOpt): Promise<string>;
+    getAppKeyAddress(address: Hex, origin: string): Promise<`0x${string}`>;
+    exportAccount(address: Hex, opts?: {
+        withAppKeyOrigin: string;
+    }): Promise<string>;
+    removeAccount(address: string): void;
+}
+export {};

package/dist/simple-keyring.js

@@ -0,0 +1,178 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _SimpleKeyring_instances, _SimpleKeyring_wallets, _SimpleKeyring_getPrivateKeyFor, _SimpleKeyring_getWalletForAccount;
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("@ethereumjs/util");
+const eth_sig_util_1 = require("@metamask/eth-sig-util");
+const utils_1 = require("@metamask/utils");
+const keccak_1 = require("ethereum-cryptography/keccak");
+const randombytes_1 = __importDefault(require("randombytes"));
+const TYPE = 'Simple Key Pair';
+class SimpleKeyring {
+    constructor(privateKeys = []) {
+        _SimpleKeyring_instances.add(this);
+        _SimpleKeyring_wallets.set(this, void 0);
+        this.type = TYPE;
+        __classPrivateFieldSet(this, _SimpleKeyring_wallets, [], "f");
+        /* istanbul ignore next: It's not possible to write a unit test for this, because a constructor isn't allowed
+         * to be async. Jest can't await the constructor, and when the error gets thrown, Jest can't catch it. */
+        this.deserialize(privateKeys).catch((error) => {
+            throw new Error(`Problem deserializing SimpleKeyring ${error.message}`);
+        });
+    }
+    async serialize() {
+        return __classPrivateFieldGet(this, _SimpleKeyring_wallets, "f").map((a) => a.privateKey.toString('hex'));
+    }
+    async deserialize(privateKeys = []) {
+        __classPrivateFieldSet(this, _SimpleKeyring_wallets, privateKeys.map((hexPrivateKey) => {
+            const strippedHexPrivateKey = (0, util_1.stripHexPrefix)(hexPrivateKey);
+            const privateKey = Buffer.from(strippedHexPrivateKey, 'hex');
+            const publicKey = (0, util_1.privateToPublic)(privateKey);
+            return { privateKey, publicKey };
+        }), "f");
+    }
+    async addAccounts(numAccounts = 1) {
+        const newWallets = [];
+        for (let i = 0; i < numAccounts; i++) {
+            const privateKey = generateKey();
+            const publicKey = (0, util_1.privateToPublic)(privateKey);
+            newWallets.push({ privateKey, publicKey });
+        }
+        __classPrivateFieldSet(this, _SimpleKeyring_wallets, __classPrivateFieldGet(this, _SimpleKeyring_wallets, "f").concat(newWallets), "f");
+        const hexWallets = newWallets.map(({ publicKey }) => (0, utils_1.add0x)((0, util_1.bufferToHex)((0, util_1.publicToAddress)(publicKey))));
+        return hexWallets;
+    }
+    async getAccounts() {
+        return __classPrivateFieldGet(this, _SimpleKeyring_wallets, "f").map(({ publicKey }) => (0, utils_1.add0x)((0, util_1.bufferToHex)((0, util_1.publicToAddress)(publicKey))));
+    }
+    async signTransaction(address, transaction, opts = {}) {
+        const privKey = __classPrivateFieldGet(this, _SimpleKeyring_instances, "m", _SimpleKeyring_getPrivateKeyFor).call(this, address, opts);
+        const signedTx = transaction.sign(privKey);
+        // Newer versions of Ethereumjs-tx are immutable and return a new tx object
+        return signedTx === undefined ? transaction : signedTx;
+    }
+    // For eth_sign, we need to sign arbitrary data:
+    async signMessage(address, data, opts = { withAppKeyOrigin: '', validateMessage: true }) {
+        const message = (0, util_1.stripHexPrefix)(data);
+        if (opts.validateMessage &&
+            (message.length === 0 || !message.match(/^[a-fA-F0-9]*$/u))) {
+            throw new Error('Cannot sign invalid message');
+        }
+        const privKey = __classPrivateFieldGet(this, _SimpleKeyring_instances, "m", _SimpleKeyring_getPrivateKeyFor).call(this, address, opts);
+        const msgSig = (0, util_1.ecsign)(Buffer.from(message, 'hex'), privKey);
+        const rawMsgSig = (0, eth_sig_util_1.concatSig)((0, util_1.toBuffer)(msgSig.v), msgSig.r, msgSig.s);
+        return rawMsgSig;
+    }
+    // For personal_sign, we need to prefix the message:
+    async signPersonalMessage(address, msgHex, opts = { withAppKeyOrigin: '' }) {
+        const privKey = __classPrivateFieldGet(this, _SimpleKeyring_instances, "m", _SimpleKeyring_getPrivateKeyFor).call(this, address, opts);
+        return (0, eth_sig_util_1.personalSign)({ privateKey: privKey, data: msgHex });
+    }
+    // For eth_decryptMessage:
+    async decryptMessage(withAccount, encryptedData) {
+        const wallet = __classPrivateFieldGet(this, _SimpleKeyring_instances, "m", _SimpleKeyring_getWalletForAccount).call(this, withAccount);
+        const privateKey = wallet.privateKey.toString('hex');
+        return (0, eth_sig_util_1.decrypt)({ privateKey, encryptedData });
+    }
+    // personal_signTypedData, signs data along with the schema
+    async signTypedData(address, typedData, opts = { version: eth_sig_util_1.SignTypedDataVersion.V1 }) {
+        // Treat invalid versions as "V1"
+        let version = eth_sig_util_1.SignTypedDataVersion.V1;
+        if (opts.version && isSignTypedDataVersion(opts.version)) {
+            version = eth_sig_util_1.SignTypedDataVersion[opts.version];
+        }
+        const privateKey = __classPrivateFieldGet(this, _SimpleKeyring_instances, "m", _SimpleKeyring_getPrivateKeyFor).call(this, address, opts);
+        return (0, eth_sig_util_1.signTypedData)({ privateKey, data: typedData, version });
+    }
+    // get public key for nacl
+    async getEncryptionPublicKey(withAccount, opts) {
+        const privKey = __classPrivateFieldGet(this, _SimpleKeyring_instances, "m", _SimpleKeyring_getPrivateKeyFor).call(this, withAccount, opts);
+        const publicKey = (0, eth_sig_util_1.getEncryptionPublicKey)(privKey.toString('hex'));
+        return publicKey;
+    }
+    // returns an address specific to an app
+    async getAppKeyAddress(address, origin) {
+        if (!origin || typeof origin !== 'string') {
+            throw new Error(`'origin' must be a non-empty string`);
+        }
+        const wallet = __classPrivateFieldGet(this, _SimpleKeyring_instances, "m", _SimpleKeyring_getWalletForAccount).call(this, address, {
+            withAppKeyOrigin: origin,
+        });
+        const appKeyAddress = (0, utils_1.add0x)((0, util_1.bufferToHex)((0, util_1.publicToAddress)(wallet.publicKey)));
+        return appKeyAddress;
+    }
+    // exportAccount should return a hex-encoded private key:
+    async exportAccount(address, opts = { withAppKeyOrigin: '' }) {
+        const wallet = __classPrivateFieldGet(this, _SimpleKeyring_instances, "m", _SimpleKeyring_getWalletForAccount).call(this, address, opts);
+        return wallet.privateKey.toString('hex');
+    }
+    removeAccount(address) {
+        if (!__classPrivateFieldGet(this, _SimpleKeyring_wallets, "f")
+            .map(({ publicKey }) => (0, util_1.bufferToHex)((0, util_1.publicToAddress)(publicKey)).toLowerCase())
+            .includes(address.toLowerCase())) {
+            throw new Error(`Address ${address} not found in this keyring`);
+        }
+        __classPrivateFieldSet(this, _SimpleKeyring_wallets, __classPrivateFieldGet(this, _SimpleKeyring_wallets, "f").filter(({ publicKey }) => (0, util_1.bufferToHex)((0, util_1.publicToAddress)(publicKey)).toLowerCase() !==
+            address.toLowerCase()), "f");
+    }
+}
+exports.default = SimpleKeyring;
+_SimpleKeyring_wallets = new WeakMap(), _SimpleKeyring_instances = new WeakSet(), _SimpleKeyring_getPrivateKeyFor = function _SimpleKeyring_getPrivateKeyFor(address, opts = { withAppKeyOrigin: '' }) {
+    if (!address) {
+        throw new Error('Must specify address.');
+    }
+    const wallet = __classPrivateFieldGet(this, _SimpleKeyring_instances, "m", _SimpleKeyring_getWalletForAccount).call(this, address, opts);
+    return wallet.privateKey;
+}, _SimpleKeyring_getWalletForAccount = function _SimpleKeyring_getWalletForAccount(account, opts = {}) {
+    const address = (0, eth_sig_util_1.normalize)(account);
+    let wallet = __classPrivateFieldGet(this, _SimpleKeyring_wallets, "f").find(({ publicKey }) => (0, util_1.bufferToHex)((0, util_1.publicToAddress)(publicKey)) === address);
+    if (!wallet) {
+        throw new Error('Simple Keyring - Unable to find matching address.');
+    }
+    if (opts.withAppKeyOrigin) {
+        const { privateKey } = wallet;
+        const appKeyOriginBuffer = Buffer.from(opts.withAppKeyOrigin, 'utf8');
+        const appKeyBuffer = Buffer.concat([privateKey, appKeyOriginBuffer]);
+        const appKeyPrivateKey = (0, util_1.arrToBufArr)((0, keccak_1.keccak256)(appKeyBuffer));
+        const appKeyPublicKey = (0, util_1.privateToPublic)(appKeyPrivateKey);
+        wallet = { privateKey: appKeyPrivateKey, publicKey: appKeyPublicKey };
+    }
+    return wallet;
+};
+SimpleKeyring.type = TYPE;
+/**
+ * Generate and validate a new random key of 32 bytes.
+ *
+ * @returns Buffer The generated key.
+ */
+function generateKey() {
+    const privateKey = (0, randombytes_1.default)(32);
+    if (!(0, util_1.isValidPrivate)(privateKey)) {
+        throw new Error('Private key does not satisfy the curve requirements (ie. it is invalid)');
+    }
+    return privateKey;
+}
+/**
+ * Type predicate type guard to check if a string is in the enum SignTypedDataVersion.
+ *
+ * @param version - The string to check.
+ * @returns Whether it's in the enum.
+ */
+// TODO: Put this in @metamask/eth-sig-util
+function isSignTypedDataVersion(version) {
+    return version in eth_sig_util_1.SignTypedDataVersion;
+}
+//# sourceMappingURL=simple-keyring.js.map

package/dist/simple-keyring.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-keyring.js","sourceRoot":"","sources":["../src/simple-keyring.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AACA,2CAS0B;AAC1B,yDAQgC;AAChC,2CAA4E;AAC5E,yDAAyD;AACzD,8DAAsC;AAOtC,MAAM,IAAI,GAAG,iBAAiB,CAAC;AAE/B,MAAqB,aAAa;IAOhC,YAAY,cAAwB,EAAE;;QANtC,yCAAsD;QAE7C,SAAI,GAAW,IAAI,CAAC;QAK3B,uBAAA,IAAI,0BAAY,EAAE,MAAA,CAAC;QAEnB;iHACyG;QACzG,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,KAAY,EAAE,EAAE;YACnD,MAAM,IAAI,KAAK,CAAC,uCAAuC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1E,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,SAAS;QACb,OAAO,uBAAA,IAAI,8BAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAChE,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,cAAwB,EAAE;QAC1C,uBAAA,IAAI,0BAAY,WAAW,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE;YAChD,MAAM,qBAAqB,GAAG,IAAA,qBAAc,EAAC,aAAa,CAAC,CAAC;YAC5D,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;YAC7D,MAAM,SAAS,GAAG,IAAA,sBAAe,EAAC,UAAU,CAAC,CAAC;YAC9C,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;QACnC,CAAC,CAAC,MAAA,CAAC;IACL,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,WAAW,GAAG,CAAC;QAC/B,MAAM,UAAU,GAAG,EAAE,CAAC;QACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,EAAE,CAAC,EAAE,EAAE;YACpC,MAAM,UAAU,GAAG,WAAW,EAAE,CAAC;YACjC,MAAM,SAAS,GAAG,IAAA,sBAAe,EAAC,UAAU,CAAC,CAAC;YAC9C,UAAU,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;SAC5C;QACD,uBAAA,IAAI,0BAAY,uBAAA,IAAI,8BAAS,CAAC,MAAM,CAAC,UAAU,CAAC,MAAA,CAAC;QACjD,MAAM,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAClD,IAAA,aAAK,EAAC,IAAA,kBAAW,EAAC,IAAA,sBAAe,EAAC,SAAS,CAAC,CAAC,CAAC,CAC/C,CAAC;QACF,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,WAAW;QACf,OAAO,uBAAA,IAAI,8BAAS,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CACzC,IAAA,aAAK,EAAC,IAAA,kBAAW,EAAC,IAAA,sBAAe,EAAC,SAAS,CAAC,CAAC,CAAC,CAC/C,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,OAAY,EACZ,WAA6B,EAC7B,OAAmB,EAAE;QAErB,MAAM,OAAO,GAAG,uBAAA,IAAI,iEAAkB,MAAtB,IAAI,EAAmB,OAAO,EAAE,IAAI,CAAC,CAAC;QACtD,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3C,2EAA2E;QAC3E,OAAO,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC;IACzD,CAAC;IAED,gDAAgD;IAChD,KAAK,CAAC,WAAW,CACf,OAAY,EACZ,IAAY,EACZ,IAAI,GAAG,EAAE,gBAAgB,EAAE,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE;QAEtD,MAAM,OAAO,GAAG,IAAA,qBAAc,EAAC,IAAI,CAAC,CAAC;QACrC,IACE,IAAI,CAAC,eAAe;YACpB,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,EAC3D;YACA,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;SAChD;QACD,MAAM,OAAO,GAAG,uBAAA,IAAI,iEAAkB,MAAtB,IAAI,EAAmB,OAAO,EAAE,IAAI,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,IAAA,aAAM,EAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,IAAA,wBAAS,EAAC,IAAA,eAAQ,EAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;QACpE,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,oDAAoD;IACpD,KAAK,CAAC,mBAAmB,CACvB,OAAY,EACZ,MAAW,EACX,IAAI,GAAG,EAAE,gBAAgB,EAAE,EAAE,EAAE;QAE/B,MAAM,OAAO,GAAG,uBAAA,IAAI,iEAAkB,MAAtB,IAAI,EAAmB,OAAO,EAAE,IAAI,CAAC,CAAC;QACtD,OAAO,IAAA,2BAAY,EAAC,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,0BAA0B;IAC1B,KAAK,CAAC,cAAc,CAAC,WAAgB,EAAE,aAAmC;QACxE,MAAM,MAAM,GAAG,uBAAA,IAAI,oEAAqB,MAAzB,IAAI,EAAsB,WAAW,CAAC,CAAC;QACtD,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACrD,OAAO,IAAA,sBAAO,EAAC,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC,CAAC;IAChD,CAAC;IAED,2DAA2D;IAC3D,KAAK,CAAC,aAAa,CACjB,OAAY,EACZ,SAAc,EACd,OAAmB,EAAE,OAAO,EAAE,mCAAoB,CAAC,EAAE,EAAE;QAEvD,iCAAiC;QACjC,IAAI,OAAO,GAAG,mCAAoB,CAAC,EAAE,CAAC;QAEtC,IAAI,IAAI,CAAC,OAAO,IAAI,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YACxD,OAAO,GAAG,mCAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC9C;QAED,MAAM,UAAU,GAAG,uBAAA,IAAI,iEAAkB,MAAtB,IAAI,EAAmB,OAAO,EAAE,IAAI,CAAC,CAAC;QACzD,OAAO,IAAA,4BAAa,EAAC,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,0BAA0B;IAC1B,KAAK,CAAC,sBAAsB,CAAC,WAAgB,EAAE,IAAiB;QAC9D,MAAM,OAAO,GAAG,uBAAA,IAAI,iEAAkB,MAAtB,IAAI,EAAmB,WAAW,EAAE,IAAI,CAAC,CAAC;QAC1D,MAAM,SAAS,GAAG,IAAA,qCAAsB,EAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QAClE,OAAO,SAAS,CAAC;IACnB,CAAC;IAUD,wCAAwC;IACxC,KAAK,CAAC,gBAAgB,CAAC,OAAY,EAAE,MAAc;QACjD,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;YACzC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;SACxD;QACD,MAAM,MAAM,GAAG,uBAAA,IAAI,oEAAqB,MAAzB,IAAI,EAAsB,OAAO,EAAE;YAChD,gBAAgB,EAAE,MAAM;SACzB,CAAC,CAAC;QACH,MAAM,aAAa,GAAG,IAAA,aAAK,EAAC,IAAA,kBAAW,EAAC,IAAA,sBAAe,EAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC5E,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,yDAAyD;IACzD,KAAK,CAAC,aAAa,CAAC,OAAY,EAAE,IAAI,GAAG,EAAE,gBAAgB,EAAE,EAAE,EAAE;QAC/D,MAAM,MAAM,GAAG,uBAAA,IAAI,oEAAqB,MAAzB,IAAI,EAAsB,OAAO,EAAE,IAAI,CAAC,CAAC;QACxD,OAAO,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,aAAa,CAAC,OAAe;QAC3B,IACE,CAAC,uBAAA,IAAI,8BAAS;aACX,GAAG,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CACrB,IAAA,kBAAW,EAAC,IAAA,sBAAe,EAAC,SAAS,CAAC,CAAC,CAAC,WAAW,EAAE,CACtD;aACA,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,EAClC;YACA,MAAM,IAAI,KAAK,CAAC,WAAW,OAAO,4BAA4B,CAAC,CAAC;SACjE;QAED,uBAAA,IAAI,0BAAY,uBAAA,IAAI,8BAAS,CAAC,MAAM,CAClC,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAChB,IAAA,kBAAW,EAAC,IAAA,sBAAe,EAAC,SAAS,CAAC,CAAC,CAAC,WAAW,EAAE;YACrD,OAAO,CAAC,WAAW,EAAE,CACxB,MAAA,CAAC;IACJ,CAAC;;AAnKH,gCAyLC;6JAhEmB,OAAY,EAAE,OAAmB,EAAE,gBAAgB,EAAE,EAAE,EAAE;IACzE,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;KAC1C;IACD,MAAM,MAAM,GAAG,uBAAA,IAAI,oEAAqB,MAAzB,IAAI,EAAsB,OAAO,EAAE,IAAI,CAAC,CAAC;IACxD,OAAO,MAAM,CAAC,UAAU,CAAC;AAC3B,CAAC,mFAsCoB,OAAwB,EAAE,OAAmB,EAAE;IAClE,MAAM,OAAO,GAAG,IAAA,wBAAS,EAAC,OAAO,CAAC,CAAC;IACnC,IAAI,MAAM,GAAG,uBAAA,IAAI,8BAAS,CAAC,IAAI,CAC7B,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,IAAA,kBAAW,EAAC,IAAA,sBAAe,EAAC,SAAS,CAAC,CAAC,KAAK,OAAO,CACvE,CAAC;IACF,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;KACtE;IAED,IAAI,IAAI,CAAC,gBAAgB,EAAE;QACzB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,MAAM,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;QACtE,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC,CAAC;QACrE,MAAM,gBAAgB,GAAG,IAAA,kBAAW,EAAC,IAAA,kBAAS,EAAC,YAAY,CAAC,CAAC,CAAC;QAC9D,MAAM,eAAe,GAAG,IAAA,sBAAe,EAAC,gBAAgB,CAAC,CAAC;QAC1D,MAAM,GAAG,EAAE,UAAU,EAAE,gBAAgB,EAAE,SAAS,EAAE,eAAe,EAAE,CAAC;KACvE;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAnLM,kBAAI,GAAW,IAAI,CAAC;AAsL7B;;;;GAIG;AACH,SAAS,WAAW;IAClB,MAAM,UAAU,GAAG,IAAA,qBAAW,EAAC,EAAE,CAAC,CAAC;IAEnC,IAAI,CAAC,IAAA,qBAAc,EAAC,UAAU,CAAC,EAAE;QAC/B,MAAM,IAAI,KAAK,CACb,yEAAyE,CAC1E,CAAC;KACH;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;GAKG;AACH,2CAA2C;AAC3C,SAAS,sBAAsB,CAC7B,OAAsC;IAEtC,OAAO,OAAO,IAAI,mCAAoB,CAAC;AACzC,CAAC","sourcesContent":["import { TypedTransaction } from '@ethereumjs/tx';\nimport {\n  arrToBufArr,\n  bufferToHex,\n  ecsign,\n  isValidPrivate,\n  privateToPublic,\n  publicToAddress,\n  stripHexPrefix,\n  toBuffer,\n} from '@ethereumjs/util';\nimport {\n  concatSig,\n  decrypt,\n  getEncryptionPublicKey,\n  normalize,\n  personalSign,\n  signTypedData,\n  SignTypedDataVersion,\n} from '@metamask/eth-sig-util';\nimport { add0x, Eip1024EncryptedData, Hex, Keyring } from '@metamask/utils';\nimport { keccak256 } from 'ethereum-cryptography/keccak';\nimport randombytes from 'randombytes';\n\ntype KeyringOpt = {\n  withAppKeyOrigin?: string;\n  version?: SignTypedDataVersion | string;\n};\n\nconst TYPE = 'Simple Key Pair';\n\nexport default class SimpleKeyring implements Keyring<string[]> {\n  #wallets: { privateKey: Buffer; publicKey: Buffer }[];\n\n  readonly type: string = TYPE;\n\n  static type: string = TYPE;\n\n  constructor(privateKeys: string[] = []) {\n    this.#wallets = [];\n\n    /* istanbul ignore next: It's not possible to write a unit test for this, because a constructor isn't allowed\n     * to be async. Jest can't await the constructor, and when the error gets thrown, Jest can't catch it. */\n    this.deserialize(privateKeys).catch((error: Error) => {\n      throw new Error(`Problem deserializing SimpleKeyring ${error.message}`);\n    });\n  }\n\n  async serialize() {\n    return this.#wallets.map((a) => a.privateKey.toString('hex'));\n  }\n\n  async deserialize(privateKeys: string[] = []) {\n    this.#wallets = privateKeys.map((hexPrivateKey) => {\n      const strippedHexPrivateKey = stripHexPrefix(hexPrivateKey);\n      const privateKey = Buffer.from(strippedHexPrivateKey, 'hex');\n      const publicKey = privateToPublic(privateKey);\n      return { privateKey, publicKey };\n    });\n  }\n\n  async addAccounts(numAccounts = 1) {\n    const newWallets = [];\n    for (let i = 0; i < numAccounts; i++) {\n      const privateKey = generateKey();\n      const publicKey = privateToPublic(privateKey);\n      newWallets.push({ privateKey, publicKey });\n    }\n    this.#wallets = this.#wallets.concat(newWallets);\n    const hexWallets = newWallets.map(({ publicKey }) =>\n      add0x(bufferToHex(publicToAddress(publicKey))),\n    );\n    return hexWallets;\n  }\n\n  async getAccounts() {\n    return this.#wallets.map(({ publicKey }) =>\n      add0x(bufferToHex(publicToAddress(publicKey))),\n    );\n  }\n\n  async signTransaction(\n    address: Hex,\n    transaction: TypedTransaction,\n    opts: KeyringOpt = {},\n  ): Promise<TypedTransaction> {\n    const privKey = this.#getPrivateKeyFor(address, opts);\n    const signedTx = transaction.sign(privKey);\n    // Newer versions of Ethereumjs-tx are immutable and return a new tx object\n    return signedTx === undefined ? transaction : signedTx;\n  }\n\n  // For eth_sign, we need to sign arbitrary data:\n  async signMessage(\n    address: Hex,\n    data: string,\n    opts = { withAppKeyOrigin: '', validateMessage: true },\n  ) {\n    const message = stripHexPrefix(data);\n    if (\n      opts.validateMessage &&\n      (message.length === 0 || !message.match(/^[a-fA-F0-9]*$/u))\n    ) {\n      throw new Error('Cannot sign invalid message');\n    }\n    const privKey = this.#getPrivateKeyFor(address, opts);\n    const msgSig = ecsign(Buffer.from(message, 'hex'), privKey);\n    const rawMsgSig = concatSig(toBuffer(msgSig.v), msgSig.r, msgSig.s);\n    return rawMsgSig;\n  }\n\n  // For personal_sign, we need to prefix the message:\n  async signPersonalMessage(\n    address: Hex,\n    msgHex: Hex,\n    opts = { withAppKeyOrigin: '' },\n  ) {\n    const privKey = this.#getPrivateKeyFor(address, opts);\n    return personalSign({ privateKey: privKey, data: msgHex });\n  }\n\n  // For eth_decryptMessage:\n  async decryptMessage(withAccount: Hex, encryptedData: Eip1024EncryptedData) {\n    const wallet = this.#getWalletForAccount(withAccount);\n    const privateKey = wallet.privateKey.toString('hex');\n    return decrypt({ privateKey, encryptedData });\n  }\n\n  // personal_signTypedData, signs data along with the schema\n  async signTypedData(\n    address: Hex,\n    typedData: any,\n    opts: KeyringOpt = { version: SignTypedDataVersion.V1 },\n  ) {\n    // Treat invalid versions as \"V1\"\n    let version = SignTypedDataVersion.V1;\n\n    if (opts.version && isSignTypedDataVersion(opts.version)) {\n      version = SignTypedDataVersion[opts.version];\n    }\n\n    const privateKey = this.#getPrivateKeyFor(address, opts);\n    return signTypedData({ privateKey, data: typedData, version });\n  }\n\n  // get public key for nacl\n  async getEncryptionPublicKey(withAccount: Hex, opts?: KeyringOpt) {\n    const privKey = this.#getPrivateKeyFor(withAccount, opts);\n    const publicKey = getEncryptionPublicKey(privKey.toString('hex'));\n    return publicKey;\n  }\n\n  #getPrivateKeyFor(address: Hex, opts: KeyringOpt = { withAppKeyOrigin: '' }) {\n    if (!address) {\n      throw new Error('Must specify address.');\n    }\n    const wallet = this.#getWalletForAccount(address, opts);\n    return wallet.privateKey;\n  }\n\n  // returns an address specific to an app\n  async getAppKeyAddress(address: Hex, origin: string) {\n    if (!origin || typeof origin !== 'string') {\n      throw new Error(`'origin' must be a non-empty string`);\n    }\n    const wallet = this.#getWalletForAccount(address, {\n      withAppKeyOrigin: origin,\n    });\n    const appKeyAddress = add0x(bufferToHex(publicToAddress(wallet.publicKey)));\n    return appKeyAddress;\n  }\n\n  // exportAccount should return a hex-encoded private key:\n  async exportAccount(address: Hex, opts = { withAppKeyOrigin: '' }) {\n    const wallet = this.#getWalletForAccount(address, opts);\n    return wallet.privateKey.toString('hex');\n  }\n\n  removeAccount(address: string) {\n    if (\n      !this.#wallets\n        .map(({ publicKey }) =>\n          bufferToHex(publicToAddress(publicKey)).toLowerCase(),\n        )\n        .includes(address.toLowerCase())\n    ) {\n      throw new Error(`Address ${address} not found in this keyring`);\n    }\n\n    this.#wallets = this.#wallets.filter(\n      ({ publicKey }) =>\n        bufferToHex(publicToAddress(publicKey)).toLowerCase() !==\n        address.toLowerCase(),\n    );\n  }\n\n  #getWalletForAccount(account: string | number, opts: KeyringOpt = {}) {\n    const address = normalize(account);\n    let wallet = this.#wallets.find(\n      ({ publicKey }) => bufferToHex(publicToAddress(publicKey)) === address,\n    );\n    if (!wallet) {\n      throw new Error('Simple Keyring - Unable to find matching address.');\n    }\n\n    if (opts.withAppKeyOrigin) {\n      const { privateKey } = wallet;\n      const appKeyOriginBuffer = Buffer.from(opts.withAppKeyOrigin, 'utf8');\n      const appKeyBuffer = Buffer.concat([privateKey, appKeyOriginBuffer]);\n      const appKeyPrivateKey = arrToBufArr(keccak256(appKeyBuffer));\n      const appKeyPublicKey = privateToPublic(appKeyPrivateKey);\n      wallet = { privateKey: appKeyPrivateKey, publicKey: appKeyPublicKey };\n    }\n\n    return wallet;\n  }\n}\n\n/**\n * Generate and validate a new random key of 32 bytes.\n *\n * @returns Buffer The generated key.\n */\nfunction generateKey(): Buffer {\n  const privateKey = randombytes(32);\n\n  if (!isValidPrivate(privateKey)) {\n    throw new Error(\n      'Private key does not satisfy the curve requirements (ie. it is invalid)',\n    );\n  }\n  return privateKey;\n}\n\n/**\n * Type predicate type guard to check if a string is in the enum SignTypedDataVersion.\n *\n * @param version - The string to check.\n * @returns Whether it's in the enum.\n */\n// TODO: Put this in @metamask/eth-sig-util\nfunction isSignTypedDataVersion(\n  version: SignTypedDataVersion | string,\n): version is SignTypedDataVersion {\n  return version in SignTypedDataVersion;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/eth-simple-keyring",
-  "version": "5.0.0",
+  "version": "5.1.1",
   "description": "A simple standard interface for a series of Ethereum private keys.",
   "keywords": [
     "ethereum",
@@ -14,44 +14,63 @@
     "type": "git",
     "url": "https://github.com/MetaMask/eth-simple-keyring.git"
   },
-  "license": "ISC",
-  "author": "Dan Finlay",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
-    "index.js"
+    "dist/"
   ],
   "scripts": {
-    "test": "jest",
-    "test:watch": "jest --watch",
+    "build": "tsc --project tsconfig.build.json",
+    "build:clean": "rimraf dist && yarn build",
+    "build:docs": "typedoc",
+    "lint": "yarn lint:eslint && yarn lint:misc --check && yarn lint:dependencies",
+    "lint:dependencies": "depcheck",
     "lint:eslint": "eslint . --cache --ext js,ts",
+    "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
     "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' '**/*.yml' '!.yarnrc.yml' --ignore-path .gitignore --no-error-on-unmatched-pattern",
-    "lint": "yarn lint:eslint && yarn lint:misc --check",
-    "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write"
+    "prepack": "./scripts/prepack.sh",
+    "sample": "ts-node src/sample.ts",
+    "test": "jest",
+    "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@ethereumjs/util": "^8.0.0",
-    "@metamask/eth-sig-util": "^5.0.1",
-    "ethereum-cryptography": "^1.1.2",
+    "@ethereumjs/util": "^8.0.5",
+    "@metamask/eth-sig-util": "^6.0.1",
+    "@metamask/utils": "^5.0.2",
+    "ethereum-cryptography": "^1.2.0",
     "randombytes": "^2.1.0"
   },
   "devDependencies": {
-    "@ethereumjs/tx": "^4.0.0",
-    "@lavamoat/allow-scripts": "^2.1.0",
-    "@metamask/auto-changelog": "^3.0.0",
-    "@metamask/eslint-config": "^8.0.0",
-    "@metamask/eslint-config-jest": "^11.0.0",
-    "@metamask/eslint-config-nodejs": "^11.0.1",
-    "@types/jest": "^26.0.24",
-    "eslint": "^7.30.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.23.4",
-    "eslint-plugin-jest": "^27.1.5",
+    "@ethereumjs/tx": "^4.1.1",
+    "@lavamoat/allow-scripts": "^2.3.0",
+    "@metamask/auto-changelog": "^3.1.0",
+    "@metamask/eslint-config": "^11.1.0",
+    "@metamask/eslint-config-jest": "^11.1.0",
+    "@metamask/eslint-config-nodejs": "^11.1.0",
+    "@metamask/eslint-config-typescript": "^11.1.0",
+    "@types/ethereumjs-tx": "^1.0.1",
+    "@types/jest": "^29.5.0",
+    "@types/node": "^18.15.10",
+    "@types/randombytes": "^2.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.57.0",
+    "@typescript-eslint/parser": "^5.57.0",
+    "depcheck": "^1.4.3",
+    "eslint": "^8.36.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-jsdoc": "^39.6.2",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.4.0",
-    "jest": "^27.0.6",
-    "prettier": "^2.3.2",
-    "prettier-plugin-packagejson": "^2.2.11"
+    "eslint-plugin-prettier": "^4.2.1",
+    "ethereumjs-tx": "^1.3.7",
+    "jest": "^29.5.0",
+    "prettier": "^2.8.7",
+    "ts-jest": "^29.0.5",
+    "ts-node": "^10.9.1",
+    "typedoc": "^0.25.1",
+    "typescript": "~4.8.4"
   },
+  "packageManager": "yarn@3.3.0",
   "engines": {
     "node": ">=14.0.0"
   },
@@ -63,8 +82,9 @@
     "allowScripts": {
       "keccak": true,
       "secp256k1": true,
-      "@lavamoat/preinstall-always-fail": false
+      "@lavamoat/preinstall-always-fail": false,
+      "ethereumjs-tx>ethereumjs-util>ethereum-cryptography>keccak": false,
+      "ethereumjs-tx>ethereumjs-util>ethereum-cryptography>secp256k1": false
     }
-  },
-  "packageManager": "yarn@3.3.0"
-}
+  }
+}

package/index.js

@@ -1,206 +0,0 @@
-const { EventEmitter } = require('events');
-const {
-  isValidPrivate,
-  stripHexPrefix,
-  privateToPublic,
-  bufferToHex,
-  publicToAddress,
-  ecsign,
-  arrToBufArr,
-} = require('@ethereumjs/util');
-const randomBytes = require('randombytes');
-const { keccak256 } = require('ethereum-cryptography/keccak');
-
-const type = 'Simple Key Pair';
-const {
-  concatSig,
-  decrypt,
-  getEncryptionPublicKey,
-  normalize,
-  personalSign,
-  signTypedData,
-  SignTypedDataVersion,
-} = require('@metamask/eth-sig-util');
-
-function generateKey() {
-  const privateKey = randomBytes(32);
-  // I don't think this is possible, but this validation was here previously,
-  // so it has been preserved just in case.
-  // istanbul ignore next
-  if (!isValidPrivate(privateKey)) {
-    throw new Error(
-      'Private key does not satisfy the curve requirements (ie. it is invalid)',
-    );
-  }
-  return privateKey;
-}
-
-class SimpleKeyring extends EventEmitter {
-  constructor(opts) {
-    super();
-    this.type = type;
-    this._wallets = [];
-    this.deserialize(opts);
-  }
-
-  async serialize() {
-    return this._wallets.map(({ privateKey }) => privateKey.toString('hex'));
-  }
-
-  async deserialize(privateKeys = []) {
-    this._wallets = privateKeys.map((hexPrivateKey) => {
-      const strippedHexPrivateKey = stripHexPrefix(hexPrivateKey);
-      const privateKey = Buffer.from(strippedHexPrivateKey, 'hex');
-      const publicKey = privateToPublic(privateKey);
-      return { privateKey, publicKey };
-    });
-  }
-
-  async addAccounts(n = 1) {
-    const newWallets = [];
-    for (let i = 0; i < n; i++) {
-      const privateKey = generateKey();
-      const publicKey = privateToPublic(privateKey);
-      newWallets.push({ privateKey, publicKey });
-    }
-    this._wallets = this._wallets.concat(newWallets);
-    const hexWallets = newWallets.map(({ publicKey }) =>
-      bufferToHex(publicToAddress(publicKey)),
-    );
-    return hexWallets;
-  }
-
-  async getAccounts() {
-    return this._wallets.map(({ publicKey }) =>
-      bufferToHex(publicToAddress(publicKey)),
-    );
-  }
-
-  // tx is an instance of the ethereumjs-transaction class.
-  async signTransaction(address, tx, opts = {}) {
-    const privKey = this._getPrivateKeyFor(address, opts);
-    const signedTx = tx.sign(privKey);
-    // Newer versions of Ethereumjs-tx are immutable and return a new tx object
-    return signedTx === undefined ? tx : signedTx;
-  }
-
-  // For eth_sign, we need to sign arbitrary data:
-  async signMessage(address, data, opts = {}) {
-    const message = stripHexPrefix(data);
-    const privKey = this._getPrivateKeyFor(address, opts);
-    const msgSig = ecsign(Buffer.from(message, 'hex'), privKey);
-    const rawMsgSig = concatSig(msgSig.v, msgSig.r, msgSig.s);
-    return rawMsgSig;
-  }
-
-  // For personal_sign, we need to prefix the message:
-  async signPersonalMessage(address, msgHex, opts = {}) {
-    const privKey = this._getPrivateKeyFor(address, opts);
-    const privateKey = Buffer.from(privKey, 'hex');
-    const sig = personalSign({ privateKey, data: msgHex });
-    return sig;
-  }
-
-  // For eth_decryptMessage:
-  async decryptMessage(withAccount, encryptedData) {
-    const wallet = this._getWalletForAccount(withAccount);
-    const { privateKey } = wallet;
-    const sig = decrypt({ privateKey, encryptedData });
-    return sig;
-  }
-
-  // personal_signTypedData, signs data along with the schema
-  async signTypedData(
-    withAccount,
-    typedData,
-    opts = { version: SignTypedDataVersion.V1 },
-  ) {
-    // Treat invalid versions as "V1"
-    const version = Object.keys(SignTypedDataVersion).includes(opts.version)
-      ? opts.version
-      : SignTypedDataVersion.V1;
-
-    const privateKey = this._getPrivateKeyFor(withAccount, opts);
-    return signTypedData({ privateKey, data: typedData, version });
-  }
-
-  // get public key for nacl
-  async getEncryptionPublicKey(withAccount, opts = {}) {
-    const privKey = this._getPrivateKeyFor(withAccount, opts);
-    const publicKey = getEncryptionPublicKey(privKey);
-    return publicKey;
-  }
-
-  _getPrivateKeyFor(address, opts = {}) {
-    if (!address) {
-      throw new Error('Must specify address.');
-    }
-    const wallet = this._getWalletForAccount(address, opts);
-    return wallet.privateKey;
-  }
-
-  // returns an address specific to an app
-  async getAppKeyAddress(address, origin) {
-    if (!origin || typeof origin !== 'string') {
-      throw new Error(`'origin' must be a non-empty string`);
-    }
-    const wallet = this._getWalletForAccount(address, {
-      withAppKeyOrigin: origin,
-    });
-    const appKeyAddress = normalize(
-      publicToAddress(wallet.publicKey).toString('hex'),
-    );
-    return appKeyAddress;
-  }
-
-  // exportAccount should return a hex-encoded private key:
-  async exportAccount(address, opts = {}) {
-    const wallet = this._getWalletForAccount(address, opts);
-    return wallet.privateKey.toString('hex');
-  }
-
-  removeAccount(address) {
-    if (
-      !this._wallets
-        .map(({ publicKey }) =>
-          bufferToHex(publicToAddress(publicKey)).toLowerCase(),
-        )
-        .includes(address.toLowerCase())
-    ) {
-      throw new Error(`Address ${address} not found in this keyring`);
-    }
-
-    this._wallets = this._wallets.filter(
-      ({ publicKey }) =>
-        bufferToHex(publicToAddress(publicKey)).toLowerCase() !==
-        address.toLowerCase(),
-    );
-  }
-
-  /**
-   * @private
-   */
-  _getWalletForAccount(account, opts = {}) {
-    const address = normalize(account);
-    let wallet = this._wallets.find(
-      ({ publicKey }) => bufferToHex(publicToAddress(publicKey)) === address,
-    );
-    if (!wallet) {
-      throw new Error('Simple Keyring - Unable to find matching address.');
-    }
-
-    if (opts.withAppKeyOrigin) {
-      const { privateKey } = wallet;
-      const appKeyOriginBuffer = Buffer.from(opts.withAppKeyOrigin, 'utf8');
-      const appKeyBuffer = Buffer.concat([privateKey, appKeyOriginBuffer]);
-      const appKeyPrivateKey = arrToBufArr(keccak256(appKeyBuffer, 256));
-      const appKeyPublicKey = privateToPublic(appKeyPrivateKey);
-      wallet = { privateKey: appKeyPrivateKey, publicKey: appKeyPublicKey };
-    }
-
-    return wallet;
-  }
-}
-
-SimpleKeyring.type = type;
-module.exports = SimpleKeyring;