package tezos-protocol-018-Proxford

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file constants_repr.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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2018 Dynamic Ledger Solutions, Inc. <contact@tezos.com>     *)
(* Copyright (c) 2020-2021 Nomadic Labs <contact@nomadic-labs.com>           *)
(* Copyright (c) 2021-2022 Trili Tech, <contact@trili.tech>                  *)
(*                                                                           *)
(* 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.                                                 *)
(*                                                                           *)
(*****************************************************************************)
let version_value = "oxford_018"

let version = "v1"

let mainnet_id = Chain_id.of_b58check_exn "NetXdQprcVkpaWU"

(* The fitness version number was:
   - "\000" until and including proto 004
   - "\001" until and including proto 010
*)
let fitness_version_number = "\002"

let proof_of_work_nonce_size = 8

let nonce_length = 32

let max_anon_ops_per_block = 132

let max_proposals_per_delegate = 20

let max_operation_data_length = 32 * 1024 (* 32kB *)

let max_micheline_node_count = 50_000

let max_micheline_bytes_limit = 50_000

let max_allowed_global_constant_depth = 10_000

(* In previous versions of the protocol, this
   [michelson_maximum_type_size] limit was set to 1000 but
   the contract input types (pair <parameter_type> <storage_type>)
   were not checked. Both components, <parameter_type> and
   <storage_type> where however checked hence it was possible to build
   types as big as 2001. *)
let michelson_maximum_type_size = 2001

(* This constant declares the number of subcaches used by the cache
   mechanism (see {Context.Cache}). *)
let cache_layout_size = 3

let max_slashing_period = 2

(* The {!Sc_rollups.wrapped_proof_encoding} uses unbounded sub-encodings.
   To avoid attacks through too large proofs and long decoding times on public
   nodes, we put another layer of security by restricting the maximum_size
   to [30Kb].

   Even if the operation size limit is currently [32Kb] (see
   {!Constants_repr.max_operation_data_length}) the node's mempool can still
   be spammed with larger proofs before detecting that the operations are
   indeed larger than the limit.

   By design, the proofs should be created and verified for a single tick
   which should limit the number of read/writes in the Merkle tree, and thefore,
   limit the total size of a proof. Thus, [30Kb] can be lowered once we
   have empirically observed that a valid proof can not be that large.

   Note that an encoded proof that is [30Kb] might still be not included
   in a valid L1 operation. The refutation operation also contains other
   information such as an inbox proof. We only put here an upper bound
   for the size.
*)
let sc_max_wrapped_proof_binary_size = 30_000

(* A limit on the size of the binary encoding of sc rollup messages. This limit
   depends on the assumed overhead of the proof and metadata in a manager
   operation justifying the existence of some chunk of data in the rollup state.
   The value of this constant reflects the global constant of 4KB in the WASM
   PVM specification chosen for the limit of chunks that are embedded in proofs.
*)
let sc_rollup_message_size_limit = 4_096

(** A limit on the number of messages per inbox level.

    Benchmarks have shown that proving the inclusion of the element at
    index 0 in a skip list of [1_000_000] elements is ~=6Kb large.
*)
let sc_rollup_max_number_of_messages_per_level = Z.of_int 1_000_000

type fixed = unit

let fixed_encoding =
  let open Data_encoding in
  conv
    (fun () ->
      ( ( proof_of_work_nonce_size,
          nonce_length,
          max_anon_ops_per_block,
          max_operation_data_length,
          max_proposals_per_delegate,
          max_micheline_node_count,
          max_micheline_bytes_limit,
          max_allowed_global_constant_depth,
          cache_layout_size,
          michelson_maximum_type_size ),
        ( max_slashing_period,
          sc_max_wrapped_proof_binary_size,
          sc_rollup_message_size_limit,
          sc_rollup_max_number_of_messages_per_level ) ))
    (fun ( ( _proof_of_work_nonce_size,
             _nonce_length,
             _max_anon_ops_per_block,
             _max_operation_data_length,
             _max_proposals_per_delegate,
             _max_micheline_node_count,
             _max_micheline_bytes_limit,
             _max_allowed_global_constant_depth,
             _cache_layout_size,
             _michelson_maximum_type_size ),
           ( _max_slashing_period,
             _sc_max_wrapped_proof_binary_size,
             _sc_rollup_message_size_limit,
             _sc_rollup_number_of_messages_per_level ) ) -> ())
    (merge_objs
       (obj10
          (req "proof_of_work_nonce_size" uint8)
          (req "nonce_length" uint8)
          (req "max_anon_ops_per_block" uint8)
          (req "max_operation_data_length" int31)
          (req "max_proposals_per_delegate" uint8)
          (req "max_micheline_node_count" int31)
          (req "max_micheline_bytes_limit" int31)
          (req "max_allowed_global_constants_depth" int31)
          (req "cache_layout_size" uint8)
          (req "michelson_maximum_type_size" uint16))
       (obj4
          (req "max_slashing_period" uint8)
          (req "smart_rollup_max_wrapped_proof_binary_size" int31)
          (req "smart_rollup_message_size_limit" int31)
          (req "smart_rollup_max_number_of_messages_per_level" n)))

