-
Notifications
You must be signed in to change notification settings - Fork 4
/
facts.ts
489 lines (382 loc) · 18.8 KB
/
facts.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
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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
import { logVerbose } from 'common/logger';
import {
getAccount,
getNetwork,
getNetworkNodeUrl,
getNodePublicKey,
getPrivateKey,
NetworkType,
} from 'common/network';
import { createTxExecutor, isPrivateTxMode } from 'common/tx';
import {
ext,
FactHistoryReader,
FactReader,
FactRemover,
FactWriter,
IEthOptions,
PassportGenerator,
PassportOwnership,
PassportReader,
Permissions,
} from 'verifiable-data';
import Web3 from 'web3';
import { MockIPFSClient } from '../mocks/MockIPFSClient';
import { deployContract, Contract } from 'common/deployContracts';
let passportLogic;
let passportLogicRegistry;
let passportFactory;
let passportLogicAddress;
let passportLogicRegistryAddress;
let passportFactoryAddress;
let passportOwner;
let passportOwnerPrivateKey;
let passportAddress;
let factProviderAddress;
let factProviderPrivateKey;
let privateDataFactSecretKey;
const mockIPFSClient = new MockIPFSClient();
const PassportLogic = artifacts.require('PassportLogic');
const PassportLogicRegistry = artifacts.require('PassportLogicRegistry');
const PassportFactory = artifacts.require('PassportFactory');
const web3 = new Web3(new Web3.providers.HttpProvider(getNetworkNodeUrl()));
const contractCreationParams: any = {};
let options: IEthOptions = null;
const txHashes: any = {};
const txExecutor = createTxExecutor(web3);
// padded hex of "FAKE_KEY_HASH"
const dataKeyHash = '0x46414b455f4b45595f4841534800000000000000000000000000000000000000';
before(async () => {
passportOwner = await getAccount(web3, 1);
passportOwnerPrivateKey = getPrivateKey(1);
factProviderAddress = await getAccount(web3, 2);
factProviderPrivateKey = getPrivateKey(2);
if (isPrivateTxMode) {
switch (getNetwork()) {
case NetworkType.Quorum:
contractCreationParams.privateFor = [getNodePublicKey(1)];
options = {
txRetriever: ext.quorum.getPrivateTx,
};
break;
default:
break;
}
}
// deploy contracts
passportLogic = await deployContract(Contract.PassportLogic, contractCreationParams);
passportLogicAddress = passportLogic.address;
passportLogicRegistry = await deployContract(Contract.PassportLogicRegistry, contractCreationParams);
passportLogicRegistryAddress = passportLogicRegistry.address;
passportFactory = await deployContract(Contract.PassportFactory, contractCreationParams);
passportFactoryAddress = passportFactory.address;
logVerbose('----------------------------------------------------------');
logVerbose('PASSPORT LOGIC:'.padEnd(30), passportLogicAddress);
logVerbose('PASSPORT REGISTRY:'.padEnd(30), passportLogicRegistryAddress);
logVerbose('PASSPORT FACTORY:'.padEnd(30), passportFactoryAddress);
logVerbose('PASSPORT OWNER:'.padEnd(30), passportOwner);
logVerbose('PASSPORT OWNER PRIVATE KEY:'.padEnd(30), passportOwnerPrivateKey);
logVerbose('FACT PROVIDER:'.padEnd(30), factProviderAddress);
logVerbose('FACT PROVIDER PRIVATE KEY:'.padEnd(30), factProviderPrivateKey);
logVerbose('----------------------------------------------------------');
});
describe('Passport creation and facts', () => {
it('Should be able to create passport', async () => {
// Given
const generator = new PassportGenerator(web3, passportFactoryAddress);
// When
const txData = await generator.createPassport(passportOwner);
const receipt = await txExecutor(txData);
// Then
passportAddress = PassportGenerator.getPassportAddressFromReceipt(receipt);
expect(receipt.from.toLowerCase()).to.equal(passportOwner.toLowerCase());
expect(receipt).to.have.property('to');
logVerbose('----------------------------------------------------------');
logVerbose('PASSPORT:'.padEnd(30), passportAddress);
logVerbose('----------------------------------------------------------');
});
if (isPrivateTxMode) {
const web3Node3 = new Web3(new Web3.providers.HttpProvider(getNetworkNodeUrl(2)));
it('Created passport should not be visible from other nodes', async () => {
// Visible in node 1
let code = await web3.eth.getCode(passportAddress);
expect(code.length).to.be.greaterThan(3);
// Not visible in node 3
code = await web3Node3.eth.getCode(passportAddress);
expect(code.length).to.be.lessThan(4);
});
}
it('Should be able to claim ownership', async () => {
// Given
const ownership = new PassportOwnership(web3, passportAddress);
// When
const txData = await ownership.claimOwnership(passportOwner);
const receipt = await txExecutor(txData);
// Then
expect(receipt.from.toLowerCase()).to.equal(passportOwner.toLowerCase());
expect(receipt).to.have.property('to');
});
it('Should be able to get a list of all created passports', async () => {
// Given
const reader = new PassportReader(web3);
// When
const passports = await reader.getPassportsList(passportFactoryAddress);
// Then
expect(passports[0]).to.have.property('passportAddress');
expect(passports[0]).to.have.property('ownerAddress');
});
if (isPrivateTxMode) {
const web3Node3 = new Web3(new Web3.providers.HttpProvider(getNetworkNodeUrl(2)));
it('Should not be able to get a list of all created passports from other node', async () => {
// Given
const reader = new PassportReader(web3Node3);
// When
const passports = await reader.getPassportsList(passportFactoryAddress);
// Then
expect(passports.length).to.equal(0);
});
}
// #region -------------- Fact writing -------------------------------------------------------------------
it('Should be able to write String fact', async () => {
txHashes.string_fact = await writeAndValidateFact(writer => writer.setString('string_fact', 'hello', factProviderAddress));
txHashes.second_fact = await writeAndValidateFact(writer => writer.setString('second_fact', 'world', factProviderAddress));
txHashes.second_fact_update = await writeAndValidateFact(writer => writer.setString('second_fact', 'bar', factProviderAddress));
});
it('Should be able to write Address fact', async () => {
txHashes.address_fact =
await writeAndValidateFact(writer => writer.setAddress('address_fact', '0xab46F39e60f495d46856C972fEde6220cFab0d70', factProviderAddress));
});
it('Should be able to write Int fact', async () => {
txHashes.int_fact = await writeAndValidateFact(writer => writer.setInt('int_fact', -321, factProviderAddress));
});
it('Should be able to write Uint fact', async () => {
txHashes.uint_fact = await writeAndValidateFact(writer => writer.setUint('uint_fact', 123, factProviderAddress));
});
it('Should be able to write Bool fact', async () => {
txHashes.bool_fact = await writeAndValidateFact(writer => writer.setBool('bool_fact', true, factProviderAddress));
});
it('Should be able to write Bytes fact', async () => {
txHashes.bytes_fact = await writeAndValidateFact(writer => writer.setBytes('bytes_fact', [1, 2, 3], factProviderAddress));
});
it('Should be able to write TxData fact', async () => {
txHashes.txdata_fact = await writeAndValidateFact(writer => writer.setTxdata('txdata_fact', [1, 2, 3, 4, 5], factProviderAddress));
});
it('Should be able to write IPFSData fact', async () => {
txHashes.ipfs_fact = await writeAndValidateFact(writer => writer.setIPFSData('ipfs_fact', 'Value in IPFS', factProviderAddress, mockIPFSClient));
});
it('Should be able to write PrivateDataHashes fact', async () => {
txHashes.privatedatahashes_fact = await writeAndValidateFact(writer => writer.setPrivateDataHashes('privatedatahashes_fact', {
dataIpfsHash: 'FAKE_IPFS_HASH',
dataKeyHash,
}, factProviderAddress));
});
it('Should be able to write PrivateData fact', async () => {
const writer = new FactWriter(web3, passportAddress, options);
const writeResult = await writer.setPrivateData('privatedata_fact', [1, 2, 3, 4, 5, 6], factProviderAddress, mockIPFSClient);
txHashes.privatedata_fact = await writeAndValidateFact(_ => writeResult.tx);
privateDataFactSecretKey = Buffer.from(writeResult.dataKey).toString('hex');
logVerbose('----------------------------------------------------------');
logVerbose('PRIVATE FACT SECRET KEY:'.padEnd(30), privateDataFactSecretKey.toString('hex'));
logVerbose('----------------------------------------------------------');
});
// #endregion
// #region -------------- Fact reading -------------------------------------------------------------------
it('Should be able to read String fact', async () => {
await readAndValidateFact(reader => reader.getString(factProviderAddress, 'string_fact'), 'hello');
});
it('Should be able to read Address fact', async () => {
await readAndValidateFact(reader => reader.getAddress(factProviderAddress, 'address_fact'), '0xab46F39e60f495d46856C972fEde6220cFab0d70');
});
it('Should be able to read Int fact', async () => {
await readAndValidateFact(reader => reader.getInt(factProviderAddress, 'int_fact'), -321);
});
it('Should be able to read Uint fact', async () => {
await readAndValidateFact(reader => reader.getUint(factProviderAddress, 'uint_fact'), 123);
});
it('Should be able to read Bool fact', async () => {
await readAndValidateFact(reader => reader.getBool(factProviderAddress, 'bool_fact'), true);
});
it('Should be able to read Bytes fact', async () => {
await readAndValidateFact(reader => reader.getBytes(factProviderAddress, 'bytes_fact'), [1, 2, 3]);
});
it('Should be able to read IPFSData fact', async () => {
await readAndValidateFact(reader => reader.getIPFSData(factProviderAddress, 'ipfs_fact', mockIPFSClient), 'Value in IPFS');
});
it('Should be able to read TxData fact', async () => {
await readAndValidateFact(reader => reader.getTxdata(factProviderAddress, 'txdata_fact'), [1, 2, 3, 4, 5]);
});
it('Should be able to read PrivateDataHashes fact', async () => {
await readAndValidateFact(reader => reader.getPrivateDataHashes(factProviderAddress, 'privatedatahashes_fact'), {
dataIpfsHash: 'FAKE_IPFS_HASH',
dataKeyHash,
});
});
it('Should be able to read PrivateData fact using owner private key', async () => {
await readAndValidateFact(reader => reader.getPrivateData(
factProviderAddress, 'privatedata_fact', passportOwnerPrivateKey, mockIPFSClient), [1, 2, 3, 4, 5, 6]);
});
it('Should be able to read PrivateData fact using secret key', async () => {
await readAndValidateFact(reader => reader.getPrivateDataUsingSecretKey(
factProviderAddress, 'privatedata_fact', privateDataFactSecretKey, mockIPFSClient), [1, 2, 3, 4, 5, 6]);
});
// #endregion
// #region -------------- Fact reading from TX -------------------------------------------------------------------
it('Should be able to read String fact from TX', async () => {
await readAndValidateTxFact(reader => reader.getString(txHashes.string_fact), 'hello');
});
it('Should be able to read Address fact from TX', async () => {
await readAndValidateTxFact(reader => reader.getAddress(txHashes.address_fact), '0xab46f39e60f495d46856c972fede6220cfab0d70');
});
it('Should be able to read Int fact from TX', async () => {
await readAndValidateTxFact(reader => reader.getInt(txHashes.int_fact), -321);
});
it('Should be able to read Uint fact from TX', async () => {
await readAndValidateTxFact(reader => reader.getUint(txHashes.uint_fact), 123);
});
it('Should be able to read Bool fact from TX', async () => {
await readAndValidateTxFact(reader => reader.getBool(txHashes.bool_fact), true);
});
it('Should be able to read Bytes fact from TX', async () => {
await readAndValidateTxFact(reader => reader.getBytes(txHashes.bytes_fact), [1, 2, 3]);
});
it('Should be able to read TxData fact from TX', async () => {
await readAndValidateTxFact(reader => reader.getTxdata(txHashes.txdata_fact), [1, 2, 3, 4, 5]);
});
it('Should be able to read IPFSData fact from TX', async () => {
await readAndValidateTxFact(reader => reader.getIPFSData(txHashes.ipfs_fact, mockIPFSClient), 'Value in IPFS');
});
it('Should be able to read PrivateDataHashes from TX', async () => {
await readAndValidateTxFact(reader => reader.getPrivateDataHashes(txHashes.privatedatahashes_fact), {
dataIpfsHash: 'FAKE_IPFS_HASH',
dataKeyHash,
});
});
it('Should be able to read PrivateFact from TX using owner private key', async () => {
await readAndValidateTxFact(reader =>
reader.getPrivateData(txHashes.privatedata_fact, passportOwnerPrivateKey, mockIPFSClient), [1, 2, 3, 4, 5, 6]);
});
it('Should be able to read PrivateFact from TX using secret key', async () => {
await readAndValidateTxFact(reader =>
reader.getPrivateDataUsingSecretKey(txHashes.privatedata_fact, privateDataFactSecretKey, mockIPFSClient), [1, 2, 3, 4, 5, 6]);
});
// #endregion
// #region -------------- Fact deletion -------------------------------------------------------------------
it('Should be able to delete String fact', async () => {
await deleteAndValidateFact(remover => remover.deleteString('string_fact', factProviderAddress));
await readAndValidateFact(reader => reader.getString(factProviderAddress, 'string_fact'), null);
});
it('Should be able to delete Address fact', async () => {
await deleteAndValidateFact(remover => remover.deleteAddress('address_fact', factProviderAddress));
await readAndValidateFact(reader => reader.getAddress(factProviderAddress, 'address_fact'), null);
});
it('Should be able to delete Int fact', async () => {
await deleteAndValidateFact(remover => remover.deleteInt('int_fact', factProviderAddress));
await readAndValidateFact(reader => reader.getInt(factProviderAddress, 'int_fact'), null);
});
it('Should be able to delete Uint fact', async () => {
await deleteAndValidateFact(remover => remover.deleteUint('uint_fact', factProviderAddress));
await readAndValidateFact(reader => reader.getUint(factProviderAddress, 'uint_fact'), null);
});
it('Should be able to delete Bool fact', async () => {
await deleteAndValidateFact(remover => remover.deleteBool('bool_fact', factProviderAddress));
await readAndValidateFact(reader => reader.getBool(factProviderAddress, 'bool_fact'), null);
});
it('Should be able to delete Bytes fact', async () => {
await deleteAndValidateFact(remover => remover.deleteBytes('bytes_fact', factProviderAddress));
await readAndValidateFact(reader => reader.getBytes(factProviderAddress, 'bytes_fact'), null);
});
it('Should be able to delete TxData fact', async () => {
await deleteAndValidateFact(remover => remover.deleteTxdata('txdata_fact', factProviderAddress));
await readAndValidateFact(reader => reader.getTxdata(factProviderAddress, 'txdata_fact'), null);
});
it('Should be able to delete IPFSData fact', async () => {
await deleteAndValidateFact(remover => remover.deleteIPFSHash('ipfs_fact', factProviderAddress));
await readAndValidateFact(reader => reader.getIPFSData(factProviderAddress, 'ipfs_fact', mockIPFSClient), null);
});
it('Should be able to delete PrivateDataHashes fact', async () => {
await deleteAndValidateFact(remover => remover.deletePrivateDataHashes('privatedatahashes_fact', factProviderAddress));
await readAndValidateFact(reader => reader.getPrivateDataHashes(factProviderAddress, 'privatedatahashes_fact'), null);
});
// #endregion
// #region -------------- Reading fact history -------------------------------------------------------------------
it('Should be able read facts history.', async () => {
// Given
const reader = new PassportReader(web3);
// When
let response = await reader.readPassportHistory(passportAddress);
const dataSource = factProviderAddress.toLowerCase();
// Then
expect(response[1].factProviderAddress.toLowerCase()).to.equal(dataSource);
expect(response[1]).to.have.property('blockNumber');
expect(response[1]).to.have.property('transactionHash');
expect(JSON.stringify(response)).to.contains('string_fact');
// When filtering by fact key and data source address
response = await reader.readPassportHistory(passportAddress, {
key: 'second_fact',
factProviderAddress: dataSource,
});
// Then
expect(response.length).to.equal(2);
expect(response[0].factProviderAddress.toLowerCase()).to.equal(dataSource);
expect(response[1].factProviderAddress.toLowerCase()).to.equal(dataSource);
expect(response[0].transactionHash).to.equal(txHashes.second_fact);
expect(response[1].transactionHash).to.equal(txHashes.second_fact_update);
expect(response[0].key).to.equal('second_fact');
expect(response[1].key).to.equal('second_fact');
});
// #endregion
// #region -------------- Adding FactProvider to Whitelist -------------------------------------------------------------------
it('Should be able to whitelist fact provider.', async () => {
// Given
const permissions = new Permissions(web3, passportAddress);
// When
const txData = await permissions.addFactProviderToWhitelist(factProviderAddress, passportOwner);
const receipt = await txExecutor(txData);
// Then
expect(receipt.from.toLowerCase()).to.equal(passportOwner.toLowerCase());
expect(receipt).to.have.property('to');
});
// #endregion
});
// #region -------------- Helpers -------------------------------------------------------------------
async function writeAndValidateFact(writeFact: (writer: FactWriter) => any) {
// Given
const writer = new FactWriter(web3, passportAddress, options);
// When
const txData = await writeFact(writer);
const receipt = await txExecutor(txData);
// Then
expect(receipt.from.toLowerCase()).to.equal(factProviderAddress.toLowerCase());
expect(receipt).to.have.property('to');
return receipt.transactionHash;
}
async function readAndValidateFact(readFact: (reader: FactReader) => any, expectedValue) {
// Given
const reader = new FactReader(web3, passportAddress, options);
// When
const response = await readFact(reader);
// Then
expect(response).to.deep.equal(expectedValue);
}
async function readAndValidateTxFact(readFact: (reader: FactHistoryReader) => any, expectedValue) {
// Given
const reader = new FactHistoryReader(web3, options);
// When
const response = await readFact(reader);
// Then
expect(response).to.have.property('factProviderAddress');
expect(response).to.have.property('key');
expect(response).to.have.property('value');
expect(response.value).to.deep.equal(expectedValue);
}
async function deleteAndValidateFact(deleteFact: (remover: FactRemover) => any) {
// Given
const remover = new FactRemover(web3, passportAddress);
// When
const txData = await deleteFact(remover);
const transaction = await txExecutor(txData);
// Then
expect(transaction.from.toLowerCase()).to.equal(factProviderAddress.toLowerCase());
expect(transaction).to.have.property('to');
}
// #endregion