generated from PolymeshAssociation/typescript-boilerplate
/
Network.ts
509 lines (452 loc) · 13.4 KB
/
Network.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
import BigNumber from 'bignumber.js';
import { Account, Context, transferPolyx, TransferPolyxParams } from '~/internal';
import { eventByIndexedArgs, eventsByIndexedArgs, transactionByHash } from '~/middleware/queries';
import { eventsByArgs, extrinsicByHash } from '~/middleware/queriesV2';
import {
CallIdEnum,
EventIdEnum as EventId,
ModuleIdEnum as ModuleId,
ModuleIdEnum,
Query,
} from '~/middleware/types';
import { Query as QueryV2 } from '~/middleware/typesV2';
import {
EventIdentifier,
ExtrinsicDataWithFees,
NetworkProperties,
ProcedureMethod,
ProtocolFees,
SubCallback,
TxTag,
UnsubCallback,
} from '~/types';
import { Ensured, EnsuredV2 } from '~/types/utils';
import { TREASURY_MODULE_ADDRESS } from '~/utils/constants';
import {
balanceToBigNumber,
extrinsicIdentifierToTxTag,
middlewareEventToEventIdentifier,
middlewareV2EventDetailsToEventIdentifier,
moduleAddressToString,
stringToBlockHash,
textToString,
u32ToBigNumber,
} from '~/utils/conversion';
import { createProcedureMethod, optionize } from '~/utils/internal';
/**
* Handles all Network related functionality, including querying for historical events from middleware
*/
export class Network {
private context: Context;
/**
* @hidden
*/
constructor(context: Context) {
this.context = context;
this.transferPolyx = createProcedureMethod(
{ getProcedureAndArgs: args => [transferPolyx, args] },
context
);
}
/**
* Retrieve the number of the latest block in the chain
*/
public getLatestBlock(): Promise<BigNumber> {
return this.context.getLatestBlock();
}
/**
* Fetch the current network version (i.e. 3.1.0)
*/
public async getVersion(): Promise<string> {
return this.context.getNetworkVersion();
}
/**
* Retrieve the chain's SS58 format
*/
public getSs58Format(): BigNumber {
return this.context.ss58Format;
}
/**
* Retrieve information for the current network
*/
public async getNetworkProperties(): Promise<NetworkProperties> {
const {
context: {
polymeshApi: {
runtimeVersion: { specVersion },
rpc: {
system: { chain },
},
},
},
} = this;
const name = await chain();
return {
name: textToString(name),
version: u32ToBigNumber(specVersion),
};
}
/**
* Retrieve the protocol fees associated with running specific transactions
*
* @param args.tags - list of transaction tags (i.e. [TxTags.asset.CreateAsset, TxTags.asset.RegisterTicker] or ["asset.createAsset", "asset.registerTicker"])
*/
public getProtocolFees(args: { tags: TxTag[] }): Promise<ProtocolFees[]> {
return this.context.getProtocolFees(args);
}
/**
* Get the treasury wallet address
*/
public getTreasuryAccount(): Account {
const { context } = this;
return new Account(
{ address: moduleAddressToString(TREASURY_MODULE_ADDRESS, context) },
context
);
}
/**
* Get the Treasury POLYX balance
*
* @note can be subscribed to
*/
public getTreasuryBalance(): Promise<BigNumber>;
public getTreasuryBalance(callback: SubCallback<BigNumber>): Promise<UnsubCallback>;
// eslint-disable-next-line require-jsdoc
public async getTreasuryBalance(
callback?: SubCallback<BigNumber>
): Promise<BigNumber | UnsubCallback> {
const account = this.getTreasuryAccount();
if (callback) {
return account.getBalance(({ free: freeBalance }) => {
// eslint-disable-next-line @typescript-eslint/no-floating-promises -- callback errors should be handled by the caller
callback(freeBalance);
});
}
const { free } = await account.getBalance();
return free;
}
/**
* Transfer an amount of POLYX to a specified Account
*/
public transferPolyx: ProcedureMethod<TransferPolyxParams, void>;
/**
* Retrieve a single event by any of its indexed arguments. Can be filtered using parameters
*
* @param opts.moduleId - type of the module to fetch
* @param opts.eventId - type of the event to fetch
* @param opts.eventArg0 - event parameter value to filter by in position 0
* @param opts.eventArg1 - event parameter value to filter by in position 1
* @param opts.eventArg2 - event parameter value to filter by in position 2
*
* @note uses the middleware
*/
public async getEventByIndexedArgs(opts: {
moduleId: ModuleId;
eventId: EventId;
eventArg0?: string;
eventArg1?: string;
eventArg2?: string;
}): Promise<EventIdentifier | null> {
const { context } = this;
const { moduleId, eventId, eventArg0, eventArg1, eventArg2 } = opts;
const {
data: { eventByIndexedArgs: event },
} = await context.queryMiddleware<Ensured<Query, 'eventByIndexedArgs'>>(
eventByIndexedArgs({
moduleId,
eventId,
eventArg0,
eventArg1,
eventArg2,
})
);
return optionize(middlewareEventToEventIdentifier)(event);
}
/**
* Retrieve a single event by any of its indexed arguments. Can be filtered using parameters
*
* @param opts.moduleId - type of the module to fetch
* @param opts.eventId - type of the event to fetch
* @param opts.eventArg0 - event parameter value to filter by in position 0
* @param opts.eventArg1 - event parameter value to filter by in position 1
* @param opts.eventArg2 - event parameter value to filter by in position 2
*
* @note uses the middlewareV2
*/
public async getEventByIndexedArgsV2(opts: {
moduleId: ModuleId;
eventId: EventId;
eventArg0?: string;
eventArg1?: string;
eventArg2?: string;
}): Promise<EventIdentifier | null> {
const { context } = this;
const { moduleId, eventId, eventArg0, eventArg1, eventArg2 } = opts;
const {
data: {
events: {
nodes: [event],
},
},
} = await context.queryMiddlewareV2<EnsuredV2<QueryV2, 'events'>>(
eventsByArgs(
{
moduleId,
eventId,
eventArg0,
eventArg1,
eventArg2,
},
new BigNumber(1)
)
);
return optionize(middlewareV2EventDetailsToEventIdentifier)(event?.block, event?.eventIdx);
}
/**
* Retrieve a list of events. Can be filtered using parameters
*
* @param opts.moduleId - type of the module to fetch
* @param opts.eventId - type of the event to fetch
* @param opts.eventArg0 - event parameter value to filter by in position 0
* @param opts.eventArg1 - event parameter value to filter by in position 1
* @param opts.eventArg2 - event parameter value to filter by in position 2
* @param opts.size - page size
* @param opts.start - page offset
*
* @note uses the middleware
*/
public async getEventsByIndexedArgs(opts: {
moduleId: ModuleId;
eventId: EventId;
eventArg0?: string;
eventArg1?: string;
eventArg2?: string;
size?: BigNumber;
start?: BigNumber;
}): Promise<EventIdentifier[] | null> {
const { context } = this;
const { moduleId, eventId, eventArg0, eventArg1, eventArg2, size, start } = opts;
const result = await context.queryMiddleware<Ensured<Query, 'eventsByIndexedArgs'>>(
eventsByIndexedArgs({
moduleId,
eventId,
eventArg0,
eventArg1,
eventArg2,
count: size?.toNumber(),
skip: start?.toNumber(),
})
);
const {
data: { eventsByIndexedArgs: events },
} = result;
if (events) {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
return events.map(event => middlewareEventToEventIdentifier(event!));
}
return null;
}
/**
* Retrieve a list of events. Can be filtered using parameters
*
* @param opts.moduleId - type of the module to fetch
* @param opts.eventId - type of the event to fetch
* @param opts.eventArg0 - event parameter value to filter by in position 0
* @param opts.eventArg1 - event parameter value to filter by in position 1
* @param opts.eventArg2 - event parameter value to filter by in position 2
* @param opts.size - page size
* @param opts.start - page offset
*
* @note uses the middlewareV2
*/
public async getEventsByIndexedArgsV2(opts: {
moduleId: ModuleId;
eventId: EventId;
eventArg0?: string;
eventArg1?: string;
eventArg2?: string;
size?: BigNumber;
start?: BigNumber;
}): Promise<EventIdentifier[] | null> {
const { context } = this;
const { moduleId, eventId, eventArg0, eventArg1, eventArg2, size, start } = opts;
const {
data: {
events: { nodes: events },
},
} = await context.queryMiddlewareV2<EnsuredV2<QueryV2, 'events'>>(
eventsByArgs(
{
moduleId,
eventId,
eventArg0,
eventArg1,
eventArg2,
},
size,
start
)
);
if (events.length) {
return events.map(({ block, eventIdx }) =>
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
middlewareV2EventDetailsToEventIdentifier(block!, eventIdx)
);
}
return null;
}
/**
* Retrieve a transaction by hash
*
* @param opts.txHash - hash of the transaction
*
* @note uses the middleware
*/
public async getTransactionByHash(opts: {
txHash: string;
}): Promise<ExtrinsicDataWithFees | null> {
const {
context: {
polymeshApi: {
rpc: {
chain: { getBlock },
payment: { queryInfo },
},
},
},
context,
} = this;
const { txHash: transactionHash } = opts;
const result = await context.queryMiddleware<Ensured<Query, 'transactionByHash'>>(
transactionByHash({
transactionHash,
})
);
const {
data: { transactionByHash: transaction },
} = result;
if (transaction) {
const {
block_id: blockNumber,
extrinsic_idx: extrinsicIdx,
address: rawAddress,
nonce,
module_id: moduleId,
call_id: callId,
params,
success: txSuccess,
spec_version_id: specVersionId,
extrinsic_hash: extrinsicHash,
block,
} = transaction;
const txTag = extrinsicIdentifierToTxTag({ moduleId, callId });
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const blockHash = block!.hash!;
const rawBlockHash = stringToBlockHash(blockHash, context);
const {
block: { extrinsics },
} = await getBlock(rawBlockHash);
const [{ partialFee }, [{ fees: protocolFees }]] = await Promise.all([
queryInfo(extrinsics[extrinsicIdx].toHex(), rawBlockHash),
context.getProtocolFees({ tags: [txTag], blockHash }),
]);
return {
blockNumber: new BigNumber(blockNumber),
blockHash,
extrinsicIdx: new BigNumber(extrinsicIdx),
address: rawAddress ?? null,
nonce: nonce ? new BigNumber(nonce) : null,
txTag,
params,
success: !!txSuccess,
specVersionId: new BigNumber(specVersionId),
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
extrinsicHash: extrinsicHash!,
fee: {
gas: balanceToBigNumber(partialFee),
protocol: protocolFees,
},
};
}
return null;
}
/**
* Retrieve a transaction by hash
*
* @param opts.txHash - hash of the transaction
*
* @note uses the middlewareV2
*/
public async getTransactionByHashV2(opts: {
txHash: string;
}): Promise<ExtrinsicDataWithFees | null> {
const {
context: {
polymeshApi: {
rpc: {
chain: { getBlock },
payment: { queryInfo },
},
},
},
context,
} = this;
const {
data: {
extrinsics: {
nodes: [transaction],
},
},
} = await context.queryMiddlewareV2<EnsuredV2<QueryV2, 'extrinsics'>>(
extrinsicByHash({
extrinsicHash: opts.txHash,
})
);
if (transaction) {
const {
extrinsicIdx,
address: rawAddress,
nonce,
moduleId,
callId,
paramsTxt,
success: txSuccess,
specVersionId,
extrinsicHash,
block,
} = transaction;
const txTag = extrinsicIdentifierToTxTag({
moduleId: moduleId as ModuleIdEnum,
callId: callId as CallIdEnum,
});
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const { hash: blockHash, blockId: blockNumber } = block!;
const rawBlockHash = stringToBlockHash(blockHash, context);
const {
block: { extrinsics: blockExtrinsics },
} = await getBlock(rawBlockHash);
const [{ partialFee }, [{ fees: protocolFees }]] = await Promise.all([
queryInfo(blockExtrinsics[extrinsicIdx].toHex(), rawBlockHash),
context.getProtocolFees({ tags: [txTag], blockHash }),
]);
return {
blockNumber: new BigNumber(blockNumber),
blockHash,
extrinsicIdx: new BigNumber(extrinsicIdx),
address: rawAddress ?? null,
nonce: nonce ? new BigNumber(nonce) : null,
txTag,
params: JSON.parse(paramsTxt),
success: !!txSuccess,
specVersionId: new BigNumber(specVersionId),
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
extrinsicHash: extrinsicHash!,
fee: {
gas: balanceToBigNumber(partialFee),
protocol: protocolFees,
},
};
}
return null;
}
}