-
Notifications
You must be signed in to change notification settings - Fork 4.9k
/
web3_subscriptions.ts
156 lines (134 loc) · 4.56 KB
/
web3_subscriptions.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
/*
This file is part of web3.js.
web3.js is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
web3.js is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with web3.js. If not, see <http://www.gnu.org/licenses/>.
*/
// eslint-disable-next-line max-classes-per-file
import {
HexString,
BlockOutput,
Web3BaseProvider,
Web3APISpec,
Web3APIParams,
EthExecutionAPI,
Log,
JsonRpcNotification,
JsonRpcSubscriptionResult,
DataFormat,
DEFAULT_RETURN_FORMAT,
JsonRpcSubscriptionResultOld,
EIP1193Provider,
} from 'web3-types';
import { jsonRpc } from 'web3-utils';
import { Web3EventEmitter, Web3EventMap } from './web3_event_emitter.js';
import { Web3RequestManager } from './web3_request_manager.js';
export abstract class Web3Subscription<
EventMap extends Web3EventMap,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
ArgsType = any,
API extends Web3APISpec = EthExecutionAPI,
> extends Web3EventEmitter<EventMap> {
private readonly _requestManager: Web3RequestManager<API>;
private readonly _lastBlock?: BlockOutput;
private readonly _returnFormat: DataFormat;
private _id?: HexString;
private _messageListener?: (data?: JsonRpcNotification<Log>) => void;
public constructor(
public readonly args: ArgsType,
options: { requestManager: Web3RequestManager<API>; returnFormat?: DataFormat },
) {
super();
this._requestManager = options.requestManager;
this._returnFormat = options.returnFormat ?? (DEFAULT_RETURN_FORMAT as DataFormat);
}
public get id() {
return this._id;
}
public get lastBlock() {
return this._lastBlock;
}
public async subscribe() {
this._id = await this._requestManager.send({
method: 'eth_subscribe',
params: this._buildSubscriptionParams(),
});
const messageListener = (
data?:
| JsonRpcSubscriptionResult
| JsonRpcSubscriptionResultOld<Log>
| JsonRpcNotification<Log>,
) => {
// for EIP-1193 provider
if (data?.data) {
this._processSubscriptionResult(data?.data?.result ?? data?.data);
return;
}
if (
data &&
jsonRpc.isResponseWithNotification(
data as unknown as JsonRpcSubscriptionResult | JsonRpcNotification<Log>,
)
) {
this._processSubscriptionResult(data?.params.result);
}
};
if (typeof (this._requestManager.provider as EIP1193Provider<API>).request === 'function') {
(this._requestManager.provider as Web3BaseProvider).on<Log>('message', messageListener);
} else {
(this._requestManager.provider as Web3BaseProvider).on<Log>('data', messageListener);
}
this._messageListener = messageListener;
}
protected get returnFormat() {
return this._returnFormat;
}
public async resubscribe() {
await this.unsubscribe();
await this.subscribe();
}
public async unsubscribe() {
if (!this.id) {
return;
}
await this._requestManager.send({
method: 'eth_unsubscribe',
params: [this.id] as Web3APIParams<API, 'eth_unsubscribe'>,
});
this._id = undefined;
(this._requestManager.provider as Web3BaseProvider).removeListener(
'message',
this._messageListener as never,
);
}
// eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
protected _processSubscriptionResult(_data: unknown) {
// Do nothing - This should be overridden in subclass.
}
// eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
protected _processSubscriptionError(_err: Error) {
// Do nothing - This should be overridden in subclass.
}
// eslint-disable-next-line class-methods-use-this
protected _buildSubscriptionParams(): Web3APIParams<API, 'eth_subscribe'> {
// This should be overridden in the subclass
throw new Error('Implement in the child class');
}
}
export type Web3SubscriptionConstructor<
API extends Web3APISpec,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
SubscriptionType extends Web3Subscription<any, any, API> = Web3Subscription<any, any, API>,
> = new (
// We accept any type of arguments here and don't deal with this type internally
// eslint-disable-next-line @typescript-eslint/no-explicit-any
args: any,
options: { requestManager: Web3RequestManager<API>; returnFormat?: DataFormat },
) => SubscriptionType;