confirmations

Documentation

Index

• type EventInfo
• type Manager
  • func NewBlockConfirmationManager(baseContext context.Context, connector ffcapi.API, desc string) Manager
• type Notification
• type NotificationType
• type RemovedListenerInfo
• type TransactionInfo

Types

type EventInfo

type EventInfo struct {
	ID            *ffcapi.EventID
	Confirmations func(ctx context.Context, notification *apitypes.ConfirmationsNotification)
}

type Manager

type Manager interface {
	Notify(n *Notification) error
	Start()
	Stop()
	NewBlockHashes() chan<- *ffcapi.BlockHashEvent
	CheckInFlight(listenerID *fftypes.UUID) bool
}

Manager listens to the blocks on the chain, and attributes confirmations to pending events. Once those events meet a threshold they are considered final and dispatched to the relevant listener.

func NewBlockConfirmationManager

func NewBlockConfirmationManager(baseContext context.Context, connector ffcapi.API, desc string) Manager

type Notification

type Notification struct {
	NotificationType NotificationType
	Event            *EventInfo           // NewEventLog, RemovedEventLog
	Transaction      *TransactionInfo     // NewTransaction, RemovedTransaction
	RemovedListener  *RemovedListenerInfo // ListenerRemoved
	// contains filtered or unexported fields
}

type NotificationType

type NotificationType int

const (
	NewEventLog NotificationType = iota
	RemovedEventLog
	NewTransaction
	RemovedTransaction
	ListenerRemoved
)

type RemovedListenerInfo

type RemovedListenerInfo struct {
	ListenerID *fftypes.UUID
	Completed  chan struct{}
}

type TransactionInfo

type TransactionInfo struct {
	TransactionHash string
	Receipt         func(ctx context.Context, receipt *ffcapi.TransactionReceiptResponse)
	Confirmations   func(ctx context.Context, notification *apitypes.ConfirmationsNotification)
}