protocol/bc/types/block_header.go

   1 package types
   2
   3 import (
   4         "encoding/hex"
   5         "fmt"
   6         "io"
   7         "time"
   8
   9         "github.com/bytom/bytom/encoding/blockchain"
  10         "github.com/bytom/bytom/encoding/bufpool"
  11         "github.com/bytom/bytom/errors"
  12         "github.com/bytom/bytom/protocol/bc"
  13 )
  14
  15 // BlockHeader defines information about a block and is used in the Bytom
  16 type BlockHeader struct {
  17         Version           uint64  // The version of the block.
  18         Height            uint64  // The height of the block.
  19         PreviousBlockHash bc.Hash // The hash of the previous block.
  20         Timestamp         uint64  // The time of the block in seconds.
  21         BlockWitness
  22         SupLinks
  23         BlockCommitment
  24 }
  25
  26 // Time returns the time represented by the Timestamp in block header.
  27 func (bh *BlockHeader) Time() time.Time {
  28         return time.Unix(int64(bh.Timestamp), 0).UTC()
  29 }
  30
  31 // Hash returns complete hash of the block header.
  32 func (bh *BlockHeader) Hash() bc.Hash {
  33         h, _ := mapBlockHeader(bh)
  34         return h
  35 }
  36
  37 // MarshalText fulfills the json.Marshaler interface. This guarantees that
  38 // block headers will get deserialized correctly when being parsed from HTTP
  39 // requests.
  40 func (bh *BlockHeader) MarshalText() ([]byte, error) {
  41         buf := bufpool.Get()
  42         defer bufpool.Put(buf)
  43
  44         if _, err := bh.WriteTo(buf); err != nil {
  45                 return nil, err
  46         }
  47
  48         enc := make([]byte, hex.EncodedLen(buf.Len()))
  49         hex.Encode(enc, buf.Bytes())
  50         return enc, nil
  51 }
  52
  53 // UnmarshalText fulfills the encoding.TextUnmarshaler interface.
  54 func (bh *BlockHeader) UnmarshalText(text []byte) error {
  55         decoded := make([]byte, hex.DecodedLen(len(text)))
  56         if _, err := hex.Decode(decoded, text); err != nil {
  57                 return err
  58         }
  59
  60         _, err := bh.readFrom(blockchain.NewReader(decoded))
  61         return err
  62 }
  63
  64 func (bh *BlockHeader) readFrom(r *blockchain.Reader) (serflag uint8, err error) {
  65         var serflags [1]byte
  66         io.ReadFull(r, serflags[:])
  67         serflag = serflags[0]
  68         switch serflag {
  69         case SerBlockHeader, SerBlockFull:
  70         default:
  71                 return 0, fmt.Errorf("unsupported serialization flags 0x%x", serflags)
  72         }
  73
  74         if bh.Version, err = blockchain.ReadVarint63(r); err != nil {
  75                 return 0, err
  76         }
  77
  78         if bh.Height, err = blockchain.ReadVarint63(r); err != nil {
  79                 return 0, err
  80         }
  81
  82         if _, err = bh.PreviousBlockHash.ReadFrom(r); err != nil {
  83                 return 0, err
  84         }
  85
  86         if bh.Timestamp, err = blockchain.ReadVarint63(r); err != nil {
  87                 return 0, err
  88         }
  89
  90         if _, err = blockchain.ReadExtensibleString(r, bh.BlockCommitment.readFrom); err != nil {
  91                 return 0, err
  92         }
  93
  94         if _, err = blockchain.ReadExtensibleString(r, bh.BlockWitness.readFrom); err != nil {
  95                 return 0, err
  96         }
  97
  98         if _, err = blockchain.ReadExtensibleString(r, bh.SupLinks.readFrom); err != nil {
  99                 return 0, err
 100         }
 101
 102         return
 103 }
 104
 105 // WriteTo writes the block header to the input io.Writer
 106 func (bh *BlockHeader) WriteTo(w io.Writer) (int64, error) {
 107         ew := errors.NewWriter(w)
 108         if err := bh.writeTo(ew, SerBlockHeader); err != nil {
 109                 return 0, err
 110         }
 111         return ew.Written(), ew.Err()
 112 }
 113
 114 func (bh *BlockHeader) writeTo(w io.Writer, serflags uint8) (err error) {
 115         w.Write([]byte{serflags})
 116         if _, err = blockchain.WriteVarint63(w, bh.Version); err != nil {
 117                 return err
 118         }
 119
 120         if _, err = blockchain.WriteVarint63(w, bh.Height); err != nil {
 121                 return err
 122         }
 123
 124         if _, err = bh.PreviousBlockHash.WriteTo(w); err != nil {
 125                 return err
 126         }
 127
 128         if _, err = blockchain.WriteVarint63(w, bh.Timestamp); err != nil {
 129                 return err
 130         }
 131
 132         if _, err = blockchain.WriteExtensibleString(w, nil, bh.BlockCommitment.writeTo); err != nil {
 133                 return err
 134         }
 135
 136         if _, err = blockchain.WriteExtensibleString(w, nil, bh.BlockWitness.writeTo); err != nil {
 137                 return err
 138         }
 139
 140         if _, err = blockchain.WriteExtensibleString(w, nil, bh.SupLinks.writeTo); err != nil {
 141                 return err
 142         }
 143
 144         return
 145 }