localcoin

Documentation

Index

• func NewLocalCoin() consinterface.CoinItemInterface
• type LocalCoin
  • func (*LocalCoin) CheckCoinMessage(*deserialized.DeserializedItem, bool, bool, consinterface.ConsItem, ...) (round types.ConsensusRound, ret messages.MsgHeader, ...)
  • func (sc1 *LocalCoin) GenerateCoinMessage(types.ConsensusRound, bool, consinterface.ConsItem, ...) (ret messages.MsgHeader)
  • func (LocalCoin) GetBufferCount(messages.MsgIDHeader, *generalconfig.GeneralConfig, *consinterface.MemCheckers) (endThreshold int, maxPossible int, msgid messages.MsgID, err error)
  • func (LocalCoin) GetHeader(sig.Pub, *generalconfig.GeneralConfig, messages.HeaderID) (messages.MsgHeader, error)
• type MsgState
  • func NewLocalCoinMsgState(isMv bool, seed int64, _ *generalconfig.GeneralConfig) *MsgState
  • func (sms *MsgState) CheckFinishedMessage(deser *deserialized.DeserializedItem) bool
  • func (sms *MsgState) GetCoinSignType() types.SignType
  • func (sms *MsgState) GetCoins(round types.ConsensusRound) []types.BinVal
  • func (sms *MsgState) GotMsg(consinterface.MessageState, *deserialized.DeserializedItem, ...) (types.ConsensusRound, error)
  • func (sms *MsgState) New(_ types.ConsensusIndex, presets []struct{ ... }) consinterface.CoinMessageStateInterface

Functions

func NewLocalCoin

func NewLocalCoin() consinterface.CoinItemInterface

Types

type LocalCoin

type LocalCoin struct {
}

LocalCoin represents a local random coin.

func (*LocalCoin) CheckCoinMessage

func (*LocalCoin) CheckCoinMessage(*deserialized.DeserializedItem,
	bool, bool, consinterface.ConsItem, consinterface.CoinMessageStateInterface,
	consinterface.MessageState) (round types.ConsensusRound, ret messages.MsgHeader,
	progress, shouldForward bool, err error)

CheckCoinMessage should be called from within ProcessMessage of the ConsensusItem that is using this coin. It returns the round the coin corresponds to and true in first boolean position if made progress towards decision, or false if already decided, and return true in second position if the message should be forwarded. If the message is invalid an error is returned.

func (*LocalCoin) GenerateCoinMessage

func (sc1 *LocalCoin) GenerateCoinMessage(types.ConsensusRound, bool, consinterface.ConsItem,
	consinterface.CoinMessageStateInterface, consinterface.MessageState) (ret messages.MsgHeader)

func (LocalCoin) GetBufferCount

func (LocalCoin) GetBufferCount(messages.MsgIDHeader, *generalconfig.GeneralConfig,
	*consinterface.MemCheckers) (endThreshold int,
	maxPossible int, msgid messages.MsgID, err error)

GetBufferCount returns the thresholds for messages of type coin. The thresholds are n-t.

func (LocalCoin) GetHeader

func (LocalCoin) GetHeader(sig.Pub, *generalconfig.GeneralConfig,
	messages.HeaderID) (messages.MsgHeader, error)

GetHeader should a blank message header for the HeaderID, this object will be used to deserialize a message into itself (see consinterface.DeserializeMessage).

type MsgState

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

LocalCoinMsgState represents the state of the local coin.

func NewLocalCoinMsgState

func NewLocalCoinMsgState(isMv bool, seed int64,
	_ *generalconfig.GeneralConfig) *MsgState

NewLocalCoinMsgState generates a new LocalCoinMsgState object.

func (*MsgState) CheckFinishedMessage

func (sms *MsgState) CheckFinishedMessage(deser *deserialized.DeserializedItem) bool

CheckFinishedMessage checks if the message is for the coin and if the coin is already known. If so true is returned, false otherwise.

func (*MsgState) GetCoinSignType

func (sms *MsgState) GetCoinSignType() types.SignType

GetCoinSignType returns what type of signature is used to sign coin messages

func (*MsgState) GetCoins

func (sms *MsgState) GetCoins(round types.ConsensusRound) []types.BinVal

GetCoins returns the set of binary coin values that are currently valid.

func (*MsgState) GotMsg

func (sms *MsgState) GotMsg(consinterface.MessageState, *deserialized.DeserializedItem,
	*generalconfig.GeneralConfig, *consinterface.MemCheckers) (types.ConsensusRound, error)

GotMsg processes messages of type CoinMessage. Once an n-t threshold of these messages have been received from different processes the value of the coin is revealed.

func (*MsgState) New

func (sms *MsgState) New(_ types.ConsensusIndex, presets []struct {
	Round types.ConsensusRound
	Val   types.BinVal
}) consinterface.CoinMessageStateInterface

New creates a new empty LocalCoinMsgState object for the consensus index idx.