scanner

package module

Go to main page

Versions in this module

v0

v0.4.0

Sep 10, 2024

v0.3.2

Mar 29, 2023

Changes in this version

+ const DefaultIncrementalScannerBlockLag

+ const DefaultIncrementalScannerMaxBlockGap

type IncrementalScannerConfig

+ IncrementalScannerBlockLag uint64

+ IncrementalScannerMaxBlockGap uint64

v0.3.1

Feb 14, 2023

v0.3.0

Feb 14, 2023

Changes in this version

+ const DefaultScriptRunnerMaxConcurrentScripts

+ func DefaultExcludeAddress(id flow.ChainID, address flow.Address) bool

type AddressBatch

+ func (b *AddressBatch) Split() (AddressBatch, AddressBatch)

+ type AddressProviderConfig struct

+ ExcludeAddress func(id flow.ChainID, address flow.Address) bool

+ func DefaultAddressProviderConfig() AddressProviderConfig

type Component

+ Start func(ctx context.Context) <-chan struct{}

type ComponentBase

+ func NewComponentWithStart(name string, start func(ctx context.Context), logger zerolog.Logger) *ComponentBase

+ func (c *ComponentBase) Start(ctx context.Context) <-chan struct{}

+ type Config struct

+ BatchSize int

+ ContinuousScan bool

+ Logger zerolog.Logger

+ Reporter StatusReporter

+ ScriptResultHandler ScriptResultHandler

+ func DefaultConfig() Config

+ func (c Config) WithBatchSize(value int) Config

+ func (c Config) WithCandidateScanners(value []candidates.CandidateScanner) Config

+ func (c Config) WithChainID(value flow.ChainID) Config

+ func (c Config) WithContinuousScan(value bool) Config

+ func (c Config) WithExcludeAddress(value func(id flow.ChainID, address flow.Address) bool) Config

+ func (c Config) WithHandleScriptError(value func(AddressBatch, error) ScriptErrorAction) Config

+ func (c Config) WithLogger(value zerolog.Logger) Config

+ func (c Config) WithMaxConcurrentScripts(value int) Config

+ func (c Config) WithScript(value []byte) Config

+ func (c Config) WithScriptResultHandler(value ScriptResultHandler) Config

+ func (c Config) WithStatusReporter(value StatusReporter) Config

+ type DefaultStatusReporter struct

+ func (r *DefaultStatusReporter) ReportFullScanProgress(current uint64, total uint64)

+ func (r *DefaultStatusReporter) ReportIncrementalBlockDiff(diff uint64)

+ func (r *DefaultStatusReporter) ReportIncrementalBlockHeight(height uint64)

+ func (r *DefaultStatusReporter) ReportIsFullScanRunning(running bool)

type FullScanRunner

+ func (r *FullScanRunner) NewBatch(blockHeight uint64) *FullScan

+ type FullScanRunnerConfig struct

+ ChainID flow.ChainID

+ func DefaultFullScanRunnerConfig() FullScanRunnerConfig

+ type IncrementalScannerConfig struct

+ CandidateScanners []candidates.CandidateScanner

+ func DefaultIncrementalScannerConfig() IncrementalScannerConfig

+ type ScriptErrorAction interface

+ func DefaultHandleScriptError(_ AddressBatch, err error) ScriptErrorAction

+ type ScriptErrorActionExclude struct

+ Addresses []flow.Address

+ type ScriptErrorActionNone struct

+ type ScriptErrorActionRetry struct

+ type ScriptErrorActionSplit struct

+ type ScriptErrorActionUnhandled struct

+ type ScriptRunnerConfig struct

+ HandleScriptError func(AddressBatch, error) ScriptErrorAction

+ MaxConcurrentScripts int

+ Script []byte

+ func DefaultScriptRunnerConfig() ScriptRunnerConfig

v0.2.2

Jan 30, 2023

v0.2.1

Jan 30, 2023

v0.2.0

Jan 20, 2023

Changes in this version

+ const DefaultStatusReporterPort

type ScanConcluded

+ ScanIsComplete bool

+ type Scanner struct

+ func NewScanner(client client.Client, options ...BlockScannerOption) *Scanner

+ func (scanner *Scanner) Scan() (ScanConcluded, error)

+ type StatusReporterOption = func(*statusReporter)

+ func WithStartServer(shouldStartServer bool) StatusReporterOption

+ func WithStatusReporterPort(port int) StatusReporterOption

v0.1.0

Jan 19, 2023

Changes in this version

+ const DefaultBatchSize

+ const FullScanReferenceBlockSwitch

+ const IncrementalScannerBlockLag

