58 lines
2.3 KiB
OCaml
58 lines
2.3 KiB
OCaml
|
(**************************************************************************)
|
||
|
|
(* *)
|
||
|
|
(* Copyright (c) 2014 - 2016. *)
|
||
|
|
(* Dynamic Ledger Solutions, Inc. <contact@tezos.com> *)
|
||
|
|
(* *)
|
||
|
|
(* All rights reserved. No warranty, explicit or implicit, provided. *)
|
||
|
|
(* *)
|
||
|
|
(**************************************************************************)
|
||
|
|
|
||
|
|
open State
|
||
|
|
|
||
|
|
type t = private Block_hash.t list
|
||
|
|
(** A type for sparse block locator (/à la/ Bitcoin) *)
|
||
|
|
|
||
|
|
val encoding: t Data_encoding.t
|
||
|
|
|
||
|
|
type error += Invalid_locator of P2p.Peer_id.t * t
|
||
|
|
|
||
|
|
val compute: Block.t -> int -> t Lwt.t
|
||
|
|
(** [compute block max_length] compute the sparse block locator for
|
||
|
|
the [block]. The locator contains at most [max_length] elements. *)
|
||
|
|
|
||
|
|
val fold:
|
||
|
|
f:('a -> block:Block_hash.t -> pred:Block_hash.t -> step:int -> strict_step:bool -> 'a) ->
|
||
|
|
'a -> t -> 'a
|
||
|
|
(** [map f l] applies [f] to each block of the locator, the last one
|
||
|
|
excepted. The function also receives the expected predecessor
|
||
|
|
[pred] of the [block] after [step] steps, i.e. the next block in
|
||
|
|
the locator. When [strict_step] is [true], then [step] is the
|
||
|
|
exact number of predecessor to be followed before to found
|
||
|
|
[pred]. Otherwise, it is only an upper bound. *)
|
||
|
|
|
||
|
|
type step = {
|
||
|
|
block: Block_hash.t ;
|
||
|
|
predecessor: Block_hash.t ;
|
||
|
|
step: int ;
|
||
|
|
strict_step: bool ;
|
||
|
|
}
|
||
|
|
val to_steps: t -> step list
|
||
|
|
|
||
|
|
val estimated_length: t -> int
|
||
|
|
(** [estimated_length locator] estimate the length of the chain
|
||
|
|
represented by [locator]. *)
|
||
|
|
|
||
|
|
val known_ancestor: State.Net.t -> t -> (Block.t * t) option Lwt.t
|
||
|
|
(** [known_ancestor net_state locator] computes the first block of
|
||
|
|
[locator] that is known to be a valid block. It also computes the
|
||
|
|
'prefix' of [locator] with end at the first valid block. The
|
||
|
|
function returns [None] when no block in the locator are known or
|
||
|
|
if the first known block is invalid. *)
|
||
|
|
|
||
|
|
val find_new:
|
||
|
|
State.Net.t -> t -> int -> Block_hash.t list Lwt.t
|
||
|
|
(** [find_new net locator max_length] returns the blocks from our
|
||
|
|
current branch that would be unknown to a peer that sends us the
|
||
|
|
[locator]. *)
|
||
|
|
|