types

type AssemblerConsensusPosition ¶ added in v0.0.19

type AssemblerConsensusPosition struct {
	DecisionNum DecisionNum
	BatchIndex  int
}

type Batch ¶ added in v0.0.19

type Batch interface {
	BatchID
	Requests() BatchedRequests
}

type BatchAttestation ¶ added in v0.0.16

type BatchAttestation interface {
	Fragments() []BatchAttestationFragment
	Digest() []byte
	Seq() BatchSequence
	Primary() PartyID
	Shard() ShardID
	Serialize() []byte
	Deserialize([]byte) error
}

type BatchAttestationFragment ¶ added in v0.0.16

type BatchAttestationFragment interface {
	Seq() BatchSequence
	Primary() PartyID
	Shard() ShardID
	Signer() PartyID
	Signature() []byte
	Digest() []byte
	Serialize() []byte
	Deserialize([]byte) error
	ConfigSequence() ConfigSequence
	String() string
}

type BatchID ¶

type BatchID interface {
	// Shard the shard from which this batch was produced.
	Shard() ShardID
	// Primary is the Party ID of the primary batcher which produces this batch.
	Primary() PartyID
	// Seq is the sequence number of this batch.
	Seq() BatchSequence
	// Digest is the digest of the requests in this batch.
	Digest() []byte
}

BatchID is the tuple that identifies a batch.

type BatchSequence ¶

type BatchSequence uint64

BatchSequence is the number a primary batcher assigns to the batches it produces.

type BatchedRequests ¶

type BatchedRequests [][]byte

BatchedRequests are used to represent a batch of requests.

The requests can be: 1. Client TXs - in the batchers and assemblers 2. Consensus requests, .i.e. control events submitted from batchers to consensus.

func (br *BatchedRequests) Deserialize(bytes []byte) error

func (br *BatchedRequests) Digest() []byte

func (br *BatchedRequests) Serialize() []byte

func (br *BatchedRequests) SizeBytes() int64

type ConfigSequence ¶ added in v0.0.19

type ConfigSequence uint64

ConfigSequence numbers configuration changes, as delivered by a config TX and the corresponding config block. It starts from 0 (on the genesis block) and increases by 1 with every config change.

type DecisionNum ¶

type DecisionNum uint64

DecisionNum is the number the consensus nodes assign to each decision they produce.

type Logger ¶

type Logger interface {
	Debugf(template string, args ...interface{})
	Infof(template string, args ...interface{})
	Errorf(template string, args ...interface{})
	Warnf(template string, args ...interface{})
	Panicf(template string, args ...interface{})
}

type OrderedBatchAttestation ¶ added in v0.0.19

type OrderedBatchAttestation interface {
	BatchAttestation() BatchAttestation
	// OrderingInfo is an opaque object that provides extra information on the order of the batch attestation and
	// metadata to be used in the construction of the block.
	OrderingInfo() OrderingInfo
}

OrderedBatchAttestation carries the BatchAttestation and information on the actual order of the batch from the consensus cluster. This information is used when appending to the ledger, and helps the assembler to recover following a shutdown or a failure.

type OrderingInfo ¶ added in v0.0.19

type OrderingInfo interface {
	fmt.Stringer
}

OrderingInfo is an opaque object that provides extra information on the order of the batch attestation and metadata to be used in the construction of the block.

type PartyID ¶

type PartyID uint16

PartyID identifies a party, must be >0.

type ShardID ¶

type ShardID uint16

ShardID identifies a shard, should be >0. Value math.MaxUint16 is reserved.

const ShardIDConsensus ShardID = math.MaxUint16

type SimpleBatch ¶

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

func NewSimpleBatch(seq BatchSequence, shard ShardID, primary PartyID, requests BatchedRequests) *SimpleBatch

func (sb *SimpleBatch) Digest() []byte

func (sb *SimpleBatch) Primary() PartyID

func (sb *SimpleBatch) Requests() BatchedRequests

func (sb *SimpleBatch) Seq() BatchSequence

func (sb *SimpleBatch) Shard() ShardID

type SimpleBatchAttestationFragment ¶

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

func NewSimpleBatchAttestationFragment(shard ShardID, primary PartyID, seq BatchSequence, digest []byte, signer PartyID, configSqn ConfigSequence) *SimpleBatchAttestationFragment

func (s *SimpleBatchAttestationFragment) ConfigSequence() ConfigSequence

func (s *SimpleBatchAttestationFragment) Deserialize(bytes []byte) error

func (s *SimpleBatchAttestationFragment) Digest() []byte

func (s *SimpleBatchAttestationFragment) Primary() PartyID

func (s *SimpleBatchAttestationFragment) Seq() BatchSequence

func (s *SimpleBatchAttestationFragment) Serialize() []byte

func (s *SimpleBatchAttestationFragment) SetSignature(sig []byte)

func (s *SimpleBatchAttestationFragment) Shard() ShardID

func (s *SimpleBatchAttestationFragment) Signature() []byte

func (s *SimpleBatchAttestationFragment) Signer() PartyID

func (s *SimpleBatchAttestationFragment) String() string

func (s *SimpleBatchAttestationFragment) ToBeSigned() []byte