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.Issuance:
 242                 computedAssetID := e.WitnessAssetDefinition.ComputeAssetID()
 243                 if computedAssetID != *e.Value.AssetId {
 244                         return errors.WithDetailf(ErrMismatchedAssetID, "asset ID is %x, issuance wants %x", computedAssetID.Bytes(), e.Value.AssetId.Bytes())
 245                 }
 246
 247                 gasLeft, err := vm.Verify(NewTxVMContext(vs, e, e.WitnessAssetDefinition.IssuanceProgram, e.WitnessArguments), vs.gasStatus.GasLeft)
 248                 if err != nil {
 249                         return errors.Wrap(err, "checking issuance program")
 250                 }
 251                 if err = vs.gasStatus.updateUsage(gasLeft); err != nil {
 252                         return err
 253                 }
 254
 255                 destVS := *vs
 256                 destVS.destPos = 0
 257                 if err = checkValidDest(&destVS, e.WitnessDestination); err != nil {
 258                         return errors.Wrap(err, "checking issuance destination")
 259                 }
 260
 261         case *bc.Spend:
 262                 if e.SpentOutputId == nil {
 263                         return errors.Wrap(ErrMissingField, "spend without spent output ID")
 264                 }
 265                 spentOutput, err := vs.tx.IntraChainOutput(*e.SpentOutputId)
 266                 if err != nil {
 267                         return errors.Wrap(err, "getting spend prevout")
 268                 }
 269
 270                 gasLeft, err := vm.Verify(NewTxVMContext(vs, e, spentOutput.ControlProgram, e.WitnessArguments), vs.gasStatus.GasLeft)
 271                 if err != nil {
 272                         return errors.Wrap(err, "checking control program")
 273                 }
 274                 if err = vs.gasStatus.updateUsage(gasLeft); err != nil {
 275                         return err
 276                 }
 277
 278                 eq, err := spentOutput.Source.Value.Equal(e.WitnessDestination.Value)
 279                 if err != nil {
 280                         return err
 281                 }
 282                 if !eq {
 283                         return errors.WithDetailf(
 284                                 ErrMismatchedValue,
 285                                 "previous output is for %d unit(s) of %x, spend wants %d unit(s) of %x",
 286                                 spentOutput.Source.Value.Amount,
 287                                 spentOutput.Source.Value.AssetId.Bytes(),
 288                                 e.WitnessDestination.Value.Amount,
 289                                 e.WitnessDestination.Value.AssetId.Bytes(),
 290                         )
 291                 }
 292
 293                 vs2 := *vs
 294                 vs2.destPos = 0
 295                 if err = checkValidDest(&vs2, e.WitnessDestination); err != nil {
 296                         return errors.Wrap(err, "checking spend destination")
 297                 }
 298
 299         case *bc.Coinbase:
 300                 if vs.block == nil || len(vs.block.Transactions) == 0 || vs.block.Transactions[0] != vs.tx {
 301                         return ErrWrongCoinbaseTransaction
 302                 }
 303
 304                 if *e.WitnessDestination.Value.AssetId != *consensus.BTMAssetID {
 305                         return ErrWrongCoinbaseAsset
 306                 }
 307
 308                 if e.Arbitrary != nil && len(e.Arbitrary) > consensus.CoinbaseArbitrarySizeLimit {
 309                         return ErrCoinbaseArbitraryOversize
 310                 }
 311
 312                 vs2 := *vs
 313                 vs2.destPos = 0
 314                 if err = checkValidDest(&vs2, e.WitnessDestination); err != nil {
 315                         return errors.Wrap(err, "checking coinbase destination")
 316                 }
 317                 vs.gasStatus.StorageGas = 0
 318
 319         default:
 320                 return fmt.Errorf("entry has unexpected type %T", e)
 321         }
 322
 323         return nil
 324 }
 325
 326 func checkValidSrc(vstate *validationState, vs *bc.ValueSource) error {
 327         if vs == nil {
 328                 return errors.Wrap(ErrMissingField, "empty value source")
 329         }
 330         if vs.Ref == nil {
 331                 return errors.Wrap(ErrMissingField, "missing ref on value source")
 332         }
 333         if vs.Value == nil || vs.Value.AssetId == nil {
 334                 return errors.Wrap(ErrMissingField, "missing value on value source")
 335         }
 336
 337         e, ok := vstate.tx.Entries[*vs.Ref]
 338         if !ok {
 339                 return errors.Wrapf(bc.ErrMissingEntry, "entry for value source %x not found", vs.Ref.Bytes())
 340         }
 341
 342         vstate2 := *vstate
 343         vstate2.entryID = *vs.Ref
 344         if err := checkValid(&vstate2, e); err != nil {
 345                 return errors.Wrap(err, "checking value source")
 346         }
 347
 348         var dest *bc.ValueDestination
 349         switch ref := e.(type) {
 350         case *bc.Coinbase:
 351                 if vs.Position != 0 {
 352                         return errors.Wrapf(ErrPosition, "invalid position %d for coinbase source", vs.Position)
 353                 }
 354                 dest = ref.WitnessDestination
 355
 356         case *bc.Issuance:
 357                 if vs.Position != 0 {
 358                         return errors.Wrapf(ErrPosition, "invalid position %d for issuance source", vs.Position)
 359                 }
 360                 dest = ref.WitnessDestination
 361
 362         case *bc.Spend:
 363                 if vs.Position != 0 {
 364                         return errors.Wrapf(ErrPosition, "invalid position %d for spend source", vs.Position)
 365                 }
 366                 dest = ref.WitnessDestination
 367
 368         case *bc.Mux:
 369                 if vs.Position >= uint64(len(ref.WitnessDestinations)) {
 370                         return errors.Wrapf(ErrPosition, "invalid position %d for %d-destination mux source", vs.Position, len(ref.WitnessDestinations))
 371                 }
 372                 dest = ref.WitnessDestinations[vs.Position]
 373
 374         default:
 375                 return errors.Wrapf(bc.ErrEntryType, "value source is %T, should be coinbase, issuance, spend, or mux", e)
 376         }
 377
 378         if dest.Ref == nil || *dest.Ref != vstate.entryID {
 379                 return errors.Wrapf(ErrMismatchedReference, "value source for %x has disagreeing destination %x", vstate.entryID.Bytes(), dest.Ref.Bytes())
 380         }
 381
 382         if dest.Position != vstate.sourcePos {
 383                 return errors.Wrapf(ErrMismatchedPosition, "value source position %d disagrees with %d", dest.Position, vstate.sourcePos)
 384         }
 385
 386         eq, err := dest.Value.Equal(vs.Value)
 387         if err != nil {
 388                 return errors.Sub(ErrMissingField, err)
 389         }
 390         if !eq {
 391                 return errors.Wrapf(ErrMismatchedValue, "source value %v disagrees with %v", dest.Value, vs.Value)
 392         }
 393
 394         return nil
 395 }
 396
 397 func checkValidDest(vs *validationState, vd *bc.ValueDestination) error {
 398         if vd == nil {
 399                 return errors.Wrap(ErrMissingField, "empty value destination")
 400         }
 401         if vd.Ref == nil {
 402                 return errors.Wrap(ErrMissingField, "missing ref on value destination")
 403         }
 404         if vd.Value == nil || vd.Value.AssetId == nil {
 405                 return errors.Wrap(ErrMissingField, "missing value on value destination")
 406         }
 407
 408         e, ok := vs.tx.Entries[*vd.Ref]
 409         if !ok {
 410                 return errors.Wrapf(bc.ErrMissingEntry, "entry for value destination %x not found", vd.Ref.Bytes())
 411         }
 412
 413         var src *bc.ValueSource
 414         switch ref := e.(type) {
 415         case *bc.IntraChainOutput:
 416                 if vd.Position != 0 {
 417                         return errors.Wrapf(ErrPosition, "invalid position %d for output destination", vd.Position)
 418                 }
 419                 src = ref.Source
 420
 421         case *bc.CrossChainOutput:
 422                 if vd.Position != 0 {
 423                         return errors.Wrapf(ErrPosition, "invalid position %d for output destination", vd.Position)
 424                 }
 425                 src = ref.Source
 426
 427         case *bc.VoteOutput:
 428                 if vd.Position != 0 {
 429                         return errors.Wrapf(ErrPosition, "invalid position %d for output destination", vd.Position)
 430                 }
 431                 src = ref.Source
 432
 433         case *bc.Retirement:
 434                 if vd.Position != 0 {
 435                         return errors.Wrapf(ErrPosition, "invalid position %d for retirement destination", vd.Position)
 436                 }
 437                 src = ref.Source
 438
 439         case *bc.Mux:
 440                 if vd.Position >= uint64(len(ref.Sources)) {
 441                         return errors.Wrapf(ErrPosition, "invalid position %d for %d-source mux destination", vd.Position, len(ref.Sources))
 442                 }
 443                 src = ref.Sources[vd.Position]
 444
 445         default:
 446                 return errors.Wrapf(bc.ErrEntryType, "value destination is %T, should be intra-chain/cross-chain output, retirement, or mux", e)
 447         }
 448
 449         if src.Ref == nil || *src.Ref != vs.entryID {
 450                 return errors.Wrapf(ErrMismatchedReference, "value destination for %x has disagreeing source %x", vs.entryID.Bytes(), src.Ref.Bytes())
 451         }
 452
 453         if src.Position != vs.destPos {
 454                 return errors.Wrapf(ErrMismatchedPosition, "value destination position %d disagrees with %d", src.Position, vs.destPos)
 455         }
 456
 457         eq, err := src.Value.Equal(vd.Value)
 458         if err != nil {
 459                 return errors.Sub(ErrMissingField, err)
 460         }
 461         if !eq {
 462                 return errors.Wrapf(ErrMismatchedValue, "destination value %v disagrees with %v", src.Value, vd.Value)
 463         }
 464
 465         return nil
 466 }
 467
 468 func checkStandardTx(tx *bc.Tx, blockHeight uint64) error {
 469         for _, id := range tx.InputIDs {
 470                 if blockHeight >= ruleAA && id.IsZero() {
 471                         return ErrEmptyInputIDs
 472                 }
 473         }
 474
 475         for _, id := range tx.GasInputIDs {
 476                 spend, err := tx.Spend(id)
 477                 if err != nil {
 478                         continue
 479                 }
 480
 481                 code := []byte{}
 482                 outputEntry, err := tx.Entry(*spend.SpentOutputId)
 483                 if err != nil {
 484                         return err
 485                 }
 486                 switch output := outputEntry.(type) {
 487                 case *bc.IntraChainOutput:
 488                         code = output.ControlProgram.Code
 489                 case *bc.VoteOutput:
 490                         code = output.ControlProgram.Code
 491                 default:
 492                         return errors.Wrapf(bc.ErrEntryType, "entry %x has unexpected type %T", id.Bytes(), outputEntry)
 493                 }
 494
 495                 if !segwit.IsP2WScript(code) {
 496                         return ErrNotStandardTx
 497                 }
 498         }
 499         return nil
 500 }
 501
 502 func checkTimeRange(tx *bc.Tx, block *bc.Block) error {
 503         if tx.TimeRange == 0 {
 504                 return nil
 505         }
 506
 507         if tx.TimeRange < block.Height {
 508                 return ErrBadTimeRange
 509         }
 510
 511         return nil
 512 }
 513
 514 // ValidateTx validates a transaction.
 515 func ValidateTx(tx *bc.Tx, block *bc.Block) (*GasState, error) {
 516         gasStatus := &GasState{GasValid: false}
 517         if block.Version == 1 && tx.Version != 1 {
 518                 return gasStatus, errors.WithDetailf(ErrTxVersion, "block version %d, transaction version %d", block.Version, tx.Version)
 519         }
 520         if tx.SerializedSize == 0 {
 521                 return gasStatus, ErrWrongTransactionSize
 522         }
 523         if err := checkTimeRange(tx, block); err != nil {
 524                 return gasStatus, err
 525         }
 526         if err := checkStandardTx(tx, block.Height); err != nil {
 527                 return gasStatus, err
 528         }
 529
 530         vs := &validationState{
 531                 block:     block,
 532                 tx:        tx,
 533                 entryID:   tx.ID,
 534                 gasStatus: gasStatus,
 535                 cache:     make(map[bc.Hash]error),
 536         }
 537         return vs.gasStatus, checkValid(vs, tx.TxHeader)
 538 }