-
Notifications
You must be signed in to change notification settings - Fork 0
/
types.ts
268 lines (220 loc) · 6.66 KB
/
types.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
import { Utils } from '@aleph-indexer/core'
import { Blockchain, IndexableEntityType, RawEntity } from '../../../types.js'
import { BlockchainRequestArgs } from '../../types.js'
import { FetcherMsClient } from '../client.js'
// ---------------------- Pagination --------------------------
export interface BaseFetcherPaginationCursors<C> {
backward?: C
forward?: C
}
export type BaseFetcherPaginationResponse<D, C> = {
cursors: BaseFetcherPaginationCursors<C>
chunk: D[]
count: number
}
// ------------------------ Options ---------------------
export type FetcherJobRunnerHandleFetchResult<C> = {
error?: Error
newInterval?: number
lastCursors: BaseFetcherPaginationCursors<C>
}
export type FetcherJobRunnerUpdateCursorResult<C> = {
newItems: boolean
newCursors: BaseFetcherPaginationCursors<C>
}
export type BaseFetcherJobRunnerOptions<C> = Omit<
Utils.JobRunnerOptions,
'name' | 'intervalFn'
> & {
handleFetch: (ctx: {
firstRun: boolean
interval: number
}) => Promise<FetcherJobRunnerHandleFetchResult<C>>
updateCursors?: (ctx: {
prevCursors?: BaseFetcherPaginationCursors<C>
lastCursors: BaseFetcherPaginationCursors<C>
}) => Promise<FetcherJobRunnerUpdateCursorResult<C>>
checkComplete?: (ctx: {
fetcherState: BaseFetcherState<C>
jobState: BaseFetcherJobState
newItems: boolean
error?: Error
}) => Promise<boolean>
}
export interface BaseFetcherOptions<C> {
id: string
jobs?: {
forward?: BaseFetcherJobRunnerOptions<C>
backward?: BaseFetcherJobRunnerOptions<C>
}
}
// ---------------------- State --------------------------
export type BaseFetcherJobState = {
frequency?: number
lastRun: number
numRuns: number
complete: boolean
useHistoricRPC: boolean
}
export type BaseFetcherJobStates = {
forward: BaseFetcherJobState
backward: BaseFetcherJobState
}
export type BaseFetcherState<C> = {
id: string
jobs: BaseFetcherJobStates
cursors?: BaseFetcherPaginationCursors<C>
}
// ---------------------------------------------------------
export type AccountEntityHistoryState<C> = {
fetcher: string
type: IndexableEntityType
blockchain: Blockchain
account: string
completeHistory: boolean
firstTimestamp?: number
lastTimestamp?: number
cursors?: BaseFetcherPaginationCursors<C>
}
// @todo
export type AccountStateState<T> = any
export type FetcherPartitionRequestArgs = BlockchainRequestArgs & {
fetcher: string
}
export type EntityFetcherState = {
pendingEntities: number
entitiesThroughput: number
}
export type AccountEntityHistoryFetcherState = {
accountFetchers: number
}
export type AccountEntityFetcherMainState = EntityFetcherState &
AccountEntityHistoryFetcherState & {
type: IndexableEntityType
}
export type FetcherState<T = any> = (AccountEntityFetcherMainState & {
blockchain: Blockchain
fetcher: string
type: IndexableEntityType
data?: T
})[]
export type EntityState = {
id: string
isCached: boolean
isPending: boolean
pendingAddTime?: string
pendingExecTime?: string
data?: RawEntity
}
export type IndexerIdRequestArgs = {
/**
* Indexer instance id
*/
indexerId?: string
}
export type FetcherAccountPartitionRequestArgs = IndexerIdRequestArgs & {
account: string
}
export type FetcherAccountEntityTypeRequestArgs = {
type: IndexableEntityType
}
// Account transaction ------------------------------
export type AddAccountEntityRequestArgs = BlockchainRequestArgs &
FetcherAccountPartitionRequestArgs &
FetcherAccountEntityTypeRequestArgs
export type DelAccountEntityRequestArgs = BlockchainRequestArgs &
FetcherAccountPartitionRequestArgs &
FetcherAccountEntityTypeRequestArgs
export type GetAccountEntityStateRequestArgs = BlockchainRequestArgs &
FetcherAccountPartitionRequestArgs &
FetcherAccountEntityTypeRequestArgs
// Account state ------------------------------
/**
* Accounts and timestamp range to get the ids for.
*/
export type FetchAccountEntitiesByDateRequestArgs = BlockchainRequestArgs &
FetcherAccountPartitionRequestArgs &
FetcherAccountEntityTypeRequestArgs & {
startDate: number
endDate: number
/**
* Metadata for extending functionality if needed
*/
meta?: any
}
export type FetchEntitiesByIdRequestArgs = BlockchainRequestArgs &
IndexerIdRequestArgs &
FetcherAccountEntityTypeRequestArgs & {
/**
* Whether to refresh the transaction cache.
*/
refreshCache?: boolean
/**
* Signatures to fetch.
*/
ids: string[]
/**
* Metadata for extending functionality if needed
*/
meta?: any
}
// ------------------ Other ----------------------
export type FetcherStateRequestArgs = Omit<
FetcherPartitionRequestArgs,
'blockchainId'
> & {
blockchainId?: Blockchain[]
type?: IndexableEntityType[]
}
export type CheckEntityRequestArgs = BlockchainRequestArgs &
FetcherAccountEntityTypeRequestArgs & {
ids: string[]
}
export type DelEntityRequestArgs = BlockchainRequestArgs &
FetcherAccountEntityTypeRequestArgs & {
ids: string[]
}
export type FetcherCommonDomainContext = {
apiClient: FetcherMsClient
dataPath: string
}
export type FetcherInstanceDomainContext = FetcherCommonDomainContext & {
instanceName: string
}
export type FetcherMainDomainContext = FetcherCommonDomainContext
export interface BlockchainFetcherI<C = any> {
start(): Promise<void>
stop(): Promise<void>
/**
* Requests a new signature fetcher, which will fetch all txn ids including a given account.
* @param args Arguments for the fetcher.
*/
addAccountEntityFetcher(args: AddAccountEntityRequestArgs): Promise<void>
/**
* Requests to remove a signature fetcher.
* @param args The account to remove the fetcher from.
*/
delAccountEntityFetcher(args: DelAccountEntityRequestArgs): Promise<void>
/**
* Returns a signature fetcher's state.
* @param args The account to get the fetcher's state from.
*/
getAccountEntityFetcherState(
args: GetAccountEntityStateRequestArgs,
): Promise<AccountEntityHistoryState<C> | undefined>
/**
* Returns all txn ids fetched for a given account by timestamp range as a stream.
* @param args Account and timestamp range to get the ids for.
*/
fetchAccountEntitiesByDate(
args: FetchAccountEntitiesByDateRequestArgs,
): Promise<void | AsyncIterable<string[]>>
/**
* Adds new ids to the fetcher loop to fetch their related transactions.
* @param args The ids of the transactions to fetch.
*/
fetchEntitiesById(args: FetchEntitiesByIdRequestArgs): Promise<void>
getFetcherState(args: FetcherStateRequestArgs): Promise<FetcherState>
getEntityState(args: CheckEntityRequestArgs): Promise<EntityState[]>
delEntityCache(args: DelEntityRequestArgs): Promise<void>
}