block

Documentation

Overview

Package block contains Neo block definition.

This is one of the core structures of Neo blockchain.

Index

• Constants
• Variables
• type Block
  • func New(stateRootEnabled bool) *Block
  • func NewBlockFromTrimmedBytes(stateRootEnabled bool, b []byte) (*Block, error)
  • func (b *Block) Compare(item queue.Item) int
  • func (b *Block) ComputeMerkleRoot() util.Uint256
  • func (b *Block) DecodeBinary(br *io.BinReader)
  • func (b *Block) EncodeBinary(bw *io.BinWriter)
  • func (b *Block) GetExpectedBlockSize() int
  • func (b *Block) GetExpectedBlockSizeWithoutTransactions(txCount int) int
  • func (b Block) MarshalJSON() ([]byte, error)
  • func (b *Block) RebuildMerkleRoot()
  • func (b *Block) Trim() ([]byte, error)
  • func (b *Block) UnmarshalJSON(data []byte) error
• type Header
  • func (b *Header) DecodeBinary(br *io.BinReader)
  • func (b *Header) EncodeBinary(bw *io.BinWriter)
  • func (b *Header) Hash() util.Uint256
  • func (b Header) MarshalJSON() ([]byte, error)
  • func (b *Header) UnmarshalJSON(data []byte) error

Constants

const (
	// MaxTransactionsPerBlock is the maximum number of transactions per block.
	MaxTransactionsPerBlock = math.MaxUint16
)

Variables

var ErrMaxContentsPerBlock = errors.New("the number of contents exceeds the maximum number of contents per block")

ErrMaxContentsPerBlock is returned when the maximum number of contents per block is reached.

Types

type Block

type Block struct {
	// The base of the block.
	Header

	// Transaction list.
	Transactions []*transaction.Transaction

	// True if this block is created from trimmed data.
	Trimmed bool
}

Block represents one block in the chain.

func New

func New(stateRootEnabled bool) *Block

New creates a new blank block with proper state root setting.

func NewBlockFromTrimmedBytes

func NewBlockFromTrimmedBytes(stateRootEnabled bool, b []byte) (*Block, error)

NewBlockFromTrimmedBytes returns a new block from trimmed data. This is commonly used to create a block from stored data. Blocks created from trimmed data will have their Trimmed field set to true.

func (*Block) Compare

func (b *Block) Compare(item queue.Item) int

Compare implements the queue Item interface.

func (*Block) ComputeMerkleRoot

func (b *Block) ComputeMerkleRoot() util.Uint256

ComputeMerkleRoot computes Merkle tree root hash based on actual block's data.

func (*Block) DecodeBinary

func (b *Block) DecodeBinary(br *io.BinReader)

DecodeBinary decodes the block from the given BinReader, implementing Serializable interface.

func (*Block) EncodeBinary

func (b *Block) EncodeBinary(bw *io.BinWriter)

EncodeBinary encodes the block to the given BinWriter, implementing Serializable interface.

func (*Block) GetExpectedBlockSize

func (b *Block) GetExpectedBlockSize() int

GetExpectedBlockSize returns expected block size which should be equal to io.GetVarSize(b).

func (*Block) GetExpectedBlockSizeWithoutTransactions

func (b *Block) GetExpectedBlockSizeWithoutTransactions(txCount int) int

GetExpectedBlockSizeWithoutTransactions returns expected block size without transactions size.

func (Block) MarshalJSON

func (b Block) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler interface.

func (*Block) RebuildMerkleRoot

func (b *Block) RebuildMerkleRoot()

RebuildMerkleRoot rebuilds the merkleroot of the block.

func (*Block) Trim

func (b *Block) Trim() ([]byte, error)

Trim returns a subset of the block data to save up space in storage. Notice that only the hashes of the transactions are stored.

func (*Block) UnmarshalJSON

func (b *Block) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json.Unmarshaler interface.

type Header

type Header struct {
	// Version of the block.
	Version uint32

	// hash of the previous block.
	PrevHash util.Uint256

	// Root hash of a transaction list.
	MerkleRoot util.Uint256

	// Timestamp is a millisecond-precision timestamp.
	// The time stamp of each block must be later than previous block's time stamp.
	// Generally the difference of two block's time stamp is about 15 seconds and imprecision is allowed.
	// The height of the block must be exactly equal to the height of the previous block plus 1.
	Timestamp uint64

	// Nonce is block random number.
	Nonce uint64

	// index/height of the block
	Index uint32

	// Contract address of the next miner
	NextConsensus util.Uint160

	// Script used to validate the block
	Script transaction.Witness

	// StateRootEnabled specifies if header contains state root.
	StateRootEnabled bool
	// PrevStateRoot is state root of the previous block.
	PrevStateRoot util.Uint256
	// PrimaryIndex is the index of primary consensus node for this block.
	PrimaryIndex byte
	// contains filtered or unexported fields
}

Header holds the base info of a block.

func (*Header) DecodeBinary

func (b *Header) DecodeBinary(br *io.BinReader)

DecodeBinary implements Serializable interface.

func (*Header) EncodeBinary

func (b *Header) EncodeBinary(bw *io.BinWriter)

EncodeBinary implements Serializable interface.

func (*Header) Hash

func (b *Header) Hash() util.Uint256

Hash returns the hash of the block.

func (Header) MarshalJSON

func (b Header) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler interface.

func (*Header) UnmarshalJSON

func (b *Header) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json.Unmarshaler interface.