Documentation
¶
Index ¶
- Constants
- func MakeEmptyPendingForParent(bcReader blockchain.Reader, latestHeader *core.Header) (pending.Pending, error)deprecated
- func MakeEmptyPreConfirmedForParent(bcReader blockchain.Reader, latestHeader *core.Header) (pending.PreConfirmed, error)
- type CommittedBlock
- type DataSource
- type EventListener
- type NewHeadSubscription
- type NoopSynchronizer
- func (n *NoopSynchronizer) HighestBlockHeader() *core.Header
- func (n *NoopSynchronizer) PreConfirmedChain() (preconfirmed.ChainReader, error)
- func (n *NoopSynchronizer) StartingBlockNumber() (uint64, error)
- func (n *NoopSynchronizer) SubscribeNewHeads() NewHeadSubscription
- func (n *NoopSynchronizer) SubscribePreConfirmed() PreConfirmedDataSubscription
- func (n *NoopSynchronizer) SubscribeReorg() ReorgSubscription
- type PendingTxSubscription
- type PreConfirmedDataSubscription
- type Reader
- type ReorgBlockRange
- type ReorgSubscription
- type SelectiveListener
- type Synchronizer
- func (s *Synchronizer) HighestBlockHeader() *core.Header
- func (s *Synchronizer) PreConfirmedChain() (preconfirmed.ChainReader, error)
- func (s *Synchronizer) Run(ctx context.Context) error
- func (s *Synchronizer) StartingBlockNumber() (uint64, error)
- func (s *Synchronizer) SubscribeNewHeads() NewHeadSubscription
- func (s *Synchronizer) SubscribePreConfirmed() PreConfirmedDataSubscription
- func (s *Synchronizer) SubscribeReorg() ReorgSubscription
- func (s *Synchronizer) WithListener(listener EventListener) *Synchronizer
- func (s *Synchronizer) WithPlugin(plugin junoplugin.JunoPlugin) *Synchronizer
Constants ¶
View Source
const ( OpVerify = "verify" OpStore = "store" OpFetch = "fetch" )
Variables ¶
This section is empty.
Functions ¶
func MakeEmptyPendingForParent
deprecated
added in
v0.16.0
func MakeEmptyPreConfirmedForParent ¶ added in v0.16.0
func MakeEmptyPreConfirmedForParent( bcReader blockchain.Reader, latestHeader *core.Header, ) (pending.PreConfirmed, error)
Types ¶
type CommittedBlock ¶ added in v0.15.0
type CommittedBlock struct {
Block *core.Block
StateUpdate *core.StateUpdate
NewClasses map[felt.Felt]core.ClassDefinition
Persisted chan error // This is used to signal whether the block was persisted successfully
}
type DataSource ¶ added in v0.15.0
type DataSource interface {
BlockByNumber(ctx context.Context, blockNumber uint64) (CommittedBlock, error)
BlockHeaderLatest(ctx context.Context) (*core.Header, error)
PreConfirmedBlockByNumber(
ctx context.Context,
blockNumber uint64,
blockIdentifier string,
knownTransactionCount uint64,
) (starknet.PreConfirmedUpdate, error)
PreConfirmedBlockLatest(
ctx context.Context,
blockIdentifier string,
knownTransactionCount uint64,
) (starknet.PreConfirmedUpdate, uint64, error)
}
func NewFeederGatewayDataSource ¶ added in v0.15.0
func NewFeederGatewayDataSource(blockchain *blockchain.Blockchain, starknetData starknetdata.StarknetData) DataSource
type EventListener ¶ added in v0.7.0
type NewHeadSubscription ¶ added in v0.13.2
type NewHeadSubscription struct {
*feed.Subscription[*core.Block]
}
This is a work-around. mockgen chokes when the instantiated generic type is in the interface.
type NoopSynchronizer ¶ added in v0.10.0
type NoopSynchronizer struct{}
This is temporary and will be removed once the p2p synchronizer implements this interface.
func (*NoopSynchronizer) HighestBlockHeader ¶ added in v0.10.0
func (n *NoopSynchronizer) HighestBlockHeader() *core.Header
func (*NoopSynchronizer) PreConfirmedChain ¶
func (n *NoopSynchronizer) PreConfirmedChain() (preconfirmed.ChainReader, error)
func (*NoopSynchronizer) StartingBlockNumber ¶ added in v0.10.0
func (n *NoopSynchronizer) StartingBlockNumber() (uint64, error)
func (*NoopSynchronizer) SubscribeNewHeads ¶ added in v0.10.0
func (n *NoopSynchronizer) SubscribeNewHeads() NewHeadSubscription
func (*NoopSynchronizer) SubscribePreConfirmed ¶ added in v0.16.0
func (n *NoopSynchronizer) SubscribePreConfirmed() PreConfirmedDataSubscription
func (*NoopSynchronizer) SubscribeReorg ¶ added in v0.13.0
func (n *NoopSynchronizer) SubscribeReorg() ReorgSubscription
type PendingTxSubscription ¶ added in v0.13.0
type PendingTxSubscription struct {
*feed.Subscription[[]core.Transaction]
}
type PreConfirmedDataSubscription ¶ added in v0.16.0
type PreConfirmedDataSubscription struct {
*feed.Subscription[*pending.PreConfirmed]
}
type Reader ¶ added in v0.6.2
type Reader interface {
StartingBlockNumber() (uint64, error)
HighestBlockHeader() *core.Header
SubscribeNewHeads() NewHeadSubscription
SubscribeReorg() ReorgSubscription
SubscribePreConfirmed() PreConfirmedDataSubscription
PreConfirmedChain() (preconfirmed.ChainReader, error)
}
Todo: Since this is also going to be implemented by p2p package we should move this interface to node package
type ReorgBlockRange ¶ added in v0.13.0
type ReorgBlockRange struct {
// StartBlockHash is the hash of the first known block of the orphaned chain
StartBlockHash *felt.Felt
// StartBlockNum is the number of the first known block of the orphaned chain
StartBlockNum uint64
// The last known block of the orphaned chain
EndBlockHash *felt.Felt
// Number of the last known block of the orphaned chain
EndBlockNum uint64
}
ReorgBlockRange represents data about reorganised blocks, starting and ending block number and hash
type ReorgSubscription ¶ added in v0.13.0
type ReorgSubscription struct {
*feed.Subscription[*ReorgBlockRange]
}
type SelectiveListener ¶ added in v0.7.0
type SelectiveListener struct {
OnSyncStepDoneCb func(op string, blockNum uint64, took time.Duration)
OnReorgCb func(blockNum uint64)
}
func (*SelectiveListener) OnReorg ¶ added in v0.7.0
func (l *SelectiveListener) OnReorg(blockNum uint64)
func (*SelectiveListener) OnSyncStepDone ¶ added in v0.7.0
func (l *SelectiveListener) OnSyncStepDone(op string, blockNum uint64, took time.Duration)
type Synchronizer ¶
type Synchronizer struct {
// contains filtered or unexported fields
}
Synchronizer manages a list of StarknetData to fetch the latest blockchain updates
func New ¶ added in v0.2.1
func New( bc *blockchain.Blockchain, dataSource DataSource, logger log.StructuredLogger, preConfirmedPollInterval time.Duration, readOnlyBlockchain bool, database db.KeyValueStore, ) *Synchronizer
func (*Synchronizer) HighestBlockHeader ¶ added in v0.3.0
func (s *Synchronizer) HighestBlockHeader() *core.Header
func (*Synchronizer) PreConfirmedChain ¶
func (s *Synchronizer) PreConfirmedChain() (preconfirmed.ChainReader, error)
func (*Synchronizer) Run ¶
func (s *Synchronizer) Run(ctx context.Context) error
Run starts the Synchronizer, returns an error if the loop is already running
func (*Synchronizer) StartingBlockNumber ¶ added in v0.3.0
func (s *Synchronizer) StartingBlockNumber() (uint64, error)
func (*Synchronizer) SubscribeNewHeads ¶ added in v0.7.4
func (s *Synchronizer) SubscribeNewHeads() NewHeadSubscription
func (*Synchronizer) SubscribePreConfirmed ¶ added in v0.16.0
func (s *Synchronizer) SubscribePreConfirmed() PreConfirmedDataSubscription
func (*Synchronizer) SubscribeReorg ¶ added in v0.13.0
func (s *Synchronizer) SubscribeReorg() ReorgSubscription
func (*Synchronizer) WithListener ¶ added in v0.7.0
func (s *Synchronizer) WithListener(listener EventListener) *Synchronizer
WithListener registers an EventListener
func (*Synchronizer) WithPlugin ¶ added in v0.12.3
func (s *Synchronizer) WithPlugin(plugin junoplugin.JunoPlugin) *Synchronizer
WithPlugin registers an plugin
Click to show internal directories.
Click to hide internal directories.