-
-
Notifications
You must be signed in to change notification settings - Fork 743
/
nonceManager.ts
132 lines (114 loc) · 3.59 KB
/
nonceManager.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
import type { Address } from 'abitype'
import { getTransactionCount } from '../actions/public/getTransactionCount.js'
import type { Client } from '../clients/createClient.js'
import type { MaybePromise } from '../types/utils.js'
import { LruMap } from './lru.js'
export type CreateNonceManagerParameters = {
source: NonceManagerSource
}
type FunctionParameters = {
address: Address
chainId: number
}
export type NonceManager = {
/** Get and increment a nonce. */
consume: (
parameters: FunctionParameters & { client: Client },
) => Promise<number>
/** Increment a nonce. */
increment: (chainId: FunctionParameters) => void
/** Get a nonce. */
get: (chainId: FunctionParameters & { client: Client }) => Promise<number>
/** Reset a nonce. */
reset: (chainId: FunctionParameters) => void
}
/**
* Creates a nonce manager for auto-incrementing transaction nonces.
*
* - Docs: https://viem.sh/docs/accounts/createNonceManager
*
* @example
* ```ts
* const nonceManager = createNonceManager({
* source: jsonRpc(),
* })
* ```
*/
export function createNonceManager(
parameters: CreateNonceManagerParameters,
): NonceManager {
const { source } = parameters
const deltaMap = new Map()
const nonceMap = new LruMap<number>(8192)
const promiseMap = new Map<string, Promise<number>>()
const getKey = ({ address, chainId }: FunctionParameters) =>
`${address}.${chainId}`
return {
async consume({ address, chainId, client }) {
const key = getKey({ address, chainId })
const promise = this.get({ address, chainId, client })
this.increment({ address, chainId })
const nonce = await promise
await source.set({ address, chainId }, nonce)
nonceMap.set(key, nonce)
return nonce
},
async increment({ address, chainId }) {
const key = getKey({ address, chainId })
const delta = deltaMap.get(key) ?? 0
deltaMap.set(key, delta + 1)
},
async get({ address, chainId, client }) {
const key = getKey({ address, chainId })
let promise = promiseMap.get(key)
if (!promise) {
promise = (async () => {
try {
const nonce = await source.get({ address, chainId, client })
const previousNonce = nonceMap.get(key) ?? 0
if (nonce <= previousNonce) return previousNonce + 1
nonceMap.delete(key)
return nonce
} finally {
this.reset({ address, chainId })
}
})()
promiseMap.set(key, promise)
}
const delta = deltaMap.get(key) ?? 0
return delta + (await promise)
},
reset({ address, chainId }) {
const key = getKey({ address, chainId })
deltaMap.delete(key)
promiseMap.delete(key)
},
}
}
////////////////////////////////////////////////////////////////////////////////////////////
// Sources
export type NonceManagerSource = {
/** Get a nonce. */
get(parameters: FunctionParameters & { client: Client }): MaybePromise<number>
/** Set a nonce. */
set(parameters: FunctionParameters, nonce: number): MaybePromise<void>
}
/** JSON-RPC source for a nonce manager. */
export function jsonRpc(): NonceManagerSource {
return {
async get(parameters) {
const { address, client } = parameters
return getTransactionCount(client, {
address,
blockTag: 'pending',
})
},
set() {},
}
}
////////////////////////////////////////////////////////////////////////////////////////////
// Default
/** Default Nonce Manager with a JSON-RPC source. */
export const nonceManager = /*#__PURE__*/ createNonceManager({
source: jsonRpc(),
})