Merge pull request #18106 from MinaProtocol/lyh/vesting-param-update

Apply vesting params update to runtime genesis ledger and root

Author: dannywillems

changes/18106.md

@@ -0,0 +1,4 @@
+runtime-genesis-ledger: added a new cli flag `--hardfork-slot`. It is the scheduled hardfork slot since last hardfork at which vesting parameter update should happen. User must also pass in a companion `--prefork-genesis-config` specifying the prefork genesis config's file path, used to provide the fork slot of the last fork. If they're both absent, no update will be applied for vesting parameters.
+
+daemon: now when `--hardfork-handling` is set to `migrate-exit` we will enforce `slot_chain_end` & `hard_fork_genesis_slot_delta` being set in config, and the vesting parameter update would be applied when converting ledger into hardfork format.
+

src/app/archive/lib/processor.ml

@@ -4637,9 +4637,9 @@ let add_genesis_accounts ~logger ~(runtime_config_opt : Runtime_config.t option)
           Genesis_ledger_helper.init_from_config_file ~logger
             ~proof_level:Genesis_constants.Compiled.proof_level
             ~genesis_constants ~constraint_constants runtime_config
-            ~cli_proof_level:None ~genesis_backing_type:Stable_db
+            ~cli_proof_level:None ~ledger_backing:Stable_db
         with
-        | Ok (precomputed_values, _) ->
+        | Ok precomputed_values ->
             precomputed_values
         | Error err ->
             failwithf "Could not get precomputed values, error: %s"

src/app/cli/src/cli_entrypoint/mina_cli_entrypoint.ml

@@ -49,9 +49,37 @@ let plugin_flag =
          times"
   else Command.Param.return []
 
+let make_ledger_backing ~constraint_constants ~runtime_config ~hardfork_handling
+    =
+  let current_genesis_global_slot =
+    let%map.Option { global_slot_since_genesis = current_genesis_global_slot
+                   ; _
+                   } =
+      constraint_constants.Genesis_constants.Constraint_constants.fork
+    in
+    current_genesis_global_slot
+  in
+  let hardfork_slot =
+    let%map.Option hardfork_slot_since_last_hf =
+      Runtime_config.scheduled_hard_fork_genesis_slot runtime_config
+    in
+    Mina_numbers.Global_slot_since_hard_fork.to_global_slot_since_genesis
+      ~current_genesis_global_slot hardfork_slot_since_last_hf
+  in
+
+  match (hardfork_handling, hardfork_slot) with
+  | Cli_lib.Arg_type.Hardfork_handling.Migrate_exit, Some hardfork_slot ->
+      Mina_ledger.Root.Config.Converting_db hardfork_slot
+  | Migrate_exit, _ ->
+      failwith
+        "No hardfork slot provided for Migrate_exit mode, \
+         `daemon.{slot_chain_end,hard_fork_genesis_slot_delta}` need to be \
+         configured for using this HF mode."
+  | Keep_running, _ ->
+      Stable_db
+
 let load_config_files ~logger ~genesis_constants ~constraint_constants ~conf_dir
