bdls

package module

Go to main page

Versions in this module

v1

v1.3.9

Nov 17, 2020

Changes in this version

type PubKeyAxis

+ func (t *PubKeyAxis) MarshalText() (text []byte, err error)

+ func (t *PubKeyAxis) String() string

v1.3.8

Nov 5, 2020

Changes in this version

+ const MaxConsensusLatency

v1.3.7

Oct 18, 2020

Changes in this version

type MessageType

+ const MessageType_Resync

v1.3.4

Aug 24, 2020

v1.3.3

Jul 29, 2020

v1.3.2

Jun 16, 2020

Changes in this version

type Consensus

+ func (c *Consensus) HasProposed(state State) bool

v1.3.1

Jun 13, 2020

Changes in this version

+ var S256Curve elliptic.Curve = btcec.S256()

type Config

+ PubKeyToIdentity func(pubkey *ecdsa.PublicKey) (ret Identity)

+ type Identity [2 * SizeAxis]byte

+ func DefaultPubKeyToIdentity(pubkey *ecdsa.PublicKey) (ret Identity)

v1.3.0

Jun 12, 2020

Changes in this version

+ var ErrConfigPubKeyToCoordinate = errors.New("Config.must contain at least 4 participants")

+ var ErrConfigStateCompare = errors.New("Config.StateCompare function has not set")

+ var ErrConfigStateValidate = errors.New("Config.StateValidate function has not set")

+ var ErrMessageValidator = errors.New("the message has been rejected by external validator")

type Config

+ MessageOutCallback func(m *Message, signed *SignedProto)

+ MessageValidator func(m *Message, signed *SignedProto) bool

+ PubKeyToCoordinate func(pubkey *ecdsa.PublicKey) (ret Coordinate)

type Coordinate

+ func DefaultPubKeyToCoordinate(pubkey *ecdsa.PublicKey) (ret Coordinate)

type SignedProto

+ func (sp *SignedProto) PublicKey() *ecdsa.PublicKey

v1.2.6

Jun 11, 2020

Changes in this version

type SignedProto

+ AuxData []byte

+ func (m *SignedProto) GetAuxData() []byte

v1.2.5

Jun 9, 2020

v1.2.4

Jun 9, 2020

Changes in this version

type Message

+ func DecodeMessage(bts []byte) (*Message, error)

type SignedProto

+ func DecodeSignedMessage(bts []byte) (*SignedProto, error)

v1.2.3

Jun 9, 2020

Changes in this version

type Config

+ VerifierOnly bool

v1.2.2

Jun 9, 2020

v1.2.1

Jun 5, 2020

Changes in this version

+ var ErrMismatchedTargetState = errors.New("the state in <decide> message does not match the provided target state")

v1.1.4

Jun 4, 2020

v1.1.3

Jun 3, 2020

Changes in this version

type Config

+ MessageCallback func(m *Message, signed *SignedProto)

v1.1.2

Jun 3, 2020

v1.1.1

Jun 1, 2020

Changes in this version

type Consensus

+ func (c *Consensus) DecodeSignedMessage(bts []byte) (*SignedProto, error)

v1.1.0

Apr 23, 2020

Changes in this version

type Config

+ EnableCommitUnicast bool

type Consensus

+ func (c *Consensus) Join(p PeerInterface) bool

+ func (c *Consensus) Leave(addr net.Addr) bool

+ func (c *Consensus) ValidateDecideMessage(bts []byte) error

v1.0.0

Mar 23, 2020

Changes in this version

+ const ConfigMinimumParticipants

+ const DefaultConsensusLatency

+ const ProtocolVersion

+ const SignaturePrefix

+ const SizeAxis

+ var DefaultCurve elliptic.Curve = btcec.S256()

+ var ErrCommitEmptyState = errors.New("the state is empty in <commit> message")

+ var ErrCommitHeightMismatch = errors.New("the <commit> messge has another height than expected")

+ var ErrCommitRoundMismatch = errors.New("the <commit> message is from another round")

+ var ErrCommitStateMismatch = errors.New("the state in <commit> message does not match what leader has locked")

+ var ErrCommitStateValidation = errors.New("the state data validation failed <commit> message")

+ var ErrCommitStatus = errors.New("received <commit> message in non COMMIT state")

+ var ErrConfigEpoch = errors.New("Config.Epoch is nil")

+ var ErrConfigLess = errors.New("Config.Less function has not set")

+ var ErrConfigParticipants = errors.New("Config.Participants must contain at least 4 participants")

+ var ErrConfigPrivateKey = errors.New("Config.PrivateKey has not set")

+ var ErrConfigStateNil = errors.New("Config.CurrentState is nil")

+ var ErrConfigValidateState = errors.New("Config.ValidateState function has not set")

+ var ErrDecideEmptyState = errors.New("the state is empty in <decide> message")

+ var ErrDecideHeightLower = errors.New("the <decide> message has lower height than expected")

+ var ErrDecideNotSignedByLeader = errors.New("the <decide> message is not signed by leader")

+ var ErrDecideProofHeightMismatch = errors.New("the proofs in <decide> message has mismatched height")

