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

MinaProtocol / mina / 3496

18 Mar 2025 10:34PM UTC coverage: 35.85% (-24.9%) from 60.74%
3496

push

buildkite

web-flow
Merge pull request #16698 from MinaProtocol/dkijania/encapsulate_bk_cache

[CI] Unify buildkite cache access

25592 of 71386 relevant lines covered (35.85%)

26676.38 hits per line

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

27.18
/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

18
  val ledger_sync_config : Syncable_ledger.daemon_config
19

20
  val proof_cache_db : Proof_cache_tag.cache_db
21
end
22

23
module type Inputs_intf = sig
24
  module Transition_frontier : module type of Transition_frontier
25

26
  module Best_tip_prover :
27
    Mina_intf.Best_tip_prover_intf
28
      with type transition_frontier := Transition_frontier.t
29
end
30

31
module Make (Inputs : Inputs_intf) :
32
  Mina_intf.Sync_handler_intf
33
    with type transition_frontier := Inputs.Transition_frontier.t = struct
34
  open Inputs
35

36
  let find_in_root_history frontier state_hash =
37
    let open Transition_frontier.Extensions in
×
38
    let root_history =
39
      get_extension (Transition_frontier.extensions frontier) Root_history
×
40
    in
41
    Root_history.lookup root_history state_hash
×
42

43
  let protocol_states_in_root_history frontier state_hash =
44
    let open Transition_frontier.Extensions in
×
45
    let root_history =
46
      get_extension (Transition_frontier.extensions frontier) Root_history
×
47
    in
48
    Root_history.protocol_states_for_scan_state root_history state_hash
×
49

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

91
  let answer_query :
92
         frontier:Inputs.Transition_frontier.t
93
      -> Ledger_hash.t
94
      -> Sync_ledger.Query.t Envelope.Incoming.t
95
      -> context:(module CONTEXT)
96
      -> trust_system:Trust_system.t
97
      -> Sync_ledger.Answer.t Or_error.t Deferred.t =
98
   fun ~frontier hash query ~context:(module Context) ~trust_system ->
99
    match get_ledger_by_hash ~frontier hash with
23✔
100
    | None ->
1✔
101
        return
102
          (Or_error.error_string
1✔
103
             (sprintf
1✔
104
                !"Failed to find ledger for hash %{sexp:Ledger_hash.t}"
1✔
105
                hash ) )
106
    | Some ledger ->
22✔
107
        let responder =
108
          Sync_ledger.Any_ledger.Responder.create ledger ignore
109
            ~context:(module Context)
110
            ~trust_system
111
        in
112
        Sync_ledger.Any_ledger.Responder.answer_query responder query
22✔
113

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

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

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

208
  module Root = struct
209
    let prove ~context:(module Context : CONTEXT) ~frontier seen_consensus_state
210
        =
211
      let module Context = struct
×
212
        include Context
213

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

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

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

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

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

286
    let hb_logger = Logger.create ()
287

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

290
    let trust_system = Trust_system.null ()
291

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

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

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

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