package tezos-protocol-018-Proxford

  1. Overview
  2. Docs
package tezos-protocol-018-Proxford
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file parameters_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
(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2018 Dynamic Ledger Solutions, Inc. <contact@tezos.com>     *)
(* Copyright (c) 2021 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.                                                 *)
(*                                                                           *)
(*****************************************************************************)

type bootstrap_account = {
  public_key_hash : Signature.Public_key_hash.t;
  public_key : Signature.Public_key.t option;
  amount : Tez_repr.t;
  delegate_to : Signature.Public_key_hash.t option;
  consensus_key : Signature.Public_key.t option;
}

type bootstrap_contract = {
  delegate : Signature.Public_key_hash.t option;
  amount : Tez_repr.t;
  script : Script_repr.t;
  hash : Contract_hash.t option;
}

type bootstrap_smart_rollup = {
  address : Sc_rollup_repr.Address.t;
  pvm_kind : Sc_rollups.Kind.t;
  boot_sector : string;
  parameters_ty : Script_repr.lazy_expr;
}

type t = {
  bootstrap_accounts : bootstrap_account list;
  bootstrap_contracts : bootstrap_contract list;
  bootstrap_smart_rollups : bootstrap_smart_rollup list;
  commitments : Commitment_repr.t list;
  constants : Constants_parametric_repr.t;
  security_deposit_ramp_up_cycles : int option;
  no_reward_cycles : int option;
}

let bootstrap_account_encoding =
  let open Data_encoding in
  union
    [
      case
        (Tag 0)
        ~title:"Public_key_known"
        (tup2 Signature.Public_key.encoding Tez_repr.encoding)
        (function
          | {
              public_key_hash;
              public_key = Some public_key;
              amount;
              delegate_to = None;
              consensus_key = None;
            } ->
              assert (
                Signature.Public_key_hash.equal
                  (Signature.Public_key.hash public_key)
                  public_key_hash) ;
              Some (public_key, amount)
          | {public_key = None; _}
          | {delegate_to = Some _; _}
          | {consensus_key = Some _; _} ->
              None)
        (fun (public_key, amount) ->
          {
            public_key = Some public_key;
            public_key_hash = Signature.Public_key.hash public_key;
            amount;
            delegate_to = None;
            consensus_key = None;
          });
      case
        (Tag 1)
        ~title:"Public_key_unknown"
        (tup2 Signature.Public_key_hash.encoding Tez_repr.encoding)
        (function
          | {
              public_key_hash;
              public_key = None;
              amount;
              delegate_to = None;
              consensus_key = None;
            } ->
              Some (public_key_hash, amount)
          | {public_key = Some _; _}
          | {delegate_to = Some _; _}
          | {consensus_key = Some _; _} ->
              None)
        (fun (public_key_hash, amount) ->
          {
            public_key = None;
            public_key_hash;
            amount;
            delegate_to = None;
            consensus_key = None;
          });
      case
        (Tag 2)
        ~title:"Public_key_known_with_delegate"
        (tup3
           Signature.Public_key.encoding
           Tez_repr.encoding
           Signature.Public_key_hash.encoding)
        (function
          | {
              public_key_hash;
              public_key = Some public_key;
              amount;
              delegate_to = Some delegate;
              consensus_key = None;
            } ->
              assert (
                Signature.Public_key_hash.equal
                  (Signature.Public_key.hash public_key)
                  public_key_hash) ;
              Some (public_key, amount, delegate)
          | {public_key = None; _}
          | {delegate_to = None; _}
          | {consensus_key = Some _; _} ->
              None)
        (fun (public_key, amount, delegate) ->
          {
            public_key = Some public_key;
            public_key_hash = Signature.Public_key.hash public_key;
            amount;
            delegate_to = Some delegate;
            consensus_key = None;
          });
      case
        (Tag 3)
        ~title:"Public_key_unknown_with_delegate"
        (tup3
           Signature.Public_key_hash.encoding
           Tez_repr.encoding
           Signature.Public_key_hash.encoding)
        (function
          | {
              public_key_hash;
              public_key = None;
              amount;
              delegate_to = Some delegate;
              consensus_key = None;
            } ->
              Some (public_key_hash, amount, delegate)
          | {public_key = Some _; _}
          | {delegate_to = None; _}
          | {consensus_key = Some _; _} ->
              None)
        (fun (public_key_hash, amount, delegate) ->
          {
            public_key = None;
            public_key_hash;
            amount;
            delegate_to = Some delegate;
            consensus_key = None;
          });
      case
        (Tag 4)
        ~title:"Public_key_known_with_consensus_key"
        (tup3
           Signature.Public_key.encoding
           Tez_repr.encoding
           Signature.Public_key.encoding)
        (function
          | {
              public_key_hash;
              public_key = Some public_key;
              amount;
              delegate_to = None;
              consensus_key = Some consensus_key;
            } ->
              assert (
                Signature.Public_key_hash.equal
                  (Signature.Public_key.hash public_key)
                  public_key_hash) ;
              Some (public_key, amount, consensus_key)
          | {public_key = None; _}
          | {delegate_to = Some _; _}
          | {consensus_key = None; _} ->
              None)
        (fun (public_key, amount, consensus_key) ->
          {
            public_key = Some public_key;
            public_key_hash = Signature.Public_key.hash public_key;
            amount;
            delegate_to = None;
            consensus_key = Some consensus_key;
          });
    ]

