protocol/bc/types/transaction.go

   1 package types
   2
   3 import (
   4         "bytes"
   5         "encoding/hex"
   6         "fmt"
   7         "io"
   8
   9         "github.com/vapor/encoding/blockchain"
  10         "github.com/vapor/errors"
  11         "github.com/vapor/protocol/bc"
  12 )
  13
  14 const serRequired = 0x7 // Bit mask accepted serialization flag.
  15
  16 // Tx holds a transaction along with its hash.
  17 type Tx struct {
  18         TxData
  19         *bc.Tx `json:"-"`
  20 }
  21
  22 // NewTx returns a new Tx containing data and its hash. If you have already
  23 // computed the hash, use struct literal notation to make a Tx object directly.
  24 func NewTx(data TxData) *Tx {
  25         return &Tx{
  26                 TxData: data,
  27                 Tx:     MapTx(&data),
  28         }
  29 }
  30
  31 // OutputID return the hash of the output position
  32 func (tx *Tx) OutputID(outputIndex int) *bc.Hash {
  33         return tx.ResultIds[outputIndex]
  34 }
  35
  36 // UnmarshalText fulfills the encoding.TextUnmarshaler interface.
  37 func (tx *Tx) UnmarshalText(p []byte) error {
  38         if err := tx.TxData.UnmarshalText(p); err != nil {
  39                 return err
  40         }
  41
  42         tx.Tx = MapTx(&tx.TxData)
  43         return nil
  44 }
  45
  46 // SetInputArguments sets the Arguments field in input n.
  47 func (tx *Tx) SetInputArguments(n uint32, args [][]byte) {
  48         tx.Inputs[n].SetArguments(args)
  49         id := tx.Tx.InputIDs[n]
  50         e := tx.Entries[id]
  51         switch e := e.(type) {
  52         case *bc.Spend:
  53                 e.WitnessArguments = args
  54         }
  55 }
  56
  57 // TxData encodes a transaction in the blockchain.
  58 type TxData struct {
  59         Version        uint64
  60         SerializedSize uint64
  61         TimeRange      uint64
  62         Inputs         []*TxInput
  63         Outputs        []*TxOutput
  64 }
  65
  66 // MarshalText fulfills the json.Marshaler interface.
  67 func (tx *TxData) MarshalText() ([]byte, error) {
  68         var buf bytes.Buffer
  69         if _, err := tx.WriteTo(&buf); err != nil {
  70                 return nil, err
  71         }
  72
  73         b := make([]byte, hex.EncodedLen(buf.Len()))
  74         hex.Encode(b, buf.Bytes())
  75         return b, nil
  76 }
  77
  78 // UnmarshalText fulfills the encoding.TextUnmarshaler interface.
  79 func (tx *TxData) UnmarshalText(p []byte) error {
  80         b := make([]byte, hex.DecodedLen(len(p)))
  81         if _, err := hex.Decode(b, p); err != nil {
  82                 return err
  83         }
  84
  85         r := blockchain.NewReader(b)
  86         if err := tx.readFrom(r); err != nil {
  87                 return err
  88         }
  89
  90         if trailing := r.Len(); trailing > 0 {
  91                 return fmt.Errorf("trailing garbage (%d bytes)", trailing)
  92         }
  93         return nil
  94 }
  95
  96 func (tx *TxData) readFrom(r *blockchain.Reader) (err error) {
  97         startSerializedSize := r.Len()
  98         var serflags [1]byte
  99         if _, err = io.ReadFull(r, serflags[:]); err != nil {
 100                 return errors.Wrap(err, "reading serialization flags")
 101         }
 102         if serflags[0] != serRequired {
 103                 return fmt.Errorf("unsupported serflags %#x", serflags[0])
 104         }
 105
 106         if tx.Version, err = blockchain.ReadVarint63(r); err != nil {
 107                 return errors.Wrap(err, "reading transaction version")
 108         }
 109         if tx.TimeRange, err = blockchain.ReadVarint63(r); err != nil {
 110                 return err
 111         }
 112
 113         n, err := blockchain.ReadVarint31(r)
 114         if err != nil {
 115                 return errors.Wrap(err, "reading number of transaction inputs")
 116         }
 117
 118         for ; n > 0; n-- {
 119                 ti := new(TxInput)
 120                 if err = ti.readFrom(r); err != nil {
 121                         return errors.Wrapf(err, "reading input %d", len(tx.Inputs))
 122                 }
 123                 tx.Inputs = append(tx.Inputs, ti)
 124         }
 125
 126         n, err = blockchain.ReadVarint31(r)
 127         if err != nil {
 128                 return errors.Wrap(err, "reading number of transaction outputs")
 129         }
 130
 131         for ; n > 0; n-- {
 132                 to := new(TxOutput)
 133                 if err = to.readFrom(r); err != nil {
 134                         return errors.Wrapf(err, "reading output %d", len(tx.Outputs))
 135                 }
 136                 tx.Outputs = append(tx.Outputs, to)
 137         }
 138         tx.SerializedSize = uint64(startSerializedSize - r.Len())
 139         return nil
 140 }
 141
 142 // WriteTo writes tx to w.
 143 func (tx *TxData) WriteTo(w io.Writer) (int64, error) {
 144         ew := errors.NewWriter(w)
 145         if err := tx.writeTo(ew, serRequired); err != nil {
 146                 return 0, err
 147         }
 148         return ew.Written(), ew.Err()
 149 }
 150
 151 func (tx *TxData) writeTo(w io.Writer, serflags byte) error {
 152         if _, err := w.Write([]byte{serflags}); err != nil {
 153                 return errors.Wrap(err, "writing serialization flags")
 154         }
 155         if _, err := blockchain.WriteVarint63(w, tx.Version); err != nil {
 156                 return errors.Wrap(err, "writing transaction version")
 157         }
 158         if _, err := blockchain.WriteVarint63(w, tx.TimeRange); err != nil {
 159                 return errors.Wrap(err, "writing transaction maxtime")
 160         }
 161
 162         if _, err := blockchain.WriteVarint31(w, uint64(len(tx.Inputs))); err != nil {
 163                 return errors.Wrap(err, "writing tx input count")
 164         }
 165
 166         for i, ti := range tx.Inputs {
 167                 if err := ti.writeTo(w); err != nil {
 168                         return errors.Wrapf(err, "writing tx input %d", i)
 169                 }
 170         }
 171
 172         if _, err := blockchain.WriteVarint31(w, uint64(len(tx.Outputs))); err != nil {
 173                 return errors.Wrap(err, "writing tx output count")
 174         }
 175
 176         for i, to := range tx.Outputs {
 177                 if err := to.writeTo(w); err != nil {
 178                         return errors.Wrapf(err, "writing tx output %d", i)
 179                 }
 180         }
 181         return nil
 182 }