prysm-pulse/sharding/collation.go
Raul Jordan eb9c82b581 sharding: full reorganization of collation struct, encoding, and tests pass
Former-commit-id: 0ba99518af6187fc0711a00748af2e32cbbf5108 [formerly 0db02c5e354fc61ab7468dfc7bff3821ee8926f8]
Former-commit-id: 2defc15718fbffbd4d10a1f32f02a75637493016
2018-05-09 17:25:27 -04:00

101 lines
3.2 KiB
Go

package sharding
import (
"math/big"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/core/types"
"github.com/ethereum/go-ethereum/crypto/sha3"
"github.com/ethereum/go-ethereum/rlp"
)
// Collation base struct.
type Collation struct {
header *CollationHeader
body []byte
transactions []*types.Transaction
}
// CollationHeader base struct.
type CollationHeader struct {
data collationHeaderData
}
type collationHeaderData struct {
ShardID *big.Int // the shard ID of the shard.
ChunkRoot *common.Hash // the root of the chunk tree which identifies collation body.
Period *big.Int // the period number in which collation to be Pncluded.
ProposerAddress *common.Address // address of the collation proposer.
ProposerSignature []byte // the proposer's signature for calculating collation hash.
}
// NewCollationHeader initializes a collation header struct.
func NewCollationHeader(shardID *big.Int, chunkRoot *common.Hash, period *big.Int, proposerAddress *common.Address, proposerSignature []byte) *CollationHeader {
data := collationHeaderData{
ShardID: shardID,
ChunkRoot: chunkRoot,
Period: period,
ProposerAddress: proposerAddress,
ProposerSignature: proposerSignature,
}
return &CollationHeader{data: data}
}
// Hash takes the keccak256 of the collation header's contents.
func (h *CollationHeader) Hash() (hash common.Hash) {
hw := sha3.NewKeccak256()
rlp.Encode(hw, h)
hw.Sum(hash[:0])
return hash
}
// ShardID is the identifier for a shard.
func (h *CollationHeader) ShardID() *big.Int { return h.data.ShardID }
// Period the collation corresponds to.
func (h *CollationHeader) Period() *big.Int { return h.data.Period }
// ChunkRoot of the serialized collation body.
func (h *CollationHeader) ChunkRoot() *common.Hash { return h.data.ChunkRoot }
// EncodeRLP gives an encoded representation of the collation header.
func (h *CollationHeader) EncodeRLP() ([]byte, error) {
encoded, err := rlp.EncodeToBytes(&h.data)
if err != nil {
return nil, err
}
return encoded, nil
}
// DecodeRLP uses an RLP Stream to populate the data field of a collation header.
func (h *CollationHeader) DecodeRLP(s *rlp.Stream) error {
err := s.Decode(&h.data)
return err
}
// Header returns the collation's header.
func (c *Collation) Header() *CollationHeader { return c.header }
// Body returns the collation's byte body.
func (c *Collation) Body() []byte { return c.body }
// Transactions returns an array of tx's in the collation.
func (c *Collation) Transactions() []*types.Transaction { return c.transactions }
// ProposerAddress is the coinbase addr of the creator for the collation.
func (c *Collation) ProposerAddress() *common.Address {
return c.header.data.ProposerAddress
}
// AddTransaction adds to the collation's body of tx blobs.
func (c *Collation) AddTransaction(tx *types.Transaction) {
// TODO: Include blob serialization instead.
c.transactions = append(c.transactions, tx)
}
// SetChunkRoot updates the collation header's chunk root.
func (c *Collation) SetChunkRoot() {
chunkRoot := common.BytesToHash(c.body)
c.header.data.ChunkRoot = &chunkRoot
}