let fixed = ()

type t = {fixed : fixed; parametric : Constants_parametric_repr.t}

let all_of_parametric parametric = {fixed; parametric}

let encoding =
  let open Data_encoding in
  conv
    (fun {fixed; parametric} -> (fixed, parametric))
    (fun (fixed, parametric) -> {fixed; parametric})
    (merge_objs fixed_encoding Constants_parametric_repr.encoding)

type error += Invalid_protocol_constants of string (* `Permanent *)

let () =
  register_error_kind
    `Permanent
    ~id:"constants.invalid_protocol_constants"
    ~title:"Invalid protocol constants"
    ~description:"The provided protocol constants are not coherent."
    ~pp:(fun ppf reason ->
      Format.fprintf ppf "Invalid protocol constants: %s" reason)
    Data_encoding.(obj1 (req "reason" @@ string Plain))
    (function Invalid_protocol_constants reason -> Some reason | _ -> None)
    (fun reason -> Invalid_protocol_constants reason)

let check_constants constants =
  let open Result_syntax in
  let open Constants_parametric_repr in
  let* () =
    error_unless
      Period_repr.(constants.minimal_block_delay > zero)
      (Invalid_protocol_constants
         "The minimal block delay must be greater than zero")
  in
  let* () =
    error_unless
      Period_repr.(constants.delay_increment_per_round > zero)
      (Invalid_protocol_constants
         "The delay increment per round must be greater than zero")
  in
  let* () =
    error_unless
      Compare.Int.(constants.consensus_committee_size > 0)
      (Invalid_protocol_constants
         "The consensus committee size must be strictly greater than 0.")
  in
  let* () =
    error_unless
      Compare.Int.(
        constants.consensus_threshold >= 0
        && constants.consensus_threshold <= constants.consensus_committee_size)
      (Invalid_protocol_constants
         "The consensus threshold must be greater than or equal to 0 and less \
          than or equal to the consensus commitee size.")
  in
  let* () =
    error_unless
      (let Ratio_repr.{numerator; denominator} =
         constants.minimal_participation_ratio
       in
       Compare.Int.(numerator >= 0 && denominator > 0))
      (Invalid_protocol_constants
         "The minimal participation ratio must be a non-negative valid ratio.")
  in
  let* () =
    error_unless
      Compare.Int.(
        constants.minimal_participation_ratio.numerator
        <= constants.minimal_participation_ratio.denominator)
      (Invalid_protocol_constants
         "The minimal participation ratio must be less than or equal to 100%.")
  in
  (* The [limit_of_delegation_over_baking] should be non-negative. *)
  let* () =
    error_unless
      Compare.Int.(constants.limit_of_delegation_over_baking >= 0)
      (Invalid_protocol_constants
         "The delegation over baking limit must be greater than or equal to 0.")
  in
  let* () =
    error_unless
      (let snapshot_frequence =
         Int32.div
           constants.blocks_per_cycle
           constants.blocks_per_stake_snapshot
       in
       Compare.Int32.(
         snapshot_frequence > Int32.zero
         && snapshot_frequence < Int32.of_int (1 lsl 16)))
      (Invalid_protocol_constants
         "The ratio blocks_per_cycle per blocks_per_stake_snapshot should be \
          between 1 and 65535")
  in
  let* () =
    error_unless
      Compare.Int32.(
        constants.nonce_revelation_threshold > Int32.zero
        && constants.nonce_revelation_threshold < constants.blocks_per_cycle)
      (Invalid_protocol_constants
         "The nonce revelation threshold must be strictly smaller than \
          blocks_per_cycle and strictly positive.")
  in
  let* () =
    error_unless
      Compare.Int64.(
        let threshold = Int64.of_int32 constants.nonce_revelation_threshold in
        let block = Period_repr.to_seconds constants.minimal_block_delay in
        let ips =
          (* We reduce the ips for short blocks_per_commitment so that we have
             low difficulty during tests *)
          if Compare.Int32.(constants.blocks_per_commitment > 32l) then
            Int64.of_int 200_000
          else Int64.one
        in
        let factor = Int64.of_int 5 in
        let difficulty = Int64.(mul (mul ips factor) (mul threshold block)) in
        constants.vdf_difficulty > difficulty)
      (Invalid_protocol_constants
         "The VDF difficulty must be strictly greater than the product of the \
          nonce_revelation_threshold, the minimial_block_delay, a benchmark of \
          modulo squaring in class groups and a security threshold.")
  in
  let* () =
    error_unless
      Compare.Int.(constants.sc_rollup.origination_size >= 0)
      (Invalid_protocol_constants
         "The smart rollup origination size must be non-negative.")
  in
  let* () =
    error_unless
      Compare.Int.(constants.sc_rollup.challenge_window_in_blocks >= 0)
      (Invalid_protocol_constants
         "The smart rollup challenge window in blocks must be non-negative.")
  in
  let* () =
    error_unless
      Tez_repr.(constants.sc_rollup.stake_amount >= zero)
      (Invalid_protocol_constants
         "The smart rollup max stake amount must be non-negative.")
  in
  let* () =
    error_unless
      Compare.Int.(constants.sc_rollup.commitment_period_in_blocks > 0)
      (Invalid_protocol_constants
         "The smart rollup commitment period in blocks must be strictly \
          greater than 0.")
  in
  let* () =
    error_unless
      (let sc_rollup_max_lookahead_in_blocks =
         constants.sc_rollup.max_lookahead_in_blocks
       in
       Compare.Int32.(
         sc_rollup_max_lookahead_in_blocks
         > Int32.of_int constants.sc_rollup.commitment_period_in_blocks
         && (* Check that [smart_rollup_challenge_window_in_blocks <
               smart_rollup_max_lookahead_in_blocks]. Otherwise committers would be
               forced to commit at an artificially slow rate, affecting the
               throughput of the rollup. *)
         sc_rollup_max_lookahead_in_blocks
         > Int32.of_int constants.sc_rollup.challenge_window_in_blocks))
      (Invalid_protocol_constants
         "The smart rollup max lookahead in blocks must be greater than \
          [smart_rollup_commitment_period_in_blocks] and \
          [smart_rollup_challenge_window_in_blocks].")
  in
  let* () =
    error_unless
      Compare.Int.(
        constants.dal.number_of_slots > 0
        && constants.dal.number_of_slots <= 256)
      (Invalid_protocol_constants
         "The number of data availability slot must be between 1 and 256")
  in
  let* () =
    error_unless
      Compare.Int32.(
        constants.dal.blocks_per_epoch > 0l
        && constants.dal.blocks_per_epoch <= constants.blocks_per_cycle
        && Int32.rem constants.blocks_per_cycle constants.dal.blocks_per_epoch
           = 0l)
      (Invalid_protocol_constants
         "The epoch length must be between 1 and blocks_per_cycle, and \
          blocks_per_epoch must divide blocks_per_cycle.")
  in
  let* () =
    error_unless
      Compare.Int.(constants.dal.attestation_lag > 1)
      (Invalid_protocol_constants
         "The attestation_lag must be strictly greater than 1, because only \
          slot headers in finalized blocks are attested.")
  in
  let* () =
    error_unless
      Compare.Int.(
        constants.sc_rollup.max_number_of_stored_cemented_commitments > 0)
      (Invalid_protocol_constants
         "The number of maximum stored cemented commitments must be strictly \
          positive")
  in
  Result.return_unit

module Generated = struct
  type t = {
    consensus_threshold : int;
    issuance_weights : Constants_parametric_repr.issuance_weights;
  }

  let generate ~consensus_committee_size =
    (* The weights are expressed in [(256 * 80)]th of the total
       reward, because it is the smallest proportion used so far*)
    let consensus_threshold = (consensus_committee_size * 2 / 3) + 1 in
    let bonus_committee_size = consensus_committee_size - consensus_threshold in
    let base_total_issued_per_minute = Tez_repr.of_mutez_exn 85_007_812L in
    let _reward_parts_whole = 20480 (* = 256 * 80 *) in
    let reward_parts_half = 10240 (* = reward_parts_whole / 2 *) in
    let reward_parts_quarter = 5120 (* = reward_parts_whole / 4 *) in
    let reward_parts_16th = 1280 (* = reward_parts_whole / 16 *) in
    {
      consensus_threshold;
      issuance_weights =
        {
          base_total_issued_per_minute;
          (* 85.007812 tez/minute *)
          baking_reward_fixed_portion_weight =
            (* 1/4 or 1/2 *)
            (if Compare.Int.(bonus_committee_size <= 0) then
             (* a fortiori, consensus_committee_size < 4 *)
             reward_parts_half
            else reward_parts_quarter);
          baking_reward_bonus_weight =
            (* 1/4 or 0 *)
            (if Compare.Int.(bonus_committee_size <= 0) then 0
            else reward_parts_quarter);
          attesting_reward_weight = reward_parts_half;
          (* 1/2 *)
          (* All block (baking + attesting)rewards sum to 1 ( *256*80 ) *)
          liquidity_baking_subsidy_weight = reward_parts_16th;
          (* 1/16 *)
          seed_nonce_revelation_tip_weight = 1;
          (* 1/20480 *)
          vdf_revelation_tip_weight = 1;
          (* 1/20480 *)
        };
    }
end

let cache_layout p =
  Constants_parametric_repr.
    [
      p.cache_script_size;
      p.cache_stake_distribution_cycles;
      p.cache_sampler_state_cycles;
    ]
OCaml

Innovation. Community. Security.