Source file `mempool.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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2018 Dynamic Ledger Solutions, Inc. <contact@tezos.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.                                                 *)
(*                                                                           *)
(*****************************************************************************)

type t = {
  known_valid : Tezos_crypto.Hashed.Operation_hash.Set.t;
  pending : Tezos_crypto.Hashed.Operation_hash.Set.t;
}

type mempool = t

let encoding =
  let open Data_encoding in
  def
    "mempool"
    ~description:
      "A batch of operation. This format is used to gossip operations between \
       peers."
  @@ conv
       (fun {known_valid; pending} -> (known_valid, pending))
       (fun (known_valid, pending) -> {known_valid; pending})
       (obj2
          (req "known_valid" Tezos_crypto.Hashed.Operation_hash.Set.encoding)
          (req
             "pending"
             (* This [dynamic_size] is redundant with the [Set]'s
                internal [dynamic_size]. Removing it would require to
                handle retro-compatibility as other nodes would
                use/expect the legacy encoding. *)
             (dynamic_size Tezos_crypto.Hashed.Operation_hash.Set.encoding)))

let bounded_encoding ?max_operations () =
  match max_operations with
  | None -> encoding
  | Some max_operations ->
      Data_encoding.check_size
        (8 + (max_operations * Tezos_crypto.Hashed.Operation_hash.size))
        encoding

let empty =
  {
    known_valid = Tezos_crypto.Hashed.Operation_hash.Set.empty;
    pending = Tezos_crypto.Hashed.Operation_hash.Set.empty;
  }

let is_empty {known_valid; pending} =
  Tezos_crypto.Hashed.Operation_hash.Set.is_empty known_valid
  && Tezos_crypto.Hashed.Operation_hash.Set.is_empty pending

let remove oph {known_valid; pending} =
  {
    known_valid = Tezos_crypto.Hashed.Operation_hash.Set.remove oph known_valid;
    pending = Tezos_crypto.Hashed.Operation_hash.Set.remove oph pending;
  }

let cons_valid oph t =
  {
    known_valid = Tezos_crypto.Hashed.Operation_hash.Set.add oph t.known_valid;
    pending = t.pending;
  }

let () = Data_encoding.Registration.register encoding