choices

Documentation

Index

• type Decidable
• type Status
  • func (s Status) Bytes() []byte
  • func (s Status) Decided() bool
  • func (s Status) Fetched() bool
  • func (s Status) MarshalJSON() ([]byte, error)
  • func (s Status) String() string
  • func (s *Status) UnmarshalJSON(b []byte) error
  • func (s Status) Valid() error
• type TestDecidable
  • func (d *TestDecidable) Accept(context.Context) error
  • func (d *TestDecidable) ID() ids.ID
  • func (d *TestDecidable) Reject(context.Context) error
  • func (d *TestDecidable) Status() Status

Types

type Decidable

type Decidable interface {
	// ID returns a unique ID for this element.
	//
	// Typically, this is implemented by using a cryptographic hash of a
	// binary representation of this element. An element should return the same
	// IDs upon repeated calls.
	ID() ids.ID

	// Accept this element.
	//
	// This element will be accepted by every correct node in the network.
	Accept(context.Context) error

	// Reject this element.
	//
	// This element will not be accepted by any correct node in the network.
	Reject(context.Context) error

	// Status returns this element's current status.
	//
	// If Accept has been called on an element with this ID, Accepted should be
	// returned. Similarly, if Reject has been called on an element with this
	// ID, Rejected should be returned. If the contents of this element are
	// unknown, then Unknown should be returned. Otherwise, Processing should be
	// returned.
	//
	// TODO: Consider allowing Status to return an error.
	Status() Status
}

Decidable represents element that can be decided.

Decidable objects are typically thought of as either transactions, blocks, or vertices.

type Status

type Status uint32

const (
	Unknown Status = iota
	Processing
	Rejected
	Accepted
)

List of possible status values Unknown Zero value, means the operation is not known Processing means the operation is known, but hasn't been decided yet Rejected means the operation will never be accepted Accepted means the operation was accepted

func (Status) Bytes

func (s Status) Bytes() []byte

Bytes returns the byte repr. of this status

func (Status) Decided

func (s Status) Decided() bool

Decided returns true if the status is Rejected or Accepted.

func (Status) Fetched

func (s Status) Fetched() bool

Fetched returns true if the status has been set.

func (Status) MarshalJSON

func (s Status) MarshalJSON() ([]byte, error)

func (Status) String

func (s Status) String() string

func (*Status) UnmarshalJSON

func (s *Status) UnmarshalJSON(b []byte) error

func (Status) Valid

func (s Status) Valid() error

Valid returns nil if the status is a valid status.

type TestDecidable

type TestDecidable struct {
	IDV              ids.ID
	AcceptV, RejectV error
	StatusV          Status
}

TestDecidable is a test Decidable

func (*TestDecidable) Accept

func (d *TestDecidable) Accept(context.Context) error

func (*TestDecidable) ID

func (d *TestDecidable) ID() ids.ID

func (*TestDecidable) Reject

func (d *TestDecidable) Reject(context.Context) error

func (*TestDecidable) Status

func (d *TestDecidable) Status() Status