sync

type Option func(*Parameters)

type Parameters struct {
	// PruningWindow defines the duration within which headers are retained before being pruned.
	PruningWindow time.Duration
	// SyncFromHash is the hash of the header from which Syncer should start syncing.
	// Zero value to disable. Value updates up and down the chain are gracefully handled by Syncer.
	//
	// By default, Syncer maintains PruningWindow number of headers. SyncFromHash overrides this default,
	// allowing any user to specify a custom starting point.
	//
	// SyncFromHash has higher priority than SyncFromHeight.
	SyncFromHash string
	// SyncFromHeight is the height of the header from which Syncer should start syncing.
	// Zero value to disable. Value updates up and down the chain are gracefully handled by Syncer.
	//
	// By default, Syncer maintains PruningWindow number of headers. SyncFromHeight overrides this default,
	// allowing any user to specify a custom starting point.
	//
	// SyncFromHeight has lower priority than SyncFromHash.
	SyncFromHeight uint64
	// contains filtered or unexported fields
}

type State struct {
	ID         uint64      `json:"id"`          // incrementing ID of a sync
	Height     uint64      `json:"height"`      // height at the moment when State is requested for a sync
	FromHeight uint64      `json:"from_height"` // the starting point of a sync
	ToHeight   uint64      `json:"to_height"`   // the ending point of a sync
	FromHash   header.Hash `json:"from_hash"`
	ToHash     header.Hash `json:"to_hash"`
	Start      time.Time   `json:"start"`
	End        time.Time   `json:"end"`
	Error      string      `json:"error,omitempty"` // the error that might happen within a sync
}

type Syncer[H header.Header[H]] struct {
	Params *Parameters
	// contains filtered or unexported fields
}