+ var ErrDecideProofInsufficient = errors.New("the <decide> message has insufficient <commit> proofs to the proposed state")

+ var ErrDecideProofRoundMismatch = errors.New("the proofs in <decide> message has mismatched round")

+ var ErrDecideProofStateValidation = errors.New("the proofs in <decide> message has invalid state data")

+ var ErrDecideProofTypeMismatch = errors.New("the proofs in <decide> message is not <commit>")

+ var ErrDecideProofUnknownParticipant = errors.New("the proofs in <decide> message has unknown participant")

+ var ErrDecideStateValidation = errors.New("the state data validation failed <decide> message")

+ var ErrIntOverflowMessage = fmt.Errorf("proto: integer overflow")

+ var ErrInvalidLengthMessage = fmt.Errorf("proto: negative length found during unmarshaling")

+ var ErrLockEmptyState = errors.New("the state is empty in <lock> message")

+ var ErrLockHeightMismatch = errors.New("the <lock> message has another height than expected")

+ var ErrLockNotSignedByLeader = errors.New("the <lock> message is not signed by leader")

+ var ErrLockProofHeightMismatch = errors.New("the proofs in <lock> message has mismatched height")

+ var ErrLockProofInsufficient = errors.New(...)

+ var ErrLockProofRoundMismatch = errors.New("the proofs in <lock> message has mismatched round")

+ var ErrLockProofStateValidation = errors.New("the proofs in <lock> message has invalid state data")

+ var ErrLockProofTypeMismatch = errors.New("the proofs in <lock> message is not <roundchange>")

+ var ErrLockProofUnknownParticipant = errors.New("the proofs in <lock> message has unknown participant")

+ var ErrLockReleaseStatus = errors.New("received <lock-release> message in non LOCK-RELEASE state")

+ var ErrLockRoundLower = errors.New("the <lock> message has lower round than expected")

+ var ErrLockStateValidation = errors.New("the state data validation failed <lock> message")

+ var ErrMessageIsEmpty = errors.New("the message being verified is empty")

+ var ErrMessageSignature = errors.New("cannot verify the signature of this message")

+ var ErrMessageUnknownMessageType = errors.New("unrecognized message type")

+ var ErrMessageUnknownParticipant = errors.New("the message is from unknown partcipants")

+ var ErrMessageVersion = errors.New("the message has different version")

+ var ErrPubKey = errors.New("incorrect pubkey format")

+ var ErrRoundChangeHeightMismatch = errors.New("the <roundchange> message has another height than expected")

+ var ErrRoundChangeRoundLower = errors.New("the <roundchange> message has lower round than expected")

+ var ErrRoundChangeStateValidation = errors.New("the state data validation failed <roundchange> message")

+ var ErrSelectHeightMismatch = errors.New("the <select> message has another height than expected")

+ var ErrSelectNotSignedByLeader = errors.New("the <select> message is not signed by leader")

+ var ErrSelectProofExceeded = errors.New("the <select> message overall state proposals exceeded maximal")

+ var ErrSelectProofHeightMismatch = errors.New("the proofs in <select> message has mismatched height")

+ var ErrSelectProofInsufficient = errors.New("the <select> message has insufficient overall proofs")

+ var ErrSelectProofNotTheMaximal = errors.New("the proposed state is not the maximal one in the <select> message")

+ var ErrSelectProofRoundMismatch = errors.New("the proofs in <select> message has mismatched round")

+ var ErrSelectProofStateValidation = errors.New("the proofs in <select> message has invalid state data")

+ var ErrSelectProofTypeMismatch = errors.New("the proofs in <select> message is not <roundchange>")

+ var ErrSelectProofUnknownParticipant = errors.New("the proofs in <select> message has unknown participant")

+ var ErrSelectRoundLower = errors.New("the <select> message has lower round than expected")

+ var ErrSelectStateMismatch = errors.New("the <select> message has nil state but proof contains non-nil state")

+ var ErrSelectStateValidation = errors.New("the state data validation failed <select> message")

+ var ErrUnexpectedEndOfGroupMessage = fmt.Errorf("proto: unexpected end of group")

+ var MessageType_name = map[int32]string

+ var MessageType_value = map[string]int32

+ func VerifyConfig(c *Config) error

+ type Config struct

+ CurrentHeight uint64

+ CurrentState State

+ Epoch time.Time

+ Participants []*ecdsa.PublicKey

+ PrivateKey *ecdsa.PrivateKey

+ StateCompare func(a State, b State) int

+ StateHash func(State) StateHash

+ StateValidate func(State) bool

+ type Consensus struct

+ func NewConsensus(config *Config) (*Consensus, error)

+ func (c *Consensus) AddPeer(p PeerInterface) bool

+ func (c *Consensus) CurrentProof() *SignedProto

+ func (c *Consensus) CurrentState() (height uint64, round uint64, data State)

+ func (c *Consensus) Propose(s State)

+ func (c *Consensus) ReceiveMessage(bts []byte, now time.Time) error

+ func (c *Consensus) RemovePeer(addr net.Addr) bool

