• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

MinaProtocol / mina / 3001

01 Dec 2024 06:25PM UTC coverage: 36.257% (-24.4%) from 60.697%
3001

push

buildkite

web-flow
Merge pull request #16393 from leopardracer/patch-1

fix: typos in documentation files

25609 of 70631 relevant lines covered (36.26%)

27168.12 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

27.72
/src/lib/sync_handler/sync_handler.ml
1
open Core_kernel
5✔
2
open Async
3
open Mina_base
4
module Ledger = Mina_ledger.Ledger
5
module Sync_ledger = Mina_ledger.Sync_ledger
6
open Frontier_base
7
open Network_peer
8

9
module type CONTEXT = sig
10
  val logger : Logger.t
11

12
  val precomputed_values : Precomputed_values.t
13

14
  val constraint_constants : Genesis_constants.Constraint_constants.t
15

16
  val consensus_constants : Consensus.Constants.t
17
end
18

19
module type Inputs_intf = sig
20
  module Transition_frontier : module type of Transition_frontier
21

22
  module Best_tip_prover :
23
    Mina_intf.Best_tip_prover_intf
24
      with type transition_frontier := Transition_frontier.t
25
end
26

27
module Make (Inputs : Inputs_intf) :
28
  Mina_intf.Sync_handler_intf
29
    with type transition_frontier := Inputs.Transition_frontier.t = struct
30
  open Inputs
31

32
  let find_in_root_history frontier state_hash =
33
    let open Transition_frontier.Extensions in
×
34
    let root_history =
35
      get_extension (Transition_frontier.extensions frontier) Root_history
×
36
    in
37
    Root_history.lookup root_history state_hash
×
38

39
  let protocol_states_in_root_history frontier state_hash =
40
    let open Transition_frontier.Extensions in
×
41
    let root_history =
42
      get_extension (Transition_frontier.extensions frontier) Root_history
×
43
    in
44
    Root_history.protocol_states_for_scan_state root_history state_hash
×
45

46
  let get_ledger_by_hash ~frontier ledger_hash =
47
    let root_ledger =
23✔
48
      Ledger.Any_ledger.cast (module Ledger.Db)
49
      @@ Transition_frontier.root_snarked_ledger frontier
23✔
50
    in
51
    let staking_epoch_ledger =
23✔
52
      Transition_frontier.consensus_local_state frontier
23✔
53
      |> Consensus.Data.Local_state.staking_epoch_ledger
54
    in
55
    let next_epoch_ledger =
23✔
56
      Transition_frontier.consensus_local_state frontier
23✔
57
      |> Consensus.Data.Local_state.next_epoch_ledger
58
    in
59
    if
23✔
60
      Ledger_hash.equal ledger_hash
61
        (Ledger.Any_ledger.M.merkle_root root_ledger)
23✔
62
    then Some root_ledger
×
63
    else if
23✔
64
      Ledger_hash.equal ledger_hash
65
        (Consensus.Data.Local_state.Snapshot.Ledger_snapshot.merkle_root
23✔
66
           staking_epoch_ledger )
67
    then
68
      match staking_epoch_ledger with
11✔
69
      | Consensus.Data.Local_state.Snapshot.Ledger_snapshot.Genesis_epoch_ledger
1✔
70
          _ ->
71
          None
72
      | Ledger_db ledger ->
10✔
73
          Some (Ledger.Any_ledger.cast (module Ledger.Db) ledger)
10✔
74
    else if
12✔
75
      Ledger_hash.equal ledger_hash
76
        (Consensus.Data.Local_state.Snapshot.Ledger_snapshot.merkle_root
12✔
77
           next_epoch_ledger )
78
    then
79
      match next_epoch_ledger with
12✔
80
      | Consensus.Data.Local_state.Snapshot.Ledger_snapshot.Genesis_epoch_ledger
×
81
          _ ->
82
          None
83
      | Ledger_db ledger ->
12✔
84
          Some (Ledger.Any_ledger.cast (module Ledger.Db) ledger)
12✔
85
    else None
×
86

87
  let answer_query :
88
         frontier:Inputs.Transition_frontier.t
89
      -> Ledger_hash.t
90
      -> Sync_ledger.Query.t Envelope.Incoming.t
