common

Documentation

Index

• type ChainID
• type InvalidationResult
• type MessageAcceptor
• type MessageReplacingPolicy
• type NodeMetastate
  • func FromBytes(buf []byte) (*NodeMetastate, error)
  • func NewNodeMetastate(height uint64) *NodeMetastate
  • func (n *NodeMetastate) Bytes() ([]byte, error)
  • func (n *NodeMetastate) Height() uint64
  • func (n *NodeMetastate) Update(height uint64)
• type PKIidType
• type Payload

Types

type ChainID

type ChainID []byte

ChainID defines the identity representation of a chain

type InvalidationResult

type InvalidationResult int

InvalidationResult determines how a message affects another message when it is put into gossip message store

const (
	// MessageNoAction means messages have no relation
	MessageNoAction InvalidationResult = iota
	// MessageInvalidates means message invalidates the other message
	MessageInvalidates
	// MessageInvalidated means message is invalidated by the other message
	MessageInvalidated
)

type MessageAcceptor

type MessageAcceptor func(interface{}) bool

MessageAcceptor is a predicate that is used to determine in which messages the subscriber that created the instance of the MessageAcceptor is interested in.

type MessageReplacingPolicy

type MessageReplacingPolicy func(this interface{}, that interface{}) InvalidationResult

MessageReplacingPolicy Returns: MESSAGE_INVALIDATES if this message invalidates that MESSAGE_INVALIDATED if this message is invalidated by that MESSAGE_NO_ACTION otherwise

type NodeMetastate

type NodeMetastate struct {

	// Actual ledger height
	LedgerHeight uint64
}

NodeMetastate information to store the information about current height of the ledger (last accepted block sequence number).

func FromBytes

func FromBytes(buf []byte) (*NodeMetastate, error)

FromBytes - encode from byte array into meta data structure

func NewNodeMetastate

func NewNodeMetastate(height uint64) *NodeMetastate

NewNodeMetastate creates new meta data with given ledger height

func (*NodeMetastate) Bytes

func (n *NodeMetastate) Bytes() ([]byte, error)

Bytes decodes meta state into byte array for serialization

func (*NodeMetastate) Height

func (n *NodeMetastate) Height() uint64

Height returns ledger height from the state

func (*NodeMetastate) Update

func (n *NodeMetastate) Update(height uint64)

Update state with new ledger height

type PKIidType

type PKIidType []byte

PKIidType defines the type that holds the PKI-id which is the security identifier of a peer

type Payload

type Payload struct {
	ChainID ChainID // The channel's ID of the block
	Data    []byte  // The content of the message, possibly encrypted or signed
	Hash    string  // The message hash
	SeqNum  uint64  // The message sequence number
}

Payload defines an object that contains a ledger block