confirmations

Documentation

Index

• type BlockInfo
• 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 BlockInfo

type BlockInfo struct {
	BlockNumber       fftypes.FFuint64 `json:"blockNumber"`
	BlockHash         string           `json:"blockHash"`
	ParentHash        string           `json:"parentHash"`
	TransactionHashes []string         `json:"transactionHashes,omitempty"`
}

type EventInfo

type EventInfo struct {
	ID        *ffcapi.EventID
	Confirmed func(ctx context.Context, confirmations []BlockInfo)
}

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
	Transaction      *TransactionInfo
	RemovedListener  *RemovedListenerInfo
}

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)
	Confirmed       func(ctx context.Context, confirmations []BlockInfo)
}