merkle_ledger_test: constrain all modules with canonical module types from intf, functorize Base_types in prep for tests

Author: martyall

src/lib/merkle_ledger_tests/test.ml

@@ -54,6 +54,7 @@ let test_db () =
   Quickcheck.test ~trials:5 ~sexp_of:[%sexp_of: Balance.t list]
     gen_non_zero_balances ~f:(fun balances ->
       let account_ids = Account_id.gen_accounts num_accounts in
+      let T = Account_id.eq in
       let accounts = List.map2_exn account_ids balances ~f:Account.create in
       DB.with_ledger ~depth:Depth.depth ~f:(fun db ->
           let enumerate_dir_combinations max_depth =

src/lib/merkle_ledger_tests/test_database.ml

@@ -130,6 +130,7 @@ module Make (Test : Test_intf) = struct
               Quickcheck.random_value ~seed:(`Deterministic "balance 1")
                 Balance.gen
             in
+            let T = Account_id.eq in
             let account = Account.create account_id balance in
             let balance' =
               Quickcheck.random_value ~seed:(`Deterministic "balance 2")
@@ -437,6 +438,7 @@ module Make (Test : Test_intf) = struct
             Quickcheck.random_value
               (Quickcheck.Generator.list_with_length num_accounts Balance.gen)
           in
+          let T = Account_id.eq in
           let accounts = List.map2_exn account_ids balances ~f:Account.create in
           Test.with_instance (fun mdb ->
               List.iter accounts ~f:(fun account ->
@@ -462,6 +464,7 @@ module Make (Test : Test_intf) = struct
               List.fold balances ~init:0 ~f:(fun accum balance ->
                   Balance.to_nanomina_int balance + accum )
             in
+            let T = Account_id.eq in
             let accounts =
               List.map2_exn account_ids balances ~f:Account.create
             in
@@ -492,6 +495,7 @@ module Make (Test : Test_intf) = struct
                   List.fold some_balances ~init:0 ~f:(fun accum balance ->
                       Balance.to_int balance + accum )
                 in
+                let T = Account_id.eq in
                 let accounts =
                   List.map2_exn account_ids balances ~f:Account.create
                 in
@@ -517,6 +521,14 @@ module Make (Test : Test_intf) = struct
 end
 
 module Make_db (Depth : sig
+  module Account :
+    Merkle_ledger.Intf.Account
+      with type account_id := Account_id.t
+       and type token_id := Token_id.t
+       and type balance := Balance.t
+
+  module Hash : Merkle_ledger.Intf.Hash with type account := Account.t
+
   val depth : int
 end) =
 Make (struct
@@ -543,7 +555,7 @@ Make (struct
   end
 
   module Inputs = struct
-    include Test_stubs.Base_inputs
+    include Test_stubs.Make_base_inputs (Account) (Hash)
     module Location = Location
     module Location_binable = Location_binable
     module Kvdb = In_memory_kvdb
@@ -559,12 +571,18 @@ Make (struct
 end)
 
 module Depth_4 = struct
+  module Account = Test_stubs.Account
+  module Hash = Test_stubs.Hash
+
   let depth = 4
 end
 
 module Mdb_d4 = Make_db (Depth_4)
 
 module Depth_30 = struct
+  module Account = Test_stubs.Account
+  module Hash = Test_stubs.Hash
+
   let depth = 30
 end
 

src/lib/merkle_ledger_tests/test_mask.ml

@@ -320,6 +320,7 @@ module Make (Test : Test_intf) = struct
               in
               let account_ids = Account_id.gen_accounts num_accounts in
               let balances = gen_values Balance.gen in
+              let T = Account_id.eq in
               let accounts =
                 List.map2_exn account_ids balances ~f:(fun public_key balance ->
                     Account.create public_key balance )
@@ -350,6 +351,7 @@ module Make (Test : Test_intf) = struct
               in
               let account_ids = Account_id.gen_accounts num_accounts in
               let balances = gen_values Balance.gen num_accounts in
+              let T = Account_id.eq in
               let base_accounts =
                 List.map2_exn account_ids balances ~f:Account.create
               in
@@ -409,6 +411,7 @@ module Make (Test : Test_intf) = struct
               Quickcheck.random_value
                 (Quickcheck.Generator.list_with_length num_accounts Balance.gen)
             in
+            let T = Account_id.eq in
             let accounts =
               List.map2_exn account_ids balances ~f:Account.create
             in
@@ -444,6 +447,7 @@ module Make (Test : Test_intf) = struct
               List.init num_accounts ~f:(fun n ->
                   Balance.of_nanomina_int_exn (n + 1) )
             in
+            let T = Account_id.eq in
             let parent_accounts =
               List.map2_exn account_ids balances ~f:Account.create
             in
@@ -486,6 +490,7 @@ module Make (Test : Test_intf) = struct
               List.init num_accounts ~f:(fun n ->
                   Balance.of_nanomina_int_exn (n + 1) )
             in
+            let T = Account_id.eq in
             let parent_accounts =
               List.map2_exn account_ids balances ~f:Account.create
             in
@@ -539,6 +544,7 @@ module Make (Test : Test_intf) = struct
               Quickcheck.random_value
                 (Quickcheck.Generator.list_with_length num_accounts Balance.gen)
             in
+            let T = Account_id.eq in
             let accounts =
               List.map2_exn account_ids balances ~f:Account.create
             in
@@ -571,6 +577,7 @@ module Make (Test : Test_intf) = struct
               Quickcheck.random_value
                 (Quickcheck.Generator.list_with_length num_accounts Balance.gen)
             in
+            let T = Account_id.eq in
             let accounts =
               List.map2_exn account_ids balances ~f:Account.create
             in
@@ -612,6 +619,7 @@ module Make (Test : Test_intf) = struct
         Test.with_instances (fun maskable mask ->
             let attached_mask = Maskable.register_mask maskable mask in
             let k = Account_id.gen_accounts 1 |> List.hd_exn in
+            let T = Account_id.eq in
             let acct1 = Account.create k (Balance.of_nanomina_int_exn 10) in
             let loc =
               Mask.Attached.get_or_create_account attached_mask k acct1

src/lib/merkle_ledger_tests/test_stubs.ml

@@ -8,69 +8,7 @@ module Balance = struct
   let of_int = of_nanomina_int_exn
 end
 
-module Account = struct
-  (* want bin_io, not available with Account.t *)
-  type t = Mina_base.Account.Stable.Latest.t
-  [@@deriving bin_io_unversioned, sexp, equal, compare, hash, yojson]
-
-  type key = Mina_base.Account.Key.Stable.Latest.t
-  [@@deriving bin_io_unversioned, sexp, equal, compare, hash]
-
-  (* use Account items needed *)
-  let empty = Mina_base.Account.empty
-
-  let public_key = Mina_base.Account.public_key
-
-  let identifier = Mina_base.Account.identifier
-
-  let key_gen = Mina_base.Account.key_gen
-
-  let gen = Mina_base.Account.gen
-
-  let create = Mina_base.Account.create
-
-  let balance Mina_base.Account.{ balance; _ } = balance
-
-  let update_balance t bal = { t with Mina_base.Account.balance = bal }
-
-  let token Mina_base.Account.{ token_id; _ } = token_id
-end
-
 module Receipt = Mina_base.Receipt
-
-module Hash = struct
-  module T = struct
-    type t = Md5.t [@@deriving sexp, hash, compare, bin_io_unversioned, equal]
-  end
-
-  include T
-
-  include Codable.Make_base58_check (struct
-    type t = T.t [@@deriving bin_io_unversioned]
-
-    let description = "Ledger test hash"
-
-    let version_byte = Base58_check.Version_bytes.ledger_test_hash
-  end)
-
-  include Hashable.Make_binable (T)
-
-  (* to prevent pre-image attack,
-   * important impossible to create an account such that (merge a b = hash_account account) *)
-
-  let hash_account account =
-    Md5.digest_string (Format.sprintf !"0%{sexp: Account.t}" account)
-
-  let merge ~height a b =
-    let res =
-      Md5.digest_string
-        (sprintf "test_ledger_%d:%s%s" height (Md5.to_hex a) (Md5.to_hex b))
-    in
-    res
-
-  let empty_account = hash_account Account.empty
-end
-
 module Intf = Merkle_ledger.Intf
 
 module In_memory_kvdb : Intf.Key_value_database with type config := string =
@@ -146,7 +84,13 @@ module Storage_locations : Intf.Storage_locations = struct
   let key_value_db_dir = ""
 end
 
-module Key = struct
+module Key : sig
+  include Merkle_ledger.Intf.Key with type t = Mina_base.Account.Key.t
+
+  val gen : t Base_quickcheck.Generator.t
+
+  val gen_keys : int -> t list
+end = struct
   [%%versioned
   module Stable = struct
     module V1 = struct
@@ -159,9 +103,9 @@ module Key = struct
 
   let to_string = Signature_lib.Public_key.Compressed.to_base58_check
 
-  let gen = Account.key_gen
+  let gen = Mina_base.Account.key_gen
 
-  let empty : t = Account.empty.public_key
+  let empty : t = Mina_base.Account.empty.public_key
 
   let gen_keys num_keys =
     Quickcheck.random_value (Quickcheck.Generator.list_with_length num_keys gen)
@@ -172,7 +116,19 @@ end
 
 module Token_id = Mina_base.Token_id
 
-module Account_id = struct
+module Account_id : sig
+  include
+    Merkle_ledger.Intf.Account_id
+      with type token_id := Mina_base.Token_id.t
+       and type key := Key.t
+
+  val gen : t Base_quickcheck.Generator.t
+
+  val gen_accounts : int -> t list
+
+  val eq :
+    (Mina_wire_types.Mina_base_account_id.M.V2.t, t) Core_kernel.Type_equal.t
+end = struct
   [%%versioned
   module Stable = struct
     module V2 = struct
@@ -183,6 +139,8 @@ module Account_id = struct
     end
   end]
 
+  type t = Mina_base.Account_id.t
+
   include Hashable.Make_binable (Stable.Latest)
   include Comparable.Make (Stable.Latest)
 
@@ -203,9 +161,89 @@ module Account_id = struct
   let gen_accounts num_accounts =
     Quickcheck.random_value
       (Quickcheck.Generator.list_with_length num_accounts gen)
+
+  let eq = Core_kernel.Type_equal.T
 end
 
-module Base_inputs = struct
+module Account : sig
+  include
+    Merkle_ledger.Intf.Account
+      with type token_id := Token_id.t
+       and type account_id := Account_id.t
+       and type balance := Balance.t
+       and type t = Mina_base.Account.t
+
+  val gen : t Base_quickcheck.Generator.t
+
+  val create : Mina_base.Account_id.t -> Balance.t -> t
+
+  val update_balance : t -> Balance.t -> t
+
+  val public_key : t -> Mina_base.Account.Key.t
+end = struct
+  (* want bin_io, not available with Account.t *)
+  type t = Mina_base.Account.Stable.Latest.t
+  [@@deriving bin_io_unversioned, sexp, equal, compare, hash, yojson]
+
+  (* use Account items needed *)
+  let empty = Mina_base.Account.empty
+
+  let public_key = Mina_base.Account.public_key
+
+  let gen = Mina_base.Account.gen
+
+  let create = Mina_base.Account.create
+
+  let balance Mina_base.Account.{ balance; _ } = balance
+
+  let update_balance t bal = { t with Mina_base.Account.balance = bal }
+
+  let token Mina_base.Account.{ token_id; _ } = token_id
+
+  let identifier ({ public_key; token_id; _ } : t) =
+    Account_id.create public_key token_id
+end
+
+module Hash : Merkle_ledger.Intf.Hash with type account := Account.t = struct
+  module T = struct
+    type t = Md5.t [@@deriving sexp, hash, compare, bin_io_unversioned, equal]
+  end
+
+  include T
+
+  include Codable.Make_base58_check (struct
+    type t = T.t [@@deriving bin_io_unversioned]
+
+    let description = "Ledger test hash"
+
+    let version_byte = Base58_check.Version_bytes.ledger_test_hash
+  end)
+
+  include Hashable.Make_binable (T)
+
+  (* to prevent pre-image attack,
+   * important impossible to create an account such that (merge a b = hash_account account) *)
+
+  let hash_account account =
+    Md5.digest_string (Format.sprintf !"0%{sexp: Account.t}" account)
+
+  let merge ~height a b =
+    let res =
+      Md5.digest_string
+        (sprintf "test_ledger_%d:%s%s" height (Md5.to_hex a) (Md5.to_hex b))
+    in
+    res
+
+  let empty_account = hash_account Account.empty
+end
+
+module Make_base_inputs
+    (Account : Merkle_ledger.Intf.Account
+                 with type account_id := Account_id.t
+                  and type token_id := Token_id.t
+                  and type balance := Balance.t)
+    (Hash : Merkle_ledger.Intf.Hash with type account := Account.t) =
+struct
   module Key = Key
   module Account_id = Account_id
   module Token_id = Token_id
@@ -221,3 +259,5 @@ module Base_inputs = struct
   module Account = Account
   module Hash = Hash
 end
+
+module Base_inputs = Make_base_inputs (Account) (Hash)