-
Notifications
You must be signed in to change notification settings - Fork 5
/
TxWriter.ts
634 lines (548 loc) · 22.4 KB
/
TxWriter.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
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
import '../env/BigIntSerializer'
import di from 'a-di';
import { class_Dfr, class_EventEmitter, obj_extend } from 'atma-utils';
import { $bigint } from '@dequanto/utils/$bigint';
import { $txData } from '@dequanto/utils/$txData';
import { $logger } from '@dequanto/utils/$logger';
import { $promise } from '@dequanto/utils/$promise';
import { $account } from '@dequanto/utils/$account';
import { $gas } from '@dequanto/utils/$gas';
import { $require } from '@dequanto/utils/$require';
import { $contract } from '@dequanto/utils/$contract';
import { $error } from '@dequanto/utils/$error';
import type { Web3Client } from '@dequanto/clients/Web3Client';
import { TxDataBuilder } from './TxDataBuilder';
import { TxLogger } from './TxLogger';
import { EoAccount, Erc4337Account, IAccount, SafeAccount, TAccount } from "@dequanto/models/TAccount";
import { TAddress } from '@dequanto/models/TAddress';
import { Web3ClientFactory } from '@dequanto/clients/Web3ClientFactory';
import { TPlatform } from '@dequanto/models/TPlatform';
import { ClientErrorUtil } from '@dequanto/clients/utils/ClientErrorUtil';
import { ITxLogItem } from './receipt/ITxLogItem';
import { TxLogParser } from './receipt/TxLogParser';
import { ISafeServiceTransport } from '@dequanto/safe/transport/ISafeServiceTransport';
import { SigFileTransport } from './sig-transports/SigFileTransport';
import { TxWriterAccountAgents } from './agents/TxWriterAccountAgents';
import { PromiseEvent } from '@dequanto/class/PromiseEvent';
import { $sig } from '@dequanto/utils/$sig';
import { TEth } from '@dequanto/models/TEth';
import { SafeServiceTypes } from '@dequanto/safe/types/SafeServiceTypes';
import { ChainAccountService } from '@dequanto/ChainAccountService';
import { $is } from '@dequanto/utils/$is';
interface ITxWriterEvents {
transactionHash (hash: TEth.Hex)
receipt (receipt: TEth.TxReceipt)
confirmation (confNumber: number, receipt: TEth.TxReceipt)
error (error: Error)
sent ()
log (message: string)
safeTxProposed (safeTx: SafeServiceTypes.ProposeTransactionProps)
}
export interface ITxWriterOptions {
timeout?: number | boolean
retries?: number
retryDelay?: number
safeTransport?: ISafeServiceTransport
/** Tx Data will be saved to the store(e.g. a File), and will wait until the signature appears in the store. */
sigTransport?: string
/** Optionally disable waiting for the transport response */
sigTransportWait?: boolean
/** Save the tx data to the file (before agents run, if any) */
txOutput?: string
/** Proceed the Tx up to the signature */
signOnly?: boolean
/** Provide a pre-signed signature for this transaction data. */
signature?: TEth.Hex
/**
* The callback is executed on error, to give the opportunity to build a new Tx to resubmit the tx.
* @param tx - current TxWriter object
* @param error - current Error with receipt(if any)
* @param errCount - num of errors already handled
*/
onErrorRebuild? (tx: TxWriter, error: Error & { receipt?: TEth.TxReceipt }, errCount: number): Promise<TxDataBuilder>
/**
* Do not log Transaction states (start, receipt, etc)
*/
silent?: boolean
}
const DEFAULTS: ITxWriterOptions = {};
export class TxWriter extends class_EventEmitter<ITxWriterEvents> {
onSent = new class_Dfr<string | TEth.Hex>();
onCompleted = new class_Dfr<TEth.TxReceipt>();
onSaved = new class_Dfr<string>();
onSigned = new class_Dfr<TEth.Hex>();
receipt: TEth.TxReceipt
onConfirmed (waitForCount: number): Promise<string> {
let promise = new class_Dfr();
if (this.tx.confirmations >= waitForCount) {
promise.resolve(this.tx.hash);
} else {
this.confirmationAwaiters.push({
count: waitForCount,
promise
});
}
return promise as any;
}
wait (): Promise<TEth.TxReceipt> {
return this.onCompleted as any as Promise<TEth.TxReceipt>;
}
id = Math.round(Math.random() * 10**10) + '';
tx: {
timestamp: number
confirmations: number,
hash?: TEth.Hex
timeout?: NodeJS.Timer
receipt?: TEth.TxReceipt
error?: Error
knownLogs?: ITxLogItem[]
} = null
txs: TxWriter['tx'][] = []
options: ITxWriterOptions;
private logger: TxLogger;
private confirmationAwaiters = [] as { count: number, promise }[]
protected constructor (
public client: Web3Client,
public builder: TxDataBuilder,
public account: TAccount
) {
super();
this.options = obj_extend({}, DEFAULTS);
this.logger = new TxLogger(this.id, this.getSenderName(), this.builder);
}
public send (options?: ITxWriterOptions): this {
if (this.tx == null) {
this.logger.logStart();
this.onCompleted.defer();
this.onSent.defer();
// was not sent
if (options) {
this.options = obj_extend(this.options, options);
}
this.sendTxInner();
}
return this;
}
public async call() {
let tx = await this.builder.getTxData(this.client);
let result = await this.client.call(tx);
return result;
}
protected write (options?: ITxWriterOptions) {
if (this.builder?.config?.send !== 'manual') {
this.send(options);
}
}
private async sendTxInner () {
if (this.options?.txOutput != null) {
// handle none blockchain
await this.saveTxAndExit()
return;
}
let agent = TxWriterAccountAgents.get(this.account);
if (agent != null) {
let sender = await this.getSender();
let innerWriter = await agent.process(sender, this.account, this);
this.pipeInnerWriter(innerWriter);
return;
}
let time = Date.now();
let sender: EoAccount = await this.getSender();
try {
await Promise.all([
this.builder.ensureNonce(),
this.builder.ensureGas(),
]);
} catch (error) {
this.onCompleted.reject(error);
return;
}
let key = sender?.key;
let signedTxBuffer = key == null
? null
: await this.builder.signToString(sender.key);
if (signedTxBuffer == null) {
if (this.options?.sigTransport != null) {
let transport = di.resolve(SigFileTransport);
let shouldWait = this.options?.sigTransportWait !== false;
let { signed, path } = await transport.create(this.options.sigTransport, this.builder, { wait: shouldWait });
if (path) {
this.onSaved.resolve(path);
}
if (shouldWait === false) {
return;
}
}
if (this.options?.signature) {
let tx = $txData.getJson(this.builder.data, this.client);
signedTxBuffer = await $sig.TxSerializer.serialize(tx, this.options.signature);
}
}
let tx = <TxWriter['tx']> {
timestamp: Date.now(),
confirmations: 0,
hash: null,
receipt: null,
timeout: null as NodeJS.Timeout,
};
tx.timeout = this.startTimer(tx);
this.tx = tx;
this.txs.push(tx);
let promiseEvent: PromiseEvent<TEth.TxReceipt>;
if (signedTxBuffer != null) {
this.onSigned.resolve(signedTxBuffer);
if (this.options?.signOnly === true) {
this.onCompleted.reject(new Error(`SIGN_ONLY: Tx not completed as only signature is awaited`));
return;
}
promiseEvent = this
.client
.sendSignedTransaction(signedTxBuffer);
} else {
let txData = this.builder.getTxData(this.client);
promiseEvent = this
.client
.sendTransaction(txData);
}
promiseEvent
.once('transactionHash', hash => {
if (tx.hash === hash) {
return;
}
if (tx.hash != null && tx.timeout != null) {
// network has reaccepted the tx, restart previous timeout
this.clearTimer(tx);
tx.timeout = this.startTimer(tx);
}
tx.hash = hash;
this.onSent.resolve(hash);
this.emit('transactionHash', hash);
this.emit('log', `Tx hash: ${hash}`);
})
// .on('confirmation', (confNumber, receipt) => {
// tx.hash = receipt.transactionHash ?? tx.hash;
// this.onSent.resolve();
// this.emit('confirmation', confNumber, receipt);
// this.emit('log', `Tx confirmation received for ${tx.hash}. Confirmations: ${confNumber}`);
// let arr = this.confirmationAwaiters;
// for (let i = 0; i < arr.length; i++) {
// if (confNumber >= arr[i].count) {
// arr[i].promise.resolve();
// arr.splice(i, 1);
// i--;
// }
// }
// })
.on('error', (error: Error & {data?, transactionHash?}) => {
this.onSent.reject(error);
this.onCompleted.reject(error);
this.clearTimer(tx);
this.logger.logError(error);
this.emit('error', error);
this.emit('log', `Tx ERROR "${error.message}"`);
})
.then(async receipt => {
this.clearTimer(tx);
try {
await this.extractLogs(receipt, tx);
} catch (error) {
console.error('Logs error', error);
}
try {
tx.receipt = receipt;
tx.hash = receipt.transactionHash ?? tx.hash;
this.receipt = receipt;
this.logger.logReceipt(receipt, Date.now() - time);
this.onSent.resolve();
this.emit('receipt', receipt);
let hash = tx.hash;
let status = receipt.status;
let gasFormatted = $gas.formatUsed(this.builder.data, <any>receipt);
this.emit('log', `Tx receipt: ${hash}.\n\tStatus: ${status}.\n\tGas used: ${gasFormatted}`);
this.onCompleted.resolve(receipt);
} catch (error) {
console.error('FATAL ERROR', error);
throw error;
}
}, async (err: Error & { receipt?: TEth.TxReceipt, data, transactionHash? }) => {
if (err.data != null && this.builder.abi != null) {
err.data = $contract.decodeCustomError(err.data, this.builder.abi);
$error.normalizeEvmCustomError(err);
}
this.logger.log(`Tx errored ${err.message}`);
this.clearTimer(tx);
tx.error = err;
tx.hash = err.transactionHash ?? tx.receipt?.transactionHash ?? tx.hash;
const options = this.options ?? {};
if (err.receipt?.status !== 1) {
// read reason
// let rpc = await this.client.getRpc();
// let tx = await this.client.getTransaction(err.receipt.transactionHash);
// try {
// let result = await rpc.eth_call(tx, tx.blockNumber);
// } catch (err) {
// $logger.log('CALL ERROR', err);
// }
}
if (ClientErrorUtil.IsInsufficientFunds(err)) {
if (this.builder.config?.gasFunding) {
this.fundAccountAndResend().catch (err => {
this.onCompleted.reject(err);
});
return;
}
if (options.retries == null) {
options.retries = 1;
options.retryDelay = 5000;
// If insufficient funds this is can be due to the blockchain hasn't confirmed some incoming transactions
}
}
if (ClientErrorUtil.IsNonceTooLow(err)) {
if (options.retries == null) {
options.retries = 1;
}
let nonce = this.builder.data.nonce;
// reset nonce
await this.builder.setNonce();
this.logger.log(`Nonce was ${Number(nonce)} too low. Retries left: ${options.retries}. New nonce: ${Number(this.builder.data.nonce)}`);
}
let submitsCount = this.txs.length;
let submitsMax = (options.retries ?? 0) + 1;
if (submitsCount < submitsMax) {
let ms = options.retryDelay ?? 3000;
let waitMs = ms * submitsCount;
$logger.log(`Tx retry in ${waitMs}ms`);
await $promise.wait(waitMs);
let onErrorRebuild = options.onErrorRebuild;
if (onErrorRebuild != null) {
let txBuilder = await onErrorRebuild(this, err, submitsCount);
if (txBuilder != null) {
this.builder = txBuilder;
}
}
this.resubmit({ increaseGas: false });
return;
}
this.onCompleted.reject(err);
});
}
public catch (fn) {
return this.onCompleted.catch(fn);
}
private async getSender (): Promise<EoAccount> {
let account = this.account;
let sender = $account.getSender(account);
if (sender.key == null) {
/** check the encrypted storage. In case no key is found, assume the target node contains unlocked or locked account */
let addressOrName = sender.address ?? sender.name;
let service = di.resolve(ChainAccountService);
let fromStorage = await service.get(addressOrName, { platform: this.client.platform });
if (fromStorage) {
sender = fromStorage as EoAccount;
}
}
return sender;
}
private getSenderName () {
let sender = $account.getSender(this.account);
return (sender.name as any) ?? sender.address;
}
private async extractLogs(receipt: TEth.TxReceipt, tx: TxWriter['tx']) {
let parser = di.resolve(TxLogParser);
let logs = await parser.parse(receipt, {
platform: this.client.network,
abi: this.builder.abi,
});
tx.knownLogs = logs.filter(x => x != null);
}
private async fundAccountAndResend () {
let gasFunding = this.builder.config.gasFunding;
let sender = $account.getSender(this.account);
await this.builder.setGas({
gasEstimation: true,
from: sender.address
});
let { gas } = this.builder.data;
let gasPrice = TxDataBuilder.getGasPrice(this.builder);
let LITTLE_BIT_MORE = 1.3;
let wei = $bigint.multWithFloat(gasPrice * BigInt(gas as any), LITTLE_BIT_MORE);
let fundTx = await this.transferNative(gasFunding, sender.address, wei);
await fundTx.onCompleted;
// account was funded resubmit the tx
this.resubmit();
}
private startTimer (tx: TxWriter['tx']): NodeJS.Timeout {
let timeout = this.options?.timeout
let ms: number;
if (typeof timeout === 'boolean') {
if (timeout === false) {
// Timeout was disabled
return null;
}
ms = this.client.TIMEOUT;
} else {
ms = timeout ?? this.client.TIMEOUT;
}
return setTimeout(() => {
if (this.txs.length > 3) {
let hashes = this.txs.map(x => x.hash).join(', ')
this.onCompleted.reject(new Error(`${this.txs.length} retries timed out, with hashes: ${ hashes }`))
return;
}
tx.error = new Error(`Timed out ${ms}ms`);
this.resubmit()
}, ms);
}
private clearTimer (tx: TxWriter['tx']) {
if (tx.timeout) {
clearTimeout(tx.timeout as any);
tx.timeout = null;
}
}
private resubmit ({ increaseGas = true}: { increaseGas?: boolean} = {}) {
if (increaseGas !== false) {
this.builder.increaseGas(1.1);
}
this.sendTxInner();
}
private pipeInnerWriter (innerWriter: TxWriter) {
innerWriter.onCompleted.then(
(receipt) => {
this.tx = innerWriter.tx;
this.receipt = receipt;
this.onCompleted.resolve(receipt);
},
(error) => {
this.onCompleted.reject(error);
}
);
innerWriter.onSent.then(
(hash) => this.onSent.resolve(hash),
(error) => this.onSent.reject(error)
);
innerWriter.on('error', error => this.emit('error', error));
innerWriter.on('log', message => this.emit('log', message));
}
/** Use this transfer also in case of additional account funding */
public async transferNative (from: EoAccount, to: TAddress, amount: bigint): Promise<TxWriter> {
let txBuilder = new TxDataBuilder(this.client, from, {
to: to,
value: $bigint.toHex(amount)
});
let GAS = 21000;
await Promise.all([
txBuilder.setGas({ gasLimit: GAS }),
txBuilder.setNonce(),
]);
return TxWriter.write(this.client, txBuilder, from);
}
toJSON (): TTxWriterJson {
let account = this.account;
let accountJson: string | any;
if (typeof account !== 'string') {
accountJson = JSON.parse(JSON.stringify(account)) as (EoAccount | SafeAccount | Erc4337Account);
// Clean any KEY to prevent leaking. When resubmitted if one is required should be taken from the storage
if ('operator' in accountJson) {
delete accountJson.operator.key;
} else {
delete accountJson.key;
}
} else {
accountJson = account;
}
return {
id: this.id,
platform: this.client.platform,
options: this.options,
account: accountJson,
txs: this.txs,
builder: this.builder.toJSON(),
};
}
//** We can save the Tx Data for later reuse/blockchain send */
async saveTxAndExit (additionalProperties?) {
let path = this.options?.txOutput;
$require.notNull(path, 'Save tx data to the file, but the path is undefined');
await this.builder.save(path, additionalProperties);
this.onSent.resolve(path);
this.onSaved.resolve(path);
this.onCompleted.reject(new Error(`Transaction is not submitted to the blockchain. It has been saved to "${path}". Subscribe to the "onSaved" promise instead`))
}
static async fromJSON (json: TTxWriterJson, client?: Web3Client, account?: TAccount): Promise<TxWriter> {
client = client ?? Web3ClientFactory.get(json.platform);
account = account ?? json.account;
let builder = TxDataBuilder.fromJSON(client, account, {
config: json.builder.config,
tx: json.builder.tx,
});
let writer = TxWriter.create(client, builder, account, json.options);
let txs = json.txs;
writer.id = json.id;
writer.tx = txs[txs.length - 1];
writer.txs = txs;
writer.receipt = txs.find(x =>x.receipt)?.receipt;
return writer;
}
static write (
client: Web3Client,
builder: TxDataBuilder,
account: IAccount,
options?: ITxWriterOptions
): TxWriter {
let writer = new TxWriter(client, builder, account);
writer.write(options);
return writer;
}
static create (
client: Web3Client,
builder: TxDataBuilder,
account: TAccount,
options?: ITxWriterOptions
): TxWriter {
return new TxWriter(client, builder, account);
}
static async writeTxData (
client: Web3Client,
data: Partial<TEth.TxLike>,
accountMix: TAccount,
options?: ITxWriterOptions
): Promise<TxWriter> {
let account = await TxWriter.prepareAccount(accountMix);
let txBuilder = new TxDataBuilder(client, account, data);
await Promise.all([
txBuilder.ensureGas(),
txBuilder.ensureNonce(),
]);
let w = new TxWriter(client, txBuilder, account);
w.send(options);
return w;
}
static async prepareAccount (account: TAccount): Promise<IAccount> {
if (typeof account !== 'string') {
return account;
}
let service = di.resolve(ChainAccountService);
let stored = await service.get(account);
if (stored != null) {
return stored;
}
if ($is.Address(account)) {
return {
address: account
};
}
throw new Error(`Account ${account} not found`);
}
static defaultOptions (options: ITxWriterOptions) {
obj_extend(DEFAULTS, options);
}
static DEFAULTS = DEFAULTS
}
export type TTxWriterJson = {
id: string
platform: TPlatform
options: ITxWriterOptions
account: TAccount
txs: TxWriter['txs']
builder: ReturnType<TxDataBuilder['toJSON']>
};