+ func (c *Consensus) SetLatency(latency time.Duration)

+ func (c *Consensus) Update(now time.Time) error

+ type Coordinate [2 * SizeAxis]byte

+ func (c Coordinate) Equal(x1 PubKeyAxis, y1 PubKeyAxis) bool

+ type IPCPeer struct

+ func NewIPCPeer(c *Consensus, latency time.Duration) *IPCPeer

+ func (p *IPCPeer) Close()

+ func (p *IPCPeer) GetBytesCount() int64

+ func (p *IPCPeer) GetLatencies() (min time.Duration, max time.Duration, total time.Duration)

+ func (p *IPCPeer) GetLatestState() (height uint64, round uint64, data State)

+ func (p *IPCPeer) GetMessageCount() int64

+ func (p *IPCPeer) GetPublicKey() *ecdsa.PublicKey

+ func (p *IPCPeer) Propose(s State)

+ func (p *IPCPeer) RemoteAddr() net.Addr

+ func (p *IPCPeer) Send(msg []byte) error

+ func (p *IPCPeer) Update()

+ type Message struct

+ Height uint64

+ LockRelease *SignedProto

+ Proof []*SignedProto

+ Round uint64

+ State []byte

+ Type MessageType

+ XXX_NoUnkeyedLiteral struct{}

+ XXX_sizecache int32

+ XXX_unrecognized []byte

+ func (*Message) Descriptor() ([]byte, []int)

+ func (*Message) ProtoMessage()

+ func (m *Message) GetHeight() uint64

+ func (m *Message) GetLockRelease() *SignedProto

+ func (m *Message) GetProof() []*SignedProto

+ func (m *Message) GetRound() uint64

+ func (m *Message) GetState() []byte

+ func (m *Message) GetType() MessageType

+ func (m *Message) Marshal() (dAtA []byte, err error)

+ func (m *Message) MarshalTo(dAtA []byte) (int, error)

+ func (m *Message) MarshalToSizedBuffer(dAtA []byte) (int, error)

+ func (m *Message) Reset()

+ func (m *Message) Size() (n int)

+ func (m *Message) String() string

+ func (m *Message) Unmarshal(dAtA []byte) error

+ func (m *Message) XXX_DiscardUnknown()

+ func (m *Message) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

+ func (m *Message) XXX_Merge(src proto.Message)

+ func (m *Message) XXX_Size() int

+ func (m *Message) XXX_Unmarshal(b []byte) error

+ type MessageType int32

+ const MessageType_Commit

+ const MessageType_Decide

+ const MessageType_Lock

+ const MessageType_LockRelease

+ const MessageType_Nop

+ const MessageType_RoundChange

+ const MessageType_Select

+ func (MessageType) EnumDescriptor() ([]byte, []int)

+ func (x MessageType) String() string

+ type PeerInterface interface

+ GetPublicKey func() *ecdsa.PublicKey

+ RemoteAddr func() net.Addr

+ Send func(msg []byte) error

+ type PubKeyAxis [SizeAxis]byte

+ func (t *PubKeyAxis) MarshalTo(data []byte) (n int, err error)

+ func (t *PubKeyAxis) Size() int

+ func (t *PubKeyAxis) Unmarshal(data []byte) error

+ func (t PubKeyAxis) Marshal() ([]byte, error)

+ type SignedProto struct

+ Message []byte

+ R []byte

+ S []byte

+ Version uint32

+ X PubKeyAxis

+ XXX_NoUnkeyedLiteral struct{}

+ XXX_sizecache int32

+ XXX_unrecognized []byte

+ Y PubKeyAxis

+ func (*SignedProto) Descriptor() ([]byte, []int)

+ func (*SignedProto) ProtoMessage()

+ func (m *SignedProto) GetMessage() []byte

+ func (m *SignedProto) GetR() []byte

+ func (m *SignedProto) GetS() []byte

+ func (m *SignedProto) GetVersion() uint32

+ func (m *SignedProto) Marshal() (dAtA []byte, err error)

+ func (m *SignedProto) MarshalTo(dAtA []byte) (int, error)

+ func (m *SignedProto) MarshalToSizedBuffer(dAtA []byte) (int, error)

+ func (m *SignedProto) Reset()

+ func (m *SignedProto) Size() (n int)

+ func (m *SignedProto) String() string

+ func (m *SignedProto) Unmarshal(dAtA []byte) error

+ func (m *SignedProto) XXX_DiscardUnknown()

+ func (m *SignedProto) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

+ func (m *SignedProto) XXX_Merge(src proto.Message)

+ func (m *SignedProto) XXX_Size() int

+ func (m *SignedProto) XXX_Unmarshal(b []byte) error

+ func (sp *SignedProto) Coordinate() (ret Coordinate)

+ func (sp *SignedProto) Hash() []byte

+ func (sp *SignedProto) Sign(m *Message, privateKey *ecdsa.PrivateKey)

+ func (sp *SignedProto) Verify() bool

+ type State []byte

+ type StateHash [blake2b.Size256]byte

+ func DefaultHash(s State) StateHash

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL