blockchain

Documentation

Index

• Constants
• func DecodeValidators(encoded []byte, validators *Validators) error
• type Blockchain
  • func LoadOrNewBlockchain(db dbm.DB, genesisDoc *genesis.GenesisDoc, logger *logging.Logger) (*Blockchain, error)
  • func (bc *Blockchain) CommitBlock(blockTime time.Time, blockHash, appHash []byte) error
  • func (bc *Blockchain) Encode() ([]byte, error)
• type BlockchainInfo
• type PersistedState
  • func Decode(encodedState []byte) (*PersistedState, error)
• type Root
  • func NewRoot(genesisDoc *genesis.GenesisDoc) *Root
  • func (r *Root) GenesisDoc() genesis.GenesisDoc
  • func (r *Root) GenesisHash() []byte
• type Tip
  • func NewTip(chainID string, genesisTime time.Time, genesisHash []byte) *Tip
  • func (t *Tip) AppHashAfterLastBlock() []byte
  • func (t *Tip) ChainID() string
  • func (t *Tip) IterateValidators(iter func(publicKey crypto.PublicKey, power uint64) (stop bool)) (stopped bool)
  • func (t *Tip) LastBlockHash() []byte
  • func (t *Tip) LastBlockHeight() uint64
  • func (t *Tip) LastBlockTime() time.Time
  • func (t *Tip) NumValidators() int
• type TipInfo
• type Validators
  • func NewValidators() Validators
  • func (vs *Validators) AddPower(publicKey crypto.PublicKey, power uint64) error
  • func (vs *Validators) AlterPower(publicKey crypto.PublicKey, power uint64) error
  • func (vs *Validators) Encode() []byte
  • func (vs *Validators) Iterate(iter func(publicKey crypto.PublicKey, power uint64) (stop bool)) (stopped bool)
  • func (vs *Validators) Length() int
  • func (vs *Validators) SubtractPower(publicKey crypto.PublicKey, power uint64) error
  • func (vs *Validators) TotalPower() uint64
• type ValidatorsWindow
  • func NewValidatorsWindow(size int) ValidatorsWindow
  • func (vw *ValidatorsWindow) AlterPower(publicKey crypto.PublicKey, power uint64) error
  • func (vw *ValidatorsWindow) CommitInto(validatorsToUpdate *Validators) error

Constants

const DefaultValidatorsWindowSize = 10

Blocks to average validator power over

Functions

func DecodeValidators

func DecodeValidators(encoded []byte, validators *Validators) error

Decodes validators encoded with Encode - expects the exact encoded size with no trailing bytes

Types

type Blockchain

type Blockchain struct {
	*Root
	*Tip
	sync.RWMutex
	// contains filtered or unexported fields
}

func LoadOrNewBlockchain

func LoadOrNewBlockchain(db dbm.DB, genesisDoc *genesis.GenesisDoc,
	logger *logging.Logger) (*Blockchain, error)

func (*Blockchain) CommitBlock

func (bc *Blockchain) CommitBlock(blockTime time.Time, blockHash, appHash []byte) error

func (*Blockchain) Encode

func (bc *Blockchain) Encode() ([]byte, error)

type BlockchainInfo

type BlockchainInfo interface {
	TipInfo
	GenesisHash() []byte
	GenesisDoc() genesis.GenesisDoc
}

type PersistedState

type PersistedState struct {
	AppHashAfterLastBlock []byte
	LastBlockHeight       uint64
	GenesisDoc            genesis.GenesisDoc
}

func Decode

func Decode(encodedState []byte) (*PersistedState, error)

type Root

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

func NewRoot

func NewRoot(genesisDoc *genesis.GenesisDoc) *Root

func (*Root) GenesisDoc

func (r *Root) GenesisDoc() genesis.GenesisDoc

func (*Root) GenesisHash

func (r *Root) GenesisHash() []byte

type Tip

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

func NewTip

func NewTip(chainID string, genesisTime time.Time, genesisHash []byte) *Tip

Create genesis Tip

func (*Tip) AppHashAfterLastBlock

func (t *Tip) AppHashAfterLastBlock() []byte

func (*Tip) ChainID

func (t *Tip) ChainID() string

func (*Tip) IterateValidators

func (t *Tip) IterateValidators(iter func(publicKey crypto.PublicKey, power uint64) (stop bool)) (stopped bool)

func (*Tip) LastBlockHash

func (t *Tip) LastBlockHash() []byte

func (*Tip) LastBlockHeight

func (t *Tip) LastBlockHeight() uint64

func (*Tip) LastBlockTime

func (t *Tip) LastBlockTime() time.Time

func (*Tip) NumValidators

func (t *Tip) NumValidators() int

type TipInfo

type TipInfo interface {
	ChainID() string
	LastBlockHeight() uint64
	LastBlockTime() time.Time
	LastBlockHash() []byte
	AppHashAfterLastBlock() []byte
	IterateValidators(iter func(publicKey crypto.PublicKey, power uint64) (stop bool)) (stopped bool)
	NumValidators() int
}

type Validators

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

A Validator multiset

func NewValidators

func NewValidators() Validators

func (*Validators) AddPower

func (vs *Validators) AddPower(publicKey crypto.PublicKey, power uint64) error

func (*Validators) AlterPower

func (vs *Validators) AlterPower(publicKey crypto.PublicKey, power uint64) error

Add the power of a validator

func (*Validators) Encode

func (vs *Validators) Encode() []byte

Uses the fixed width public key encoding to

func (*Validators) Iterate

func (vs *Validators) Iterate(iter func(publicKey crypto.PublicKey, power uint64) (stop bool)) (stopped bool)

Iterates over validators sorted by address

func (*Validators) Length

func (vs *Validators) Length() int

func (*Validators) SubtractPower

func (vs *Validators) SubtractPower(publicKey crypto.PublicKey, power uint64) error

func (*Validators) TotalPower

func (vs *Validators) TotalPower() uint64

type ValidatorsWindow

type ValidatorsWindow struct {
	Buckets []Validators
	Total   Validators
	// contains filtered or unexported fields
}

func NewValidatorsWindow

func NewValidatorsWindow(size int) ValidatorsWindow

Provides a sliding window over the last size buckets of validator power changes

func (*ValidatorsWindow) AlterPower

func (vw *ValidatorsWindow) AlterPower(publicKey crypto.PublicKey, power uint64) error

Updates the current head bucket (accumulator)

func (*ValidatorsWindow) CommitInto

func (vw *ValidatorsWindow) CommitInto(validatorsToUpdate *Validators) error