-
Notifications
You must be signed in to change notification settings - Fork 669
/
unique_tx.go
333 lines (277 loc) · 7.51 KB
/
unique_tx.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
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
// (c) 2019-2020, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.
package avm
import (
"errors"
"fmt"
"github.com/ava-labs/avalanchego/ids"
"github.com/ava-labs/avalanchego/snow/choices"
"github.com/ava-labs/avalanchego/snow/consensus/snowstorm"
"github.com/ava-labs/avalanchego/vms/components/avax"
)
var (
errAssetIDMismatch = errors.New("asset IDs in the input don't match the utxo")
errWrongAssetID = errors.New("asset ID must be AVAX in the atomic tx")
errMissingUTXO = errors.New("missing utxo")
errUnknownTx = errors.New("transaction is unknown")
errRejectedTx = errors.New("transaction is rejected")
)
// UniqueTx provides a de-duplication service for txs. This only provides a
// performance boost
type UniqueTx struct {
*TxState
vm *VM
txID ids.ID
}
// TxState ...
type TxState struct {
*Tx
unique, verifiedTx, verifiedState bool
validity error
inputs ids.Set
inputUTXOs []*avax.UTXOID
utxos []*avax.UTXO
deps []snowstorm.Tx
status choices.Status
}
func (tx *UniqueTx) refresh() {
tx.vm.numTxRefreshes.Inc()
if tx.TxState == nil {
tx.TxState = &TxState{}
}
if tx.unique {
return
}
unique := tx.vm.state.UniqueTx(tx)
prevTx := tx.Tx
if unique == tx {
tx.vm.numTxRefreshMisses.Inc()
// If no one was in the cache, make sure that there wasn't an
// intermediate object whose state I must reflect
if status, err := tx.vm.state.Status(tx.ID()); err == nil {
tx.status = status
}
tx.unique = true
} else {
tx.vm.numTxRefreshHits.Inc()
// If someone is in the cache, they must be up to date
// This ensures that every unique tx object points to the same tx state
tx.TxState = unique.TxState
}
if tx.Tx != nil {
return
}
if prevTx == nil {
// TODO: register hits/misses for this
if innerTx, err := tx.vm.state.Tx(tx.ID()); err == nil {
tx.Tx = innerTx
}
} else {
tx.Tx = prevTx
}
}
// Evict is called when this UniqueTx will no longer be returned from a cache
// lookup
func (tx *UniqueTx) Evict() {
// Lock is already held here
tx.unique = false
tx.deps = nil
}
func (tx *UniqueTx) setStatus(status choices.Status) error {
tx.refresh()
if tx.status == status {
return nil
}
tx.status = status
return tx.vm.state.SetStatus(tx.ID(), status)
}
// ID returns the wrapped txID
func (tx *UniqueTx) ID() ids.ID { return tx.txID }
// Accept is called when the transaction was finalized as accepted by consensus
func (tx *UniqueTx) Accept() error {
if s := tx.Status(); s != choices.Processing {
tx.vm.ctx.Log.Error("Failed to accept tx %s because the tx is in state %s", tx.txID, s)
return fmt.Errorf("transaction has invalid status: %s", s)
}
defer tx.vm.db.Abort()
// Remove spent utxos
for _, utxo := range tx.InputUTXOs() {
if utxo.Symbolic() {
// If the UTXO is symbolic, it can't be spent
continue
}
utxoID := utxo.InputID()
if err := tx.vm.state.SpendUTXO(utxoID); err != nil {
tx.vm.ctx.Log.Error("Failed to spend utxo %s due to %s", utxoID, err)
return err
}
}
// Add new utxos
for _, utxo := range tx.UTXOs() {
if err := tx.vm.state.FundUTXO(utxo); err != nil {
tx.vm.ctx.Log.Error("Failed to fund utxo %s due to %s", utxo.InputID(), err)
return err
}
}
if err := tx.setStatus(choices.Accepted); err != nil {
tx.vm.ctx.Log.Error("Failed to accept tx %s due to %s", tx.txID, err)
return err
}
txID := tx.ID()
commitBatch, err := tx.vm.db.CommitBatch()
if err != nil {
tx.vm.ctx.Log.Error("Failed to calculate CommitBatch for %s due to %s", txID, err)
return err
}
if err := tx.ExecuteWithSideEffects(tx.vm, commitBatch); err != nil {
tx.vm.ctx.Log.Error("Failed to commit accept %s due to %s", txID, err)
return err
}
tx.vm.ctx.Log.Verbo("Accepted Tx: %s", txID)
tx.vm.pubsub.Publish("accepted", txID)
tx.vm.walletService.decided(txID)
tx.deps = nil // Needed to prevent a memory leak
return nil
}
// Reject is called when the transaction was finalized as rejected by consensus
func (tx *UniqueTx) Reject() error {
defer tx.vm.db.Abort()
if err := tx.setStatus(choices.Rejected); err != nil {
tx.vm.ctx.Log.Error("Failed to reject tx %s due to %s", tx.txID, err)
return err
}
txID := tx.ID()
tx.vm.ctx.Log.Debug("Rejecting Tx: %s", txID)
if err := tx.vm.db.Commit(); err != nil {
tx.vm.ctx.Log.Error("Failed to commit reject %s due to %s", tx.txID, err)
return err
}
tx.vm.pubsub.Publish("rejected", txID)
tx.vm.walletService.decided(txID)
tx.deps = nil // Needed to prevent a memory leak
return nil
}
// Status returns the current status of this transaction
func (tx *UniqueTx) Status() choices.Status {
tx.refresh()
return tx.status
}
// Dependencies returns the set of transactions this transaction builds on
func (tx *UniqueTx) Dependencies() []snowstorm.Tx {
tx.refresh()
if tx.Tx == nil || len(tx.deps) != 0 {
return tx.deps
}
txIDs := ids.Set{}
for _, in := range tx.InputUTXOs() {
if in.Symbolic() {
continue
}
txID, _ := in.InputSource()
if txIDs.Contains(txID) {
continue
}
txIDs.Add(txID)
tx.deps = append(tx.deps, &UniqueTx{
vm: tx.vm,
txID: txID,
})
}
consumedIDs := tx.Tx.ConsumedAssetIDs()
for _, assetID := range tx.Tx.AssetIDs().List() {
if consumedIDs.Contains(assetID) || txIDs.Contains(assetID) {
continue
}
txIDs.Add(assetID)
tx.deps = append(tx.deps, &UniqueTx{
vm: tx.vm,
txID: assetID,
})
}
return tx.deps
}
// InputIDs returns the set of utxoIDs this transaction consumes
func (tx *UniqueTx) InputIDs() ids.Set {
tx.refresh()
if tx.Tx == nil || tx.inputs.Len() != 0 {
return tx.inputs
}
for _, utxo := range tx.InputUTXOs() {
tx.inputs.Add(utxo.InputID())
}
return tx.inputs
}
// InputUTXOs returns the utxos that will be consumed on tx acceptance
func (tx *UniqueTx) InputUTXOs() []*avax.UTXOID {
tx.refresh()
if tx.Tx == nil || len(tx.inputUTXOs) != 0 {
return tx.inputUTXOs
}
tx.inputUTXOs = tx.Tx.InputUTXOs()
return tx.inputUTXOs
}
// UTXOs returns the utxos that will be added to the UTXO set on tx acceptance
func (tx *UniqueTx) UTXOs() []*avax.UTXO {
tx.refresh()
if tx.Tx == nil || len(tx.utxos) != 0 {
return tx.utxos
}
tx.utxos = tx.Tx.UTXOs()
return tx.utxos
}
// Bytes returns the binary representation of this transaction
func (tx *UniqueTx) Bytes() []byte {
tx.refresh()
return tx.Tx.Bytes()
}
func (tx *UniqueTx) verifyWithoutCacheWrites() error {
switch status := tx.Status(); status {
case choices.Unknown:
return errUnknownTx
case choices.Accepted:
return nil
case choices.Rejected:
return errRejectedTx
default:
return tx.SemanticVerify()
}
}
// Verify the validity of this transaction
func (tx *UniqueTx) Verify() error {
if err := tx.verifyWithoutCacheWrites(); err != nil {
return err
}
tx.verifiedState = true
tx.vm.pubsub.Publish("verified", tx.ID())
return nil
}
// SyntacticVerify verifies that this transaction is well formed
func (tx *UniqueTx) SyntacticVerify() error {
tx.refresh()
if tx.Tx == nil {
return errUnknownTx
}
if tx.verifiedTx {
return tx.validity
}
tx.verifiedTx = true
tx.validity = tx.Tx.SyntacticVerify(
tx.vm.ctx,
tx.vm.codec,
tx.vm.ctx.AVAXAssetID,
tx.vm.txFee,
tx.vm.creationTxFee,
len(tx.vm.fxs),
)
return tx.validity
}
// SemanticVerify the validity of this transaction
func (tx *UniqueTx) SemanticVerify() error {
// SyntacticVerify sets the error on validity and is checked in the next
// statement
_ = tx.SyntacticVerify()
if tx.validity != nil || tx.verifiedState {
return tx.validity
}
return tx.Tx.SemanticVerify(tx.vm, tx.UnsignedTx)
}