rootchain

Documentation

Index

• Constants
• Variables
• func GetPublicKeyAndVerifier(signer crypto.Signer) ([]byte, crypto.Verifier, error)
• func NewDistributedRootGenesis(rootGenesis []*genesis.RootGenesis) (*genesis.RootGenesis, []*genesis.PartitionGenesis, error)
• func NewPartitionRecordFromNodes(nodes []*genesis.PartitionNode) ([]*genesis.PartitionRecord, error)
• func NewRootGenesis(id string, s crypto.Signer, encPubKey []byte, ...) (*genesis.RootGenesis, []*genesis.PartitionGenesis, error)
• type CertRequestStore
  • func NewCertificationRequestStore() *CertRequestStore
  • func (c *CertRequestStore) Add(request *certification.BlockCertificationRequest) error
  • func (c *CertRequestStore) Clear(id p.SystemIdentifier)
  • func (c *CertRequestStore) GetRequests(id p.SystemIdentifier) []*certification.BlockCertificationRequest
  • func (c *CertRequestStore) IsConsensusReceived(id p.SystemIdentifier, nrOfNodes int) (*certificates.InputRecord, bool)
  • func (c *CertRequestStore) Reset()
• type CertificationRequestStore
• type GenesisOption
  • func WithBlockRate(rate uint32) GenesisOption
  • func WithConsensusTimeout(timeoutMs uint32) GenesisOption
  • func WithHashAlgorithm(hashAlgorithm gocrypto.Hash) GenesisOption
  • func WithQuorumThreshold(threshold uint32) GenesisOption
  • func WithTotalNodes(rootValidators uint32) GenesisOption
• type Net
• type Option
  • func WithStateStore(store StateStore) Option
  • func WithT3Timeout(timeout time.Duration) Option
• type RootChain
  • func NewRootChain(peer *network.Peer, genesis *genesis.RootGenesis, signer crypto.Signer, ...) (*RootChain, error)
  • func (rc *RootChain) Close()
• type RootNodeInfo
• type State
  • func NewState(g *genesis.RootGenesis, self string, signer crypto.Signer, ...) (*State, error)
  • func NewStateFromPartitionRecords(partitions []*genesis.PartitionRecord, nodeId string, signer crypto.Signer, ...) (*State, error)
  • func (s *State) CopyOldInputRecords(id p.SystemIdentifier)
  • func (s *State) CreateUnicityCertificates() (*store.RootState, error)
  • func (s *State) GetLatestUnicityCertificate(id p.SystemIdentifier) (*certificates.UnicityCertificate, error)
  • func (s *State) HandleBlockCertificationRequest(req *certification.BlockCertificationRequest) (*certificates.UnicityCertificate, error)
• type StateStore

Constants

const (
	ErrEncryptionPubKeyIsNil          = "encryption public key is nil"
	ErrQuorumThresholdOnlyDistributed = "quorum threshold must only be less than total nodes in root chain"
)

Variables

var ErrSignerIsNil = errors.New("signer is nil")

Functions

func GetPublicKeyAndVerifier

func GetPublicKeyAndVerifier(signer crypto.Signer) ([]byte, crypto.Verifier, error)

func NewDistributedRootGenesis

func NewDistributedRootGenesis(rootGenesis []*genesis.RootGenesis) (*genesis.RootGenesis, []*genesis.PartitionGenesis, error)

func NewPartitionRecordFromNodes

func NewPartitionRecordFromNodes(nodes []*genesis.PartitionNode) ([]*genesis.PartitionRecord, error)

func NewRootGenesis

func NewRootGenesis(id string, s crypto.Signer, encPubKey []byte, partitions []*genesis.PartitionRecord,
	opts ...GenesisOption) (*genesis.RootGenesis, []*genesis.PartitionGenesis, error)

Types

type CertRequestStore

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

func NewCertificationRequestStore

func NewCertificationRequestStore() *CertRequestStore

NewCertificationRequestStore create new certification requests store

func (*CertRequestStore) Add

func (c *CertRequestStore) Add(request *certification.BlockCertificationRequest) error

