-
Notifications
You must be signed in to change notification settings - Fork 131
/
PrivateKey.js
422 lines (379 loc) · 11.1 KB
/
PrivateKey.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
/*-
*
* Hedera JavaScript SDK
*
* Copyright (C) 2020 - 2023 Hedera Hashgraph, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
import * as cryptography from "@hashgraph/cryptography";
import Mnemonic from "./Mnemonic.js";
import PublicKey from "./PublicKey.js";
import Key from "./Key.js";
import CACHE from "./Cache.js";
/**
* @typedef {import("./transaction/Transaction.js").default} Transaction
* @typedef {import("./account/AccountId.js").default} AccountId
*/
/**
* @namespace proto
* @typedef {import("@hashgraph/proto").proto.IKey} HashgraphProto.proto.IKey
* @typedef {import("@hashgraph/proto").proto.ITransaction} HashgraphProto.proto.ITransaction
* @typedef {import("@hashgraph/proto").proto.ISignaturePair} HashgraphProto.proto.ISignaturePair
* @typedef {import("@hashgraph/proto").proto.ISignedTransaction} HashgraphProto.proto.ISignedTransaction
*/
export default class PrivateKey extends Key {
/**
* @internal
* @hideconstructor
* @param {cryptography.PrivateKey} key
*/
constructor(key) {
super();
this._key = key;
}
/**
* Generate a random Ed25519 private key.
*
* @returns {PrivateKey}
*/
static generateED25519() {
return new PrivateKey(cryptography.PrivateKey.generateED25519());
}
/**
* Generate a random EDSA private key.
*
* @returns {PrivateKey}
*/
static generateECDSA() {
return new PrivateKey(cryptography.PrivateKey.generateECDSA());
}
/**
* Depredated - Use `generateED25519()` instead
* Generate a random Ed25519 private key.
*
* @returns {PrivateKey}
*/
static generate() {
return PrivateKey.generateED25519();
}
/**
* Depredated - Use `generateED25519Async()` instead
* Generate a random Ed25519 private key.
*
* @returns {Promise<PrivateKey>}
*/
static async generateAsync() {
return new PrivateKey(await cryptography.PrivateKey.generateAsync());
}
/**
* Generate a random Ed25519 private key.
*
* @returns {Promise<PrivateKey>}
*/
static async generateED25519Async() {
return new PrivateKey(
await cryptography.PrivateKey.generateED25519Async()
);
}
/**
* Generate a random ECDSA private key.
*
* @returns {Promise<PrivateKey>}
*/
static async generateECDSAAsync() {
return new PrivateKey(
await cryptography.PrivateKey.generateECDSAAsync()
);
}
/**
* Construct a private key from bytes. Requires DER header.
*
* @param {Uint8Array} data
* @returns {PrivateKey}
*/
static fromBytes(data) {
return new PrivateKey(cryptography.PrivateKey.fromBytes(data));
}
/**
* Construct a ECDSA private key from bytes.
*
* @param {Uint8Array} data
* @returns {PrivateKey}
*/
static fromBytesECDSA(data) {
return new PrivateKey(cryptography.PrivateKey.fromBytesECDSA(data));
}
/**
* Construct a ED25519 private key from bytes.
*
* @param {Uint8Array} data
* @returns {PrivateKey}
*/
static fromBytesED25519(data) {
return new PrivateKey(cryptography.PrivateKey.fromBytesED25519(data));
}
/**
* Construct a private key from a hex-encoded string. Requires DER header.
*
* @param {string} text
* @returns {PrivateKey}
*/
static fromString(text) {
return new PrivateKey(cryptography.PrivateKey.fromString(text));
}
/**
* Construct a ECDSA private key from a hex-encoded string.
*
* @param {string} text
* @returns {PrivateKey}
*/
static fromStringECDSA(text) {
return new PrivateKey(cryptography.PrivateKey.fromStringECDSA(text));
}
/**
* Construct a Ed25519 private key from a hex-encoded string.
*
* @param {string} text
* @returns {PrivateKey}
*/
static fromStringED25519(text) {
return new PrivateKey(cryptography.PrivateKey.fromStringED25519(text));
}
/**
* Construct a Ed25519 private key from a Uint8Array seed.
*
* @param {Uint8Array} seed
* @returns {Promise<PrivateKey>}
*/
static async fromSeedED25519(seed) {
return new PrivateKey(
await cryptography.PrivateKey.fromSeedED25519(seed)
);
}
/**
* Construct a Ed25519 private key from a Uint8Array seed.
*
* @param {Uint8Array} seed
* @returns {Promise<PrivateKey>}
*/
static async fromSeedECDSAsecp256k1(seed) {
return new PrivateKey(
await cryptography.PrivateKey.fromSeedECDSAsecp256k1(seed)
);
}
/**
* @deprecated - Use `Mnemonic.from[Words|String]().to[Ed25519|Ecdsa]PrivateKey()` instead
*
* Recover a private key from a mnemonic phrase (and optionally a password).
* @param {Mnemonic | cryptography.Mnemonic | string} mnemonic
* @param {string} [passphrase]
* @returns {Promise<PrivateKey>}
*/
static async fromMnemonic(mnemonic, passphrase = "") {
if (mnemonic instanceof Mnemonic) {
return new PrivateKey(
// eslint-disable-next-line deprecation/deprecation
await cryptography.PrivateKey.fromMnemonic(
mnemonic._mnemonic,
passphrase
)
);
}
return new PrivateKey(
// eslint-disable-next-line deprecation/deprecation
await cryptography.PrivateKey.fromMnemonic(mnemonic, passphrase)
);
}
/**
* Recover a private key from a keystore, previously created by `.toKeystore()`.
*
* This key will _not_ support child key derivation.
*
* @param {Uint8Array} data
* @param {string} [passphrase]
* @returns {Promise<PrivateKey>}
* @throws {cryptography.BadKeyError} If the passphrase is incorrect or the hash fails to validate.
*/
static async fromKeystore(data, passphrase = "") {
return new PrivateKey(
await cryptography.PrivateKey.fromKeystore(data, passphrase)
);
}
/**
* Recover a private key from a pem string; the private key may be encrypted.
*
* This method assumes the .pem file has been converted to a string already.
*
* If `passphrase` is not null or empty, this looks for the first `ENCRYPTED PRIVATE KEY`
* section and uses `passphrase` to decrypt it; otherwise, it looks for the first `PRIVATE KEY`
* section and decodes that as a DER-encoded private key.
*
* @param {string} data
* @param {string} [passphrase]
* @returns {Promise<PrivateKey>}
*/
static async fromPem(data, passphrase = "") {
return new PrivateKey(
await cryptography.PrivateKey.fromPem(data, passphrase)
);
}
/**
* Derive a new private key at the given wallet index.
*
* Only currently supported for keys created with `fromMnemonic()`; other keys will throw
* an error.
*
* You can check if a key supports derivation with `.supportsDerivation()`
*
* @param {number} index
* @returns {Promise<PrivateKey>}
* @throws If this key does not support derivation.
*/
async derive(index) {
return new PrivateKey(await this._key.derive(index));
}
/**
* @param {number} index
* @returns {Promise<PrivateKey>}
* @throws If this key does not support derivation.
*/
async legacyDerive(index) {
return new PrivateKey(await this._key.legacyDerive(index));
}
/**
* Get the public key associated with this private key.
*
* The public key can be freely given and used by other parties to verify
* the signatures generated by this private key.
*
* @returns {PublicKey}
*/
get publicKey() {
return new PublicKey(this._key.publicKey);
}
/**
* Get the public key associated with this private key.
*
* The public key can be freely given and used by other parties to verify
* the signatures generated by this private key.
*
* @returns {?Uint8Array}
*/
get chainCode() {
return this._key._chainCode;
}
/**
* Sign a message with this private key.
*
* @param {Uint8Array} bytes
* @returns {Uint8Array} - The signature bytes without the message
*/
sign(bytes) {
return this._key.sign(bytes);
}
/**
* @param {Transaction} transaction
* @returns {Uint8Array}
*/
signTransaction(transaction) {
const tx = transaction._signedTransactions.get(0);
const signature =
tx.bodyBytes != null ? this.sign(tx.bodyBytes) : new Uint8Array();
transaction.addSignature(this.publicKey, signature);
return signature;
}
/**
* Check if `derive` can be called on this private key.
*
* This is only the case if the key was created from a mnemonic.
*
* @returns {boolean}
*/
isDerivable() {
return this._key.isDerivable();
}
/**
* @returns {Uint8Array}
*/
toBytes() {
return this._key.toBytes();
}
/**
* @returns {Uint8Array}
*/
toBytesDer() {
return this._key.toBytesDer();
}
/**
* @returns {Uint8Array}
*/
toBytesRaw() {
return this._key.toBytesRaw();
}
/**
* @returns {string}
*/
toString() {
return this._key.toStringDer();
}
/**
* @returns {string}
*/
toStringDer() {
return this._key.toStringDer();
}
/**
* @returns {string}
*/
toStringRaw() {
return this._key.toStringRaw();
}
/**
* Create a keystore with a given passphrase.
*
* The key can be recovered later with `fromKeystore()`.
*
* Note that this will not retain the ancillary data used for
* deriving child keys, thus `.derive()` on the restored key will
* throw even if this instance supports derivation.
*
* @param {string} [passphrase]
* @returns {Promise<Uint8Array>}
*/
toKeystore(passphrase = "") {
return this._key.toKeystore(passphrase);
}
/**
* @returns {HashgraphProto.proto.IKey}
*/
_toProtobufKey() {
return this.publicKey._toProtobufKey();
}
/**
* @param {Long | number} shard
* @param {Long | number} realm
* @returns {AccountId}
*/
toAccountId(shard, realm) {
return this.publicKey.toAccountId(shard, realm);
}
/**
* @returns {string}
*/
get type() {
return this._key._type;
}
}
CACHE.setPrivateKeyConstructor((key) => new PrivateKey(key));