This repository has been archived by the owner on Jan 26, 2022. It is now read-only.
/
Keyring.ts
346 lines (272 loc) · 10.4 KB
/
Keyring.ts
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
// Copyright 2017-2019 @polkadot/ui-keyring authors & contributors
// This software may be modified and distributed under the terms
// of the Apache-2.0 license. See the LICENSE file for details.
import { KeyringPair, KeyringPair$Meta, KeyringPair$Json } from '@polkadot/keyring/types';
import { KeypairType } from '@polkadot/util-crypto/types';
import { AddressSubject, SingleAddress } from './observable/types';
import { CreateResult, KeyringAddress, KeyringAddressType,
KeyringItemType, KeyringJson, KeyringJson$Meta,
KeyringOptions, KeyringStruct } from './types';
import createPair from '@polkadot/keyring/pair';
import { hexToU8a, isHex, isString } from '@polkadot/util';
import env from './observable/development';
import Base from './Base';
import { accountKey, addressKey, accountRegex, addressRegex, contractKey, contractRegex } from './defaults';
import keyringOption from './options';
// import Vue from 'vue';
const RECENT_EXPIRY = 24 * 60 * 60;
// No accounts (or test accounts) should be loaded until after the chain determination.
// Chain determination occurs outside of Keyring.
// Loading `keyring.loadAll({ type: 'ed25519' | 'sr25519' })` is triggered
// from the API after the chain is received
import { Vue, Component } from 'vue-property-decorator';
// @Component({})
export class Keyring extends Base implements KeyringStruct {
private stores = {
address: (): AddressSubject => this.addresses,
contract: (): AddressSubject => this.contracts,
account: (): AddressSubject => this.accounts,
};
public addExternal(address: string | Uint8Array, meta: KeyringPair$Meta = {}): CreateResult {
const pair = this.keyring.addFromAddress(address, { ...meta, isExternal: true }, null);
return {
json: this.saveAccount(pair),
pair,
};
}
public addPair(pair: KeyringPair, password: string): CreateResult {
this.keyring.addPair(pair);
return {
json: this.saveAccount(pair, password),
pair,
};
}
public addUri(suri: string, password?: string, meta: KeyringPair$Meta = {}, type?: KeypairType): CreateResult {
const pair = this.keyring.addFromUri(suri, meta, type);
return {
json: this.saveAccount(pair, password),
pair,
};
}
public backupAccount(pair: KeyringPair, password: string): KeyringPair$Json {
if (!pair.isLocked) {
pair.lock();
}
pair.decodePkcs8(password);
return pair.toJson(password);
}
public createFromUri(suri: string, meta: KeyringPair$Meta = {}, type?: KeypairType): KeyringPair {
return this.keyring.createFromUri(suri, meta, type);
}
public encryptAccount(pair: KeyringPair, password: string): void {
const json = pair.toJson(password);
json.meta.whenEdited = Date.now();
this.keyring.addFromJson(json);
this.accounts.add(this._store, pair.address, json);
}
public forgetAccount(address: string): void {
this.keyring.removePair(address);
this.accounts.remove(this._store, address);
}
public forgetAddress(address: string): void {
this.addresses.remove(this._store, address);
}
public forgetContract(address: string): void {
this.contracts.remove(this._store, address);
}
public getAccount(address: string | Uint8Array): KeyringAddress | undefined {
return this.getAddress(address, 'account');
}
public getAccounts(): KeyringAddress[] {
const available = this.accounts.subject.getValue();
return Object
.keys(available)
.map((address): KeyringAddress => this.getAddress(address, 'account') as KeyringAddress)
.filter((account): boolean => env.isDevelopment() || account.meta.isTesting !== true);
}
public getAddress(_address: string | Uint8Array, type: KeyringItemType | null = null): KeyringAddress | undefined {
const address = isString(_address)
? _address
: this.encodeAddress(_address);
const publicKey = this.decodeAddress(address);
const stores = type
? [this.stores[type]]
: Object.values(this.stores);
const info = stores.reduce<SingleAddress | undefined>((lastInfo, store): SingleAddress | undefined =>
(store().subject.getValue()[address] || lastInfo), undefined);
return info && {
address,
publicKey,
meta: info.json.meta,
};
}
public getAddresses(): KeyringAddress[] {
const available = this.addresses.subject.getValue();
return Object
.keys(available)
.map((address): KeyringAddress => this.getAddress(address) as KeyringAddress);
}
// public getContract(address: string | Uint8Array): KeyringAddress | undefined {
// return this.getAddress(address, 'contract');
// }
// public getContracts(): KeyringAddress[] {
// const available = this.contracts.subject.getValue();
// return Object
// .entries(available)
// .filter(([, { json: { meta: { contract } } }]): boolean =>
// !!contract && contract.genesisHash === this.genesisHash,
// )
// .map(([address]): KeyringAddress => storessthis.getContract(address) as KeyringAddress);
// }
private rewriteKey(json: KeyringJson, key: string, hexAddr: string, creator: (addr: string) => string): void {
if (hexAddr.substr(0, 2) === '0x') {
return;
}
this._store.remove(key);
this._store.set(creator(hexAddr), json);
}
private loadAccount(json: KeyringJson, key: string): void {
if (!json.meta.isTesting && (json as KeyringPair$Json).encoded) {
// FIXME Just for the transition period (ignoreChecksum)
const pair = this.keyring.addFromJson(json as KeyringPair$Json, true);
this.accounts.add(this._store, pair.address, json);
}
const [, hexAddr] = key.split(':');
this.rewriteKey(json, key, hexAddr.trim(), accountKey);
}
private loadAddress(json: KeyringJson, key: string): void {
const { isRecent, whenCreated = 0 } = json.meta;
if (isRecent && (Date.now() - whenCreated) > RECENT_EXPIRY) {
this._store.remove(key);
return;
}
const address = this.encodeAddress(
isHex(json.address)
? hexToU8a(json.address)
// FIXME Just for the transition period (ignoreChecksum)
: this.decodeAddress(json.address, true)
);
const [, hexAddr] = key.split(':');
this.addresses.add(this._store, address, json);
this.rewriteKey(json, key, hexAddr, addressKey);
}
private loadContract(json: KeyringJson, key: string): void {
const address = this.encodeAddress(
this.decodeAddress(json.address),
);
const [, hexAddr] = key.split(':');
// move genesisHash to top-level (TODO Remove from contracts section?)
json.meta.genesisHash = json.meta.genesisHash || (json.meta.contract && json.meta.contract.genesisHash);
this.contracts.add(this._store, address, json);
this.rewriteKey(json, key, hexAddr, contractKey);
}
private loadInjected(address: string, meta: KeyringJson$Meta): void {
const json = {
address,
meta: {
...meta,
isInjected: true,
},
};
const pair = this.keyring.addFromAddress(address, json.meta);
this.accounts.add(this._store, pair.address, json);
}
private allowGenesis(json?: KeyringJson | { meta: KeyringJson$Meta } | null): boolean {
if (json && json.meta && this.genesisHash) {
if (json.meta.genesisHash) {
return this.genesisHash === json.meta.genesisHash;
} else if (json.meta.contract) {
return this.genesisHash === json.meta.contract.genesisHash;
}
}
return true;
}
public loadAll(options: KeyringOptions, injected: { address: string; meta: KeyringJson$Meta }[] = []): void {
super.initKeyring(options);
this._store.all((key: string, json: KeyringJson): void => {
if (options.filter ? options.filter(json) : true) {
if (this.allowGenesis(json)) {
if (accountRegex.test(key)) {
this.loadAccount(json, key);
} else if (addressRegex.test(key)) {
this.loadAddress(json, key);
} else if (contractRegex.test(key)) {
this.loadContract(json, key);
}
}
}
});
injected.forEach((account): void => {
if (this.allowGenesis(account)) {
this.loadInjected(account.address, account.meta);
}
});
keyringOption.init(this);
}
public restoreAccount(json: KeyringPair$Json, password: string): KeyringPair {
const type = Array.isArray(json.encoding.content) ? json.encoding.content[1] : 'ed25519';
const pair = createPair(
type,
{
// FIXME Just for the transition period (ignoreChecksum)
publicKey: this.decodeAddress(json.address, true)
},
json.meta,
hexToU8a(json.encoded)
);
// unlock, save account and then lock (locking cleans secretKey, so needs to be last)
pair.decodePkcs8(password);
this.addPair(pair, password);
pair.lock();
return pair;
}
public saveAccount(pair: KeyringPair, password?: string): KeyringPair$Json {
this.addTimestamp(pair);
const json = pair.toJson(password);
this.keyring.addFromJson(json);
this.accounts.add(this._store, pair.address, json);
return json;
}
public saveAccountMeta(pair: KeyringPair, meta: KeyringPair$Meta): void {
const address = pair.address;
this._store.get(accountKey(address), (json: KeyringJson): void => {
pair.setMeta(meta);
json.meta = pair.meta;
this.accounts.add(this._store, address, json);
});
}
public saveAddress(address: string, meta: KeyringPair$Meta, type: KeyringAddressType = 'address'): KeyringPair$Json {
const available = this.addresses.subject.getValue();
const json = (available[address] && available[address].json) || {
address,
meta: {
isRecent: undefined,
whenCreated: Date.now()
}
};
Object.keys(meta).forEach((key): void => {
json.meta[key] = meta[key];
});
delete json.meta.isRecent;
this.stores[type]().add(this._store, address, json);
return json as KeyringPair$Json;
}
public saveContract(address: string, meta: KeyringPair$Meta): KeyringPair$Json {
return this.saveAddress(address, meta, 'contract');
}
public saveRecent(address: string): SingleAddress {
const available = this.addresses.subject.getValue();
if (!available[address]) {
this.addresses.add(this._store, address, {
address,
meta: {
isRecent: true,
whenCreated: Date.now()
}
});
}
return this.addresses.subject.getValue()[address];
}
}
const keyringInstance = new Keyring();
export default keyringInstance;