package octez-libs

  1. Overview
  2. Docs
package octez-libs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file srs.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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2024 Nomadic Labs <contact@nomadic-labs.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.                                                 *)
(*                                                                           *)
(*****************************************************************************)

open Error_monad
open Kzg.Bls
open Zcash_srs

exception Failed_to_load_trusted_setup of string

let read_srs ?len ~srs_g1_path ~srs_g2_path () =
  let open Lwt_result_syntax in
  let to_bigstring ~path =
    let*! fd = Lwt_unix.openfile path [Unix.O_RDONLY] 0o440 in
    Lwt.finalize
      (fun () ->
        match
          Lwt_bytes.map_file ~fd:(Lwt_unix.unix_file_descr fd) ~shared:false ()
        with
        | exception Unix.Unix_error (error_code, function_name, _) ->
            raise
              (Failed_to_load_trusted_setup
                 (Format.sprintf
                    "%s: Unix.Unix_error: %s"
                    function_name
                    (Unix.error_message error_code)))
        | exception e ->
            raise (Failed_to_load_trusted_setup (Printexc.to_string e))
        | res -> Lwt.return res)
      (fun () -> Lwt_unix.close fd)
  in
  let*! srs_g1_bigstring = to_bigstring ~path:srs_g1_path in
  let*! srs_g2_bigstring = to_bigstring ~path:srs_g2_path in
  let*? srs_g1 = Srs_g1.of_bigstring srs_g1_bigstring ?len in
  let*? srs_g2 = Srs_g2.of_bigstring srs_g2_bigstring ?len in
  return (srs_g1, srs_g2)

type srs_verifier = {shards : G2.t; pages : G2.t; commitment : G2.t}

let max_verifier_srs_size = Srs_g1.size srs_g1

let get_verifier_srs2_aux max_srs_size get_srs2 ~max_polynomial_length
    ~page_length_domain ~shard_length =
  let shards = get_srs2 shard_length in
  let pages = get_srs2 page_length_domain in
  let commitment = get_srs2 (max_srs_size - max_polynomial_length) in
  {shards; pages; commitment}

let max_srs_size = max_srs_g1_size

let get_srs2 i = List.assoc i srs_g2

let get_verifier_srs1 () = srs_g1

let get_verifier_srs2 = get_verifier_srs2_aux max_srs_size get_srs2

let is_in_srs2 i = List.mem_assoc i srs_g2

