package octez-libs

  1. Overview
  2. Docs
package octez-libs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file tezos_context_disk.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2022-2022 Tarides <contact@tarides.com>                     *)
(*                                                                           *)
(* Permission is hereby granted, free of charge, to any person obtaining a   *)
(* copy of this software and associated documentation files (the "Software"),*)
(* to deal in the Software without restriction, including without limitation *)
(* the rights to use, copy, modify, merge, publish, distribute, sublicense,  *)
(* and/or sell copies of the Software, and to permit persons to whom the     *)
(* Software is furnished to do so, subject to the following conditions:      *)
(*                                                                           *)
(* The above copyright notice and this permission notice shall be included   *)
(* in all copies or substantial portions of the Software.                    *)
(*                                                                           *)
(* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR*)
(* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,  *)
(* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL   *)
(* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER*)
(* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING   *)
(* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER       *)
(* DEALINGS IN THE SOFTWARE.                                                 *)
(*                                                                           *)
(*****************************************************************************)

(** Context comes with two variants: [Context] and [Context_binary] with
    different tradeoffs.

    Both have different Merkle tree representations (i.e. when presented the
    same data, they don't produce the same hashes).

    [lib_context] represents directories as a structured tree of inodes, instead
    of a flat list of files, to get efficient copy-on-write and optimised read
    patterns.

    The context variants differ by the branching factors used for these inode
    trees:

    - [Context] uses a branching factor of 32;
    - [Context_binary] uses a branching factor of 2.

    To represent a large directory, [Context] uses less but larger inodes than
    [Context_binary].

    As persisting inodes on disk have an overhead (i.e. the serialisation of an
    inode is prefixed by its 32 byte hash), [Context] is thus optimised for
    storing a large quantity of data on disk.

    On the opposite, as the inodes in Merkle proofs contain the hashes of the
    shallow siblings, [Context_binary] is thus optimised for producing smaller
    Merkle proofs. *)

module type TEZOS_CONTEXT_UNIX = Context.TEZOS_CONTEXT_UNIX

module Context_binary = Context.Make (Tezos_context_encoding.Context_binary)

(** The context of a tezos node. Persisted to disk. *)
module Context = Context.Make (Tezos_context_encoding.Context)
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct