Check for networks vs hw-ledger discrepancies (#943)

* Check for networks vs hw-ledger discrepancies

* Rename ledgerApps

* Bump dev

* type imports
This commit is contained in:
Jaco
2021-04-13 13:23:53 +02:00
committed by GitHub
parent 1b334d570e
commit ea187707c8
9 changed files with 647 additions and 392 deletions
+2 -2
View File
@@ -13,13 +13,13 @@
"sideEffects": false,
"dependencies": {
"@babel/runtime": "^7.13.10",
"@ledgerhq/hw-transport-webusb": "^5.48.0"
"@ledgerhq/hw-transport-webusb": "^5.49.0"
},
"devDependencies": {
"@types/ledgerhq__hw-transport-node-hid": "^4.22.2",
"@types/ledgerhq__hw-transport-webusb": "^4.70.1"
},
"optionalDependencies": {
"@ledgerhq/hw-transport-node-hid-singleton": "^5.48.0"
"@ledgerhq/hw-transport-node-hid-singleton": "^5.49.0"
}
}
+1 -1
View File
@@ -16,6 +16,6 @@
"@babel/runtime": "^7.13.10",
"@polkadot/hw-ledger-transports": "6.1.1",
"@polkadot/util": "^6.1.1",
"@zondax/ledger-polkadot": "^0.13.4"
"@zondax/ledger-polkadot": "^0.13.6"
}
}
+10
View File
@@ -0,0 +1,10 @@
// Copyright 2017-2021 @polkadot/hw-ledger authors & contributors
// SPDX-License-Identifier: Apache-2.0
export const LEDGER_DEFAULT_ACCOUNT = 0x80000000;
export const LEDGER_DEFAULT_CHANGE = 0x80000000;
export const LEDGER_DEFAULT_INDEX = 0x80000000;
export const LEDGER_SUCCESS_CODE = 0x9000;
+24
View File
@@ -0,0 +1,24 @@
// Copyright 2017-2021 @polkadot/hw-ledger authors & contributors
// SPDX-License-Identifier: Apache-2.0
import { knownLedger } from '@polkadot/networks/defaults';
import { ledgerApps } from './defaults';
describe('defaults', (): void => {
it('has entries for each of the apps (hwledger -> networks)', (): void => {
expect(
Object.keys(knownLedger).filter((network) =>
!ledgerApps[network]
)
).toEqual([]);
});
it('has entries for each of the apps (networks -> hwledger)', (): void => {
expect(
Object.keys(ledgerApps).filter((network) =>
!knownLedger[network]
)
).toEqual([]);
});
});
+17
View File
@@ -0,0 +1,17 @@
// Copyright 2017-2021 @polkadot/hw-ledger authors & contributors
// SPDX-License-Identifier: Apache-2.0
import type Transport from '@ledgerhq/hw-transport';
import type { SubstrateApp } from '@zondax/ledger-polkadot';
import { newDockApp, newKusamaApp, newPolkadotApp, newPolymeshApp } from '@zondax/ledger-polkadot';
// These match up with the network keys in the @polkadot/networks package
// (which is turn aligns with the substrate/ss58-registry.json as the single
// source of truth)
export const ledgerApps: Record<string, (transport: Transport) => SubstrateApp> = {
'dock-mainnet': newDockApp,
kusama: newKusamaApp,
polkadot: newPolkadotApp,
polymesh: newPolymeshApp
};
+8 -25
View File
@@ -3,35 +3,18 @@
import './detectPackage';
import type Transport from '@ledgerhq/hw-transport';
import type { ResponseBase, SubstrateApp } from '@zondax/ledger-polkadot';
import type { AccountOptions, LedgerAddress, LedgerSignature, LedgerTypes, LedgerVersion } from './types';
import { newDockApp, newKusamaApp, newPolkadotApp, newPolymeshApp, ResponseBase, SubstrateApp } from '@zondax/ledger-polkadot';
import { transports } from '@polkadot/hw-ledger-transports';
import { assert, u8aToBuffer } from '@polkadot/util';
import { LEDGER_DEFAULT_ACCOUNT, LEDGER_DEFAULT_CHANGE, LEDGER_DEFAULT_INDEX, LEDGER_SUCCESS_CODE } from './constants';
import { ledgerApps } from './defaults';
export { packageInfo } from './packageInfo';
export const LEDGER_DEFAULT_ACCOUNT = 0x80000000;
export const LEDGER_DEFAULT_CHANGE = 0x80000000;
export const LEDGER_DEFAULT_INDEX = 0x80000000;
const SUCCESS_CODE = 0x9000;
// These match up with the network keys in the @polkadot/networks package
// (which is turn aligns with the substrate/ss58-registry.json as the single
// source of truth)
const APPS: Record<string, (transport: Transport) => SubstrateApp> = {
dock: newDockApp,
kusama: newKusamaApp,
polkadot: newPolkadotApp,
polymesh: newPolymeshApp
};
type Chain = keyof typeof APPS;
type Chain = keyof typeof ledgerApps;
// A very basic wrapper for a ledger app -
// - it connects automatically, creating an app as required
@@ -46,7 +29,7 @@ export class Ledger {
constructor (transport: LedgerTypes, chain: Chain) {
// u2f is deprecated
assert(['hid', 'webusb'].includes(transport), `Unsupported transport ${transport}`);
assert(Object.keys(APPS).includes(chain), `Unsupported chain ${chain}`);
assert(Object.keys(ledgerApps).includes(chain), `Unsupported chain ${chain}`);
this.#chain = chain;
this.#transport = transport;
@@ -94,7 +77,7 @@ export class Ledger {
const transport = await def.create();
this.#app = APPS[this.#chain](transport);
this.#app = ledgerApps[this.#chain](transport);
}
return this.#app;
@@ -115,7 +98,7 @@ export class Ledger {
#wrapError = async <T extends ResponseBase> (promise: Promise<T>): Promise<T> => {
const result = await promise;
assert(result.return_code === SUCCESS_CODE, result.error_message);
assert(result.return_code === LEDGER_SUCCESS_CODE, result.error_message);
return result;
};