Fix/npm linkability

README.md

@@ -265,6 +265,16 @@ inter-compatibility between keystores. Implementing features which
 increase complexity and reduce inter-compatibility should be
 discouraged.
 
+### Developing locally with another app (ex. [Caravan](https://github.com/unchained-capital/caravan))
+
+If you would like to develop unchained-wallets locally while also developing an app that depends on unchained-wallets, you'll need to do a few steps:
+
+1. Change `"main": "lib/index.js"` in package.json to `"main": "src/index.ts"` This step is temporary while we convert this package to ESM.
+1. In the root of this project run `npm link`
+1. In the root of the project that depends on this package run `npm link unchained-wallets`
+
+Now when you start up your app, whatever bundler you're using (Vite, Webpack, etc.) should compile this package as well.
+
 ### Developing against local Trezor connect
 
 If for some reason you need to use a [local instance of Trezor Connect](https://wiki.trezor.io/Developers_guide:Running_Trezor_Connect_on_localhost)

images/compile.js

@@ -3,14 +3,13 @@
 //
 // FIXME there is probably a smart babel-based way to do this.
 
-
-const fs = require('fs');
-const path = require('path');
-const imagesDir = path.dirname(__filename);
+import { readFileSync, writeFileSync } from "fs";
+import { dirname, join } from "path";
+const imagesDir = dirname(__filename);
 
 function base64Data(imagePath) {
-  const bytes = fs.readFileSync(path.join(imagesDir, imagePath));
-  return Buffer.from(bytes).toString('base64');
+  const bytes = readFileSync(join(imagesDir, imagePath));
+  return Buffer.from(bytes).toString("base64");
 }
 
 function mimeType(imagePath) {
@@ -33,21 +32,66 @@ function imageData(imagePath, label) {
 
 const IMAGES = {
   ledger: {
-    warning: imageData("ledger/warning.png", "Ledger screen displaying a `WARNING!` message."),
-    derivationPathIsUnusualV1: imageData("ledger/derivationPathIsUnusualV1.png" ,"Ledger screen displaying a message about an 'unusual path'."),
-    derivationPathV1: imageData("ledger/derivationPathV1.png",  "Ledger screen displaying a derivation path."),
-    rejectIfNotSureV1: imageData("ledger/rejectIfNotSureV1.png", "Ledger screen displaying a prompt about being sure."),
-    addressScrollV1: imageData("ledger/addressScrollV1.png", "Ledger screen displaying a bitcoin address."),
-    unusualDerivationBeta: imageData("ledger/unusualDerivationBeta.png", "The derivation path is unusual."),
-    fullDerivationPathBeta: imageData("ledger/fullDerivationPathBeta.png", "Ledger screen displaying a derivation path."),
-    rejectIfNotSureBeta: imageData("ledger/rejectIfNotSureBeta.png", "Reject if you're not sure."),
-    approveDerivationBeta: imageData("ledger/approveDerivationBeta.png", "Approve the derivation path if you are sure."),
-    derivationPathBeta: imageData("ledger/derivationPathBeta.png", "Ledger screen displaying a derivation path."),
-    addressClickThroughBeta: imageData("ledger/addressClickThroughBeta.png", "Ledger screen will display your corresponding public key."),
-    approveAddressBeta: imageData("ledger/approveAddressBeta.png", "Ledger screen asks for your approval."),
-    exportPublicKeyBeta: imageData("ledger/exportPublicKeyBeta.png", "Ledger screen asking to export public key"),
-    exportPublicKeyV1: imageData("ledger/exportPublicKeyV1.png", "Ledger screen asking to export public key"),
-  }
+    warning: imageData(
+      "ledger/warning.png",
+      "Ledger screen displaying a `WARNING!` message."
+    ),
+    derivationPathIsUnusualV1: imageData(
+      "ledger/derivationPathIsUnusualV1.png",
+      "Ledger screen displaying a message about an 'unusual path'."
+    ),
+    derivationPathV1: imageData(
+      "ledger/derivationPathV1.png",
+      "Ledger screen displaying a derivation path."
+    ),
+    rejectIfNotSureV1: imageData(
+      "ledger/rejectIfNotSureV1.png",
+      "Ledger screen displaying a prompt about being sure."
+    ),
+    addressScrollV1: imageData(
+      "ledger/addressScrollV1.png",
+      "Ledger screen displaying a bitcoin address."
+    ),
+    unusualDerivationBeta: imageData(
+      "ledger/unusualDerivationBeta.png",
+      "The derivation path is unusual."
+    ),
+    fullDerivationPathBeta: imageData(
+      "ledger/fullDerivationPathBeta.png",
+      "Ledger screen displaying a derivation path."
+    ),
+    rejectIfNotSureBeta: imageData(
+      "ledger/rejectIfNotSureBeta.png",
+      "Reject if you're not sure."
+    ),
+    approveDerivationBeta: imageData(
+      "ledger/approveDerivationBeta.png",
+      "Approve the derivation path if you are sure."
+    ),
+    derivationPathBeta: imageData(
+      "ledger/derivationPathBeta.png",
+      "Ledger screen displaying a derivation path."
+    ),
+    addressClickThroughBeta: imageData(
+      "ledger/addressClickThroughBeta.png",
+      "Ledger screen will display your corresponding public key."
+    ),
+    approveAddressBeta: imageData(
+      "ledger/approveAddressBeta.png",
+      "Ledger screen asks for your approval."
+    ),
+    exportPublicKeyBeta: imageData(
+      "ledger/exportPublicKeyBeta.png",
+      "Ledger screen asking to export public key"
+    ),
+    exportPublicKeyV1: imageData(
+      "ledger/exportPublicKeyV1.png",
+      "Ledger screen asking to export public key"
+    ),
+  },
 };
 
-fs.writeFileSync(path.join(imagesDir, '../lib/images.js'), "export default " + JSON.stringify(IMAGES) + ";");
+writeFileSync(
+  join(imagesDir, "../lib/images.js"),
+  `export default ${JSON.stringify(IMAGES)};`
+);

package.json

@@ -49,7 +49,7 @@
     "build-types": "tsc -p tsconfig.json",
     "build-types:watch": "tsc --watch",
     "check-types": "tsc -p tsconfig.json --noEmit --emitDeclarationOnly false",
-    "compile": "babel --extensions .ts,.js -d lib/ src/ && npm run compile-images",
+    "compile": "babel --extensions .ts,.js -d lib/ src/",
     "compile:trezor-dev": "TREZOR_DEV=true babel --extensions .ts,.js --watch -d lib/ src/ && npm run compile-images",
     "compile:watch": "babel --watch --extensions .ts,.js -d lib/ src/ && compile-images",
     "prepublish": "npm run compile",

src/index.ts

@@ -610,4 +610,7 @@ export * from "./custom";
 export * from "./hermit";
 export * from "./ledger";
 export * from "./trezor";
-export * from "./policy";
+import * as MultisigWallet from "./policy";
+
+const MultisigWalletPolicy = MultisigWallet.MultisigWalletPolicy;
+export { braidDetailsToWalletConfig, MultisigWalletPolicy };

src/ledger.ts

@@ -72,8 +72,7 @@ export const LEDGER = "ledger";
 
 export const LEDGER_V2 = "ledger_v2";
 
-/* eslint-disable @typescript-eslint/no-var-requires */
-const TransportU2F = require("@ledgerhq/hw-transport-u2f").default;
+import TransportU2F from "@ledgerhq/hw-transport-u2f";
 
 import TransportWebUSB from "@ledgerhq/hw-transport-webusb";
 import LedgerBtc from "@ledgerhq/hw-app-btc";

src/trezor.js

@@ -61,8 +61,7 @@ import { MULTISIG_ROOT } from "./index";
  */
 export const TREZOR = "trezor";
 
-// eslint-disable-next-line
-const TrezorConnect = require("@trezor/connect-web").default;
+import TrezorConnect from "@trezor/connect-web";
 
 const ADDRESS_SCRIPT_TYPES = {
   [P2SH]: "SPENDMULTISIG",