OSDN Git Service

feature: add cross-chain input (#61)
[bytom/vapor.git] / protocol / validation / tx.go
1 package validation
2
3 import (
4         "fmt"
5         "math"
6
7         "github.com/vapor/consensus"
8         "github.com/vapor/consensus/segwit"
9         "github.com/vapor/errors"
10         "github.com/vapor/math/checked"
11         "github.com/vapor/protocol/bc"
12         "github.com/vapor/protocol/vm"
13 )
14
15 const ruleAA = 142500
16
17 // validate transaction error
18 var (
19         ErrTxVersion                 = errors.New("invalid transaction version")
20         ErrWrongTransactionSize      = errors.New("invalid transaction size")
21         ErrBadTimeRange              = errors.New("invalid transaction time range")
22         ErrEmptyInputIDs             = errors.New("got the empty InputIDs")
23         ErrNotStandardTx             = errors.New("not standard transaction")
24         ErrWrongCoinbaseTransaction  = errors.New("wrong coinbase transaction")
25         ErrWrongCoinbaseAsset        = errors.New("wrong coinbase assetID")
26         ErrCoinbaseArbitraryOversize = errors.New("coinbase arbitrary size is larger than limit")
27         ErrEmptyResults              = errors.New("transaction has no results")
28         ErrMismatchedAssetID         = errors.New("mismatched assetID")
29         ErrMismatchedPosition        = errors.New("mismatched value source/dest position")
30         ErrMismatchedReference       = errors.New("mismatched reference")
31         ErrMismatchedValue           = errors.New("mismatched value")
32         ErrMissingField              = errors.New("missing required field")
33         ErrNoSource                  = errors.New("no source for value")
34         ErrOverflow                  = errors.New("arithmetic overflow/underflow")
35         ErrPosition                  = errors.New("invalid source or destination position")
36         ErrUnbalanced                = errors.New("unbalanced asset amount between input and output")
37         ErrOverGasCredit             = errors.New("all gas credit has been spend")
38         ErrGasCalculate              = errors.New("gas usage calculate got a math error")
39 )
40
41 // GasState record the gas usage status
42 type GasState struct {
43         BTMValue   uint64
44         GasLeft    int64
45         GasUsed    int64
46         GasValid   bool
47         StorageGas int64
48 }
49
50 func (g *GasState) setGas(BTMValue int64, txSize int64) error {
51         if BTMValue < 0 {
52                 return errors.Wrap(ErrGasCalculate, "input BTM is negative")
53         }
54
55         g.BTMValue = uint64(BTMValue)
56
57         var ok bool
58         if g.GasLeft, ok = checked.DivInt64(BTMValue, consensus.VMGasRate); !ok {
59                 return errors.Wrap(ErrGasCalculate, "setGas calc gas amount")
60         }
61
62         if g.GasLeft > consensus.MaxGasAmount {
63                 g.GasLeft = consensus.MaxGasAmount
64         }
65
66         if g.StorageGas, ok = checked.MulInt64(txSize, consensus.StorageGasRate); !ok {
67                 return errors.Wrap(ErrGasCalculate, "setGas calc tx storage gas")
68         }
69         return nil
70 }
71
72 func (g *GasState) setGasValid() error {
73         var ok bool
74         if g.GasLeft, ok = checked.SubInt64(g.GasLeft, g.StorageGas); !ok || g.GasLeft < 0 {
75                 return errors.Wrap(ErrGasCalculate, "setGasValid calc gasLeft")
76         }
77
78         if g.GasUsed, ok = checked.AddInt64(g.GasUsed, g.StorageGas); !ok {
79                 return errors.Wrap(ErrGasCalculate, "setGasValid calc gasUsed")
80         }
81
82         g.GasValid = true
83         return nil
84 }
85
86 func (g *GasState) updateUsage(gasLeft int64) error {
87         if gasLeft < 0 {
88                 return errors.Wrap(ErrGasCalculate, "updateUsage input negative gas")
89         }
90
91         if gasUsed, ok := checked.SubInt64(g.GasLeft, gasLeft); ok {
92                 g.GasUsed += gasUsed
93                 g.GasLeft = gasLeft
94         } else {
95                 return errors.Wrap(ErrGasCalculate, "updateUsage calc gas diff")
96         }
97
98         if !g.GasValid && (g.GasUsed > consensus.DefaultGasCredit || g.StorageGas > g.GasLeft) {
99                 return ErrOverGasCredit
100         }
101         return nil
102 }
103
104 // validationState contains the context that must propagate through
105 // the transaction graph when validating entries.
106 type validationState struct {
107         block     *bc.Block
108         tx        *bc.Tx
109         gasStatus *GasState
110         entryID   bc.Hash           // The ID of the nearest enclosing entry
111         sourcePos uint64            // The source position, for validate ValueSources
112         destPos   uint64            // The destination position, for validate ValueDestinations
113         cache     map[bc.Hash]error // Memoized per-entry validation results
114 }
115
116 func checkValid(vs *validationState, e bc.Entry) (err error) {
117         var ok bool
118         entryID := bc.EntryID(e)
119         if err, ok = vs.cache[entryID]; ok {
120                 return err
121         }
122
123         defer func() {
124                 vs.cache[entryID] = err
125         }()
126
127         switch e := e.(type) {
128         case *bc.TxHeader:
129                 for i, resID := range e.ResultIds {
130                         resultEntry := vs.tx.Entries[*resID]
131                         vs2 := *vs
132                         vs2.entryID = *resID
133                         if err = checkValid(&vs2, resultEntry); err != nil {
134                                 return errors.Wrapf(err, "checking result %d", i)
135                         }
136                 }
137
138                 if e.Version == 1 && len(e.ResultIds) == 0 {
139                         return ErrEmptyResults
140                 }
141
142         case *bc.Mux:
143                 parity := make(map[bc.AssetID]int64)
144                 for i, src := range e.Sources {
145                         if src.Value.Amount > math.MaxInt64 {
146                                 return errors.WithDetailf(ErrOverflow, "amount %d exceeds maximum value 2^63", src.Value.Amount)
147                         }
148                         sum, ok := checked.AddInt64(parity[*src.Value.AssetId], int64(src.Value.Amount))
149                         if !ok {
150                                 return errors.WithDetailf(ErrOverflow, "adding %d units of asset %x from mux source %d to total %d overflows int64", src.Value.Amount, src.Value.AssetId.Bytes(), i, parity[*src.Value.AssetId])
151                         }
152                         parity[*src.Value.AssetId] = sum
153                 }
154
155                 for i, dest := range e.WitnessDestinations {
156                         sum, ok := parity[*dest.Value.AssetId]
157                         if !ok {
158                                 return errors.WithDetailf(ErrNoSource, "mux destination %d, asset %x, has no corresponding source", i, dest.Value.AssetId.Bytes())
159                         }
160                         if dest.Value.Amount > math.MaxInt64 {
161                                 return errors.WithDetailf(ErrOverflow, "amount %d exceeds maximum value 2^63", dest.Value.Amount)
162                         }
163                         diff, ok := checked.SubInt64(sum, int64(dest.Value.Amount))
164                         if !ok {
165                                 return errors.WithDetailf(ErrOverflow, "subtracting %d units of asset %x from mux destination %d from total %d underflows int64", dest.Value.Amount, dest.Value.AssetId.Bytes(), i, sum)
166                         }
167                         parity[*dest.Value.AssetId] = diff
168                 }
169
170                 for assetID, amount := range parity {
171                         if assetID == *consensus.BTMAssetID {
172                                 if err = vs.gasStatus.setGas(amount, int64(vs.tx.SerializedSize)); err != nil {
173                                         return err
174                                 }
175                         } else if amount != 0 {
176                                 return errors.WithDetailf(ErrUnbalanced, "asset %x sources - destinations = %d (should be 0)", assetID.Bytes(), amount)
177                         }
178                 }
179
180                 for _, BTMInputID := range vs.tx.GasInputIDs {
181                         e, ok := vs.tx.Entries[BTMInputID]
182                         if !ok {
183                                 return errors.Wrapf(bc.ErrMissingEntry, "entry for bytom input %x not found", BTMInputID)
184                         }
185
186                         vs2 := *vs
187                         vs2.entryID = BTMInputID
188                         if err := checkValid(&vs2, e); err != nil {
189                                 return errors.Wrap(err, "checking gas input")
190                         }
191                 }
192
193                 for i, dest := range e.WitnessDestinations {
194                         vs2 := *vs
195                         vs2.destPos = uint64(i)
196                         if err = checkValidDest(&vs2, dest); err != nil {
197                                 return errors.Wrapf(err, "checking mux destination %d", i)
198                         }
199                 }
200
201                 if err := vs.gasStatus.setGasValid(); err != nil {
202                         return err
203                 }
204
205                 for i, src := range e.Sources {
206                         vs2 := *vs
207                         vs2.sourcePos = uint64(i)
208                         if err = checkValidSrc(&vs2, src); err != nil {
209                                 return errors.Wrapf(err, "checking mux source %d", i)
210                         }
211                 }
212
213         case *bc.IntraChainOutput:
214                 vs2 := *vs
215                 vs2.sourcePos = 0
216                 if err = checkValidSrc(&vs2, e.Source); err != nil {
217                         return errors.Wrap(err, "checking output source")
218                 }
219
220         case *bc.CrossChainOutput:
221                 vs2 := *vs
222                 vs2.sourcePos = 0
223                 if err = checkValidSrc(&vs2, e.Source); err != nil {
224                         return errors.Wrap(err, "checking output source")
225                 }
226
227         case *bc.VoteOutput:
228                 vs2 := *vs
229                 vs2.sourcePos = 0
230                 if err = checkValidSrc(&vs2, e.Source); err != nil {
231                         return errors.Wrap(err, "checking output source")
232                 }
233
234         case *bc.Retirement:
235                 vs2 := *vs
236                 vs2.sourcePos = 0
237                 if err = checkValidSrc(&vs2, e.Source); err != nil {
238                         return errors.Wrap(err, "checking retirement source")
239                 }
240
241         case *bc.CrossChainInput:
242                 _, err := vm.Verify(NewTxVMContext(vs, e, e.ControlProgram, e.WitnessArguments), consensus.DefaultGasCredit)
243                 if err != nil {
244                         return errors.Wrap(err, "checking cross-chain input control program")
245                 }
246
247                 vs2 := *vs
248                 vs2.destPos = 0
249                 if err = checkValidDest(&vs2, e.WitnessDestination); err != nil {
250                         return errors.Wrap(err, "checking cross-chain input destination")
251                 }
252
253         case *bc.Spend:
254                 if e.SpentOutputId == nil {
255                         return errors.Wrap(ErrMissingField, "spend without spent output ID")
256                 }
257                 spentOutput, err := vs.tx.IntraChainOutput(*e.SpentOutputId)
258                 if err != nil {
259                         return errors.Wrap(err, "getting spend prevout")
260                 }
261                 gasLeft, err := vm.Verify(NewTxVMContext(vs, e, spentOutput.ControlProgram, e.WitnessArguments), vs.gasStatus.GasLeft)
262                 if err != nil {
263                         return errors.Wrap(err, "checking control program")
264                 }
265                 if err = vs.gasStatus.updateUsage(gasLeft); err != nil {
266                         return err
267                 }
268                 eq, err := spentOutput.Source.Value.Equal(e.WitnessDestination.Value)
269                 if err != nil {
270                         return err
271                 }
272                 if !eq {
273                         return errors.WithDetailf(
274                                 ErrMismatchedValue,
275                                 "previous output is for %d unit(s) of %x, spend wants %d unit(s) of %x",
276                                 spentOutput.Source.Value.Amount,
277                                 spentOutput.Source.Value.AssetId.Bytes(),
278                                 e.WitnessDestination.Value.Amount,
279                                 e.WitnessDestination.Value.AssetId.Bytes(),
280                         )
281                 }
282                 vs2 := *vs
283                 vs2.destPos = 0
284                 if err = checkValidDest(&vs2, e.WitnessDestination); err != nil {
285                         return errors.Wrap(err, "checking spend destination")
286                 }
287
288         case *bc.Coinbase:
289                 if vs.block == nil || len(vs.block.Transactions) == 0 || vs.block.Transactions[0] != vs.tx {
290                         return ErrWrongCoinbaseTransaction
291                 }
292
293                 if *e.WitnessDestination.Value.AssetId != *consensus.BTMAssetID {
294                         return ErrWrongCoinbaseAsset
295                 }
296
297                 if e.Arbitrary != nil && len(e.Arbitrary) > consensus.CoinbaseArbitrarySizeLimit {
298                         return ErrCoinbaseArbitraryOversize
299                 }
300
301                 vs2 := *vs
302                 vs2.destPos = 0
303                 if err = checkValidDest(&vs2, e.WitnessDestination); err != nil {
304                         return errors.Wrap(err, "checking coinbase destination")
305                 }
306                 vs.gasStatus.StorageGas = 0
307
308         default:
309                 return fmt.Errorf("entry has unexpected type %T", e)
310         }
311
312         return nil
313 }
314
315 func checkValidSrc(vstate *validationState, vs *bc.ValueSource) error {
316         if vs == nil {
317                 return errors.Wrap(ErrMissingField, "empty value source")
318         }
319         if vs.Ref == nil {
320                 return errors.Wrap(ErrMissingField, "missing ref on value source")
321         }
322         if vs.Value == nil || vs.Value.AssetId == nil {
323                 return errors.Wrap(ErrMissingField, "missing value on value source")
324         }
325
326         e, ok := vstate.tx.Entries[*vs.Ref]
327         if !ok {
328                 return errors.Wrapf(bc.ErrMissingEntry, "entry for value source %x not found", vs.Ref.Bytes())
329         }
330
331         vstate2 := *vstate
332         vstate2.entryID = *vs.Ref
333         if err := checkValid(&vstate2, e); err != nil {
334                 return errors.Wrap(err, "checking value source")
335         }
336
337         var dest *bc.ValueDestination
338         switch ref := e.(type) {
339         case *bc.Coinbase:
340                 if vs.Position != 0 {
341                         return errors.Wrapf(ErrPosition, "invalid position %d for coinbase source", vs.Position)
342                 }
343                 dest = ref.WitnessDestination
344
345         case *bc.CrossChainInput:
346                 if vs.Position != 0 {
347                         return errors.Wrapf(ErrPosition, "invalid position %d for cross-chain input source", vs.Position)
348                 }
349                 dest = ref.WitnessDestination
350
351         case *bc.Spend:
352                 if vs.Position != 0 {
353                         return errors.Wrapf(ErrPosition, "invalid position %d for spend source", vs.Position)
354                 }
355                 dest = ref.WitnessDestination
356
357         case *bc.Mux:
358                 if vs.Position >= uint64(len(ref.WitnessDestinations)) {
359                         return errors.Wrapf(ErrPosition, "invalid position %d for %d-destination mux source", vs.Position, len(ref.WitnessDestinations))
360                 }
361                 dest = ref.WitnessDestinations[vs.Position]
362
363         default:
364                 return errors.Wrapf(bc.ErrEntryType, "value source is %T, should be coinbase, cross-chain input, spend, or mux", e)
365         }
366
367         if dest.Ref == nil || *dest.Ref != vstate.entryID {
368                 return errors.Wrapf(ErrMismatchedReference, "value source for %x has disagreeing destination %x", vstate.entryID.Bytes(), dest.Ref.Bytes())
369         }
370
371         if dest.Position != vstate.sourcePos {
372                 return errors.Wrapf(ErrMismatchedPosition, "value source position %d disagrees with %d", dest.Position, vstate.sourcePos)
373         }
374
375         eq, err := dest.Value.Equal(vs.Value)
376         if err != nil {
377                 return errors.Sub(ErrMissingField, err)
378         }
379         if !eq {
380                 return errors.Wrapf(ErrMismatchedValue, "source value %v disagrees with %v", dest.Value, vs.Value)
381         }
382
383         return nil
384 }
385
386 func checkValidDest(vs *validationState, vd *bc.ValueDestination) error {
387         if vd == nil {
388                 return errors.Wrap(ErrMissingField, "empty value destination")
389         }
390         if vd.Ref == nil {
391                 return errors.Wrap(ErrMissingField, "missing ref on value destination")
392         }
393         if vd.Value == nil || vd.Value.AssetId == nil {
394                 return errors.Wrap(ErrMissingField, "missing value on value destination")
395         }
396
397         e, ok := vs.tx.Entries[*vd.Ref]
398         if !ok {
399                 return errors.Wrapf(bc.ErrMissingEntry, "entry for value destination %x not found", vd.Ref.Bytes())
400         }
401
402         var src *bc.ValueSource
403         switch ref := e.(type) {
404         case *bc.IntraChainOutput:
405                 if vd.Position != 0 {
406                         return errors.Wrapf(ErrPosition, "invalid position %d for output destination", vd.Position)
407                 }
408                 src = ref.Source
409
410         case *bc.CrossChainOutput:
411                 if vd.Position != 0 {
412                         return errors.Wrapf(ErrPosition, "invalid position %d for output destination", vd.Position)
413                 }
414                 src = ref.Source
415
416         case *bc.VoteOutput:
417                 if vd.Position != 0 {
418                         return errors.Wrapf(ErrPosition, "invalid position %d for output destination", vd.Position)
419                 }
420                 src = ref.Source
421
422         case *bc.Retirement:
423                 if vd.Position != 0 {
424                         return errors.Wrapf(ErrPosition, "invalid position %d for retirement destination", vd.Position)
425                 }
426                 src = ref.Source
427
428         case *bc.Mux:
429                 if vd.Position >= uint64(len(ref.Sources)) {
430                         return errors.Wrapf(ErrPosition, "invalid position %d for %d-source mux destination", vd.Position, len(ref.Sources))
431                 }
432                 src = ref.Sources[vd.Position]
433
434         default:
435                 return errors.Wrapf(bc.ErrEntryType, "value destination is %T, should be intra-chain/cross-chain output, retirement, or mux", e)
436         }
437
438         if src.Ref == nil || *src.Ref != vs.entryID {
439                 return errors.Wrapf(ErrMismatchedReference, "value destination for %x has disagreeing source %x", vs.entryID.Bytes(), src.Ref.Bytes())
440         }
441
442         if src.Position != vs.destPos {
443                 return errors.Wrapf(ErrMismatchedPosition, "value destination position %d disagrees with %d", src.Position, vs.destPos)
444         }
445
446         eq, err := src.Value.Equal(vd.Value)
447         if err != nil {
448                 return errors.Sub(ErrMissingField, err)
449         }
450         if !eq {
451                 return errors.Wrapf(ErrMismatchedValue, "destination value %v disagrees with %v", src.Value, vd.Value)
452         }
453
454         return nil
455 }
456
457 func checkStandardTx(tx *bc.Tx, blockHeight uint64) error {
458         for _, id := range tx.InputIDs {
459                 if blockHeight >= ruleAA && id.IsZero() {
460                         return ErrEmptyInputIDs
461                 }
462         }
463
464         for _, id := range tx.GasInputIDs {
465                 spend, err := tx.Spend(id)
466                 if err != nil {
467                         continue
468                 }
469
470                 code := []byte{}
471                 outputEntry, err := tx.Entry(*spend.SpentOutputId)
472                 if err != nil {
473                         return err
474                 }
475                 switch output := outputEntry.(type) {
476                 case *bc.IntraChainOutput:
477                         code = output.ControlProgram.Code
478                 case *bc.VoteOutput:
479                         code = output.ControlProgram.Code
480                 default:
481                         return errors.Wrapf(bc.ErrEntryType, "entry %x has unexpected type %T", id.Bytes(), outputEntry)
482                 }
483
484                 if !segwit.IsP2WScript(code) {
485                         return ErrNotStandardTx
486                 }
487         }
488         return nil
489 }
490
491 func checkTimeRange(tx *bc.Tx, block *bc.Block) error {
492         if tx.TimeRange == 0 {
493                 return nil
494         }
495
496         if tx.TimeRange < block.Height {
497                 return ErrBadTimeRange
498         }
499
500         return nil
501 }
502
503 // ValidateTx validates a transaction.
504 func ValidateTx(tx *bc.Tx, block *bc.Block) (*GasState, error) {
505         gasStatus := &GasState{GasValid: false}
506         if block.Version == 1 && tx.Version != 1 {
507                 return gasStatus, errors.WithDetailf(ErrTxVersion, "block version %d, transaction version %d", block.Version, tx.Version)
508         }
509         if tx.SerializedSize == 0 {
510                 return gasStatus, ErrWrongTransactionSize
511         }
512         if err := checkTimeRange(tx, block); err != nil {
513                 return gasStatus, err
514         }
515         if err := checkStandardTx(tx, block.Height); err != nil {
516                 return gasStatus, err
517         }
518
519         vs := &validationState{
520                 block:     block,
521                 tx:        tx,
522                 entryID:   tx.ID,
523                 gasStatus: gasStatus,
524                 cache:     make(map[bc.Hash]error),
525         }
526         return vs.gasStatus, checkValid(vs, tx.TxHeader)
527 }