module Internal_for_tests = struct
  let max_srs_size = 1 lsl 16

  let fake_srs_seed =
    Scalar.of_string
      "20812168509434597367146703229805575690060615791308155437936410982393987532344"

  let compute_fake_srs ?(size = max_srs_size) gen () = gen size fake_srs_seed

  let get_srs2 i = G2.mul G2.one (Scalar.pow fake_srs_seed (Z.of_int i))

  let get_verifier_srs2 = get_verifier_srs2_aux max_srs_size get_srs2

  let get_verifier_srs1 =
    compute_fake_srs ~size:max_verifier_srs_size Srs_g1.generate_insecure

  let is_in_srs2 _ = true

  let fake_srs1 = Lazy.from_fun (compute_fake_srs Srs_g1.generate_insecure)

  let fake_srs2 = Lazy.from_fun (compute_fake_srs Srs_g2.generate_insecure)

  module Print = struct
    (* Bounds (following inequalities are given for log₂ for simplicity)
       1 <= redundancy<= 4
       7 <= page size + (redundancy + 1) <= slot size <= 20
       5 <= page size <= slot size - (redundancy + 1) <= 18 - 5 = 13
       2 <= redundancy + 1 <= nb shards <= slot size - page size <= 15
    *)
    type range = {
      redundancy : int list;
      slot : int list;
      page : int list;
      shards : int list;
    }

    let concat_map4 {slot; redundancy; page; shards} func =
      (* Ensure validity before computing actual value *)
      let f ~slot ~redundancy ~page ~shards =
        Parameters_check.ensure_validity_without_srs
          ~slot_size:slot
          ~page_size:page
          ~redundancy_factor:redundancy
          ~number_of_shards:shards
        |> function
        | Ok () -> func ~slot ~redundancy ~page ~shards
        | _ -> 0
      in
      List.concat_map
        (fun slot ->
          List.concat_map
            (fun redundancy ->
              List.concat_map
                (fun page ->
                  List.map
                    (fun shards -> f ~slot ~redundancy ~page ~shards)
                    shards)
                page)
            redundancy)
        slot

    let generate_poly_lengths ~max_srs_size p =
      let page_srs =
        let values =
          List.map
            (fun page -> Parameters_check.domain_length ~size:page)
            p.page
        in
        values
      in
      let commitment_srs =
        concat_map4 p (fun ~slot ~redundancy:_ ~page ~shards:_ ->
            max_srs_size
            - Parameters_check.slot_as_polynomial_length
                ~page_size:page
                ~slot_size:slot)
      in
      let shard_srs =
        concat_map4 p (fun ~slot ~redundancy ~page ~shards ->
            let max_polynomial_length =
              Parameters_check.slot_as_polynomial_length
                ~page_size:page
                ~slot_size:slot
            in
            let erasure_encoded_polynomial_length =
              redundancy * max_polynomial_length
            in
            erasure_encoded_polynomial_length / shards)
      in
      let page_shards =
        List.sort_uniq (fun x y -> Int.compare y x) (page_srs @ shard_srs)
      in
      let max_srs1_needed = List.hd page_shards in
      ( max_srs1_needed,
        List.sort_uniq Int.compare (page_shards @ commitment_srs)
        |> List.filter (fun i -> i > 0) )

    let _generate_all_poly_lengths ~max_srs_size =
      List.fold_left
        (fun (acc_size, acc_lengths) p ->
          let size, lengths = generate_poly_lengths ~max_srs_size p in
          (max acc_size size, List.sort_uniq Int.compare (acc_lengths @ lengths)))
        (0, [])
  end

  let print_verifier_srs_from_file ?(max_srs_size = Zcash_srs.max_srs_g1_size)
      ~srs_g1_path ~srs_g2_path () =
    let params =
      Print.
        {
          redundancy = [1; 2; 3; 4] |> List.map (Int.shift_left 1);
          slot = [15; 16; 17; 18; 19; 20] |> List.map (Int.shift_left 1);
          page = [12] |> List.map (Int.shift_left 1);
          shards = [11; 12] |> List.map (Int.shift_left 1);
        }
    in
    let open Lwt_result_syntax in
    let srs_g1_size, lengths =
      Print.generate_poly_lengths ~max_srs_size params
    in
    let* srs_g1, srs_g2 = read_srs ~srs_g1_path ~srs_g2_path () in
    let srs2 =
      List.map
        (fun i ->
          let g2 =
            Srs_g2.get srs_g2 i |> G2.to_compressed_bytes |> Hex.of_bytes
            |> Hex.show
          in
          Printf.sprintf "(%d, \"%s\")" i g2)
        lengths
    in
    let srs1 =
      List.init srs_g1_size (fun i ->
          Printf.sprintf
            "\"%s\""
            (Srs_g1.get srs_g1 i |> G1.to_compressed_bytes |> Hex.of_bytes
           |> Hex.show))
    in
    Printf.printf
      "\n\nlet srs_g1 = [|\n  %s\n|] |> read_srs_g1"
      (String.concat " ;\n  " @@ srs1) ;
    Printf.printf
      "\n\nlet srs_g2 = [\n  %s\n] |> read_srs_g2"
      (String.concat " ;\n  " @@ srs2) ;
    return_unit
end

let ensure_srs_validity ~is_fake ~mode ~slot_size ~page_size ~redundancy_factor
    ~number_of_shards =
  let open Result_syntax in
  let assert_result condition error_message =
    if not condition then fail (`Fail (error_message ())) else return_unit
  in
  let max_polynomial_length, _erasure_encoded_polynomial_length, shard_length =
    Parameters_check.compute_lengths
      ~redundancy_factor
      ~slot_size
      ~page_size
      ~number_of_shards
  in
  let min_g1, srs_g1_length =
    match mode with
    | `Prover when is_fake ->
        (max_polynomial_length, Internal_for_tests.max_srs_size)
    | `Prover -> (max_polynomial_length, max_srs_size)
    | `Verifier -> (shard_length, max_verifier_srs_size)
  in
  let* () =
    assert_result
      (min_g1 <= srs_g1_length)
      (* The committed polynomials have degree t.max_polynomial_length - 1 at most,
         so t.max_polynomial_length coefficients. *)
      (fun () ->
        Format.asprintf
          "The size of the SRS on G1 is too small. Expected more than %d. Got \
           %d. Hint: you can reduce the size of a slot."
          min_g1
          srs_g1_length)
  in
  let page_length_domain = Parameters_check.domain_length ~size:page_size in
  let max_srs_size, is_in_srs2 =
    if is_fake then Internal_for_tests.(max_srs_size, is_in_srs2)
    else (max_srs_size, is_in_srs2)
  in
  let offset_monomial_degree = max_srs_size - max_polynomial_length in
  assert_result
    (is_in_srs2 shard_length
    && is_in_srs2 page_length_domain
    && is_in_srs2 offset_monomial_degree)
    (fun () ->
      Format.asprintf
        "The verifier SRS on G2 should contain points for indices shard_length \
         = %d, page_length_domain = %d & offset_monomial_degree = %d. Hint: \
         you can add new points to the SRS (to do that, use the function \
         Srs.Internal_for_tests.Print.print_verifier_srs_from_file)."
        shard_length
        page_length_domain
        offset_monomial_degree)
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct