-
Notifications
You must be signed in to change notification settings - Fork 54
/
ogmios.ts
231 lines (217 loc) · 9.07 KB
/
ogmios.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
/* eslint-disable promise/no-nesting */
/* eslint-disable @typescript-eslint/no-explicit-any */
import { DnsResolver } from '../utils';
import { HandleProvider, SubmitTxArgs } from '@cardano-sdk/core';
import { Logger } from 'ts-log';
import { MissingCardanoNodeOption } from '../errors';
import {
OgmiosCardanoNode,
OgmiosObservableCardanoNode,
OgmiosTxSubmitProvider,
urlToConnectionConfig
} from '@cardano-sdk/ogmios';
import { OgmiosOptionDescriptions, OgmiosProgramOptions } from '../options/ogmios';
import { RunnableModule, isConnectionError } from '@cardano-sdk/util';
import { defer, from, of } from 'rxjs';
const isCardanoNodeOperation = (prop: string | symbol): prop is 'eraSummaries' | 'systemStart' | 'stakeDistribution' =>
['eraSummaries', 'systemStart', 'stakeDistribution'].includes(prop as string);
const recreateOgmiosCardanoNode = async (
serviceName: string,
ogmiosCardanoNode: OgmiosCardanoNode,
dnsResolver: DnsResolver,
logger: Logger
) => {
const record = await dnsResolver(serviceName!);
logger.info(`DNS resolution for Ogmios service, resolved with record: ${JSON.stringify(record)}`);
await ogmiosCardanoNode
.shutdown?.()
.catch((error_) => logger.warn(`Ogmios cardano node failed to shutdown after connection error: ${error_}`));
return new OgmiosCardanoNode({ host: record.name, port: record.port }, logger);
};
const recreateOgmiosTxSubmitProvider = async (
serviceName: string,
ogmiosTxSubmitProvider: OgmiosTxSubmitProvider,
dnsResolver: DnsResolver,
logger: Logger,
handleProvider?: HandleProvider
) => {
const record = await dnsResolver(serviceName!);
logger.info(`DNS resolution for OgmiosTxSubmitProvider, resolved with record: ${JSON.stringify(record)}`);
await ogmiosTxSubmitProvider
.shutdown()
.catch((error_) => logger.warn(`OgmiosTxSubmitProvider failed to shutdown after connection error: ${error_}`));
return new OgmiosTxSubmitProvider({ host: record.name, port: record.port }, { logger }, handleProvider);
};
/**
* Creates an extended TxSubmitProvider instance :
* - use passed srv service name in order to resolve the port
* - make dealing with fail-overs (re-resolving the port) opaque
* - use exponential backoff retry internally with default timeout and factor
* - intercept 'initialize' operation and handle connection errors on initialization
* - intercept 'submitTx' operation and handle connection errors runtime
* - all other operations are bind to pool object without modifications
*
* @returns TxSubmitProvider instance
*/
export const ogmiosTxSubmitProviderWithDiscovery = async (
dnsResolver: DnsResolver,
logger: Logger,
serviceName: string,
handleProvider?: HandleProvider
): Promise<OgmiosTxSubmitProvider> => {
const { name, port } = await dnsResolver(serviceName!);
let ogmiosProvider = new OgmiosTxSubmitProvider({ host: name, port }, { logger }, handleProvider);
const txSubmitProviderProxy = new Proxy<OgmiosTxSubmitProvider>({} as OgmiosTxSubmitProvider, {
get(_, prop, receiver) {
if (prop === 'then') return;
if (prop === 'initialize') {
return () =>
ogmiosProvider.initialize().catch(async (error) => {
if (isConnectionError(error)) {
ogmiosProvider = await recreateOgmiosTxSubmitProvider(
serviceName,
ogmiosProvider,
dnsResolver,
logger,
handleProvider
);
return receiver.initialize();
}
throw error;
});
}
if (prop === 'submitTx') {
return (submitTxArgs: SubmitTxArgs) =>
ogmiosProvider.submitTx(submitTxArgs).catch(async (error) => {
if (isConnectionError(error)) {
ogmiosProvider = await recreateOgmiosTxSubmitProvider(
serviceName,
ogmiosProvider,
dnsResolver,
logger,
handleProvider
);
await receiver.initialize();
await receiver.start();
return await receiver.submitTx(submitTxArgs);
}
throw error;
});
}
// Bind if it is a function, no intercept operations
if (typeof ogmiosProvider[prop as keyof OgmiosTxSubmitProvider] === 'function') {
const method = ogmiosProvider[prop as keyof OgmiosTxSubmitProvider] as any;
return method.bind(ogmiosProvider);
}
return ogmiosProvider[prop as keyof OgmiosTxSubmitProvider];
}
});
return Object.setPrototypeOf(txSubmitProviderProxy, RunnableModule.prototype);
};
export const getOgmiosTxSubmitProvider = async (
dnsResolver: DnsResolver,
logger: Logger,
options?: OgmiosProgramOptions,
handleProvider?: HandleProvider
): Promise<OgmiosTxSubmitProvider> => {
if (options?.ogmiosSrvServiceName)
return ogmiosTxSubmitProviderWithDiscovery(dnsResolver, logger, options.ogmiosSrvServiceName, handleProvider);
if (options?.ogmiosUrl)
return new OgmiosTxSubmitProvider(urlToConnectionConfig(options?.ogmiosUrl), { logger }, handleProvider);
throw new MissingCardanoNodeOption([OgmiosOptionDescriptions.Url, OgmiosOptionDescriptions.SrvServiceName]);
};
/**
* Creates an extended OgmiosCardanoNode instance :
* - use passed srv service name in order to resolve the port
* - make dealing with fail-overs (re-resolving the port) opaque
* - use exponential backoff retry internally with default timeout and factor
* - intercept 'initialize' operation and handle connection errors on initialization
* - intercept 'eraSummaries', 'systemStart' and 'stakeDistribution' operations and handle connection errors runtime
* - all other operations are bind to pool object without modifications
*
* @returns OgmiosCardanoNode instance
*/
export const ogmiosCardanoNodeWithDiscovery = async (
dnsResolver: DnsResolver,
logger: Logger,
serviceName: string
): Promise<OgmiosCardanoNode> => {
const { name, port } = await dnsResolver(serviceName!);
let ogmiosCardanoNode = new OgmiosCardanoNode({ host: name, port }, logger);
const cardanoNodeProxy = new Proxy<OgmiosCardanoNode>({} as OgmiosCardanoNode, {
get(_, prop, receiver) {
if (prop === 'then') return;
if (prop === 'initialize') {
return () =>
ogmiosCardanoNode.initialize().catch(async (error) => {
if (isConnectionError(error)) {
ogmiosCardanoNode = await recreateOgmiosCardanoNode(serviceName, ogmiosCardanoNode, dnsResolver, logger);
return await receiver.initialize();
}
throw error;
});
}
if (isCardanoNodeOperation(prop)) {
return () =>
ogmiosCardanoNode[prop]().catch(async (error) => {
if (isConnectionError(error)) {
ogmiosCardanoNode = await recreateOgmiosCardanoNode(serviceName, ogmiosCardanoNode, dnsResolver, logger);
await receiver.initialize();
await receiver.start();
return await receiver[prop]();
}
throw error;
});
}
// Bind if it is a function, no intercept operations
if (typeof ogmiosCardanoNode[prop as keyof OgmiosCardanoNode] === 'function') {
const method = ogmiosCardanoNode[prop as keyof OgmiosCardanoNode] as any;
return method.bind(ogmiosCardanoNode);
}
return ogmiosCardanoNode[prop as keyof OgmiosCardanoNode];
}
});
return Object.setPrototypeOf(cardanoNodeProxy, RunnableModule.prototype);
};
/**
* Creates an ObservableOgmiosCardanoNode instance :
* - use passed srv service name in order to resolve the port
* - all other operations are bind to pool object without modifications
*
* @returns ObservableOgmiosCardanoNode instance
*/
export const ogmiosObservableCardanoNodeWithDiscovery = (
dnsResolver: DnsResolver,
logger: Logger,
serviceName: string
): OgmiosObservableCardanoNode =>
new OgmiosObservableCardanoNode(
{
connectionConfig$: defer(() => from(dnsResolver(serviceName).then(({ name, port }) => ({ host: name, port }))))
},
{ logger }
);
export const getOgmiosCardanoNode = async (
dnsResolver: DnsResolver,
logger: Logger,
options?: OgmiosProgramOptions
): Promise<OgmiosCardanoNode> => {
if (options?.ogmiosSrvServiceName)
return ogmiosCardanoNodeWithDiscovery(dnsResolver, logger, options.ogmiosSrvServiceName);
if (options?.ogmiosUrl) return new OgmiosCardanoNode(urlToConnectionConfig(options.ogmiosUrl), logger);
throw new MissingCardanoNodeOption([OgmiosOptionDescriptions.Url, OgmiosOptionDescriptions.SrvServiceName]);
};
export const getOgmiosObservableCardanoNode = (
dnsResolver: DnsResolver,
logger: Logger,
options?: OgmiosProgramOptions
): OgmiosObservableCardanoNode => {
if (options?.ogmiosSrvServiceName)
return ogmiosObservableCardanoNodeWithDiscovery(dnsResolver, logger, options.ogmiosSrvServiceName);
if (options?.ogmiosUrl)
return new OgmiosObservableCardanoNode(
{ connectionConfig$: of(urlToConnectionConfig(options.ogmiosUrl)) },
{ logger }
);
throw new MissingCardanoNodeOption([OgmiosOptionDescriptions.Url, OgmiosOptionDescriptions.SrvServiceName]);
};