+ const IncrementalScannerMaxBlockGap

+ const ScriptRunnerMaxConcurrentScripts

+ type AddressBatch struct

+ Addresses []flow.Address

+ BlockHeight uint64

+ func NewAddressBatch(addresses []flow.Address, blockHeight uint64, doneHandling func(), ...) AddressBatch

+ func (b *AddressBatch) DoneHandling()

+ func (b *AddressBatch) ExcludeAddress(address flow.Address)

+ func (b *AddressBatch) IsValid() bool

+ type AddressProvider struct

+ func InitAddressProvider(ctx context.Context, log zerolog.Logger, chain flow.ChainID, ...) (*AddressProvider, error)

+ func (p *AddressProvider) AddressesLen() uint

+ func (p *AddressProvider) GenerateAddressBatches(addressChan chan<- []flow.Address, batchSize int)

+ func (p *AddressProvider) GetNextAddress() (address flow.Address, isOutOfBounds bool)

+ func (p *AddressProvider) LastAddress() flow.Address

+ type BlockScanner struct

+ func NewBlockScanner(client client.Client, options ...BlockScannerOption) *BlockScanner

+ func (scanner *BlockScanner) Scan() (ScanConcluded, error)

+ type BlockScannerOption = func(*BlockScanner)

+ func WithBatchSize(batchSize int) BlockScannerOption

+ func WithCandidateScanners(candidateScanners []candidates.CandidateScanner) BlockScannerOption

+ func WithChainID(chainID flow.ChainID) BlockScannerOption

+ func WithClient(client client.Client) BlockScannerOption

+ func WithContext(ctx context.Context) BlockScannerOption

+ func WithContinuousScan(continuous bool) BlockScannerOption

+ func WithLogger(logger zerolog.Logger) BlockScannerOption

+ func WithScript(script []byte) BlockScannerOption

+ func WithScriptResultHandler(handler ScriptResultHandler) BlockScannerOption

+ func WithStatusReporter(reporter StatusReporter) BlockScannerOption

+ type Component interface

+ Done func() <-chan struct{}

+ Err func() error

+ Started func() <-chan struct{}

+ type ComponentBase struct

+ Logger zerolog.Logger

+ func NewComponent(name string, logger zerolog.Logger) *ComponentBase

+ func (c *ComponentBase) Done() <-chan struct{}

+ func (c *ComponentBase) Err() error

+ func (c *ComponentBase) Finish(err error)

+ func (c *ComponentBase) Started() <-chan struct{}

+ func (c *ComponentBase) StartupDone()

+ type FullScan struct

+ type FullScanRunner struct

+ func NewFullScanRunner(client client.Client, addressBatchChan chan<- AddressBatch, batchSize int, ...) *FullScanRunner

+ func (r *FullScanRunner) StartBatch(ctx context.Context, blockHeight uint64) *FullScan

+ type IncrementalScanner struct

+ func NewIncrementalScanner(ctx context.Context, client client.Client, ...) *IncrementalScanner

+ func (r *IncrementalScanner) LatestHandledBlock() uint64

+ type NoOpScriptResultHandler struct

+ func (d NoOpScriptResultHandler) Handle(_ ProcessedAddressBatch) error

+ type NoOpStatusReporter struct

+ func (n NoOpStatusReporter) ReportFullScanProgress(uint64, uint64)

+ func (n NoOpStatusReporter) ReportIncrementalBlockDiff(uint64)

+ func (n NoOpStatusReporter) ReportIncrementalBlockHeight(uint64)

+ func (n NoOpStatusReporter) ReportIsFullScanRunning(bool)

+ type ProcessedAddressBatch struct

+ Result cadence.Value

+ type ScanConcluded struct

+ LatestScannedBlockHeight uint64

+ ScanIsAccurate bool

+ type ScriptResultHandler interface

+ Handle func(batch ProcessedAddressBatch) error

+ type ScriptResultProcessor struct

+ func NewScriptResultProcessor(ctx context.Context, outChan <-chan ProcessedAddressBatch, ...) *ScriptResultProcessor

+ type ScriptRunner struct

+ func NewScriptRunner(ctx context.Context, client client.Client, scriptCode []byte, ...) *ScriptRunner

+ type StatusReporter interface

+ ReportFullScanProgress func(current uint64, total uint64)

+ ReportIncrementalBlockDiff func(diff uint64)

+ ReportIncrementalBlockHeight func(height uint64)

+ ReportIsFullScanRunning func(running bool)

+ func NewStatusReporter(ctx context.Context, prefix string, logger zerolog.Logger) StatusReporter

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL