beefy

Documentation

Index

• type Beefy
  • func NewBeefy(cl client.Client) Beefy
• type JustificationsSubscription
  • func (s *JustificationsSubscription) Chan() <-chan types.SignedCommitment
  • func (s *JustificationsSubscription) Err() <-chan error
  • func (s *JustificationsSubscription) Unsubscribe()

Types

type Beefy

type Beefy interface {
	GetFinalizedHead() (types.Hash, error)
	SubscribeJustifications() (*JustificationsSubscription, error)
}

func NewBeefy

func NewBeefy(cl client.Client) Beefy

NewBeefy creates a new Chain struct

type JustificationsSubscription

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

JustificationsSubscription is a subscription established through one of the Client's subscribe methods.

func (*JustificationsSubscription) Chan

func (s *JustificationsSubscription) Chan() <-chan types.SignedCommitment

Chan returns the subscription channel.

The channel is closed when Unsubscribe is called on the subscription.

func (*JustificationsSubscription) Err

func (s *JustificationsSubscription) Err() <-chan error

Err returns the subscription error channel. The intended use of Err is to schedule resubscription when the client connection is closed unexpectedly.

The error channel receives a value when the subscription has ended due to an error. The received error is nil if Close has been called on the underlying client and no other error has occurred.

The error channel is closed when Unsubscribe is called on the subscription.

func (*JustificationsSubscription) Unsubscribe

func (s *JustificationsSubscription) Unsubscribe()

Unsubscribe unsubscribes the notification and closes the error channel. It can safely be called more than once.