blob: e9687787fe9f09473c7949cd9329d0a463e93c88 (
plain) (
blame)
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
|
import { logUtils } from '@0x/utils';
import { NodeType, Web3Wrapper } from '@0x/web3-wrapper';
import * as _ from 'lodash';
// HACK(albrow): 🐉 We have to do this so that debug.setHead works correctly.
// (Geth does not seem to like debug.setHead(0), so by sending some transactions
// we increase the current block number beyond 0). Additionally, some tests seem
// to break when there are fewer than 3 blocks in the chain. (We have no idea
// why, but it was consistently reproducible).
const MINIMUM_BLOCKS = 3;
export class BlockchainLifecycle {
private readonly _web3Wrapper: Web3Wrapper;
private readonly _snapshotIdsStack: number[];
private _addresses: string[] = [];
private _nodeType: NodeType | undefined;
constructor(web3Wrapper: Web3Wrapper) {
this._web3Wrapper = web3Wrapper;
this._snapshotIdsStack = [];
}
public async startAsync(): Promise<void> {
const nodeType = await this._getNodeTypeAsync();
switch (nodeType) {
case NodeType.Ganache:
const snapshotId = await this._web3Wrapper.takeSnapshotAsync();
this._snapshotIdsStack.push(snapshotId);
break;
case NodeType.Geth:
let blockNumber = await this._web3Wrapper.getBlockNumberAsync();
if (blockNumber < MINIMUM_BLOCKS) {
// If the minimum block number is not met, force Geth to
// mine some blocks by sending some dummy transactions.
await this._mineMinimumBlocksAsync();
blockNumber = await this._web3Wrapper.getBlockNumberAsync();
}
this._snapshotIdsStack.push(blockNumber);
// HACK(albrow) It's possible that we applied a time offset but
// the transaction we mined to put that time offset into the
// blockchain was reverted. As a workaround, we mine a new dummy
// block so that the latest block timestamp accounts for any
// possible time offsets.
await this._mineDummyBlockAsync();
break;
default:
throw new Error(`Unknown node type: ${nodeType}`);
}
}
public async revertAsync(): Promise<void> {
const nodeType = await this._getNodeTypeAsync();
switch (nodeType) {
case NodeType.Ganache:
const snapshotId = this._snapshotIdsStack.pop() as number;
const didRevert = await this._web3Wrapper.revertSnapshotAsync(snapshotId);
if (!didRevert) {
throw new Error(`Snapshot with id #${snapshotId} failed to revert`);
}
break;
case NodeType.Geth:
const blockNumber = this._snapshotIdsStack.pop() as number;
await this._web3Wrapper.setHeadAsync(blockNumber);
break;
default:
throw new Error(`Unknown node type: ${nodeType}`);
}
}
private async _mineMinimumBlocksAsync(): Promise<void> {
logUtils.warn('WARNING: minimum block number for tests not met. Mining additional blocks...');
while ((await this._web3Wrapper.getBlockNumberAsync()) < MINIMUM_BLOCKS) {
logUtils.warn('Mining block...');
await this._mineDummyBlockAsync();
}
logUtils.warn('Done mining the minimum number of blocks.');
}
private async _getNodeTypeAsync(): Promise<NodeType> {
if (_.isUndefined(this._nodeType)) {
this._nodeType = await this._web3Wrapper.getNodeTypeAsync();
}
return this._nodeType;
}
// Sends a transaction that has no real effect on the state and waits for it
// to be mined.
private async _mineDummyBlockAsync(): Promise<void> {
if (this._addresses.length === 0) {
this._addresses = await this._web3Wrapper.getAvailableAddressesAsync();
if (this._addresses.length === 0) {
throw new Error('No accounts found');
}
}
await this._web3Wrapper.awaitTransactionMinedAsync(
await this._web3Wrapper.sendTransactionAsync({
from: this._addresses[0],
to: this._addresses[0],
value: '0',
}),
0,
);
}
}
|
