firecore

Aug 27, 2024

Changes in this version

+ var TmpDir string = "{data-dir}/tmp"

+ func GetTmpDir(dataDir string) (tmpDir string, err error)

type Chain

+ InfoResponseFiller func(firstStreamableBlock *pbbstream.Block, resp *pbfirehose.InfoResponse, ...) error

Apr 11, 2024

Changes in this version

type Chain

+ DefaultBlockType string

Mar 1, 2024

Changes in this version

+ var ReaderNodeVariables = maps.Keys(ReaderNodeVariablesDocumentation)

+ var ReaderNodeVariablesDocumentation = map[string]string

+ func DefaultReaderNodeBootstrapDataURLFlagDescription() string

+ func ReaderNodeVariablesValues(resolver ReaderNodeArgumentResolver) map[string]string

+ type BashNodeBootstrapper struct

+ func NewBashNodeReaderBootstrapper(cmd *cobra.Command, url string, resolver ReaderNodeArgumentResolver, ...) *BashNodeBootstrapper

+ func (b *BashNodeBootstrapper) Bootstrap() error

+ type ReaderNodeBootstrapperFactory func(ctx context.Context, logger *zap.Logger, cmd *cobra.Command, ...) (operator.Bootstrapper, error)

+ func DefaultReaderNodeBootstrapper(overrideFactory ReaderNodeBootstrapperFactory) ReaderNodeBootstrapperFactory

+ type TarballNodeBootstrapper struct

+ func NewTarballReaderNodeBootstrapper(url string, dataDir string, logger *zap.Logger) *TarballNodeBootstrapper

+ func (b *TarballNodeBootstrapper) Bootstrap() error

Feb 16, 2024

Changes in this version

type MergedBlocksWriter

+ func (w *MergedBlocksWriter) WriteBundle() error

Jan 29, 2024

Changes in this version

+ var BlockMetaServiceAddr string = ":10008"

+ var BlockMetaStoreURL string = "file://{data-dir}/storage/block-meta"

+ var StreamMergedBlocksPreprocThreads = 25

+ func GetBlockMetaStoreURL(dataDir string) (blockMetaStoreURL string, err error)

+ type StreamFactory struct

+ func NewStreamFactory(mergedBlocksStore dstore.Store, forkedBlocksStore dstore.Store, ...) *StreamFactory

+ func (sf *StreamFactory) New(ctx context.Context, handler bstream.Handler, request *pbfirehose.Request, ...) (*stream.Stream, error)

Jan 24, 2024

Changes in this version

+ var ConsoleReaderBlockReadCount = metrics.NewCounter("firecore_console_reader_block_read_count", ...)

+ var UnsafeAllowExecutableNameToBeEmpty = false

+ var UnsafeRunningFromFirecore = false

+ func RegisterMetrics()

type ConsoleReader

+ func (r *ConsoleReader) Close() error

+ type ParsingStats struct

Dec 8, 2023

Changes in this version

+ const BlockLogPrefix

+ const BlockLogPrefixLen

+ const FirePrefix

+ const FirePrefixLen

+ const InitLogPrefix

+ const InitLogPrefixLen

+ var MaxUint64 = ^uint64(0)

+ var RunningFromFirecore = false

+ func HideGlobalFlagsOnChildCmd(cmd *cobra.Command)

+ func LowBoundary(i uint64) uint64

+ func MakeDirs(directories []string) error

+ func MustParseUint64(s string) uint64

+ func NewConsoleReader(lines chan string, blockEncoder BlockEncoder, logger *zap.Logger, ...) (mindreader.ConsolerReader, error)

+ func SplitInBoundedChunks(line string, count int) ([]string, error)

+ type ConsoleReader struct

+ func (r *ConsoleReader) Done() <-chan interface{}

+ func (r *ConsoleReader) ReadBlock() (out *pbbstream.Block, err error)

+ type MergedBlocksWriter struct

+ Cmd *cobra.Command

+ Logger *zap.Logger

+ LowBlockNum uint64

