TypeScript migration

.circleci/config.yml

@@ -4,12 +4,17 @@ workflows:
   build-test:
     jobs:
       - prep-deps
+      - build:
+          requires:
+            - prep-deps
       - test-lint:
           requires:
             - prep-deps
+            - build
       - test-unit:
           requires:
             - prep-deps
+            - build
       - all-tests-pass:
           requires:
             - test-lint
@@ -28,8 +33,24 @@ jobs:
       - persist_to_workspace:
           root: .
           paths:
-          - node_modules
-          - build-artifacts
+            - node_modules
+            - build-artifacts
+
+  build:
+    docker:
+      - image: circleci/node:14
+    steps:
+      - checkout
+      - attach_workspace:
+          at: .
+      - run:
+          name: Build
+          command: |
+            ./scripts/prepack.sh
+      - persist_to_workspace:
+          root: .
+          paths:
+            - dist
 
   test-lint:
     docker:

.depcheckrc.json

@@ -0,0 +1,11 @@
+{
+  "ignores": [
+    "@lavamoat/allow-scripts",
+    "@metamask/auto-changelog",
+    "@types/*",
+    "prettier-plugin-packagejson",
+    "rimraf",
+    "ts-node",
+    "typedoc"
+  ]
+}

.eslintrc.js

@@ -1,31 +1,34 @@
 module.exports = {
   root: true,
 
-  extends: [
-    '@metamask/eslint-config',
-    '@metamask/eslint-config/config/mocha',
-    '@metamask/eslint-config/config/nodejs',
-  ],
-
-  parser: 'babel-eslint',
-
-  parserOptions: {
-    ecmaVersion: 2017,
-  },
-
-  plugins: ['json', 'import'],
-
-  globals: {
-    document: 'readonly',
-    window: 'readonly',
-  },
+  extends: ['@metamask/eslint-config'],
 
   overrides: [
     {
-      files: ['.eslintrc.js'],
+      files: ['*.ts'],
+      extends: [
+        '@metamask/eslint-config-typescript',
+        '@metamask/eslint-config-browser',
+      ],
+    },
+
+    {
+      files: ['*.js'],
       parserOptions: {
         sourceType: 'script',
       },
+      extends: ['@metamask/eslint-config-nodejs'],
+    },
+
+    {
+      files: ['*.test.ts'],
+      rules: {
+        'import/no-nodejs-modules': 'off',
+      },
+      extends: [
+        '@metamask/eslint-config-nodejs',
+        '@metamask/eslint-config-mocha',
+      ],
     },
   ],
 
@@ -36,4 +39,4 @@ module.exports = {
     'docs/',
     '.yarn/',
   ],
-}
+};

.gitignore

@@ -1,3 +1,7 @@
+.DS_Store
+dist/
+docs/
+
 # Logs
 logs
 *.log

.prettierrc.js

@@ -0,0 +1,8 @@
+// All of these are defaults except singleQuote, but we specify them
+// for explicitness
+module.exports = {
+  quoteProps: 'as-needed',
+  singleQuote: true,
+  tabWidth: 2,
+  trailingComma: 'all',
+};

README.md

@@ -1,5 +1,4 @@
-eth-ledger-bridge-keyring [![CircleCI](https://circleci.com/gh/MetaMask/eth-ledger-bridge-keyring.svg?style=svg)](https://circleci.com/gh/MetaMask/eth-ledger-bridge-keyring)
-==================
+# eth-ledger-bridge-keyring [![CircleCI](https://circleci.com/gh/MetaMask/eth-ledger-bridge-keyring.svg?style=svg)](https://circleci.com/gh/MetaMask/eth-ledger-bridge-keyring)
 
 An implementation of MetaMask's [Keyring interface](https://github.com/MetaMask/eth-simple-keyring#the-keyring-class-protocol), that uses a Ledger hardware wallet for all cryptographic operations.
 
@@ -16,17 +15,15 @@ device. However there are a number of differences:
 
 - Because extensions have limited access to browser features, there's no easy way to interact wth the Ledger Hardware wallet from the MetaMask extension. This library implements a workaround to those restrictions by injecting (on demand) an iframe to the background page of the extension, (which is hosted [here](https://metamask.github.io/eth-ledger-bridge-keyring/index.html).
 
-The iframe is allowed to interact with the Ledger device (since U2F requires SSL and the iframe is hosted under https) using the libraries from [LedgerJS](https://github.com/LedgerHQ/ledgerjs) *hw-app-eth* and *hw-transport-u2f* and establishes a two-way communication channel with the extension via postMessage.
+The iframe is allowed to interact with the Ledger device (since U2F requires SSL and the iframe is hosted under https) using the libraries from [LedgerJS](https://github.com/LedgerHQ/ledgerjs) _hw-app-eth_ and _hw-transport-u2f_ and establishes a two-way communication channel with the extension via postMessage.
 
 The iframe code it's hosted in the same repo under the branch [gh-pages](https://github.com/MetaMask/eth-ledger-bridge-keyring/tree/gh-pages) and it's being served via github pages. In the future we might move it under the metamask.io domain.
 
-Usage
------
+## Usage
 
 In addition to all the known methods from the [Keyring class protocol](https://github.com/MetaMask/eth-simple-keyring#the-keyring-class-protocol),
 there are a few others:
 
-
 - **isUnlocked** : Returns true if we have the public key in memory, which allows to generate the list of accounts at any time
 
 - **unlock** : Connects to the Ledger device and exports the extended public key, which is later used to read the available ethereum addresses inside the Ledger account.
@@ -41,16 +38,14 @@ there are a few others:
 
 - **forgetDevice** : removes all the device info from memory so the next interaction with the keyring will prompt the user to connect the Ledger device and export the account information
 
-Testing
--------
+## Testing
+
 Run the following command:
 
 ```bash
 yarn test
 ```
 
+## Attributions
 
-
-Attributions
--------
 This code was inspired by [eth-ledger-keyring](https://github.com/jamespic/eth-ledger-keyring) and [eth-hd-keyring](https://github.com/MetaMask/eth-hd-keyring)