package tezos-shell

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

The bootstrap pipeline works as follows: 1. From a locator, it computes a list of subchains (identified by a Block_locator.step) to fetch. 2. A worker starts to fetch all the headers (top to bottom) from a subchain, starting with the top subchain. 3. A worker starts to download the list of operations by batch of blocks once a batch of headers is available. 4. A worker validates blocks one by one (bottom to top).

These three workers work concurrently.

type t
val create : ?notify_new_block:(State.Block.t -> unit) -> block_header_timeout:Tezos_base.Time.System.Span.t -> block_operations_timeout:Tezos_base.Time.System.Span.t -> Block_validator.t -> Tezos_base.P2p_peer.Id.t -> Distributed_db.chain_db -> Tezos_base.Block_locator.t -> t

create ?notify_new_block ~block_header_timeout ~block_operations_timeout validator peer ddb locator initializes a bootstrap_pipeline for a locator sent by peer. It uses the Distributed_db to fetch the data needed and validator to validate blocks one by one with the function Block_validator.validate.

Moreover:

  • notify_new_block is a called everytime a valid block is received.
  • block_header_timeout is the timeout to fetch a block_header.
  • block_operations_timeout is the timeout to fetch a block operation.

If a timeout is triggered, the whole bootstrap_pipeline is canceled.

val wait : t -> (unit, Tezos_error_monad.TzCore.error list) Stdlib.result Lwt.t
val cancel : t -> unit Lwt.t

length pipeline returns the number of the headers and blocks fetched

OCaml

Innovation. Community. Security.