protocol/validation/tx.go

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