let bootstrap_contract_encoding =
  let open Data_encoding in
  conv
    (fun {delegate; amount; script; hash} -> (delegate, amount, script, hash))
    (fun (delegate, amount, script, hash) -> {delegate; amount; script; hash})
    (obj4
       (opt "delegate" Signature.Public_key_hash.encoding)
       (req "amount" Tez_repr.encoding)
       (req "script" Script_repr.encoding)
       (opt "hash" Contract_hash.encoding))

let bootstrap_smart_rollup_encoding =
  let open Data_encoding in
  conv
    (fun {address; pvm_kind; boot_sector; parameters_ty} ->
      (address, pvm_kind, boot_sector, parameters_ty))
    (fun (address, pvm_kind, boot_sector, parameters_ty) ->
      {address; pvm_kind; boot_sector; parameters_ty})
    (obj4
       (req "address" Sc_rollup_repr.Address.encoding)
       (req "pvm_kind" Sc_rollups.Kind.encoding)
       (req "kernel" (string Hex))
       (req "parameters_ty" Script_repr.lazy_expr_encoding))

let encoding =
  let open Data_encoding in
  conv
    (fun {
           bootstrap_accounts;
           bootstrap_contracts;
           bootstrap_smart_rollups;
           commitments;
           constants;
           security_deposit_ramp_up_cycles;
           no_reward_cycles;
         } ->
      ( ( bootstrap_accounts,
          bootstrap_contracts,
          bootstrap_smart_rollups,
          commitments,
          security_deposit_ramp_up_cycles,
          no_reward_cycles ),
        constants ))
    (fun ( ( bootstrap_accounts,
             bootstrap_contracts,
             bootstrap_smart_rollups,
             commitments,
             security_deposit_ramp_up_cycles,
             no_reward_cycles ),
           constants ) ->
      {
        bootstrap_accounts;
        bootstrap_contracts;
        bootstrap_smart_rollups;
        commitments;
        constants;
        security_deposit_ramp_up_cycles;
        no_reward_cycles;
      })
    (merge_objs
       (obj6
          (req "bootstrap_accounts" (list bootstrap_account_encoding))
          (dft "bootstrap_contracts" (list bootstrap_contract_encoding) [])
          (dft
             "bootstrap_smart_rollups"
             (list bootstrap_smart_rollup_encoding)
             [])
          (dft "commitments" (list Commitment_repr.encoding) [])
          (opt "security_deposit_ramp_up_cycles" int31)
          (opt "no_reward_cycles" int31))
       Constants_parametric_repr.encoding)

let check_params params = Constants_repr.check_constants params.constants