+ StopBlockNum uint64

+ Store dstore.Store

+ TweakBlock func(*pbbstream.Block) (*pbbstream.Block, error)

+ func (w *MergedBlocksWriter) ProcessBlock(blk *pbbstream.Block, obj interface{}) error

Nov 9, 2023

Changes in this version

+ var ErrInvalidPrintOutputMode = fmt.Errorf("not a valid PrintOutputMode, try [%s]", ...)

+ var UnsafeJsonBytesEncoder = "hex"

+ func InitBstream(protocol string, protocolVersion int32, acceptedPayloadVersions []int32, ...)

type Block

+ GetFirehoseBlockParentNumber func() uint64

+ GetFirehoseBlockVersion func() int32

type BlockEncoder

+ func NewBlockEncoder() BlockEncoder

+ type BlockEnveloppe struct

+ LIBNum uint64

+ func (b BlockEnveloppe) GetFirehoseBlockLIBNum() uint64

+ type BlockLIBNumDerivable interface

+ GetFirehoseBlockLIBNum func() uint64

type Chain

+ BlockAcceptedVersions []int32

type PrintOutputMode

+ const PrintOutputModeJSONL

+ func (x PrintOutputMode) IsValid() bool

+ type ReaderNodeArgumentResolver = func(in string) string

+ type TransformFlags struct

+ Parse func(cmd *cobra.Command, logger *zap.Logger) ([]*anypb.Any, error)

+ Register func(flags *pflag.FlagSet)

Sep 18, 2023

Changes in this version

+ func Compare(reference, current proto.Message, ignoreUnknown bool) (isEqual bool, differences []string)

+ type SanitizeBlockForCompareFunc func(block B) B

type ToolsConfig

+ SanitizeBlockForCompare SanitizeBlockForCompareFunc[B]

+ func (t *ToolsConfig[B]) GetSanitizeBlockForCompare() SanitizeBlockForCompareFunc[B]

Aug 30, 2023

Changes in this version

+ var UnsafeResolveReaderNodeStartBlock = func(ctx context.Context, command *cobra.Command, runtime *launcher.Runtime, ...) (uint64, error)

+ func LastMergedBlockNum(ctx context.Context, startBlockNum uint64, store dstore.Store, ...) uint64

Jul 12, 2023

Changes in this version

+ var IndexBuilderServiceAddr string = ":10009"

+ var SubstreamsTier1GRPCServingAddr string = ":10016"

+ var SubstreamsTier2GRPCServingAddr string = ":10017"

+ var UnsafePayloadKind pbbstream.Protocol = pbbstream.Protocol_UNKNOWN

+ func EncodeBlock(protocolVersion int32, b Block) (blk *bstream.Block, err error)

+ func NewToolsUpgradeMergedBlocksCmd(chain *Chain[B]) *cobra.Command

+ type Block interface

+ GetFirehoseBlockID func() string

+ GetFirehoseBlockLIBNum func() uint64

+ GetFirehoseBlockNumber func() uint64

+ GetFirehoseBlockParentID func() string

+ GetFirehoseBlockTime func() time.Time

+ type BlockEncoder interface

+ Encode func(block Block) (blk *bstream.Block, err error)

+ func NewGenericBlockEncoder(protocolVersion int32) BlockEncoder

+ type BlockEncoderFunc func(block Block) (blk *bstream.Block, err error)

+ func (f BlockEncoderFunc) Encode(block Block) (blk *bstream.Block, err error)

+ type BlockIndexer interface

+ ProcessBlock func(block B) error

+ type BlockIndexerFactory func(indexStore dstore.Store, indexSize uint64) (BlockIndexer[B], error)

+ type BlockTransformerFactory func(indexStore dstore.Store, indexPossibleSizes []uint64) (*transform.Factory, error)

type Chain

+ BlockEncoder BlockEncoder

+ BlockFactory func() Block

+ BlockIndexerFactories map[string]BlockIndexerFactory[B]

+ BlockTransformerFactories map[protoreflect.FullName]BlockTransformerFactory

+ Protocol string

+ ProtocolVersion int32

+ ReaderNodeBootstrapperFactory func(cmd *cobra.Command, nodeDataDir string) (operator.Bootstrapper, error)

+ RegisterExtraStartFlags func(flags *pflag.FlagSet)

+ RegisterSubstreamsExtensions func(chain *Chain[B]) ([]SubstreamsExtension, error)

+ func (c *Chain[B]) Init()

+ type SubstreamsExtension struct

+ PipelineOptioner pipeline.PipelineOptioner

+ WASMExtensioner wasm.WASMExtensioner

type ToolsConfig

+ MergedBlockUpgrader func(block *bstream.Block) (*bstream.Block, error)

+ RegisterExtraCmd func(chain *Chain[B], toolsCmd *cobra.Command, zlog *zap.Logger, ...) error

+ TransformFlags map[string]*TransformFlag

+ type TransformFlag struct

+ Description string

+ Parser TransformFlagParser

+ type TransformFlagParser func(in string) (*anypb.Any, error)

Apr 4, 2023

Changes in this version

+ var BlocksCacheDirectory string = "file://{data-dir}/storage/blocks-cache"

+ var Example = func(in string) string

+ var ExamplePrefixed = func(chain *Chain, prefix, in string) string

+ var FirehoseGRPCServingAddr string = ":10015"

+ var ForkedBlocksStoreURL string = "file://{data-dir}/storage/forked-blocks"

+ var IndexStoreURL string = "file://{data-dir}/storage/index"

+ var MergedBlocksStoreURL string = "file://{data-dir}/storage/merged-blocks"

+ var MergerServingAddr string = ":10012"

+ var MetricsListenAddr string = ":9102"

+ var OneBlockStoreURL string = "file://{data-dir}/storage/one-blocks"

+ var ReaderNodeGRPCAddr string = ":10010"

+ var ReaderNodeManagerAPIAddr string = ":10011"

+ var RelayerServingAddr string = ":10014"

+ func GetCommonStoresURLs(dataDir string) (mergedBlocksStoreURL, oneBlocksStoreURL, forkedBlocksStoreURL string, ...)

+ func GetIndexStore(dataDir string) (indexStore dstore.Store, possibleIndexSizes []uint64, err error)

+ func Main(chain *Chain)

+ func MustReplaceDataDir(dataDir, in string) string

+ func PrintOutputModeNames() []string

+ type BlockPrinterFunc func(block *bstream.Block, alsoPrintTransactions bool, out io.Writer) error

+ type Chain struct

+ BlockDifferenceThresholdConsideredNear uint64

+ ChainSuperviserFactory func(chainShortName string, binary string, arguments []string, dataDir string, ...) (nodeManager.ChainSuperviser, error)

+ ConsoleReaderFactory func(lines chan string, logger *zap.Logger, tracer logging.Tracer) (mindreader.ConsolerReader, error)

+ ExecutableName string

+ FirstStreamableBlock uint64

+ FullyQualifiedModule string

+ LongName string

+ ShortName string

+ Tools *ToolsConfig

+ Version string

+ func (c *Chain) BinaryName() string

+ func (c *Chain) BlockPrinter() BlockPrinterFunc

+ func (c *Chain) LoggerPackageID(subPackage string) string

+ func (c *Chain) RootLoggerPackageID() string

+ func (c *Chain) Validate()

+ func (c *Chain) VersionString() string

+ type CommandExecutor func(cmd *cobra.Command, args []string) (err error)

+ type PrintOutputMode uint

+ const PrintOutputModeJSON

+ const PrintOutputModeText

+ func ParsePrintOutputMode(name string) (PrintOutputMode, error)

+ func (x *PrintOutputMode) UnmarshalText(text []byte) error

+ func (x PrintOutputMode) MarshalText() ([]byte, error)

+ func (x PrintOutputMode) String() string

+ type ToolsConfig struct

+ BlockPrinter BlockPrinterFunc