91
      -> context:(module CONTEXT)
92
      -> trust_system:Trust_system.t
93
      -> Sync_ledger.Answer.t Or_error.t Deferred.t =
94
   fun ~frontier hash query ~context:(module Context) ~trust_system ->
95
    let (module C : Syncable_ledger.CONTEXT) =
23✔
96
      ( module struct
97
        let logger = Context.logger
98

99
        let compile_config = Context.precomputed_values.compile_config
100
      end )
101
    in
102
    match get_ledger_by_hash ~frontier hash with
103
    | None ->
1✔
104
        return
105
          (Or_error.error_string
1✔
106
             (sprintf
1✔
107
                !"Failed to find ledger for hash %{sexp:Ledger_hash.t}"
1✔
108
                hash ) )
109
    | Some ledger ->
22✔
110
        let responder =
111
          Sync_ledger.Any_ledger.Responder.create ledger ignore
112
            ~context:(module C)
113
            ~trust_system
114
        in
115
        Sync_ledger.Any_ledger.Responder.answer_query responder query
22✔
116

117
  let get_staged_ledger_aux_and_pending_coinbases_at_hash ~frontier state_hash =
118
    let open Option.Let_syntax in
×
119
    let protocol_states scan_state =
120
      Staged_ledger.Scan_state.required_state_hashes scan_state
×
121
      |> State_hash.Set.to_list
×
122
      |> List.fold_until ~init:(Some [])
