blockdata

Documentation

Overview

Package blockdata provides entire block data.

Index

• Variables
• func CheckBlock(db storage.Database, blockdata Blockdata, networkID base.NetworkID) (block.Manifest, error)
• func Clean(db storage.Database, blockdata Blockdata, remove bool) error
• func CleanByHeight(db storage.Database, blockdata Blockdata, height base.Height) error
• func ParseItemIndexLine(b []byte) (uint64, error)
• func ReadlinesWithIndex(r io.Reader, callbackHeader func([]byte) error, ...) error
• func WritelinesWithIndex(w io.Writer, getHeader func() ([]byte, error), ...) error
• type Blockdata
• type DefaultWriter
  • func NewDefaultWriter(enc encoder.Encoder) DefaultWriter
  • func (DefaultWriter) Hint() hint.Hint
  • func (bd DefaultWriter) ReadACCEPTVoteproof(r io.Reader) (base.Voteproof, error)
  • func (bd DefaultWriter) ReadINITVoteproof(r io.Reader) (base.Voteproof, error)
  • func (bd DefaultWriter) ReadManifest(r io.Reader) (block.Manifest, error)
  • func (bd DefaultWriter) ReadOperations(r io.Reader) ([]operation.Operation, error)
  • func (bd DefaultWriter) ReadOperationsTree(r io.Reader) (tree.FixedTree, error)
  • func (bd DefaultWriter) ReadProposal(r io.Reader) (base.SignedBallotFact, error)
  • func (bd DefaultWriter) ReadStates(r io.Reader) ([]state.State, error)
  • func (bd DefaultWriter) ReadStatesTree(r io.Reader) (tree.FixedTree, error)
  • func (bd DefaultWriter) ReadSuffrageInfo(r io.Reader) (block.SuffrageInfo, error)
  • func (bd DefaultWriter) WriteACCEPTVoteproof(w io.Writer, vp base.Voteproof) error
  • func (bd DefaultWriter) WriteINITVoteproof(w io.Writer, vp base.Voteproof) error
  • func (bd DefaultWriter) WriteManifest(w io.Writer, manifest block.Manifest) error
  • func (bd DefaultWriter) WriteOperations(w io.Writer, ops []operation.Operation) error
  • func (bd DefaultWriter) WriteOperationsTree(w io.Writer, tr tree.FixedTree) error
  • func (bd DefaultWriter) WriteProposal(w io.Writer, pr base.SignedBallotFact) error
  • func (bd DefaultWriter) WriteStates(w io.Writer, sts []state.State) error
  • func (bd DefaultWriter) WriteStatesTree(w io.Writer, tr tree.FixedTree) error
  • func (bd DefaultWriter) WriteSuffrageInfo(w io.Writer, si block.SuffrageInfo) error
• type ItemsHeader
• type Session
• type Writer

Variables

var (
	BlockdataWriterType = hint.Type("blockdata-writer")
	BlockdataWriterHint = hint.NewHint(BlockdataWriterType, "v0.0.1")
)

Functions

func CheckBlock

func CheckBlock(db storage.Database, blockdata Blockdata, networkID base.NetworkID) (block.Manifest, error)

func Clean

func Clean(db storage.Database, blockdata Blockdata, remove bool) error

Clean makes Database and Blockdata to be empty. If 'remove' is true, remove the Blockdata directory itself.

func CleanByHeight

func CleanByHeight(db storage.Database, blockdata Blockdata, height base.Height) error

func ParseItemIndexLine

func ParseItemIndexLine(b []byte) (uint64, error)

func ReadlinesWithIndex

func ReadlinesWithIndex(
	r io.Reader,
	callbackHeader func([]byte) error,
	callbackItem func(uint64, []byte) error,
	limit int64,
) error

func WritelinesWithIndex

func WritelinesWithIndex(
	w io.Writer,
	getHeader func() ([]byte, error),
	getItem func() (uint64, []byte, error),
) error

Types

type Blockdata

type Blockdata interface {
	hint.Hinter
	Initialize() error
	IsLocal() bool
	Exists(base.Height) (bool, error)
	Remove(base.Height) error
	RemoveAll(base.Height) error
	Clean(remove bool) error
	NewSession(base.Height) (Session, error)
	SaveSession(Session) (block.BlockdataMap, error)
	FS() fs.FS
	Writer() Writer
}

type DefaultWriter

type DefaultWriter struct {
	// contains filtered or unexported fields
}

func NewDefaultWriter

func NewDefaultWriter(enc encoder.Encoder) DefaultWriter

func (DefaultWriter) Hint

func (DefaultWriter) Hint() hint.Hint

func (DefaultWriter) ReadACCEPTVoteproof

