hw-{ledger, ledger-transports}, keyring, networks, util, util-crypto, x-{bigint, fetch, global, randomvalues, textdecoder, textencoder, ws} 11.1.2

Author: github-actions[bot]

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## master
+
+- hw-{ledger, ledger-transports}, keyring, networks, util, util-crypto, x-{bigint, fetch, global, randomvalues, textdecoder, textencoder, ws} 11.1.2
+
 ## 0.2.32 Mar 19, 2023
 
 - api, api-{augment, base, contract, derive}, rpc-{augment, core, provider}, types, types-{augment, codec, create, known} 10.1.4

hw-ledger-transports/browser.ts

@@ -1,20 +1,9 @@
 
-import type { Transport, TransportDef } from './types.ts';
+import LedgerHid from 'https://esm.sh/@ledgerhq/hw-transport-webhid@6.27.12';
+import LedgerUsb from 'https://esm.sh/@ledgerhq/hw-transport-webusb@6.27.12';
 
-import LedgerWebHid from 'https://esm.sh/@ledgerhq/hw-transport-webhid@6.27.12';
-import LedgerWebUsb from 'https://esm.sh/@ledgerhq/hw-transport-webusb@6.27.12';
+import { createDefs } from './util.ts';
 
 export { packageInfo } from './packageInfo.ts';
 
-export const transports: TransportDef[] = [
-  {
-    create: (): Promise<Transport> =>
-      (LedgerWebUsb as unknown as Transport).create(),
-    type: 'webusb'
-  },
-  {
-    create: (): Promise<Transport> =>
-      (LedgerWebHid as unknown as Transport).create(),
-    type: 'hid'
-  }
-];
+export const transports = /*#__PURE__*/ createDefs(['webusb', LedgerUsb], ['hid', LedgerHid]);

hw-ledger-transports/detectPackage.ts

@@ -1,6 +1,6 @@
 
 
-import { detectPackage } from 'https://deno.land/x/polkadot@0.2.32/util/mod.ts';
+import { detectPackage } from 'https://deno.land/x/polkadot/util/mod.ts';
 
 import others from './detectOther.ts';
 import { packageInfo } from './packageInfo.ts';

hw-ledger-transports/empty.ts

@@ -1,6 +1,6 @@
 
-import type { TransportDef } from './types.ts';
+import { createDefs } from './util.ts';
 
 export { packageInfo } from './packageInfo.ts';
 
-export const transports: TransportDef[] = [];
+export const transports = /*#__PURE__*/ createDefs();

hw-ledger-transports/node.ts

@@ -1,14 +1,8 @@
 
-import type { Transport, TransportDef } from './types.ts';
-
 import LedgerHid from 'https://esm.sh/@ledgerhq/hw-transport-node-hid-singleton@6.28.9';
 
+import { createDefs } from './util.ts';
+
 export { packageInfo } from './packageInfo.ts';
 
-export const transports: TransportDef[] = [
-  {
-    create: (): Promise<Transport> =>
-      (LedgerHid as unknown as Transport).create(),
-    type: 'hid'
-  }
-];
+export const transports = /*#__PURE__*/ createDefs(['hid', LedgerHid]);

hw-ledger-transports/packageInfo.ts

@@ -1,3 +1,3 @@
 
 
-export const packageInfo = { name: '@polkadot/hw-ledger-transports', path: new URL(import.meta.url).pathname, type: 'deno', version: '0.2.32' };
+export const packageInfo = { name: '@polkadot/hw-ledger-transports', path: new URL(import.meta.url).pathname, type: 'deno', version: '11.1.2' };

hw-ledger-transports/types.ts

@@ -1,13 +1,14 @@
 
-export type LedgerTypes = 'hid' | 'u2f' | 'webusb';
+export type TransportType = 'hid' | 'webusb';
+
 
 export interface Transport {
-  create (): Promise<Transport>;
+  // empty on purpose, just a stub
 }
 
 export interface TransportDef {
   /** Create a transport to be used in Ledger operations */
   create (): Promise<Transport>;
   /** The type of the underlying transport definition */
-  type: LedgerTypes;
+  type: TransportType;
 }

hw-ledger-transports/util.ts

@@ -0,0 +1,10 @@
+
+import type { Transport, TransportDef, TransportType } from './types.ts';
+
+export function createDefs (...items: readonly [type: TransportType, Clazz: unknown][]): TransportDef[] {
+  return items.map(([type, Clazz]): TransportDef => ({
+    create: (): Promise<Transport> =>
+      (Clazz as Pick<TransportDef, 'create'>).create(),
+    type
+  }));
+}

hw-ledger/bundle.ts

@@ -1,11 +1,12 @@
 
-import type { SubstrateApp } from 'https://esm.sh/@zondax/ledger-substrate@0.40.5';
-import type { AccountOptions, LedgerAddress, LedgerSignature, LedgerTypes, LedgerVersion } from './types.ts';
+import type { SubstrateApp } from 'https://esm.sh/@zondax/ledger-substrate@0.40.6';
+import type { TransportDef, TransportType } from 'https://deno.land/x/polkadot/hw-ledger-transports/types.ts';
+import type { AccountOptions, LedgerAddress, LedgerSignature, LedgerVersion } from './types.ts';
 
-import { newSubstrateApp } from 'https://esm.sh/@zondax/ledger-substrate@0.40.5';
+import { newSubstrateApp } from 'https://esm.sh/@zondax/ledger-substrate@0.40.6';
 
