@pezkuwi/hw-ledger 14.0.1 → 14.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/LICENSE +201 -0
  2. package/Ledger.d.ts +43 -0
  3. package/Ledger.js +112 -0
  4. package/LedgerGeneric.d.ts +63 -0
  5. package/LedgerGeneric.js +211 -0
  6. package/README.md +1 -1
  7. package/bundle-polkadot-hw-ledger.js +9708 -0
  8. package/bundle.d.ts +2 -0
  9. package/bundle.js +2 -0
  10. package/cjs/Ledger.d.ts +43 -0
  11. package/cjs/Ledger.js +117 -0
  12. package/cjs/LedgerGeneric.d.ts +63 -0
  13. package/cjs/LedgerGeneric.js +216 -0
  14. package/cjs/bundle.d.ts +2 -0
  15. package/cjs/bundle.js +7 -0
  16. package/cjs/constants.d.ts +4 -0
  17. package/cjs/constants.js +7 -0
  18. package/cjs/defaults.d.ts +14 -0
  19. package/cjs/defaults.js +61 -0
  20. package/cjs/index.d.ts +2 -0
  21. package/cjs/index.js +5 -0
  22. package/cjs/package.json +3 -0
  23. package/cjs/packageDetect.d.ts +1 -0
  24. package/cjs/packageDetect.js +7 -0
  25. package/cjs/packageInfo.d.ts +6 -0
  26. package/cjs/packageInfo.js +4 -0
  27. package/cjs/types.d.ts +34 -0
  28. package/cjs/types.js +2 -0
  29. package/constants.d.ts +4 -0
  30. package/{src/constants.ts → constants.js} +0 -6
  31. package/defaults.d.ts +14 -0
  32. package/defaults.js +58 -0
  33. package/index.d.ts +2 -0
  34. package/index.js +2 -0
  35. package/package.json +156 -6
  36. package/packageDetect.d.ts +1 -0
  37. package/{src/packageDetect.ts → packageDetect.js} +0 -8
  38. package/packageInfo.d.ts +6 -0
  39. package/packageInfo.js +1 -0
  40. package/types.d.ts +34 -0
  41. package/types.js +1 -0
  42. package/src/Ledger.ts +0 -144
  43. package/src/LedgerGeneric.ts +0 -275
  44. package/src/bundle.ts +0 -8
  45. package/src/defaults.spec.ts +0 -20
  46. package/src/defaults.ts +0 -69
  47. package/src/index.ts +0 -6
  48. package/src/mod.ts +0 -4
  49. package/src/packageInfo.ts +0 -6
  50. package/src/types.ts +0 -42
  51. package/tsconfig.build.json +0 -16
  52. package/tsconfig.spec.json +0 -16
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/Ledger.d.ts ADDED
@@ -0,0 +1,43 @@
1
+ import type { SubstrateApp } from '@zondax/ledger-substrate';
2
+ import type { TransportType } from '@polkadot/hw-ledger-transports/types';
3
+ import type { AccountOptions, LedgerAddress, LedgerSignature, LedgerVersion } from './types.js';
4
+ import { ledgerApps } from './defaults.js';
5
+ export { packageInfo } from './packageInfo.js';
6
+ type Chain = keyof typeof ledgerApps;
7
+ /**
8
+ * @name Ledger
9
+ *
10
+ * @description
11
+ * Legacy wrapper for a ledger app -
12
+ * - it connects automatically on use, creating an underlying interface as required
13
+ * - Promises reject with errors (unwrapped errors from @zondax/ledger-substrate)
14
+ * @deprecated Use LedgerGeneric for up to date integration with ledger
15
+ */
16
+ export declare class Ledger {
17
+ #private;
18
+ constructor(transport: TransportType, chain: Chain);
19
+ /**
20
+ * Returns the address associated with a specific account & address offset. Optionally
21
+ * asks for on-device confirmation
22
+ */
23
+ getAddress(confirm?: boolean, accountOffset?: number, addressOffset?: number, { account, addressIndex, change }?: Partial<AccountOptions>): Promise<LedgerAddress>;
24
+ /**
25
+ * Returns the version of the Ledger application on the device
26
+ */
27
+ getVersion(): Promise<LedgerVersion>;
28
+ /**
29
+ * Signs a transaction on the Ledger device
30
+ */
31
+ sign(message: Uint8Array, accountOffset?: number, addressOffset?: number, options?: Partial<AccountOptions>): Promise<LedgerSignature>;
32
+ /**
33
+ * Signs a message (non-transactional) on the Ledger device
34
+ */
35
+ signRaw(message: Uint8Array, accountOffset?: number, addressOffset?: number, options?: Partial<AccountOptions>): Promise<LedgerSignature>;
36
+ /**
37
+ * @internal
38
+ *
39
+ * Returns a created SubstrateApp to perform operations against. Generally
40
+ * this is only used internally, to ensure consistent bahavior.
41
+ */
42
+ withApp<T>(fn: (app: SubstrateApp) => Promise<T>): Promise<T>;
43
+ }
package/Ledger.js ADDED
@@ -0,0 +1,112 @@
1
+ import { newSubstrateApp } from '@zondax/ledger-substrate';
2
+ import { transports } from '@pezkuwi/hw-ledger-transports';
3
+ import { hexAddPrefix, u8aToBuffer, u8aWrapBytes } from '@pezkuwi/util';
4
+ import { LEDGER_DEFAULT_ACCOUNT, LEDGER_DEFAULT_CHANGE, LEDGER_DEFAULT_INDEX, LEDGER_SUCCESS_CODE } from './constants.js';
5
+ import { ledgerApps } from './defaults.js';
6
+ export { packageInfo } from './packageInfo.js';
7
+ /** @internal Wraps a SubstrateApp call, checking the result for any errors which result in a rejection */
8
+ async function wrapError(promise) {
9
+ const result = await promise;
10
+ if (result.return_code !== LEDGER_SUCCESS_CODE) {
11
+ throw new Error(result.error_message);
12
+ }
13
+ return result;
14
+ }
15
+ /** @internal Wraps a sign/signRaw call and returns the associated signature */
16
+ function sign(method, message, accountOffset = 0, addressOffset = 0, { account = LEDGER_DEFAULT_ACCOUNT, addressIndex = LEDGER_DEFAULT_INDEX, change = LEDGER_DEFAULT_CHANGE } = {}) {
17
+ return async (app) => {
18
+ const { signature } = await wrapError(app[method](account + accountOffset, change, addressIndex + addressOffset, u8aToBuffer(message)));
19
+ return {
20
+ signature: hexAddPrefix(signature.toString('hex'))
21
+ };
22
+ };
23
+ }
24
+ /**
25
+ * @name Ledger
26
+ *
27
+ * @description
28
+ * Legacy wrapper for a ledger app -
29
+ * - it connects automatically on use, creating an underlying interface as required
30
+ * - Promises reject with errors (unwrapped errors from @zondax/ledger-substrate)
31
+ * @deprecated Use LedgerGeneric for up to date integration with ledger
32
+ */
33
+ export class Ledger {
34
+ #ledgerName;
35
+ #transportDef;
36
+ #app = null;
37
+ constructor(transport, chain) {
38
+ const ledgerName = ledgerApps[chain];
39
+ const transportDef = transports.find(({ type }) => type === transport);
40
+ if (!ledgerName) {
41
+ throw new Error(`Unsupported Ledger chain ${chain}`);
42
+ }
43
+ else if (!transportDef) {
44
+ throw new Error(`Unsupported Ledger transport ${transport}`);
45
+ }
46
+ this.#ledgerName = ledgerName;
47
+ this.#transportDef = transportDef;
48
+ }
49
+ /**
50
+ * Returns the address associated with a specific account & address offset. Optionally
51
+ * asks for on-device confirmation
52
+ */
53
+ async getAddress(confirm = false, accountOffset = 0, addressOffset = 0, { account = LEDGER_DEFAULT_ACCOUNT, addressIndex = LEDGER_DEFAULT_INDEX, change = LEDGER_DEFAULT_CHANGE } = {}) {
54
+ return this.withApp(async (app) => {
55
+ const { address, pubKey } = await wrapError(app.getAddress(account + accountOffset, change, addressIndex + addressOffset, confirm));
56
+ return {
57
+ address,
58
+ publicKey: hexAddPrefix(pubKey)
59
+ };
60
+ });
61
+ }
62
+ /**
63
+ * Returns the version of the Ledger application on the device
64
+ */
65
+ async getVersion() {
66
+ return this.withApp(async (app) => {
67
+ const { device_locked: isLocked, major, minor, patch, test_mode: isTestMode } = await wrapError(app.getVersion());
68
+ return {
69
+ isLocked,
70
+ isTestMode,
71
+ version: [major, minor, patch]
72
+ };
73
+ });
74
+ }
75
+ /**
76
+ * Signs a transaction on the Ledger device
77
+ */
78
+ async sign(message, accountOffset, addressOffset, options) {
79
+ return this.withApp(sign('sign', message, accountOffset, addressOffset, options));
80
+ }
81
+ /**
82
+ * Signs a message (non-transactional) on the Ledger device
83
+ */
84
+ async signRaw(message, accountOffset, addressOffset, options) {
85
+ return this.withApp(sign('signRaw', u8aWrapBytes(message), accountOffset, addressOffset, options));
86
+ }
87
+ /**
88
+ * @internal
89
+ *
90
+ * Returns a created SubstrateApp to perform operations against. Generally
91
+ * this is only used internally, to ensure consistent bahavior.
92
+ */
93
+ async withApp(fn) {
94
+ try {
95
+ if (!this.#app) {
96
+ const transport = await this.#transportDef.create();
97
+ // We need this override for the actual type passing - the Deno environment
98
+ // is quite a bit stricter and it yields invalids between the two (specifically
99
+ // since we mangle the imports from .default in the types for CJS/ESM and between
100
+ // esm.sh versions this yields problematic outputs)
101
+ //
102
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
103
+ this.#app = newSubstrateApp(transport, this.#ledgerName);
104
+ }
105
+ return await fn(this.#app);
106
+ }
107
+ catch (error) {
108
+ this.#app = null;
109
+ throw error;
110
+ }
111
+ }
112
+ }
@@ -0,0 +1,63 @@
1
+ import type { TransportType } from '@polkadot/hw-ledger-transports/types';
2
+ import type { AccountOptionsGeneric, LedgerAddress, LedgerSignature, LedgerVersion } from './types.js';
3
+ import { PolkadotGenericApp } from '@zondax/ledger-substrate';
4
+ import { ledgerApps } from './defaults.js';
5
+ export { packageInfo } from './packageInfo.js';
6
+ type Chain = keyof typeof ledgerApps;
7
+ /**
8
+ * @name Ledger
9
+ *
10
+ * @description
11
+ * A very basic wrapper for a ledger app -
12
+ * - it connects automatically on use, creating an underlying interface as required
13
+ * - Promises reject with errors (unwrapped errors from @zondax/ledger-substrate-js)
14
+ */
15
+ export declare class LedgerGeneric {
16
+ #private;
17
+ constructor(transport: TransportType, chain: Chain, slip44: number, chainId?: string, metaUrl?: string);
18
+ /**
19
+ * @description Returns the address associated with a specific Ed25519 account & address offset. Optionally
20
+ * asks for on-device confirmation
21
+ */
22
+ getAddress(ss58Prefix: number, confirm?: boolean, accountIndex?: number, addressOffset?: number): Promise<LedgerAddress>;
23
+ /**
24
+ * @description Returns the address associated with a specific ecdsa account & address offset. Optionally
25
+ * asks for on-device confirmation
26
+ */
27
+ getAddressEcdsa(confirm?: boolean, accountIndex?: number, addressOffset?: number): Promise<LedgerAddress>;
28
+ /**
29
+ * @description Returns the version of the Ledger application on the device
30
+ */
31
+ getVersion(): Promise<LedgerVersion>;
32
+ /**
33
+ * @description Signs a transaction on the Ledger device. This requires the LedgerGeneric class to be instantiated with `chainId`, and `metaUrl`
34
+ */
35
+ sign(message: Uint8Array, accountIndex?: number, addressOffset?: number): Promise<LedgerSignature>;
36
+ /**
37
+ * @description Signs a message (non-transactional) on the Ledger device
38
+ */
39
+ signRaw(message: Uint8Array, accountIndex?: number, addressOffset?: number): Promise<LedgerSignature>;
40
+ /**
41
+ * @description Signs a transaction on the Ledger device with Ecdsa. This requires the LedgerGeneric class to be instantiated with `chainId`, and `metaUrl`
42
+ */
43
+ signEcdsa(message: Uint8Array, accountIndex?: number, addressOffset?: number): Promise<LedgerSignature>;
44
+ /**
45
+ * @description Signs a message with Ecdsa (non-transactional) on the Ledger device
46
+ */
47
+ signRawEcdsa(message: Uint8Array, accountIndex?: number, addressOffset?: number): Promise<LedgerSignature>;
48
+ /**
49
+ * @description Signs a transaction on the ledger device provided some metadata.
50
+ */
51
+ signWithMetadata(message: Uint8Array, accountIndex?: number, addressOffset?: number, options?: Partial<AccountOptionsGeneric>): Promise<LedgerSignature>;
52
+ /**
53
+ * @description Signs a transaction on the ledger device for an ecdsa signature provided some metadata.
54
+ */
55
+ signWithMetadataEcdsa(message: Uint8Array, accountIndex?: number, addressOffset?: number, options?: Partial<AccountOptionsGeneric>): Promise<LedgerSignature>;
56
+ /**
57
+ * @internal
58
+ *
59
+ * Returns a created PolkadotGenericApp to perform operations against. Generally
60
+ * this is only used internally, to ensure consistent bahavior.
61
+ */
62
+ withApp<T>(fn: (app: PolkadotGenericApp) => Promise<T>): Promise<T>;
63
+ }
@@ -0,0 +1,211 @@
1
+ import { PolkadotGenericApp } from '@zondax/ledger-substrate';
2
+ import { transports } from '@pezkuwi/hw-ledger-transports';
3
+ import { hexAddPrefix, u8aToBuffer, u8aWrapBytes } from '@pezkuwi/util';
4
+ import { ledgerApps } from './defaults.js';
5
+ export { packageInfo } from './packageInfo.js';
6
+ /** @internal Wraps a PolkadotGenericApp call, checking the result for any errors which result in a rejection */
7
+ async function wrapError(promise) {
8
+ let result;
9
+ try {
10
+ result = await promise;
11
+ }
12
+ catch (e) {
13
+ // We check to see if the propogated error is the newer ResponseError type.
14
+ // The response code use to be part of the result, but with the latest breaking changes from 0.42.x
15
+ // the interface and it's types have completely changed.
16
+ if (e.returnCode) {
17
+ throw new Error(`${e.returnCode}: ${e.errorMessage}`);
18
+ }
19
+ throw new Error(e.message);
20
+ }
21
+ return result;
22
+ }
23
+ /** @internal Wraps a signEd25519/signRawEd25519 call and returns the associated signature */
24
+ function sign(method, message, slip44, accountIndex = 0, addressOffset = 0) {
25
+ const bip42Path = `m/44'/${slip44}'/${accountIndex}'/${0}'/${addressOffset}'`;
26
+ return async (app) => {
27
+ const { signature } = await wrapError(app[method](bip42Path, u8aToBuffer(message)));
28
+ return {
29
+ signature: hexAddPrefix(signature.toString('hex'))
30
+ };
31
+ };
32
+ }
33
+ /** @internal Wraps a signEcdsa/signRawEcdsa call and returns the associated signature */
34
+ function signEcdsa(method, message, slip44, accountIndex = 0, addressOffset = 0) {
35
+ const bip42Path = `m/44'/${slip44}'/${accountIndex}'/${0}'/${addressOffset}'`;
36
+ return async (app) => {
37
+ const { r, s, v } = await wrapError(app[method](bip42Path, u8aToBuffer(message)));
38
+ const signature = Buffer.concat([r, s, v]);
39
+ return {
40
+ signature: hexAddPrefix(signature.toString('hex'))
41
+ };
42
+ };
43
+ }
44
+ /** @internal Wraps a signWithMetadataEd25519 call and returns the associated signature */
45
+ function signWithMetadata(message, slip44, accountIndex = 0, addressOffset = 0, { metadata } = {}) {
46
+ const bip42Path = `m/44'/${slip44}'/${accountIndex}'/${0}'/${addressOffset}'`;
47
+ return async (app) => {
48
+ if (!metadata) {
49
+ throw new Error('The metadata option must be present when using signWithMetadata');
50
+ }
51
+ const bufferMsg = Buffer.from(message);
52
+ const { signature } = await wrapError(app.signWithMetadataEd25519(bip42Path, bufferMsg, metadata));
53
+ return {
54
+ signature: hexAddPrefix(signature.toString('hex'))
55
+ };
56
+ };
57
+ }
58
+ /** @internal Wraps a signWithMetadataEcdsa call and returns the associated signature */
59
+ function signWithMetadataEcdsa(message, slip44, accountIndex = 0, addressOffset = 0, { metadata } = {}) {
60
+ const bip42Path = `m/44'/${slip44}'/${accountIndex}'/${0}'/${addressOffset}'`;
61
+ return async (app) => {
62
+ if (!metadata) {
63
+ throw new Error('The metadata option must be present when using signWithMetadata');
64
+ }
65
+ const bufferMsg = Buffer.from(message);
66
+ const { r, s, v } = await wrapError(app.signWithMetadataEcdsa(bip42Path, bufferMsg, metadata));
67
+ const signature = Buffer.concat([r, s, v]);
68
+ return {
69
+ signature: hexAddPrefix(signature.toString('hex'))
70
+ };
71
+ };
72
+ }
73
+ /**
74
+ * @name Ledger
75
+ *
76
+ * @description
77
+ * A very basic wrapper for a ledger app -
78
+ * - it connects automatically on use, creating an underlying interface as required
79
+ * - Promises reject with errors (unwrapped errors from @zondax/ledger-substrate-js)
80
+ */
81
+ export class LedgerGeneric {
82
+ #transportDef;
83
+ #slip44;
84
+ /**
85
+ * The chainId is represented by the chains token in all lowercase. Example: Polkadot -> dot
86
+ */
87
+ #chainId;
88
+ /**
89
+ * The metaUrl is seen as a server url that the underlying `PolkadotGenericApp` will use to
90
+ * retrieve the signature given a tx blob, and a chainId. It is important to note that if you would like to avoid
91
+ * having any network calls made, use `signWithMetadata`, and avoid `sign`.
92
+ */
93
+ #metaUrl;
94
+ #app = null;
95
+ constructor(transport, chain, slip44, chainId, metaUrl) {
96
+ const ledgerName = ledgerApps[chain];
97
+ const transportDef = transports.find(({ type }) => type === transport);
98
+ if (!ledgerName) {
99
+ throw new Error(`Unsupported Ledger chain ${chain}`);
100
+ }
101
+ else if (!transportDef) {
102
+ throw new Error(`Unsupported Ledger transport ${transport}`);
103
+ }
104
+ this.#metaUrl = metaUrl;
105
+ this.#chainId = chainId;
106
+ this.#slip44 = slip44;
107
+ this.#transportDef = transportDef;
108
+ }
109
+ /**
110
+ * @description Returns the address associated with a specific Ed25519 account & address offset. Optionally
111
+ * asks for on-device confirmation
112
+ */
113
+ async getAddress(ss58Prefix, confirm = false, accountIndex = 0, addressOffset = 0) {
114
+ const bip42Path = `m/44'/${this.#slip44}'/${accountIndex}'/${0}'/${addressOffset}'`;
115
+ return this.withApp(async (app) => {
116
+ const { address, pubKey } = await wrapError(app.getAddressEd25519(bip42Path, ss58Prefix, confirm));
117
+ return {
118
+ address,
119
+ publicKey: hexAddPrefix(pubKey)
120
+ };
121
+ });
122
+ }
123
+ /**
124
+ * @description Returns the address associated with a specific ecdsa account & address offset. Optionally
125
+ * asks for on-device confirmation
126
+ */
127
+ async getAddressEcdsa(confirm = false, accountIndex = 0, addressOffset = 0) {
128
+ const bip42Path = `m/44'/${this.#slip44}'/${accountIndex}'/${0}'/${addressOffset}'`;
129
+ return this.withApp(async (app) => {
130
+ const { address, pubKey } = await wrapError(app.getAddressEcdsa(bip42Path, confirm));
131
+ return {
132
+ address,
133
+ publicKey: hexAddPrefix(pubKey)
134
+ };
135
+ });
136
+ }
137
+ /**
138
+ * @description Returns the version of the Ledger application on the device
139
+ */
140
+ async getVersion() {
141
+ return this.withApp(async (app) => {
142
+ const { deviceLocked: isLocked, major, minor, patch, testMode: isTestMode } = await wrapError(app.getVersion());
143
+ return {
144
+ isLocked: !!isLocked,
145
+ isTestMode: !!isTestMode,
146
+ version: [major || 0, minor || 0, patch || 0]
147
+ };
148
+ });
149
+ }
150
+ /**
151
+ * @description Signs a transaction on the Ledger device. This requires the LedgerGeneric class to be instantiated with `chainId`, and `metaUrl`
152
+ */
153
+ async sign(message, accountIndex, addressOffset) {
154
+ return this.withApp(sign('signEd25519', message, this.#slip44, accountIndex, addressOffset));
155
+ }
156
+ /**
157
+ * @description Signs a message (non-transactional) on the Ledger device
158
+ */
159
+ async signRaw(message, accountIndex, addressOffset) {
160
+ return this.withApp(sign('signRawEd25519', u8aWrapBytes(message), this.#slip44, accountIndex, addressOffset));
161
+ }
162
+ /**
163
+ * @description Signs a transaction on the Ledger device with Ecdsa. This requires the LedgerGeneric class to be instantiated with `chainId`, and `metaUrl`
164
+ */
165
+ async signEcdsa(message, accountIndex, addressOffset) {
166
+ return this.withApp(signEcdsa('signEcdsa', u8aWrapBytes(message), this.#slip44, accountIndex, addressOffset));
167
+ }
168
+ /**
169
+ * @description Signs a message with Ecdsa (non-transactional) on the Ledger device
170
+ */
171
+ async signRawEcdsa(message, accountIndex, addressOffset) {
172
+ return this.withApp(signEcdsa('signRawEcdsa', u8aWrapBytes(message), this.#slip44, accountIndex, addressOffset));
173
+ }
174
+ /**
175
+ * @description Signs a transaction on the ledger device provided some metadata.
176
+ */
177
+ async signWithMetadata(message, accountIndex, addressOffset, options) {
178
+ return this.withApp(signWithMetadata(message, this.#slip44, accountIndex, addressOffset, options));
179
+ }
180
+ /**
181
+ * @description Signs a transaction on the ledger device for an ecdsa signature provided some metadata.
182
+ */
183
+ async signWithMetadataEcdsa(message, accountIndex, addressOffset, options) {
184
+ return this.withApp(signWithMetadataEcdsa(message, this.#slip44, accountIndex, addressOffset, options));
185
+ }
186
+ /**
187
+ * @internal
188
+ *
189
+ * Returns a created PolkadotGenericApp to perform operations against. Generally
190
+ * this is only used internally, to ensure consistent bahavior.
191
+ */
192
+ async withApp(fn) {
193
+ try {
194
+ if (!this.#app) {
195
+ const transport = await this.#transportDef.create();
196
+ // We need this override for the actual type passing - the Deno environment
197
+ // is quite a bit stricter and it yields invalids between the two (specifically
198
+ // since we mangle the imports from .default in the types for CJS/ESM and between
199
+ // esm.sh versions this yields problematic outputs)
200
+ //
201
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
202
+ this.#app = new PolkadotGenericApp(transport, this.#chainId, this.#metaUrl);
203
+ }
204
+ return await fn(this.#app);
205
+ }
206
+ catch (error) {
207
+ this.#app = null;
208
+ throw error;
209
+ }
210
+ }
211
+ }
package/README.md CHANGED
@@ -1,2 +1,2 @@
1
- # @pezkuwi/hw-ledger
1
+ # @polkadot/hw-ledger
2
2