Base: Add block header docstring

This commit is contained in:
Pietro 2018-09-30 15:02:05 +02:00 committed by Benjamin Canou
parent 494a4be140
commit 6a83898d98
2 changed files with 16 additions and 3 deletions

View File

@ -29,10 +29,11 @@ The shell header contains
- ``fitness``: a sequence of sequences of unsigned bytes, ordered by - ``fitness``: a sequence of sequences of unsigned bytes, ordered by
length and then lexicographically. It represents the claimed fitness length and then lexicographically. It represents the claimed fitness
of the chain ending in this block. of the chain ending in this block.
- ``operations_hash`` The root hash of a merkle tree of a list of root - ``operations_hash`` The hash of a list of root hashes of merkle
hashes of merkle trees for various sets of operations in the block. trees of operations. There is one list of operations per
validation pass
- ``context`` Hash of the state of the context after application of - ``context`` Hash of the state of the context after application of
this block. Useful for light clients. this block.
Protocol header (for tezos.alpha): Protocol header (for tezos.alpha):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@ -25,13 +25,25 @@
type shell_header = { type shell_header = {
level: Int32.t ; level: Int32.t ;
(** Height of the block, from the genesis block. *)
proto_level: int ; (* uint8 *) proto_level: int ; (* uint8 *)
(** Number of protocol changes since genesis modulo 256. *)
predecessor: Block_hash.t ; predecessor: Block_hash.t ;
(** Hash of the preceding block. *)
timestamp: Time.t ; timestamp: Time.t ;
(** Timestamp at which the block is claimed to have been created. *)
validation_passes: int ; (* uint8 *) validation_passes: int ; (* uint8 *)
(** Number of validation passes (also number of lists of operations). *)
operations_hash: Operation_list_list_hash.t ; operations_hash: Operation_list_list_hash.t ;
(** Hash of the list of lists (actually root hashes of merkle trees)
of operations included in the block. There is one list of
operations per validation pass. *)
fitness: Fitness.t ; fitness: Fitness.t ;
(** A sequence of sequences of unsigned bytes, ordered by length and
then lexicographically. It represents the claimed fitness of the
chain ending in this block. *)
context: Context_hash.t ; context: Context_hash.t ;
(** Hash of the state of the context after application of this block. *)
} }
val shell_header_encoding: shell_header Data_encoding.t val shell_header_encoding: shell_header Data_encoding.t