-import { transports } from 'https://deno.land/x/polkadot@0.2.32/hw-ledger-transports/mod.ts';
-import { hexAddPrefix, u8aToBuffer } from 'https://deno.land/x/polkadot@0.2.32/util/mod.ts';
+import { transports } from 'https://deno.land/x/polkadot/hw-ledger-transports/mod.ts';
+import { hexAddPrefix, u8aToBuffer } from 'https://deno.land/x/polkadot/util/mod.ts';
 
 import { LEDGER_DEFAULT_ACCOUNT, LEDGER_DEFAULT_CHANGE, LEDGER_DEFAULT_INDEX, LEDGER_SUCCESS_CODE } from './constants.ts';
 import { ledgerApps } from './defaults.ts';
@@ -30,22 +31,28 @@ async function wrapError <T extends WrappedResult> (promise: Promise<T>): Promis
 export class Ledger {
   #app: SubstrateApp | null = null;
 
-  #chain: Chain;
+  #ledgerName: string;
 
-  #transport: LedgerTypes;
+  #transportDef: TransportDef;
 
-  constructor (transport: LedgerTypes, chain: Chain) {
-    // u2f is deprecated
-    if (!['hid', 'webusb'].includes(transport)) {
-      throw new Error(`Unsupported transport ${transport}`);
-    } else if (!Object.keys(ledgerApps).includes(chain)) {
-      throw new Error(`Unsupported chain ${chain}`);
+  constructor (transport: TransportType, chain: Chain) {
+    const ledgerName = ledgerApps[chain];
+    const transportDef = transports.find(({ type }) => type === transport);
+
+    if (!ledgerName) {
+      throw new Error(`Unsupported Ledger chain ${chain}`);
+    } else if (!transportDef) {
+      throw new Error(`Unsupported Ledger transport ${transport}`);
     }
 
-    this.#chain = chain;
-    this.#transport = transport;
+    this.#ledgerName = ledgerName;
+    this.#transportDef = transportDef;
   }
 
+  /**
+   * Returns the address associated with a specific account & address offset. Optionally
+   * asks for on-device confirmation
+   */
   public async getAddress (confirm = false, accountOffset = 0, addressOffset = 0, { account = LEDGER_DEFAULT_ACCOUNT, addressIndex = LEDGER_DEFAULT_INDEX, change = LEDGER_DEFAULT_CHANGE }: Partial<AccountOptions> = {}): Promise<LedgerAddress> {
     return this.withApp(async (app: SubstrateApp): Promise<LedgerAddress> => {
       const { address, pubKey } = await wrapError(app.getAddress(account + accountOffset, change, addressIndex + addressOffset, confirm));
@@ -57,6 +64,9 @@ export class Ledger {
     });
   }
 
+  /**
+   * Returns the version of the Ledger application on the device
+   */
   public async getVersion (): Promise<LedgerVersion> {
     return this.withApp(async (app: SubstrateApp): Promise<LedgerVersion> => {
       const { device_locked: isLocked, major, minor, patch, test_mode: isTestMode } = await wrapError(app.getVersion());
@@ -69,6 +79,9 @@ export class Ledger {
     });
   }
 
+  /**
+   * Signs a transcation on the Ledger device
+   */
   public async sign (message: Uint8Array, accountOffset = 0, addressOffset = 0, { account = LEDGER_DEFAULT_ACCOUNT, addressIndex = LEDGER_DEFAULT_INDEX, change = LEDGER_DEFAULT_CHANGE }: Partial<AccountOptions> = {}): Promise<LedgerSignature> {
     return this.withApp(async (app: SubstrateApp): Promise<LedgerSignature> => {
       const buffer = u8aToBuffer(message);
@@ -80,27 +93,21 @@ export class Ledger {
     });
   }
 
-  async getApp (): Promise<SubstrateApp> {
-    if (!this.#app) {
-      const def = transports.find(({ type }) => type === this.#transport);
-
-      if (!def) {
-        throw new Error(`Unable to find a transport for ${this.#transport}`);
-      }
-
-      const transport = await def.create();
-
-      this.#app = newSubstrateApp(transport, ledgerApps[this.#chain]);
-    }
-
-    return this.#app;
-  }
-
+  /**
+   * @internal
+   *
+   * Returns a created SubstrateApp to perform operations against. Generally
+   * this is only used internally, to ensure consistent bahavior.
+   */
   async withApp <T> (fn: (app: SubstrateApp) => Promise<T>): Promise<T> {
     try {
-      const app = await this.getApp();
+      if (!this.#app) {
+        const transport = await this.#transportDef.create();
+
+        this.#app = newSubstrateApp(transport, this.#ledgerName);
+      }
 
-      return await fn(app);
+      return await fn(this.#app);
     } catch (error) {
       this.#app = null;
 

hw-ledger/detectOther.ts

@@ -1,5 +1,5 @@
 
-import { packageInfo as transportInfo } from 'https://deno.land/x/polkadot@0.2.32/hw-ledger-transports/packageInfo.ts';
-import { packageInfo as utilInfo } from 'https://deno.land/x/polkadot@0.2.32/util/packageInfo.ts';
+import { packageInfo as transportInfo } from 'https://deno.land/x/polkadot/hw-ledger-transports/packageInfo.ts';
+import { packageInfo as utilInfo } from 'https://deno.land/x/polkadot/util/packageInfo.ts';
 
 export default [transportInfo, utilInfo];