Add request to certification store. Per node id first valid request is stored. Rest are either duplicate or equivocating and in both cases error is returned. Clear or Reset in order to receive new requests

func (*CertRequestStore) Clear

func (c *CertRequestStore) Clear(id p.SystemIdentifier)

Clear clears requests in one partition

func (*CertRequestStore) GetRequests

func (c *CertRequestStore) GetRequests(id p.SystemIdentifier) []*certification.BlockCertificationRequest

GetRequests returns all stored requests per system identifier

func (*CertRequestStore) IsConsensusReceived

func (c *CertRequestStore) IsConsensusReceived(id p.SystemIdentifier, nrOfNodes int) (*certificates.InputRecord, bool)

IsConsensusReceived has partition with id reached consensus. Required nrOfNodes as input to calculate consensus

func (*CertRequestStore) Reset

func (c *CertRequestStore) Reset()

Reset removed all incoming requests from all stores

type CertificationRequestStore

type CertificationRequestStore interface {
	Add(request *certification.BlockCertificationRequest) error
	IsConsensusReceived(id p.SystemIdentifier, nrOfNodes int) (*certificates.InputRecord, bool)
	GetRequests(id p.SystemIdentifier) []*certification.BlockCertificationRequest
	Reset()
	Clear(id p.SystemIdentifier)
}

type GenesisOption

type GenesisOption func(c *rootGenesisConf)

func WithBlockRate

func WithBlockRate(rate uint32) GenesisOption

func WithConsensusTimeout

func WithConsensusTimeout(timeoutMs uint32) GenesisOption

func WithHashAlgorithm

func WithHashAlgorithm(hashAlgorithm gocrypto.Hash) GenesisOption

WithHashAlgorithm set custom hash algorithm (unused for now, remove?)

func WithQuorumThreshold

func WithQuorumThreshold(threshold uint32) GenesisOption

func WithTotalNodes

func WithTotalNodes(rootValidators uint32) GenesisOption

type Net

type Net interface {
	Send(msg network.OutputMessage, receivers []peer.ID) error
	ReceivedChannel() <-chan network.ReceivedMessage
}

Net provides an interface for sending messages to and receiving messages from other nodes in the network.

type Option

type Option func(c *rootChainConf)

func WithStateStore

func WithStateStore(store StateStore) Option

func WithT3Timeout

func WithT3Timeout(timeout time.Duration) Option

type RootChain

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

func NewRootChain

func NewRootChain(peer *network.Peer, genesis *genesis.RootGenesis, signer crypto.Signer, net Net, opts ...Option) (*RootChain, error)

NewRootChain creates a new instance of the root chain.

func (*RootChain) Close

func (rc *RootChain) Close()

type RootNodeInfo

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

type State

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

State holds the State of the root chain.

func NewState

func NewState(g *genesis.RootGenesis, self string, signer crypto.Signer, stateStore StateStore) (*State, error)

func NewStateFromPartitionRecords

func NewStateFromPartitionRecords(partitions []*genesis.PartitionRecord, nodeId string, signer crypto.Signer, hashAlgorithm gocrypto.Hash) (*State, error)

NewStateFromPartitionRecords creates the State from the genesis.PartitionRecord array. The State returned by this method is usually used to generate genesis file.

func (*State) CopyOldInputRecords

func (s *State) CopyOldInputRecords(id p.SystemIdentifier)

CopyOldInputRecords copies input records from the latest unicity certificate

func (*State) CreateUnicityCertificates

func (s *State) CreateUnicityCertificates() (*store.RootState, error)

CreateUnicityCertificates certifies input records and returns state containing changes (new root, round, UCs changed)

func (*State) GetLatestUnicityCertificate

func (s *State) GetLatestUnicityCertificate(id p.SystemIdentifier) (*certificates.UnicityCertificate, error)

GetLatestUnicityCertificate returns last UC for system identifier

func (*State) HandleBlockCertificationRequest

func (s *State) HandleBlockCertificationRequest(req *certification.BlockCertificationRequest) (*certificates.UnicityCertificate, error)

type StateStore

type StateStore interface {
	Save(state store.RootState) error
	Get() (store.RootState, error)
}