123
           ~f:(fun acc hash ->
124
             match
×
125
               Option.map2
126
                 (Transition_frontier.find_protocol_state frontier hash)
×
127
                 acc ~f:List.cons
128
             with
129
             | None ->
×
130
                 Stop None
131
             | Some acc' ->
×
132
                 Continue (Some acc') )
133
           ~finish:Fn.id
134
    in
135
    match
136
      let%bind breadcrumb = Transition_frontier.find frontier state_hash in
×
137
      let staged_ledger =
×
138
        Transition_frontier.Breadcrumb.staged_ledger breadcrumb
139
      in
140
      let scan_state = Staged_ledger.scan_state staged_ledger in
×
141
      let merkle_root =
×
142
        Staged_ledger.hash staged_ledger |> Staged_ledger_hash.ledger_hash
×
143
      in
144
      let%map scan_state_protocol_states = protocol_states scan_state in
×
145
      let pending_coinbase =
×
146
        Staged_ledger.pending_coinbase_collection staged_ledger
147
      in
148
      (scan_state, merkle_root, pending_coinbase, scan_state_protocol_states)
×
149
    with
150
    | Some res ->
×
151
        Some res
152
    | None ->
×
153
        let open Root_data.Historical in
154
        let%bind root = find_in_root_history frontier state_hash in
×
155
        let%map scan_state_protocol_states =
156
          protocol_states_in_root_history frontier state_hash
×
157
        in
158
        ( scan_state root
×
159
        , staged_ledger_target_ledger_hash root
×
160
        , pending_coinbase root
×
161
        , scan_state_protocol_states )
162

163
  let get_transition_chain ~frontier hashes =
164
    let open Option.Let_syntax in
×
165
    let%bind () =
166
      let requested = List.length hashes in
167
      if requested <= Transition_frontier.max_catchup_chunk_length then Some ()
×
168
      else (
×
169
        [%log' trace (Logger.create ())]
×
170
          ~metadata:[ ("n", `Int requested) ]
171
          "get_transition_chain requested $n > %d hashes"
172
          Transition_frontier.max_catchup_chunk_length ;
173
        None )
×
174
    in
175
    let get hash =
×
176
      let%map validated_transition =
177
        Option.merge
×
178
          Transition_frontier.(
179
            find frontier hash >>| Breadcrumb.validated_transition)
×
180
          ( find_in_root_history frontier hash
×
181
          >>| Root_data.Historical.transition )
×
182
          ~f:Fn.const
183
      in
184
      With_hash.data @@ Mina_block.Validated.forget validated_transition
×
185
    in
186
    match Transition_frontier.catchup_state frontier with
187
    | Full _ ->
×
188
        (* Super catchup *)
189
        Option.return @@ List.filter_map hashes ~f:get
×
190
    | Hash _ ->
×
191
        (* Normal catchup *)
192
        Option.all @@ List.map hashes ~f:get
×
193

194
  let best_tip_path ~frontier =
195
    let rec go acc b =
×
196
      let acc = Breadcrumb.state_hash b :: acc in
×
197
      match Transition_frontier.find frontier (Breadcrumb.parent_hash b) with
×
198
      | None ->
×
199
          acc
200
      | Some b' ->
×
201
          go acc b'
202
    in
203
    go [] (Transition_frontier.best_tip frontier)
×
204

205
  module Root = struct
206
    let prove ~context:(module Context : CONTEXT) ~frontier seen_consensus_state
207
        =
208
      let module Context = struct
×
209
        include Context
210

211
        let compile_config = precomputed_values.compile_config
212

213
        let logger =
214
          Logger.extend logger [ ("selection_context", `String "Root.prove") ]
×
215
      end in
216
      let open Option.Let_syntax in
217
      let%bind best_tip_with_witness =
218
        Best_tip_prover.prove ~context:(module Context) frontier
×
219
      in
220
      let is_tip_better =
×
221
        Consensus.Hooks.equal_select_status
222
          (Consensus.Hooks.select
223
             ~context:(module Context)
224
             ~existing:
225
               (With_hash.map ~f:Mina_block.consensus_state
×
226
                  best_tip_with_witness.data )
227
             ~candidate:seen_consensus_state )
228
          `Keep
229
      in
230
      let%map () = Option.some_if is_tip_better () in
×
231
      { best_tip_with_witness with
×
232
        data = With_hash.data best_tip_with_witness.data
×
233
      }
234

235
    let verify ~context:(module Context : CONTEXT) ~verifier observed_state
236
        peer_root =
237
      let module Context = struct
×
238
        include Context
239

240
        let compile_config = precomputed_values.compile_config
241

242
        let logger =
243
          Logger.extend logger [ ("selection_context", `String "Root.verify") ]
×
244
      end in
245
      let open Context in
246
      let open Deferred.Result.Let_syntax in
247
      (*TODO: use precomputed_values.genesis_constants that's already passed*)
248
      let%bind ( (`Root _, `Best_tip (best_tip_transition, _)) as
249
               verified_witness ) =
250
        Best_tip_prover.verify ~verifier
×
251
          ~genesis_constants:precomputed_values.genesis_constants
252
          ~precomputed_values peer_root
253
      in
254
      let is_before_best_tip candidate =
×
255
        Consensus.Hooks.equal_select_status
×
256
          (Consensus.Hooks.select
257
             ~context:(module Context)
258
             ~existing:
259
               (With_hash.map ~f:Mina_block.consensus_state best_tip_transition)
×
260
             ~candidate )
261
          `Keep
262
      in
263
      let%map () =
264
        Deferred.return
×
265
          (Result.ok_if_true
×
266
             (is_before_best_tip observed_state)
×
267
             ~error:
268
               (Error.createf
×
269
                  !"Peer lied about it's best tip %{sexp:State_hash.t}"
×
270
                  (State_hash.With_state_hashes.state_hash best_tip_transition) ) )
×
271
      in
272
      verified_witness
×
273
  end
274
end
275

276
include Make (struct
277
  module Transition_frontier = Transition_frontier
278
  module Best_tip_prover = Best_tip_prover
279
end)
10✔
280

281
(* TODO: port these tests *)
282
(*
283
let%test_module "Sync_handler" =
284
  ( module struct
285
    let logger = Logger.null ()
286

287
    let hb_logger = Logger.create ()
288

289
    let pids = Child_processes.Termination.create_pid_table ()
290

291
    let trust_system = Trust_system.null ()
292

293
    let f_with_verifier ~f ~logger ~pids =
294
      let%map verifier = Verifier.create ~logger ~pids in
295
      f ~logger ~verifier
296

297
    let%test "sync with ledgers from another peer via glue_sync_ledger" =
298
      Backtrace.elide := false ;
299
      Printexc.record_backtrace true ;
300
      heartbeat_flag := true ;
301
      Ledger.with_ephemeral_ledger ~f:(fun dest_ledger ->
302
          Thread_safe.block_on_async_exn (fun () ->
303
              print_heartbeat hb_logger |> don't_wait_for ;
304
              let%bind frontier =
305
                create_root_frontier ~logger ~pids Test_genesis_ledger.accounts
306
              in
307
              let source_ledger =
308
                Transition_frontier.For_tests.root_snarked_ledger frontier
309
                |> Ledger.of_database
310
              in
311
              let desired_root = Ledger.merkle_root source_ledger in
312
              let sync_ledger =
313
                Sync_ledger.Mask.create dest_ledger ~logger ~trust_system
314
              in
315
              let query_reader = Sync_ledger.Mask.query_reader sync_ledger in
316
              let answer_writer = Sync_ledger.Mask.answer_writer sync_ledger in
317
              let peer =
318
                Network_peer.Peer.create Unix.Inet_addr.localhost
319
                  ~discovery_port:0 ~communication_port:1
320
              in
321
              let network =
322
                Network.create_stub ~logger
323
                  ~ip_table:
324
                    (Hashtbl.of_alist_exn
325
                       (module Unix.Inet_addr)
326
                       [(peer.host, frontier)])
327
                  ~peers:(Hash_set.of_list (module Network_peer.Peer) [peer])
328
              in
329
              Network.glue_sync_ledger network query_reader answer_writer ;
330
              match%map
331
                Sync_ledger.Mask.fetch sync_ledger desired_root ~data:()
332
                  ~equal:(fun () () -> true)
333
              with
334
              | `Ok synced_ledger ->
335
                  heartbeat_flag := false ;
336
                  Ledger_hash.equal
337
                    (Ledger.merkle_root dest_ledger)
338
                    (Ledger.merkle_root source_ledger)
339
                  && Ledger_hash.equal
340
                       (Ledger.merkle_root synced_ledger)
341
                       (Ledger.merkle_root source_ledger)
342
              | `Target_changed _ ->
343
                  heartbeat_flag := false ;
344
                  failwith "target of sync_ledger should not change" ) )
345

346
    let to_external_transition breadcrumb =
347
      Transition_frontier.Breadcrumb.validated_transition breadcrumb
348
      |> Mina_block.Validated.forget
349

350
    let%test "a node should be able to give a valid proof of their root" =
351
      heartbeat_flag := true ;
352
      let max_length = 4 in
353
      (* Generating this many breadcrumbs will ernsure the transition_frontier to be full  *)
354
      let num_breadcrumbs = max_length + 2 in
355
      Thread_safe.block_on_async_exn (fun () ->
356
          print_heartbeat hb_logger |> don't_wait_for ;
357
          let%bind frontier =
358
            create_root_frontier ~logger ~pids Test_genesis_ledger.accounts
359
          in
360
          let%bind () =
361
            build_frontier_randomly frontier
362
              ~gen_root_breadcrumb_builder:
363
                (gen_linear_breadcrumbs ~logger ~pids ~trust_system
364
                   ~size:num_breadcrumbs
365
                   ~accounts_with_secret_keys:Test_genesis_ledger.accounts)
366
          in
367
          let seen_transition =
368
            Transition_frontier.(
369
              all_breadcrumbs frontier |> List.permute |> List.hd_exn
370
              |> Breadcrumb.validated_transition)
371
          in
372
          let observed_state =
373
            Mina_block.Validated.protocol_state seen_transition
374
            |> Protocol_state.consensus_state
375
          in
376
          let root_with_proof =
377
            Option.value_exn ~message:"Could not produce an ancestor proof"
378
              (Sync_handler.Root.prove ~logger ~frontier observed_state)
379
          in
380
          let%bind verify =
381
            f_with_verifier ~f:Sync_handler.Root.verify ~logger ~pids
382
          in
383
          let%map `Root (root_transition, _), `Best_tip (best_tip_transition, _)
384
              =
385
            verify observed_state root_with_proof |> Deferred.Or_error.ok_exn
386
          in
387
          heartbeat_flag := false ;
388
          Mina_block.(
389
            equal
390
              (With_hash.data root_transition)
391
              (to_external_transition (Transition_frontier.root frontier))
392
            && equal
393
                 (With_hash.data best_tip_transition)
394
                 (to_external_transition
395
                    (Transition_frontier.best_tip frontier))) )
396
  end )
397
*)
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc