beacon

Documentation

Overview

Package beacon implements the beacon application.

Index

• Constants
• Variables
• func GetBeacon(beaconEpoch epochtime.EpochTime, entropyCtx, entropy []byte) []byte
• func New() api.Application
• type Query
• type QueryFactory
  • func NewQueryFactory(state abciAPI.ApplicationQueryState) *QueryFactory
  • func (sf *QueryFactory) QueryAt(ctx context.Context, height int64) (Query, error)

Constants

const (
	// AppID is the unique application identifier.
	AppID uint8 = 0x04

	// AppName is the ABCI application name.
	// Run before the scheduler application.
	AppName string = "100_beacon"
)

Variables

var (
	// EventType is the ABCI event type for beacon events.
	EventType = api.EventTypeForApp(AppName)

	// QueryApp is a query for filtering events processed by the
	// beacon application.
	QueryApp = api.QueryForApp(AppName)

	// KeyGenerated is the ABCI event attribute key for the new
	// beacons (value is a CBOR serialized beacon.GenerateEvent).
	KeyGenerated = []byte("generated")
)

var (
	DebugEntropyCtx = []byte("Ekb-Dumm")
)

Functions

func GetBeacon

func GetBeacon(beaconEpoch epochtime.EpochTime, entropyCtx, entropy []byte) []byte

func New

func New() api.Application

New constructs a new beacon application instance.

Types

type Query

type Query interface {
	Beacon(context.Context) ([]byte, error)
	Genesis(context.Context) (*beacon.Genesis, error)
}

Query is the beacon query interface.

type QueryFactory

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

QueryFactory is the beacon query factory.

func NewQueryFactory

func NewQueryFactory(state abciAPI.ApplicationQueryState) *QueryFactory

NewQueryFactory returns a new QueryFactory backed by the given state instance.

func (*QueryFactory) QueryAt

func (sf *QueryFactory) QueryAt(ctx context.Context, height int64) (Query, error)

QueryAt returns the beacon query interface for a specific height.