-    ~genesis_dir ~cli_proof_level ~proof_level ~genesis_backing_type
-    config_files =
+    ~genesis_dir ~cli_proof_level ~proof_level ~hardfork_handling config_files =
   let%bind config_jsons =
     let config_files_paths =
       List.map config_files ~f:(fun (config_file, _) -> `String config_file)
@@ -98,19 +126,23 @@ let load_config_files ~logger ~genesis_constants ~constraint_constants ~conf_dir
                 ] ;
             failwithf "Could not parse configuration file: %s" err () )
   in
+  let ledger_backing =
+    make_ledger_backing ~constraint_constants ~runtime_config:config
+      ~hardfork_handling
+  in
   let chain_state_locations =
     Init.Chain_state_locations.of_config ~conf_dir config
   in
   let genesis_dir =
     Option.value ~default:chain_state_locations.genesis genesis_dir
   in
-  let%bind precomputed_values =
+  let%map precomputed_values =
     match%map
       Genesis_ledger_helper.init_from_config_file ~cli_proof_level ~genesis_dir
         ~logger ~genesis_constants ~constraint_constants ~proof_level
-        ~genesis_backing_type config
+        ~ledger_backing config
     with
-    | Ok (precomputed_values, _) ->
+    | Ok precomputed_values ->
         precomputed_values
     | Error err ->
         let ( json_config
@@ -143,7 +175,11 @@ let load_config_files ~logger ~genesis_constants ~constraint_constants ~conf_dir
           ~metadata ;
         Error.raise err
   in
-  return (precomputed_values, config_jsons, config, chain_state_locations)
+  ( precomputed_values
+  , config_jsons
+  , config
+  , chain_state_locations
+  , ledger_backing )
 
 let setup_daemon logger ~itn_features ~default_snark_worker_fee =
   let open Command.Let_syntax in
@@ -807,17 +843,15 @@ let setup_daemon logger ~itn_features ~default_snark_worker_fee =
             Genesis_constants.Compiled.constraint_constants
           in
           let compile_config = Mina_compile_config.Compiled.t in
-          let ledger_backing_type =
-            Mina_lib.Config.ledger_backing ~hardfork_handling
-          in
           let%bind ( precomputed_values
                    , config_jsons
                    , config
-                   , chain_state_locations ) =
+                   , chain_state_locations
+                   , ledger_backing ) =
             load_config_files ~logger ~conf_dir ~genesis_dir
               ~proof_level:Genesis_constants.Compiled.proof_level config_files
               ~genesis_constants ~constraint_constants ~cli_proof_level
-              ~genesis_backing_type:ledger_backing_type
+              ~hardfork_handling
           in
           constraint_constants.block_window_duration_ms |> Float.of_int
           |> Time.Span.of_ms |> Mina_metrics.initialize_all ;
@@ -1192,7 +1226,7 @@ let setup_daemon logger ~itn_features ~default_snark_worker_fee =
               |> Option.to_list |> Public_key.Compressed.Set.of_list )
               ~genesis_state_hash:
                 precomputed_values.protocol_state_with_hashes.hash.state_hash
-              ~epoch_ledger_backing_type:ledger_backing_type
+              ~epoch_ledger_backing_type:ledger_backing
           in
           trace_database_initialization "epoch ledger" __LOC__
             epoch_ledger_location ;
@@ -1451,7 +1485,8 @@ Pass one of -peer, -peer-list-file, -seed, -peer-list-url.|} ;
                  ~stop_time_interval ~node_status_url
                  ~graphql_control_port:itn_graphql_port ~simplified_node_stats
                  ~zkapp_cmd_limit:(ref compile_config.zkapp_cmd_limit)
-                 ~itn_features ~compile_config ~hardfork_handling () )
+                 ~itn_features ~compile_config ~hardfork_handling
+                 ~ledger_backing () )
           in
           { mina
           ; client_trustlist
@@ -2005,10 +2040,11 @@ let internal_commands logger ~itn_features =
           let%bind ( precomputed_values
                    , _config_jsons
                    , _config
-                   , _chain_state_locations ) =
+                   , _chain_state_locations
+                   , _ ) =
             load_config_files ~logger ~conf_dir ~genesis_dir ~genesis_constants
               ~constraint_constants ~proof_level ~cli_proof_level:None
-              ~genesis_backing_type:Stable_db config_files
+              ~hardfork_handling:Keep_running config_files
           in
           let pids = Child_processes.Termination.create_pid_table () in
           let%bind prover =

src/app/cli/src/init/client.ml

@@ -1845,7 +1845,7 @@ let compile_time_constants =
                conf_dir ^/ "daemon.json"
          in
          let open Async in
-         let%map ({ consensus_constants; _ } as precomputed_values), _ =
+         let%map ({ consensus_constants; _ } as precomputed_values) =
            config_file |> Genesis_ledger_helper.load_config_json >>| Or_error.ok
            >>| Option.value
                  ~default:
@@ -1854,8 +1854,7 @@ let compile_time_constants =
            >>| Option.value ~default:Runtime_config.default
            >>= Genesis_ledger_helper.init_from_config_file ~genesis_constants
                  ~constraint_constants ~logger:(Logger.null ()) ~proof_level
-                 ~cli_proof_level:None ~genesis_dir
-                 ~genesis_backing_type:Stable_db
+                 ~cli_proof_level:None ~genesis_dir ~ledger_backing:Stable_db
            >>| Or_error.ok_exn
          in
          let all_constants =

src/app/cli/src/init/test_submit_to_archive.ml

@@ -462,8 +462,8 @@ let load_and_initialize_config ~logger ~config_file =
   let proof_level = Genesis_constants.Compiled.proof_level in
   Genesis_ledger_helper.init_from_config_file ~genesis_constants
     ~constraint_constants ~logger ~proof_level ~cli_proof_level:None
-    ~genesis_dir:"genesis" ~genesis_backing_type:Stable_db runtime_config
-  >>| Or_error.ok_exn >>| fst
+    ~genesis_dir:"genesis" ~ledger_backing:Stable_db runtime_config
+  >>| Or_error.ok_exn
 
 let initialize_verifier_and_components ~logger
     ~(precomputed_values : Precomputed_values.t) =

src/app/delegation_verify/delegation_verify.ml

@@ -63,11 +63,11 @@ let instantiate_verify_functions ~logger ~genesis_constants
         in
         Genesis_ledger_helper.init_from_config_file ~logger ~proof_level
           ~constraint_constants ~genesis_constants ~cli_proof_level
-          ~genesis_backing_type:Stable_db config
+          ~ledger_backing:Stable_db config
       in
       let%map.Deferred precomputed_values =
         match precomputed_values with
-        | Ok (precomputed_values, _) ->
+        | Ok precomputed_values ->
             Deferred.return precomputed_values
         | Error _ ->
             Output.display_error "fail to read config file" ;

src/app/runtime_genesis_ledger/dune

@@ -13,17 +13,18 @@
   yojson
   async_unix
   ;;local libraries
+  cache_dir
+  cli_lib
+  coda_genesis_ledger
+  consensus
   genesis_constants
+  genesis_ledger_helper
+  logger
+  mina_base
   mina_runtime_config
   mina_ledger
-  genesis_ledger_helper
   mina_stdlib
-  logger
-  cache_dir
-  precomputed_values
-  coda_genesis_ledger
-  consensus
-  mina_base)
+  precomputed_values)
  (instrumentation
   (backend bisect_ppx))
  (preprocess

src/app/runtime_genesis_ledger/runtime_genesis_ledger.ml

@@ -15,14 +15,23 @@ end
 
 let logger = Logger.create ()
 
-let load_ledger ~ignore_missing_fields ~pad_app_state
+let load_ledger ~ignore_missing_fields ~pad_app_state ~hardfork_slot
     ~(constraint_constants : Genesis_constants.Constraint_constants.t)
     (accounts : Runtime_config.Accounts.t) =
+  let transform_account account =
+    let account_padded =
+      Runtime_config.Accounts.Single.to_account ~ignore_missing_fields
+        ~pad_app_state account
+    in
+    match hardfork_slot with
+    | None ->
+        account_padded
+    | Some hardfork_slot ->
+        Mina_base.Account.slot_reduction_update ~hardfork_slot account_padded
+  in
+
   let accounts =
-    List.map accounts ~f:(fun account ->
-        ( None
-        , Runtime_config.Accounts.Single.to_account ~ignore_missing_fields
-            ~pad_app_state account ) )
+    List.map accounts ~f:(fun account -> (None, transform_account account))
   in
   let packed =
     Genesis_ledger_helper.Ledger.packed_genesis_ledger_of_accounts ~logger
@@ -132,24 +141,54 @@ let load_config_exn config_file =
 
 let main ~(constraint_constants : Genesis_constants.Constraint_constants.t)
     ~config_file ~genesis_dir ~hash_output_file ~ignore_missing_fields
-    ~pad_app_state () =
+    ~pad_app_state ~hardfork_slot ~prefork_genesis_config () =
+  let hardfork_slot =
+    match (hardfork_slot, prefork_genesis_config) with
+    | None, None ->
+        None
+    | Some hardfork_slot, Some prefork_genesis_config ->
+        let runtime_config =
+          Yojson.Safe.from_file prefork_genesis_config
+          |> Runtime_config.of_yojson |> Result.ok_or_failwith
+        in
+        let current_genesis_global_slot =
+          let open Option.Let_syntax in
+          let%bind proof = runtime_config.proof in
+          let%map { global_slot_since_genesis; _ } = proof.fork in
+          Mina_numbers.Global_slot_since_genesis.of_int
+            global_slot_since_genesis
+        in
+        Option.some
+        @@ Mina_numbers.Global_slot_since_hard_fork.to_global_slot_since_genesis
+             ~current_genesis_global_slot hardfork_slot
+    | Some _, None ->
+        failwith
+          "hardfork slot is present but no prefork genesis config is provided"
+    | None, Some _ ->
+        [%log info]
+          "prefork genesis config is provided with no hardfork slot provided, \
+           ignoring" ;
+        None
+  in
   let%bind accounts, staking_accounts_opt, next_accounts_opt =
     load_config_exn config_file
   in
   let ledger =
     load_ledger ~ignore_missing_fields ~pad_app_state ~constraint_constants
-      accounts
+      ~hardfork_slot accounts
   in
   let staking_ledger : Ledger.t =
     Option.value_map ~default:ledger
       ~f:
-        (load_ledger ~ignore_missing_fields ~pad_app_state ~constraint_constants)
+        (load_ledger ~ignore_missing_fields ~pad_app_state ~constraint_constants
+           ~hardfork_slot )
       staking_accounts_opt
   in
   let next_ledger =
     Option.value_map ~default:staking_ledger
       ~f:
-        (load_ledger ~ignore_missing_fields ~pad_app_state ~constraint_constants)
+        (load_ledger ~ignore_missing_fields ~pad_app_state ~constraint_constants
+           ~hardfork_slot )
       next_accounts_opt
   in
   let%bind hash_json =
@@ -196,6 +235,21 @@ let () =
              ~doc:
                "BOOL whether to pad app_state to max allowed size (default: \
                 false)"
+         and hardfork_slot =
+           flag "--hardfork-slot"
+             (optional Cli_lib.Arg_type.hardfork_slot)
+             ~doc:
+               "INT the scheduled hardfork slot since last hardfork at which \
+                vesting parameter update should happen. If absent, don't \
+                update the vesting parameters"
+         and prefork_genesis_config =
+           flag "--prefork-genesis-config" (optional string)
+             ~doc:
+               "STRING path to prefork genesis confg, should be present if \
+                `--hardfork-slot` is set, the program would read the genesis \
+                timestamps in the config to calculate the proper hardfork \
+                slot."
          in
          main ~constraint_constants ~config_file ~genesis_dir ~hash_output_file
-           ~ignore_missing_fields ~pad_app_state) )
+           ~ignore_missing_fields ~pad_app_state ~hardfork_slot
+           ~prefork_genesis_config) )

src/lib/cli_lib/arg_type.ml

@@ -78,6 +78,10 @@ let global_slot =
   Command.Arg_type.map Command.Param.int
     ~f:Mina_numbers.Global_slot_since_genesis.of_int
 
+let hardfork_slot =
+  Command.Arg_type.map Command.Param.int
+    ~f:Mina_numbers.Global_slot_since_hard_fork.of_int
+
 let txn_fee =
   Command.Arg_type.map Command.Param.string ~f:Currency.Fee.of_mina_string_exn
 

src/lib/genesis_ledger_helper/dune

@@ -44,7 +44,8 @@
   logger
   mina_base.import
   staged_ledger_diff
-  mina_stdlib_unix)
+  mina_stdlib_unix
+  cli_lib)
  (instrumentation
   (backend bisect_ppx))
  (preprocess