generated from fission-codes/project-template
-
Notifications
You must be signed in to change notification settings - Fork 24
/
node.ts
423 lines (309 loc) · 10.9 KB
/
node.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
/*
(づ ̄ ³ ̄)づ
IPFS node things.
*/
// Considered dev dependency as these imports will not be present in the resulting lib code
import type { IPFS as IPFSCore } from "ipfs-core-types"
import type { IPFSRepo } from "ipfs-repo"
import type { PeerId } from "@libp2p/interface-peer-id"
import * as keys from "@libp2p/interface-keys"
import { multiaddr, Multiaddr } from "@multiformats/multiaddr"
import { peerIdFromString } from "@libp2p/peer-id"
import * as Storage from "../../../../components/storage/implementation.js"
import * as t from "../../../../common/type-checks.js"
import { IPFSPackage, Options as IPFSOptions } from "./package.js"
import * as IpfsRepo from "./node/repo.js"
// GLOBAL STATE
const latestPeerTimeoutIds: { [ peer: string ]: null | ReturnType<typeof setTimeout> } = {}
const isSafari = /^((?!chrome|android).)*safari/i.test(globalThis.navigator?.userAgent || "")
// TYPES
export type BackOff = {
retryNumber: number
lastBackoff: number
currentBackoff: number
}
export type Dependencies = {
storage: Storage.Implementation
}
export type Status = {
connected: boolean
lastConnectedAt: number | null
latency: number | null
}
export type IPFS = IPFSCore & {
libp2p: { ping(peerId: PeerId | Multiaddr): Promise<number> }
}
// OPTIONS
/** 🎛️ Connection interval knobs
*
* KEEP_ALIVE_INTERVAL: Interval to keep the connection alive when online
* KEEP_TRYING_INTERVAL: Interval to keep trying the connection when offline
* BACKOFF_INIT: Starting intervals for fibonacci backoff used when establishing a connection
*/
const KEEP_ALIVE_INTERVAL =
1 * 60 * 1000 // 1 minute
const KEEP_TRYING_INTERVAL =
5 * 60 * 1000 // 5 minutes
const BACKOFF_INIT = {
retryNumber: 0,
lastBackoff: 0,
currentBackoff: 1000
}
/** 🎛️ IPFS Options
*/
export const OPTIONS: IPFSOptions = {
config: {
Addresses: {
Delegates: []
},
Bootstrap: [],
Discovery: {
webRTCStar: { Enabled: false }
},
Pubsub: {
Enabled: false
}
},
preload: {
enabled: false,
addresses: []
},
libp2p: {
peerDiscovery: [],
connectionManager: {
autoDial: false
}
},
init: {
algorithm: isSafari ? keys.RSA : undefined,
emptyRepo: true
},
}
// 🚀
export async function createAndConnect(
dependencies: Dependencies,
pkg: IPFSPackage,
peersUrl: string,
repoName: string,
logging: boolean
): Promise<{ ipfs: IPFSCore; repo: IPFSRepo }> {
const peers = await listPeers(dependencies.storage, peersUrl)
if (peers.length === 0) {
throw new Error("💥 Couldn't start IPFS node, peer list is empty")
}
// Start an IPFS node & connect to all the peers
const repo = IpfsRepo.create(repoName)
const ipfs: IPFSCore = await pkg.create({ ...OPTIONS, repo })
peers.forEach(peer => {
latestPeerTimeoutIds[ peer.toString() ] = null
tryConnecting(ipfs as unknown as IPFS, peer, logging)
})
// Try connecting when browser comes online
globalThis.addEventListener("online", async () => {
(await listPeers(dependencies.storage, peersUrl))
.filter(peer => {
const peerStr = peer.toString()
return !peerStr.includes("/localhost/") &&
!peerStr.includes("/127.0.0.1/") &&
!peerStr.includes("/0.0.0.0/")
})
.forEach(peer => {
tryConnecting(ipfs as unknown as IPFS, peer, logging)
})
})
// Fin
if (logging) console.log("🚀 Started IPFS node")
return { ipfs, repo }
}
// PEERS
// -----
export function fetchPeers(peersUrl: string): Promise<string[]> {
return fetch(peersUrl)
.then(r => r.json())
.then(r => Array.isArray(r) ? r : [])
.then(r => r.filter(p => t.isString(p) && p.includes("/wss/")))
.catch(() => { throw new Error("💥 Couldn't start IPFS node, failed to fetch peer list") })
}
export async function listPeers(
storage: Storage.Implementation,
peersUrl: string
): Promise<Multiaddr[]> {
let peers
const storageKey = `ipfs-peers-${peersUrl}`
const maybePeers = await storage.getItem(storageKey)
if (t.isString(maybePeers) && maybePeers.trim() !== "") {
peers = JSON.parse(maybePeers)
fetchPeers(peersUrl).then(list =>
storage.setItem(storageKey, JSON.stringify(list))
).catch(err => {
// don't throw
console.error(err)
})
} else {
peers = await fetchPeers(peersUrl)
await storage.setItem(storageKey, JSON.stringify(peers))
}
return peers.map(multiaddr)
}
// CONNECTIONS
// -----------
function keepAlive(ipfs: IPFS, peer: Multiaddr, backoff: BackOff, status: Status): void {
let timeoutId: ReturnType<typeof setTimeout> | null = null
if (backoff.currentBackoff < KEEP_TRYING_INTERVAL) {
// Start race between reconnect and ping
timeoutId = setTimeout(() => reconnect(ipfs, peer, backoff, status), backoff.currentBackoff)
} else {
// Disregard backoff, but keep trying
timeoutId = setTimeout(() => reconnect(ipfs, peer, backoff, status), KEEP_TRYING_INTERVAL)
}
// Track the latest reconnect attempt
latestPeerTimeoutIds[ peer.toString() ] = timeoutId
ping(ipfs, peer).then(({ latency }) => {
const updatedStatus = { connected: true, lastConnectedAt: Date.now(), latency }
report(peer, updatedStatus)
// Cancel reconnect because ping won
if (timeoutId) clearTimeout(timeoutId)
// Keep alive after the latest ping-reconnect race, ignore the rest
if (timeoutId === latestPeerTimeoutIds[ peer.toString() ]) {
setTimeout(() => keepAlive(ipfs, peer, BACKOFF_INIT, updatedStatus), KEEP_ALIVE_INTERVAL)
}
}).catch(() => {
// ignore errors
})
}
async function reconnect(ipfs: IPFS, peer: Multiaddr, backoff: BackOff, status: Status): Promise<void> {
const updatedStatus = { ...status, connected: false, latency: null }
report(peer, updatedStatus)
try {
await ipfs.swarm.disconnect(peer)
await ipfs.swarm.connect(peer)
} catch {
// No action needed, we will retry
}
if (backoff.currentBackoff < KEEP_TRYING_INTERVAL) {
const nextBackoff = {
retryNumber: backoff.retryNumber + 1,
lastBackoff: backoff.currentBackoff,
currentBackoff: backoff.lastBackoff + backoff.currentBackoff
}
keepAlive(ipfs, peer, nextBackoff, updatedStatus)
} else {
keepAlive(ipfs, peer, backoff, updatedStatus)
}
}
export function tryConnecting(ipfs: IPFS, peer: Multiaddr, logging: boolean): void {
ping(ipfs, peer).then(({ latency }) => {
return ipfs.swarm
.connect(peer, { timeout: 60 * 1000 })
.then(() => {
if (logging) console.log(`🪐 Connected to ${peer}`)
const status = { connected: true, lastConnectedAt: Date.now(), latency }
report(peer, status)
// Ensure permanent connection to a peer
// NOTE: This is a temporary solution while we wait for
// https://github.com/libp2p/js-libp2p/issues/744
// (see "Keep alive" bit)
setTimeout(() => keepAlive(ipfs, peer, BACKOFF_INIT, status), KEEP_ALIVE_INTERVAL)
})
}).catch(() => {
if (logging) console.log(`🪓 Could not connect to ${peer}`)
const status = { connected: false, lastConnectedAt: null, latency: null }
report(peer, status)
keepAlive(ipfs, peer, BACKOFF_INIT, status)
})
}
export async function ping(ipfs: IPFS, peer: Multiaddr): Promise<{ latency: number }> {
return ipfs.libp2p.ping(peer).then(latency => ({ latency }))
}
// REPORTING
// ---------
let peerConnections: { peer: Multiaddr; status: Status }[] = []
let monitoringPeers = false
function report(peer: Multiaddr, status: Status): void {
peerConnections = peerConnections
.filter(connection => connection.peer !== peer)
.concat({ peer, status })
const offline = peerConnections.every(connection => !connection.status.connected)
const lastConnectedAt: number = peerConnections.reduce((newest, { status }) =>
newest >= (status.lastConnectedAt || 0) ? newest : (status.lastConnectedAt || 0),
0
)
const activeConnections = peerConnections.filter(connection => connection.status.latency !== null)
const averageLatency = activeConnections.length > 0
? peerConnections.reduce((sum, connection) => sum + (connection.status.latency || 0), 0) / activeConnections.length
: null
if (monitoringPeers) {
console.table(peerConnections)
console.log("offline", offline)
console.log("last connected at", lastConnectedAt === 0 ? null : lastConnectedAt)
console.log("average latency", averageLatency)
}
}
export async function monitorPeers() {
monitoringPeers = true
console.log("📡 Monitoring IPFS peers")
}
export function stopMonitoringPeers() {
monitoringPeers = false
}
// 🔮
let monitor: ReturnType<typeof setTimeout> | null = null
export async function monitorBitswap(dependencies: Dependencies, ipfs: IPFS, peersUrl: string, verbose: boolean): Promise<void> {
const cidCount: { [ k: string ]: number } = {}
const seen: string[] = []
const peers = await listPeers(dependencies.storage, peersUrl)
verbose = verbose === undefined ? false : true
console.log("🕵️♀️ Monitoring IPFS bitswap requests")
await stopMonitoringBitswap()
monitor = setInterval(async () => {
const peerList = peers
peerList.map(async peer => {
const peerIdString = peer.getPeerId()
if (!peerIdString) return
const peerId = peerIdFromString(peerIdString)
const wantList = await ipfs.bitswap.wantlistForPeer(peerId, { timeout: 120 * 1000 })
wantList.forEach(async cid => {
const c = cid.toString()
const s = peer + "-" + c
if (!seen.includes(s)) {
const seenCid = !!cidCount[ c ]
const emoji = seenCid ? "📡" : "🔮"
const msg = `${emoji} Peer ${peer} requested CID ${c}`
cidCount[ c ] = (cidCount[ c ] || 0) + 1
if (seenCid) {
if (verbose) console.log(msg + ` (#${cidCount[ c ]})`)
return
} else {
console.log(msg)
}
const start = performance.now()
seen.push(s)
const dag = await ipfs.dag.get(cid)
const end = performance.now()
const diff = end - start
const loaded = `loaded locally in ${diff.toFixed(2)} ms`
if (dag.value.Links) {
console.log(`🧱 ${c} is a 👉 DAG structure (${loaded})`)
; (console.table || console.log)(
dag.value.Links
.map((l: unknown) => {
if (t.isObject(l) && t.hasProp(l, "Name") && t.hasProp(l, "Hash")) {
return { name: l.Name, cid: (l.Hash as unknown as string).toString() }
} else {
return null
}
})
.filter((a: { name: string; cid: string } | null) => a)
)
} else {
console.log(`📦 ${c} is 👉 Data (${loaded})`)
console.log(dag.value)
}
}
})
})
}, 20)
}
export async function stopMonitoringBitswap() {
if (monitor) clearInterval(monitor)
}