-
Notifications
You must be signed in to change notification settings - Fork 670
/
utxo_state.go
294 lines (241 loc) · 6.14 KB
/
utxo_state.go
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
// Copyright (C) 2019-2024, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.
package avax
import (
"github.com/prometheus/client_golang/prometheus"
"github.com/ava-labs/avalanchego/cache"
"github.com/ava-labs/avalanchego/cache/metercacher"
"github.com/ava-labs/avalanchego/codec"
"github.com/ava-labs/avalanchego/database"
"github.com/ava-labs/avalanchego/database/linkeddb"
"github.com/ava-labs/avalanchego/database/prefixdb"
"github.com/ava-labs/avalanchego/ids"
)
const (
utxoCacheSize = 8192
indexCacheSize = 64
)
var (
utxoPrefix = []byte("utxo")
indexPrefix = []byte("index")
)
// UTXOState is a thin wrapper around a database to provide, caching,
// serialization, and de-serialization for UTXOs.
type UTXOState interface {
UTXOReader
UTXOWriter
// Checksum returns the current UTXOChecksum.
Checksum() ids.ID
}
// UTXOReader is a thin wrapper around a database to provide fetching of UTXOs.
type UTXOReader interface {
UTXOGetter
// UTXOIDs returns the slice of IDs associated with [addr], starting after
// [previous].
// If [previous] is not in the list, starts at beginning.
// Returns at most [limit] IDs.
UTXOIDs(addr []byte, previous ids.ID, limit int) ([]ids.ID, error)
}
// UTXOGetter is a thin wrapper around a database to provide fetching of a UTXO.
type UTXOGetter interface {
// GetUTXO attempts to load a utxo.
GetUTXO(utxoID ids.ID) (*UTXO, error)
}
type UTXOAdder interface {
AddUTXO(utxo *UTXO)
}
type UTXODeleter interface {
DeleteUTXO(utxoID ids.ID)
}
// UTXOWriter is a thin wrapper around a database to provide storage and
// deletion of UTXOs.
type UTXOWriter interface {
// PutUTXO saves the provided utxo to storage.
PutUTXO(utxo *UTXO) error
// DeleteUTXO deletes the provided utxo.
DeleteUTXO(utxoID ids.ID) error
}
type utxoState struct {
codec codec.Manager
// UTXO ID -> *UTXO. If the *UTXO is nil the UTXO doesn't exist
utxoCache cache.Cacher[ids.ID, *UTXO]
utxoDB database.Database
indexDB database.Database
indexCache cache.Cacher[string, linkeddb.LinkedDB]
trackChecksum bool
checksum ids.ID
}
func NewUTXOState(
db database.Database,
codec codec.Manager,
trackChecksum bool,
) (UTXOState, error) {
s := &utxoState{
codec: codec,
utxoCache: &cache.LRU[ids.ID, *UTXO]{Size: utxoCacheSize},
utxoDB: prefixdb.New(utxoPrefix, db),
indexDB: prefixdb.New(indexPrefix, db),
indexCache: &cache.LRU[string, linkeddb.LinkedDB]{Size: indexCacheSize},
trackChecksum: trackChecksum,
}
return s, s.initChecksum()
}
func NewMeteredUTXOState(
db database.Database,
codec codec.Manager,
metrics prometheus.Registerer,
trackChecksum bool,
) (UTXOState, error) {
utxoCache, err := metercacher.New[ids.ID, *UTXO](
"utxo_cache",
metrics,
&cache.LRU[ids.ID, *UTXO]{Size: utxoCacheSize},
)
if err != nil {
return nil, err
}
indexCache, err := metercacher.New[string, linkeddb.LinkedDB](
"index_cache",
metrics,
&cache.LRU[string, linkeddb.LinkedDB]{
Size: indexCacheSize,
},
)
if err != nil {
return nil, err
}
s := &utxoState{
codec: codec,
utxoCache: utxoCache,
utxoDB: prefixdb.New(utxoPrefix, db),
indexDB: prefixdb.New(indexPrefix, db),
indexCache: indexCache,
trackChecksum: trackChecksum,
}
return s, s.initChecksum()
}
func (s *utxoState) GetUTXO(utxoID ids.ID) (*UTXO, error) {
if utxo, found := s.utxoCache.Get(utxoID); found {
if utxo == nil {
return nil, database.ErrNotFound
}
return utxo, nil
}
bytes, err := s.utxoDB.Get(utxoID[:])
if err == database.ErrNotFound {
s.utxoCache.Put(utxoID, nil)
return nil, database.ErrNotFound
}
if err != nil {
return nil, err
}
// The key was in the database
utxo := &UTXO{}
if _, err := s.codec.Unmarshal(bytes, utxo); err != nil {
return nil, err
}
s.utxoCache.Put(utxoID, utxo)
return utxo, nil
}
func (s *utxoState) PutUTXO(utxo *UTXO) error {
utxoBytes, err := s.codec.Marshal(codecVersion, utxo)
if err != nil {
return err
}
utxoID := utxo.InputID()
s.updateChecksum(utxoID)
s.utxoCache.Put(utxoID, utxo)
if err := s.utxoDB.Put(utxoID[:], utxoBytes); err != nil {
return err
}
addressable, ok := utxo.Out.(Addressable)
if !ok {
return nil
}
addresses := addressable.Addresses()
for _, addr := range addresses {
indexList := s.getIndexDB(addr)
if err := indexList.Put(utxoID[:], nil); err != nil {
return err
}
}
return nil
}
func (s *utxoState) DeleteUTXO(utxoID ids.ID) error {
utxo, err := s.GetUTXO(utxoID)
if err == database.ErrNotFound {
return nil
}
if err != nil {
return err
}
s.updateChecksum(utxoID)
s.utxoCache.Put(utxoID, nil)
if err := s.utxoDB.Delete(utxoID[:]); err != nil {
return err
}
addressable, ok := utxo.Out.(Addressable)
if !ok {
return nil
}
addresses := addressable.Addresses()
for _, addr := range addresses {
indexList := s.getIndexDB(addr)
if err := indexList.Delete(utxoID[:]); err != nil {
return err
}
}
return nil
}
func (s *utxoState) UTXOIDs(addr []byte, start ids.ID, limit int) ([]ids.ID, error) {
indexList := s.getIndexDB(addr)
iter := indexList.NewIteratorWithStart(start[:])
defer iter.Release()
utxoIDs := []ids.ID(nil)
for len(utxoIDs) < limit && iter.Next() {
utxoID, err := ids.ToID(iter.Key())
if err != nil {
return nil, err
}
if utxoID == start {
continue
}
start = ids.Empty
utxoIDs = append(utxoIDs, utxoID)
}
return utxoIDs, iter.Error()
}
func (s *utxoState) Checksum() ids.ID {
return s.checksum
}
func (s *utxoState) getIndexDB(addr []byte) linkeddb.LinkedDB {
addrStr := string(addr)
if indexList, exists := s.indexCache.Get(addrStr); exists {
return indexList
}
indexDB := prefixdb.NewNested(addr, s.indexDB)
indexList := linkeddb.NewDefault(indexDB)
s.indexCache.Put(addrStr, indexList)
return indexList
}
func (s *utxoState) initChecksum() error {
if !s.trackChecksum {
return nil
}
it := s.utxoDB.NewIterator()
defer it.Release()
for it.Next() {
utxoID, err := ids.ToID(it.Key())
if err != nil {
return err
}
s.updateChecksum(utxoID)
}
return it.Error()
}
func (s *utxoState) updateChecksum(modifiedID ids.ID) {
if !s.trackChecksum {
return
}
s.checksum = s.checksum.XOR(modifiedID)
}