sftools

README

on StreamingFast Tools Library

All the on StreamingFast top-level binary like sf-ethereum, sf-near and all others have a bunch of tools to help maintain and debug the various elements of the stack.

This repository contains a chain agnostic shared library that is used to avoid duplication across all projects. It never has chain specific code and everything that is chain specific is injected into the appropriate function.

By conventions, all the functions exported by this library related to specific tooling assumes full control of the console output. If pretty print elements. This greatly reduce the complexity and the specific project can share as much code as possible.

API

• CheckMergedBlocks

Documentation

Index

• Variables
• func CheckMergedBlocks(ctx context.Context, logger *zap.Logger, storeURL string, fileBlockSize uint32, ...) error
• func RoundToBundleEndBlock(block, fileBlockSize uint32) uint32
• func RoundToBundleStartBlock(block, fileBlockSize uint32) uint32
• func WalkBlockPrefix(blockRange BlockRange, fileBlockSize uint32) string
• type BlockNum
  • func (b BlockNum) String() string
• type BlockRange
  • func (b BlockRange) ReprocRange() string
  • func (b BlockRange) String() string
  • func (b BlockRange) Unbounded() bool
• type FilteringFilters
  • func (f *FilteringFilters) Key() string
• type PrintDetails

Variables

var Flags = &flags{}

Functions

func CheckMergedBlocks

func CheckMergedBlocks(
	ctx context.Context,
	logger *zap.Logger,
	storeURL string,
	fileBlockSize uint32,
	blockRange BlockRange,
	blockPrinter func(block *bstream.Block),
	printDetails PrintDetails,
) error

func RoundToBundleEndBlock

func RoundToBundleEndBlock(block, fileBlockSize uint32) uint32

func RoundToBundleStartBlock

func RoundToBundleStartBlock(block, fileBlockSize uint32) uint32

func WalkBlockPrefix

func WalkBlockPrefix(blockRange BlockRange, fileBlockSize uint32) string

Types

type BlockNum

type BlockNum uint64

func (BlockNum) String

func (b BlockNum) String() string

type BlockRange

type BlockRange struct {
	Start uint64
	Stop  uint64
}

func (BlockRange) ReprocRange

func (b BlockRange) ReprocRange() string

func (BlockRange) String

func (b BlockRange) String() string

func (BlockRange) Unbounded

func (b BlockRange) Unbounded() bool

type FilteringFilters

type FilteringFilters struct {
	Include string
	Exclude string
	System  string
}

func (*FilteringFilters) Key

func (f *FilteringFilters) Key() string

type PrintDetails

type PrintDetails uint8

const (
	PrintNothing PrintDetails = iota
	PrintStats
	PrintFull
)