-
Notifications
You must be signed in to change notification settings - Fork 16
/
lockdropHelper.js
409 lines (379 loc) · 13.8 KB
/
lockdropHelper.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
const Promise = require('bluebird');
const keyring = require('@polkadot/keyring');
const { toBN, fromWei, hexToNumber } = require('web3').utils;
const bs58 = require('bs58');
const schedule = require('./schedule');
const generalizedLocks = require('./generalizedLocks');
function getEffectiveValue(ethAmount, term, lockTime, lockStart, totalETH) {
// multiplicative bonus starts at 100 / 100 = 1
let bonus = toBN(100);
// get multiplicative bonus if calculating allocation of locks
if (lockTime && lockStart) {
bonus = schedule.getEarlyParticipationBonus(lockTime, lockStart);
}
if (term == '0') {
// three month term yields no bonus
return toBN(ethAmount).mul(toBN(100).mul(bonus)).div(toBN(10000));
} else if (term == '1') {
// six month term yields 30% bonus
return toBN(ethAmount).mul(toBN(130).mul(bonus)).div(toBN(10000));
} else if (term == '2') {
// twelve month term yields 120% bonus
return toBN(ethAmount).mul(toBN(220).mul(bonus)).div(toBN(10000));
} else if (term == 'signaling') {
// 80% deduction
return toBN(ethAmount).mul(toBN(20)).div(toBN(100));
} else {
// invalid term
return toBN(0);
}
}
const getLocks = async (lockdropContract, address) => {
return await lockdropContract.getPastEvents('Locked', {
fromBlock: 0,
toBlock: 'latest',
filter: {
owner: address,
}
});
};
const getSignals = async (lockdropContract, address) => {
return await lockdropContract.getPastEvents('Signaled', {
fromBlock: 0,
toBlock: 'latest',
filter: {
contractAddr: address,
}
});
};
const getTotalLockedBalance = async (lockdropContract) => {
let { totalETHLocked, totalEffectiveETHLocked } = await calculateEffectiveLocks(lockdropContract);
return { totalETHLocked, totalEffectiveETHLocked };
};
const getTotalSignaledBalance = async (web3, lockdropContract) => {
let { totalETHSignaled, totalEffectiveETHSignaled } = await calculateEffectiveSignals(web3, lockdropContract);
return { totalETHSignaled, totalEffectiveETHSignaled };
};
const calculateEffectiveLocks = async (lockdropContracts) => {
let totalETHLocked = toBN(0);
let totalEffectiveETHLocked = toBN(0);
const locks = {};
const validatingLocks = {};
let lockEvents = []
for (index in lockdropContracts) {
let events = await lockdropContracts[index].getPastEvents('Locked', {
fromBlock: 0,
toBlock: 'latest',
});
lockEvents = [ ...lockEvents, ...events ];
}
// For truffle tests
let lockdropStartTime;
if (typeof lockdropContracts[0].LOCK_START_TIME === 'function') {
lockdropStartTime = (await lockdropContracts[0].LOCK_START_TIME());
} else {
lockdropStartTime = (await lockdropContracts[0].methods.LOCK_START_TIME().call());
}
console.log(`Lock events ${lockEvents.length}`);
lockEvents.forEach((event) => {
const data = event.returnValues;
// allocate locks to first key if multiple submitted or malformed larger key submitted
// NOTE: if key was less than length of a correct submission (66 chars), funds are considered lost
let keys = [data.edgewareAddr];
if (data.edgewareAddr.length >= 66) {
keys = data.edgewareAddr.slice(2).match(/.{1,64}/g).map(key => `0x${key}`);
}
let value = getEffectiveValue(data.eth, data.term, data.time, lockdropStartTime, totalETHLocked);
totalETHLocked = totalETHLocked.add(toBN(data.eth));
totalEffectiveETHLocked = totalEffectiveETHLocked.add(value);
// Add all validators to a separate collection to do validator election over later
if (data.isValidator) {
if (keys[0] in validatingLocks) {
validatingLocks[keys[0]] = {
lockAmt: toBN(data.eth).add(toBN(validatingLocks[keys[0]].lockAmt)).toString(),
effectiveValue: toBN(validatingLocks[keys[0]].effectiveValue).add(value).toString(),
lockAddrs: [data.lockAddr, ...validatingLocks[keys[0]].lockAddrs],
};
} else {
validatingLocks[keys[0]] = {
lockAmt: toBN(data.eth).toString(),
effectiveValue: value.toString(),
lockAddrs: [data.lockAddr],
};
}
}
// Add all locks to collection, calculating/updating effective value of lock
if (keys[0] in locks) {
locks[keys[0]] = {
lockAmt: toBN(data.eth).add(toBN(locks[keys[0]].lockAmt)).toString(),
effectiveValue: toBN(locks[keys[0]].effectiveValue).add(value).toString(),
lockAddrs: [data.lockAddr, ...locks[keys[0]].lockAddrs],
};
} else {
locks[keys[0]] = {
lockAmt: toBN(data.eth).toString(),
effectiveValue: value.toString(),
lockAddrs: [data.lockAddr],
};
}
});
// Return validating locks, locks, and total ETH locked
return { validatingLocks, locks, totalETHLocked, totalEffectiveETHLocked };
};
const calculateEffectiveSignals = async (web3, lockdropContracts, blockNumber=8461046) => {
let totalETHSignaled = toBN(0);
let totalEffectiveETHSignaled = toBN(0);
let signals = {};
let seenContracts = {};
let signalEvents = [];
for (index in lockdropContracts) {
let events = await lockdropContracts[index].getPastEvents('Signaled', {
fromBlock: 0,
toBlock: 'latest',
});
signalEvents = [ ...signalEvents, ...events ];
}
console.log(`Signal events ${signalEvents.length}`);
const promises = signalEvents.map(async (event) => {
const data = event.returnValues;
// Get balance at block that lockdrop ends
let balance = -1;
while (balance == -1) {
try {
if (blockNumber) {
balance = await web3.eth.getBalance(data.contractAddr, blockNumber);
} else {
balance = await web3.eth.getBalance(data.contractAddr);
}
} catch(e) {
console.log(`Couldn't find: ${JSON.stringify(data, null, 4)}`);
}
}
return balance;
});
// Resolve promises to ensure all inner async functions have finished
let balances = await Promise.all(promises);
let gLocks = {};
signalEvents.forEach((event, index) => {
const data = event.returnValues;
// if contract address has been seen (it is in a previously processed signal)
// then we ignore it; this means that we only acknolwedge the first signal
// for a given address.
if (!(data.contractAddr in seenContracts)) {
seenContracts[data.contractAddr] = true;
// Get value for each signal event and add it to the collection
let value;
// allocate signals to first key if multiple submitted or malformed larger key submitted
// NOTE: if key was less than length of a correct submission (66 chars), funds are considered lost
let keys = [data.edgewareAddr];
if (data.edgewareAddr.length >= 66) {
keys = data.edgewareAddr.slice(2).match(/.{1,64}/g).map(key => `0x${key}`);
}
// Treat generalized locks as 3 month locks
if (generalizedLocks.lockedContractAddresses.includes(data.contractAddr)) {
console.log('Generalized lock:', balances[index], data.contractAddr);
value = getEffectiveValue(balances[index], '0')
if (keys[0] in gLocks) {
gLocks[keys[0]] = toBN(gLocks[keys[0]]).add(value).toString();
} else {
gLocks[keys[0]] = value.toString();
}
totalETHSignaled = totalETHSignaled.add(toBN(balances[index]));
totalEffectiveETHSignaled = totalEffectiveETHSignaled.add(value);
// keep generalized locks collection separate from other signals
return;
} else {
value = getEffectiveValue(balances[index], 'signaling');
}
// Add value to total signaled ETH
totalETHSignaled = totalETHSignaled.add(toBN(balances[index]));
totalEffectiveETHSignaled = totalEffectiveETHSignaled.add(value);
// Iterate over signals, partition reward into delayed and immediate amounts
if (keys[0] in signals) {
signals[keys[0]] = {
signalAmt: toBN(balances[index]).add(toBN(signals[keys[0]].signalAmt)).toString(),
effectiveValue: toBN(signals[keys[0]]
.effectiveValue)
.add(value)
.toString(),
};
} else {
signals[keys[0]] = {
signalAmt: toBN(balances[index]).toString(),
effectiveValue: value.toString(),
};
}
}
});
// Return signals and total ETH signaled
return { signals, totalETHSignaled, totalEffectiveETHSignaled, genLocks: gLocks }
}
const getLockStorage = async (web3, lockAddress) => {
return Promise.all([0,1].map(v => {
return web3.eth.getStorageAt(lockAddress, v);
}))
.then(vals => {
return {
owner: vals[0],
unlockTime: hexToNumber(vals[1]),
};
});
};
const selectEdgewareValidators = (validatingLocks, totalAllocation, totalEffectiveETH, numOfValidators, existentialBalance=100000000000000) => {
const sortable = [];
// Add the calculated edgeware balances with the respective key to a collection
for (var key in validatingLocks) {
const keys = key.slice(2).match(/.{1,64}/g).map(key => `0x${key}`);;
if (keys.length === 3) {
sortable.push([
keys,
toBN(validatingLocks[key].effectiveValue).sub(toBN(existentialBalance)).mul(toBN(totalAllocation)).div(totalEffectiveETH)
]);
}
}
// Sort and take the top "numOfValidators" from the collection
return sortable
.sort((a,b) => (a[1].lt(b[1])) ? 1 : ((b[1].lt(a[1])) ? -1 : 0))
.map(v => {
return ([
...v[0].map(k => (k.slice(2))), // stash, controller, session
v[1].toString(), // staked balance
]);
});
};
const getEdgewareBalanceObjects = (locks, signals, genLocks, totalAllocation, totalEffectiveETH, existentialBalance=100000000000000) => {
let balances = [];
let vesting = [];
// handle locks separately than signals at first, then we'll scan over all
// entries and ensure that there are only unique entries in the collections.
for (var key in locks) {
try {
const encoded = keyring.encodeAddress(key);
balances.push([
key.slice(2),
mulByAllocationFraction(locks[key].effectiveValue, totalAllocation, totalEffectiveETH).toString(),
]);
// add the vesting account to make their entire balance liquid at launch
vesting.push([
key.slice(2),
5256000,
1,
mulByAllocationFraction(toBN(locks[key].effectiveValue), totalAllocation, totalEffectiveETH).toString(),
]);
} catch(e) {
console.log(e);
console.log(`Error processing lock event: ${key} (${locks[key].effectiveValue})`);
}
}
// handle signal entries
for (var key in signals) {
try {
// the liquid amount of the vesting is 25% of signaled value
const vestingValue = toBN(signals[key].effectiveValue).mul(toBN(25)).div(toBN(100));
// create new balance record for the signaler
balances.push([
key.slice(2),
mulByAllocationFraction(toBN(signals[key].effectiveValue), totalAllocation, totalEffectiveETH).toString(),
]);
// create vesting record for 25% liquid signal amount at launch
vesting.push([
key.slice(2),
5256000,
1,
mulByAllocationFraction(vestingValue, totalAllocation, totalEffectiveETH).toString(),
]);
} catch(e) {
console.log(e);
console.log(`Error processing signal event: ${key} (${signals[key].effectiveValue})`);
}
}
for (var key in genLocks) {
try {
const encoded = keyring.encodeAddress(key);
balances.push([
key.slice(2),
mulByAllocationFraction(toBN(genLocks[key]), totalAllocation, totalEffectiveETH).toString(),
]);
// add the vesting account to make their entire balance liquid at launch
vesting.push([
key.slice(2),
5256000,
1,
mulByAllocationFraction(toBN(genLocks[key]), totalAllocation, totalEffectiveETH).toString(),
]);
} catch(e) {
console.log(e);
console.log(`Error processing lock event: ${key} (${genLocks[key]})`);
}
}
return { balances: balances, vesting: vesting };
};
const combineToUnique = (balances, vesting) => {
let balancesMap = {};
let vestingMap = {};
balances.forEach(entry => {
let account = entry[0];
let amount = entry[1];
if (account in balancesMap) {
balancesMap[account] = toBN(balancesMap[account]).add(toBN(amount)).toString();
} else {
balancesMap[account] = amount
}
});
vesting.forEach(entry => {
let account = entry[0];
let amount = entry[3];
try {
if (account in vestingMap) {
vestingMap[account] = toBN(vestingMap[account]).add(toBN(amount)).toString();
} else {
vestingMap[account] = amount
}
} catch (e) {
console.log(e);
console.log(entry);
console.log(vestingMap[account]);
}
});
let newBalances = []
let newVesting = [];
let total = toBN(0);
Object.keys(balancesMap).forEach(key => {
total = total.add(toBN(balancesMap[key]));
newBalances.push([
key,
balancesMap[key],
]);
});
Object.keys(vestingMap).forEach(key => {
if (toBN(balancesMap[key]).eq(toBN(vestingMap[key]))) {
// pass
} else {
newVesting.push([
key,
5256000,
1,
vestingMap[key],
]);
}
});
console.log(`Balances: ${balances.length}`);
console.log(`Balances with vesting: ${vesting.length}`);
console.log(`EDG Total: ${total.toString()}`);
return { balances: newBalances, vesting: newVesting, total: total };
}
const mulByAllocationFraction = (amount, totalAllocation, totalEffectiveETH) => {
return toBN(amount).mul(toBN(totalAllocation)).div(toBN(totalEffectiveETH));
}
module.exports = {
getLocks,
getSignals,
getTotalLockedBalance,
getTotalSignaledBalance,
calculateEffectiveLocks,
calculateEffectiveSignals,
getLockStorage,
selectEdgewareValidators,
getEdgewareBalanceObjects,
combineToUnique,
};