@lifi/sdk 0.0.0-preview-dd8065ff → 0.0.0-preview-1b774eec
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +55 -2
- package/README.md +9 -0
- package/dist/cjs/actions/getChains.js +7 -1
- package/dist/cjs/actions/getChains.js.map +1 -1
- package/dist/cjs/actions/getContractCallsQuote.js +1 -1
- package/dist/cjs/actions/getGasRecommendation.js +1 -1
- package/dist/cjs/actions/getQuote.js +1 -1
- package/dist/cjs/actions/getRelayedTransactionStatus.js +1 -1
- package/dist/cjs/actions/getRelayerQuote.js +1 -1
- package/dist/cjs/actions/getRoutes.js +1 -1
- package/dist/cjs/actions/getStatus.js +1 -1
- package/dist/cjs/actions/getToken.js +1 -1
- package/dist/cjs/actions/getTokens.js +7 -1
- package/dist/cjs/actions/getTokens.js.map +1 -1
- package/dist/cjs/actions/relayTransaction.js +1 -1
- package/dist/cjs/client/createClient.js +33 -10
- package/dist/cjs/client/createClient.js.map +1 -1
- package/dist/cjs/client/findProvider.d.ts +10 -0
- package/dist/cjs/client/findProvider.js +11 -0
- package/dist/cjs/client/findProvider.js.map +1 -0
- package/dist/cjs/core/tasks/helpers/checkBalance.js +6 -3
- package/dist/cjs/core/tasks/helpers/checkBalance.js.map +1 -1
- package/dist/cjs/index.d.ts +5 -3
- package/dist/cjs/index.js +6 -3
- package/dist/cjs/types/core.d.ts +62 -2
- package/dist/cjs/utils/abort.d.ts +6 -0
- package/dist/cjs/utils/abort.js +10 -0
- package/dist/cjs/utils/abort.js.map +1 -0
- package/dist/cjs/utils/checkPackageUpdates.js +1 -1
- package/dist/cjs/utils/convertQuoteToRoute.js +1 -1
- package/dist/cjs/utils/formatUnits.js +1 -0
- package/dist/cjs/utils/formatUnits.js.map +1 -1
- package/dist/cjs/utils/lru.d.ts +14 -0
- package/dist/cjs/utils/lru.js +35 -0
- package/dist/cjs/utils/lru.js.map +1 -0
- package/dist/cjs/utils/parseUnits.js +30 -16
- package/dist/cjs/utils/parseUnits.js.map +1 -1
- package/dist/cjs/utils/request.js +2 -2
- package/dist/cjs/utils/sleep.d.ts +7 -1
- package/dist/cjs/utils/sleep.js +22 -3
- package/dist/cjs/utils/sleep.js.map +1 -1
- package/dist/cjs/utils/waitForResult.d.ts +4 -4
- package/dist/cjs/utils/waitForResult.js +4 -4
- package/dist/cjs/utils/waitForResult.js.map +1 -1
- package/dist/cjs/utils/withDedupe.d.ts +15 -12
- package/dist/cjs/utils/withDedupe.js +69 -25
- package/dist/cjs/utils/withDedupe.js.map +1 -1
- package/dist/cjs/utils/withTimeout.js +6 -2
- package/dist/cjs/utils/withTimeout.js.map +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/cjs/version.js.map +1 -1
- package/dist/esm/actions/getChains.d.ts.map +1 -1
- package/dist/esm/actions/getChains.js +7 -1
- package/dist/esm/actions/getChains.js.map +1 -1
- package/dist/esm/actions/getContractCallsQuote.js +1 -1
- package/dist/esm/actions/getGasRecommendation.js +1 -1
- package/dist/esm/actions/getQuote.js +1 -1
- package/dist/esm/actions/getRelayedTransactionStatus.js +1 -1
- package/dist/esm/actions/getRelayerQuote.js +1 -1
- package/dist/esm/actions/getRoutes.d.ts.map +1 -1
- package/dist/esm/actions/getRoutes.js +1 -1
- package/dist/esm/actions/getStatus.js +1 -1
- package/dist/esm/actions/getToken.js +1 -1
- package/dist/esm/actions/getTokens.d.ts.map +1 -1
- package/dist/esm/actions/getTokens.js +7 -1
- package/dist/esm/actions/getTokens.js.map +1 -1
- package/dist/esm/actions/index.d.ts.map +1 -1
- package/dist/esm/actions/relayTransaction.js +1 -1
- package/dist/esm/client/createClient.d.ts.map +1 -1
- package/dist/esm/client/createClient.js +33 -10
- package/dist/esm/client/createClient.js.map +1 -1
- package/dist/esm/client/findProvider.d.ts +10 -0
- package/dist/esm/client/findProvider.d.ts.map +1 -0
- package/dist/esm/client/findProvider.js +10 -0
- package/dist/esm/client/findProvider.js.map +1 -0
- package/dist/esm/core/tasks/helpers/checkBalance.js +6 -3
- package/dist/esm/core/tasks/helpers/checkBalance.js.map +1 -1
- package/dist/esm/index.d.ts +5 -3
- package/dist/esm/index.js +6 -4
- package/dist/esm/types/actions.d.ts.map +1 -1
- package/dist/esm/types/core.d.ts +62 -2
- package/dist/esm/types/core.d.ts.map +1 -1
- package/dist/esm/utils/abort.d.ts +6 -0
- package/dist/esm/utils/abort.d.ts.map +1 -0
- package/dist/esm/utils/abort.js +8 -0
- package/dist/esm/utils/abort.js.map +1 -0
- package/dist/esm/utils/checkPackageUpdates.js +1 -1
- package/dist/esm/utils/convertQuoteToRoute.js +1 -1
- package/dist/esm/utils/formatUnits.js +1 -0
- package/dist/esm/utils/formatUnits.js.map +1 -1
- package/dist/esm/utils/lru.d.ts +14 -0
- package/dist/esm/utils/lru.d.ts.map +1 -0
- package/dist/esm/utils/lru.js +34 -0
- package/dist/esm/utils/lru.js.map +1 -0
- package/dist/esm/utils/parseUnits.js +30 -16
- package/dist/esm/utils/parseUnits.js.map +1 -1
- package/dist/esm/utils/request.js +2 -2
- package/dist/esm/utils/sleep.d.ts +7 -1
- package/dist/esm/utils/sleep.d.ts.map +1 -1
- package/dist/esm/utils/sleep.js +22 -3
- package/dist/esm/utils/sleep.js.map +1 -1
- package/dist/esm/utils/waitForResult.d.ts +4 -4
- package/dist/esm/utils/waitForResult.js +4 -4
- package/dist/esm/utils/waitForResult.js.map +1 -1
- package/dist/esm/utils/withDedupe.d.ts +15 -12
- package/dist/esm/utils/withDedupe.d.ts.map +1 -1
- package/dist/esm/utils/withDedupe.js +71 -25
- package/dist/esm/utils/withDedupe.js.map +1 -1
- package/dist/esm/utils/withTimeout.d.ts.map +1 -1
- package/dist/esm/utils/withTimeout.js +6 -2
- package/dist/esm/utils/withTimeout.js.map +1 -1
- package/dist/esm/version.d.ts +1 -1
- package/dist/esm/version.js +1 -1
- package/dist/esm/version.js.map +1 -1
- package/package.json +2 -2
- package/src/actions/getChains.ts +12 -4
- package/src/actions/getTokens.ts +12 -4
- package/src/client/createClient.ts +59 -7
- package/src/client/findProvider.ts +21 -0
- package/src/core/tasks/helpers/checkBalance.ts +11 -3
- package/src/index.ts +5 -1
- package/src/types/core.ts +65 -2
- package/src/utils/abort.ts +10 -0
- package/src/utils/formatUnits.ts +6 -0
- package/src/utils/lru.ts +38 -0
- package/src/utils/parseUnits.ts +53 -20
- package/src/utils/sleep.ts +27 -3
- package/src/utils/waitForResult.ts +4 -4
- package/src/utils/withDedupe.ts +121 -27
- package/src/utils/withTimeout.ts +7 -2
- package/src/version.ts +1 -1
package/src/utils/withDedupe.ts
CHANGED
|
@@ -1,45 +1,139 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
*
|
|
4
|
-
* https://en.wikipedia.org/wiki/Cache_replacement_policies#LRU
|
|
5
|
-
*/
|
|
6
|
-
export class LruMap<value = unknown> extends Map<string, value> {
|
|
7
|
-
maxSize: number
|
|
1
|
+
import { getAbortError } from './abort.js'
|
|
2
|
+
import { LruMap } from './lru.js'
|
|
8
3
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
4
|
+
type Caller = {
|
|
5
|
+
resolve: (value: any) => void
|
|
6
|
+
reject: (error: unknown) => void
|
|
7
|
+
}
|
|
13
8
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
9
|
+
type InFlight = {
|
|
10
|
+
promise: Promise<any>
|
|
11
|
+
/** Absent when the first caller had no signal: then nothing can abort it. */
|
|
12
|
+
controller?: AbortController | undefined
|
|
13
|
+
/** Callers with a signal that are still waiting, once the first one joins. */
|
|
14
|
+
callers?: Set<Caller> | undefined
|
|
15
|
+
/** A caller without a signal joined, so the request must run to the end. */
|
|
16
|
+
pinned: boolean
|
|
21
17
|
}
|
|
22
18
|
|
|
23
19
|
/** @internal */
|
|
24
|
-
const promiseCache = /*#__PURE__*/ new LruMap<
|
|
20
|
+
const promiseCache = /*#__PURE__*/ new LruMap<InFlight>(8192)
|
|
25
21
|
|
|
26
22
|
type WithDedupeOptions = {
|
|
27
23
|
enabled?: boolean | undefined
|
|
28
24
|
id?: string | undefined
|
|
25
|
+
/** Lets this caller leave a shared request without aborting it for others. */
|
|
26
|
+
signal?: AbortSignal | undefined
|
|
29
27
|
}
|
|
30
28
|
|
|
31
|
-
/**
|
|
29
|
+
/**
|
|
30
|
+
* Deduplicates in-flight promises.
|
|
31
|
+
*
|
|
32
|
+
* When the first caller passes a signal, `fn` receives the signal to hand on
|
|
33
|
+
* to its request. A caller that aborts leaves the shared request at once; the
|
|
34
|
+
* request itself is aborted only when every caller has aborted. The next
|
|
35
|
+
* caller then starts a new request, so `fn` should pass the signal on: a run
|
|
36
|
+
* that ignores it keeps going alongside the new one.
|
|
37
|
+
*/
|
|
38
|
+
export function withDedupe<T>(
|
|
39
|
+
fn: (signal?: AbortSignal) => Promise<T>,
|
|
40
|
+
options: WithDedupeOptions
|
|
41
|
+
): Promise<T>
|
|
32
42
|
export function withDedupe<T>(
|
|
33
43
|
fn: () => Promise<T>,
|
|
34
|
-
|
|
44
|
+
options: WithDedupeOptions & { signal?: undefined }
|
|
45
|
+
): Promise<T>
|
|
46
|
+
export function withDedupe<T>(
|
|
47
|
+
fn: (signal?: AbortSignal) => Promise<T>,
|
|
48
|
+
{ enabled = true, id, signal }: WithDedupeOptions
|
|
35
49
|
): Promise<T> {
|
|
36
50
|
if (!enabled || !id) {
|
|
37
|
-
return fn()
|
|
51
|
+
return fn(signal)
|
|
52
|
+
}
|
|
53
|
+
if (signal?.aborted) {
|
|
54
|
+
return Promise.reject(getAbortError(signal))
|
|
55
|
+
}
|
|
56
|
+
let inFlight = promiseCache.get(id)
|
|
57
|
+
if (!inFlight) {
|
|
58
|
+
const controller = signal ? new AbortController() : undefined
|
|
59
|
+
const promise = fn(controller?.signal).finally(() => evict(id, promise))
|
|
60
|
+
inFlight = { promise, controller, pinned: false }
|
|
61
|
+
promiseCache.set(id, inFlight)
|
|
38
62
|
}
|
|
39
|
-
|
|
40
|
-
|
|
63
|
+
return join<T>(id, inFlight, signal)
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
function join<T>(
|
|
67
|
+
id: string,
|
|
68
|
+
inFlight: InFlight,
|
|
69
|
+
signal: AbortSignal | undefined
|
|
70
|
+
): Promise<T> {
|
|
71
|
+
if (!signal) {
|
|
72
|
+
inFlight.pinned = true
|
|
73
|
+
return inFlight.promise
|
|
74
|
+
}
|
|
75
|
+
const callers = inFlight.callers ?? subscribe(inFlight)
|
|
76
|
+
return new Promise<T>((resolve, reject) => {
|
|
77
|
+
// Stop listening before settling, so a later abort cannot reach the request.
|
|
78
|
+
const caller: Caller = {
|
|
79
|
+
resolve: (value) => {
|
|
80
|
+
signal.removeEventListener('abort', leave)
|
|
81
|
+
resolve(value)
|
|
82
|
+
},
|
|
83
|
+
reject: (error) => {
|
|
84
|
+
signal.removeEventListener('abort', leave)
|
|
85
|
+
reject(error)
|
|
86
|
+
},
|
|
87
|
+
}
|
|
88
|
+
const leave = () => {
|
|
89
|
+
// `leave` can run without the event, so the listener is not always gone.
|
|
90
|
+
signal.removeEventListener('abort', leave)
|
|
91
|
+
callers.delete(caller)
|
|
92
|
+
const reason = getAbortError(signal)
|
|
93
|
+
reject(reason)
|
|
94
|
+
if (!inFlight.pinned && callers.size === 0) {
|
|
95
|
+
// A caller arriving now must start a new request, not join this one.
|
|
96
|
+
evict(id, inFlight.promise)
|
|
97
|
+
inFlight.controller?.abort(reason)
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
callers.add(caller)
|
|
101
|
+
signal.addEventListener('abort', leave, { once: true })
|
|
102
|
+
// `fn` runs before this listener exists and may have aborted the signal.
|
|
103
|
+
if (signal.aborted) {
|
|
104
|
+
leave()
|
|
105
|
+
}
|
|
106
|
+
})
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* Hands the result to the callers with a signal, through one reaction per
|
|
111
|
+
* request, so a caller that leaves holds nothing here. It is added only when
|
|
112
|
+
* the first such caller joins: a request shared only by callers without a
|
|
113
|
+
* signal gets no handler of ours, and a failure they all ignore is still
|
|
114
|
+
* reported as an unhandled rejection.
|
|
115
|
+
*/
|
|
116
|
+
function subscribe(inFlight: InFlight): Set<Caller> {
|
|
117
|
+
const callers = new Set<Caller>()
|
|
118
|
+
inFlight.callers = callers
|
|
119
|
+
inFlight.promise.then(
|
|
120
|
+
(value) => {
|
|
121
|
+
for (const caller of callers) {
|
|
122
|
+
caller.resolve(value)
|
|
123
|
+
}
|
|
124
|
+
},
|
|
125
|
+
(error) => {
|
|
126
|
+
for (const caller of callers) {
|
|
127
|
+
caller.reject(error)
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
)
|
|
131
|
+
return callers
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
/** Drops the entry for `id` only while it still holds this request. */
|
|
135
|
+
function evict(id: string, promise: Promise<unknown>): void {
|
|
136
|
+
if (promiseCache.get(id)?.promise === promise) {
|
|
137
|
+
promiseCache.delete(id)
|
|
41
138
|
}
|
|
42
|
-
const promise = fn().finally(() => promiseCache.delete(id))
|
|
43
|
-
promiseCache.set(id, promise)
|
|
44
|
-
return promise
|
|
45
139
|
}
|
package/src/utils/withTimeout.ts
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { isAbortError } from './abort.js'
|
|
2
|
+
|
|
1
3
|
/**
|
|
2
4
|
* Wraps a function in a timeout.
|
|
3
5
|
* Based on viem's withTimeout implementation.
|
|
@@ -25,8 +27,8 @@ export function withTimeout<T>(
|
|
|
25
27
|
return new Promise((resolve, reject) => {
|
|
26
28
|
;(async () => {
|
|
27
29
|
let timeoutId!: NodeJS.Timeout
|
|
30
|
+
const controller = new AbortController()
|
|
28
31
|
try {
|
|
29
|
-
const controller = new AbortController()
|
|
30
32
|
if (timeout > 0) {
|
|
31
33
|
timeoutId = setTimeout(() => {
|
|
32
34
|
if (signal) {
|
|
@@ -38,8 +40,11 @@ export function withTimeout<T>(
|
|
|
38
40
|
}
|
|
39
41
|
resolve(await fn({ signal: controller?.signal || null }))
|
|
40
42
|
} catch (err) {
|
|
41
|
-
|
|
43
|
+
// Only an abort from our own timeout is a timeout. Any other
|
|
44
|
+
// AbortError belongs to the caller and passes through.
|
|
45
|
+
if (controller.signal.aborted && isAbortError(err)) {
|
|
42
46
|
reject(errorInstance)
|
|
47
|
+
return
|
|
43
48
|
}
|
|
44
49
|
reject(err)
|
|
45
50
|
} finally {
|
package/src/version.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
export const name = '@lifi/sdk'
|
|
2
|
-
export const version = '0.0.0-preview-
|
|
2
|
+
export const version = '0.0.0-preview-1b774eec'
|