func (bd DefaultWriter) ReadACCEPTVoteproof(r io.Reader) (base.Voteproof, error)

func (DefaultWriter) ReadINITVoteproof

func (bd DefaultWriter) ReadINITVoteproof(r io.Reader) (base.Voteproof, error)

func (DefaultWriter) ReadManifest

func (bd DefaultWriter) ReadManifest(r io.Reader) (block.Manifest, error)

func (DefaultWriter) ReadOperations

func (bd DefaultWriter) ReadOperations(r io.Reader) ([]operation.Operation, error)

func (DefaultWriter) ReadOperationsTree

func (bd DefaultWriter) ReadOperationsTree(r io.Reader) (tree.FixedTree, error)

func (DefaultWriter) ReadProposal

func (bd DefaultWriter) ReadProposal(r io.Reader) (base.SignedBallotFact, error)

func (DefaultWriter) ReadStates

func (bd DefaultWriter) ReadStates(r io.Reader) ([]state.State, error)

func (DefaultWriter) ReadStatesTree

func (bd DefaultWriter) ReadStatesTree(r io.Reader) (tree.FixedTree, error)

func (DefaultWriter) ReadSuffrageInfo

func (bd DefaultWriter) ReadSuffrageInfo(r io.Reader) (block.SuffrageInfo, error)

func (DefaultWriter) WriteACCEPTVoteproof

func (bd DefaultWriter) WriteACCEPTVoteproof(w io.Writer, vp base.Voteproof) error

func (DefaultWriter) WriteINITVoteproof

func (bd DefaultWriter) WriteINITVoteproof(w io.Writer, vp base.Voteproof) error

func (DefaultWriter) WriteManifest

func (bd DefaultWriter) WriteManifest(w io.Writer, manifest block.Manifest) error

func (DefaultWriter) WriteOperations

func (bd DefaultWriter) WriteOperations(w io.Writer, ops []operation.Operation) error

func (DefaultWriter) WriteOperationsTree

func (bd DefaultWriter) WriteOperationsTree(w io.Writer, tr tree.FixedTree) error

func (DefaultWriter) WriteProposal

func (bd DefaultWriter) WriteProposal(w io.Writer, pr base.SignedBallotFact) error

func (DefaultWriter) WriteStates

func (bd DefaultWriter) WriteStates(w io.Writer, sts []state.State) error

func (DefaultWriter) WriteStatesTree

func (bd DefaultWriter) WriteStatesTree(w io.Writer, tr tree.FixedTree) error

func (DefaultWriter) WriteSuffrageInfo

func (bd DefaultWriter) WriteSuffrageInfo(w io.Writer, si block.SuffrageInfo) error

type ItemsHeader

type ItemsHeader struct {
	Hint  hint.Hint `json:"hint"`
	Items uint64    `json:"items"`
}

type Session

type Session interface {
	Height() base.Height
	SetBlock(block.Block) error
	SetManifest(block.Manifest) error
	AddOperations(...operation.Operation) error
	CloseOperations() error
	SetOperationsTree(tree.FixedTree) error
	AddStates(...state.State) error
	CloseStates() error
	SetStatesTree(tree.FixedTree) error
	SetINITVoteproof(base.Voteproof) error
	SetACCEPTVoteproof(base.Voteproof) error
	SetSuffrageInfo(block.SuffrageInfo) error
	SetProposal(base.SignedBallotFact) error
	Import(string, io.Reader) (string, error)
	Cancel() error
}

type Writer

type Writer interface {
	hint.Hinter
	WriteManifest(io.Writer, block.Manifest) error
	WriteOperations(io.Writer, []operation.Operation) error
	WriteOperationsTree(io.Writer, tree.FixedTree) error
	WriteStates(io.Writer, []state.State) error
	WriteStatesTree(io.Writer, tree.FixedTree) error
	WriteINITVoteproof(io.Writer, base.Voteproof) error
	WriteACCEPTVoteproof(io.Writer, base.Voteproof) error
	WriteSuffrageInfo(io.Writer, block.SuffrageInfo) error
	WriteProposal(io.Writer, base.SignedBallotFact) error
	ReadManifest(io.Reader) (block.Manifest, error)
	ReadOperations(io.Reader) ([]operation.Operation, error)
	ReadOperationsTree(io.Reader) (tree.FixedTree, error)
	ReadStates(io.Reader) ([]state.State, error)
	ReadStatesTree(io.Reader) (tree.FixedTree, error)
	ReadINITVoteproof(io.Reader) (base.Voteproof, error)
	ReadACCEPTVoteproof(io.Reader) (base.Voteproof, error)
	ReadSuffrageInfo(io.Reader) (block.SuffrageInfo, error)
	ReadProposal(io.Reader) (base.SignedBallotFact, error)
}