package tezos-protocol-alpha

You can search for identifiers within the package.
in-package search v0.2.0
tezos-protocol-alpha
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Source file `delegate_slashed_deposits_storage.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
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2018 Dynamic Ledger Solutions, Inc. <contact@tezos.com>     *)
(* Copyright (c) 2021 Nomadic Labs, <contact@nomadic-labs.com>               *)
(* Copyright (c) 2022 G.B. Fefe, <gb.fefe@protonmail.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 reward_and_burn = {reward : Tez_repr.t; amount_to_burn : Tez_repr.t}

type punishing_amounts = {
  staked : reward_and_burn;
  unstaked : (Cycle_repr.t * reward_and_burn) list;
}

let record_denunciation ctxt ~operation_hash
    (misbehaviour : Misbehaviour_repr.t) delegate ~rewarded =
  let open Lwt_result_syntax in
  let*! ctxt = Forbidden_delegates_storage.forbid ctxt delegate in
  Pending_denunciations_storage.add_denunciation
    ctxt
    ~misbehaving_delegate:delegate
    operation_hash
    ~rewarded_delegate:rewarded
    misbehaviour

let punish_double_signing ctxt ~operation_hash misbehaviour delegate
    (level : Level_repr.t) ~rewarded =
  let open Lwt_result_syntax in
  let* ctxt, was_already_denounced =
    Already_denounced_storage.add_denunciation
      ctxt
      delegate
      level
      misbehaviour.Misbehaviour_repr.round
      misbehaviour.kind
  in
  if was_already_denounced then
    (* This can only happen in the very specific case where a delegate
       has crafted at least three attestations (respectively
       preattestations) on the same level and round but with three
       different slots owned by this delegate. Indeed, this makes it
       possible to have two denunciations about the same delegate,
       level, round, and kind, but different slots. Such denunciations
       are considered identical by {!Already_denounced_storage}, which
       is good because the delegate shouldn't get slashed twice on the
       same level, round, and kind. However, {!Validate}'s conflict
       handler identifies denunciations via their slot rather than
       delegate for technical reasons (because the slot is readily
       available whereas retrieving the delegate requires a call to
       {!Delegate_sampler.slot_owner} which is in Lwt and thus
       incompatible with some signatures). Therefore, if these
       denunciations (which differ only in their slots) are both
       included in the same block, then they will both be successfully
       validated, and then [was_already_denounced] will be [true]
       during the application of the second one.

       In this unlikely scenario, we simply ignore the redundant
       denunciation silently. Returning an error or raising an
       exception here would cause the whole block application to fail,
       which we don't want. *)
    return ctxt
  else record_denunciation ctxt ~operation_hash misbehaviour delegate ~rewarded

(* Misbehaviour Map: orders denunciations for application.
   See {!Misbehaviour_repr.compare} for the order on misbehaviours:
   - by increasing level, then increasing round, then kind, ignoring the slot
   - for the kind: double baking > double attesting > double preattesting *)
module MisMap = Map.Make (Misbehaviour_repr)

let compute_punishing_amount slashing_percentage frozen_deposits =
  let punish_value =
    Tez_repr.mul_percentage
      ~rounding:`Down
      frozen_deposits.Deposits_repr.initial_amount
      slashing_percentage
  in
  Tez_repr.min punish_value frozen_deposits.Deposits_repr.current_amount

let compute_reward_and_burn slashing_percentage frozen_deposits
    global_limit_of_staking_over_baking =
  let open Result_syntax in
  let punishing_amount =
    compute_punishing_amount slashing_percentage frozen_deposits
  in
  let global_limit_of_staking_over_baking_plus_two =
    Int64.add (Int64.of_int global_limit_of_staking_over_baking) 2L
  in
  let* reward =
    Tez_repr.(punishing_amount /? global_limit_of_staking_over_baking_plus_two)
  in
  let+ amount_to_burn = Tez_repr.(punishing_amount -? reward) in
  {reward; amount_to_burn}

let get_initial_frozen_deposits_of_misbehaviour_cycle ~current_cycle
    ~misbehaviour_cycle =
  let previous_cycle =
    match Cycle_repr.pred current_cycle with
    | None -> current_cycle
    | Some previous_cycle -> previous_cycle
  in
  if Cycle_repr.equal current_cycle misbehaviour_cycle then
    Delegate_storage.initial_frozen_deposits
  else if Cycle_repr.equal previous_cycle misbehaviour_cycle then
    Delegate_storage.initial_frozen_deposits_of_previous_cycle
  else fun (_ : Raw_context.t) (_ : Signature.public_key_hash) ->
    (* Denunciation applied too late.
       We could assert false, but we can also be permissive
       while keeping the same invariants. *)
    return Tez_repr.zero

let update_block_denunciations_map_with delegate denunciations initial_block_map
    =
  List.fold_left
    (fun block_map denunciation ->
      MisMap.update
        denunciation.Denunciations_repr.misbehaviour
        (function
          | None ->
              Some
                (Signature.Public_key_hash.Map.singleton delegate denunciation)
          | Some map ->
              Some
                (Signature.Public_key_hash.Map.update
                   delegate
                   (function
                     | None -> Some denunciation | Some old_d -> Some old_d)
                   map))
        block_map)
    initial_block_map
    denunciations

(* Split denunciations into two groups: those to be applied, and those to be delayed. *)
let get_applicable_and_remaining_denunciations ctxt current_cycle =
  Storage.Pending_denunciations.fold
    ctxt
    ~order:`Undefined
    ~init:(MisMap.empty, [])
    ~f:(fun delegate denunciations acc ->
      let block_map, remaining_denunciations = acc in
      (* Since the [max_slashing_period] is 2, and we want to apply denunciations at the
         end of this period, we "delay" the current cycle's misbehaviour's denunciations,
         while we apply the older denunciations.
         Indeed, we apply denunciations in the cycle following the misbehaviour, so that
         the time between the misbehaviour and the slashing is at most
         [max_slashing_period = 2] cycles. *)
      let denunciations_to_apply, denunciations_to_delay =
        if not (Constants_storage.adaptive_issuance_ns_enable ctxt) then
          (denunciations, [])
        else
          List.partition
            (fun denunciation ->
              let level = denunciation.Denunciations_repr.misbehaviour.level in
              let misb_cycle =
                Level_repr.cycle_from_raw
                  ~cycle_eras:(Raw_context.cycle_eras ctxt)
                  level
              in
              Cycle_repr.(misb_cycle < current_cycle))
            denunciations
      in
      let new_block_map =
        update_block_denunciations_map_with
          delegate
          denunciations_to_apply
          block_map
      in
      let new_remaining_denunciations =
        (delegate, denunciations_to_delay) :: remaining_denunciations
      in
      Lwt.return (new_block_map, new_remaining_denunciations))

let apply_block_denunciations ctxt current_cycle block_denunciations_map =
  let slashable_deposits_period =
    Constants_storage.slashable_deposits_period ctxt
  in
  let open Lwt_result_syntax in
  let global_limit_of_staking_over_baking =
    Constants_storage.adaptive_issuance_global_limit_of_staking_over_baking ctxt
  in
  MisMap.fold_es
    (fun ({Misbehaviour_repr.level = raw_level; round = _; kind; _} as miskey)
         denunciations_map
         acc ->
      let ctxt, balance_updates = acc in
      let level =
        Level_repr.level_from_raw
          ~cycle_eras:(Raw_context.cycle_eras ctxt)
          raw_level
      in
      let misbehaviour_cycle = level.cycle in
      let denunciations =
        Signature.Public_key_hash.Map.bindings denunciations_map
      in
      let denounced = List.map fst denunciations in
      let* ctxt, slashing_percentage =
        Slash_percentage.get ctxt ~kind ~level denounced
      in
      let+ ctxt, balance_updates =
        List.fold_left_es
          (fun (ctxt, balance_updates)
               ( delegate,
                 Denunciations_repr.{operation_hash; rewarded; misbehaviour} ) ->
            assert (
              Compare.Int.equal
                (* This compare ignores the slot *)
                (Misbehaviour_repr.compare miskey misbehaviour)
                0) ;
            (* Validate ensures that [denunciations] contains [delegate] at most once *)
            let delegate_contract = Contract_repr.Implicit delegate in
            (* Oxford values *)
            let* slash_history_opt_o =
              Storage.Contract.Slashed_deposits__Oxford.find
                ctxt
                delegate_contract
            in
            let slash_history_o =
              Option.value slash_history_opt_o ~default:[]
              |> List.map (fun (a, b) -> (a, Percentage.convert_from_o_to_p b))
            in
            let* slash_history_opt =
              Storage.Slashed_deposits.find ctxt delegate
            in
            let slash_history = Option.value slash_history_opt ~default:[] in

            (* Concatenate both, Oxford first *)
            let slash_history =
              List.fold_left
                (fun acc (cycle, percentage) ->
                  Storage.Slashed_deposits_history.add cycle percentage acc)
                slash_history_o
                slash_history
            in

            let*! ctxt =
              Storage.Contract.Slashed_deposits__Oxford.remove
                ctxt
                delegate_contract
            in

            let previous_total_slashing_percentage =
              Storage.Slashed_deposits_history.get level.cycle slash_history
            in
            let slash_history =
              Storage.Slashed_deposits_history.add
                level.cycle
                slashing_percentage
                slash_history
            in
            let*! ctxt =
              Storage.Slashed_deposits.add ctxt delegate slash_history
            in
            let new_total_slashing_percentage =
              Storage.Slashed_deposits_history.get level.cycle slash_history
            in
            (* We do not slash above 100%: if the slashing percentage would
               make the total sum of the slashing history above 100%, we rectify
               it to reach exactly 100%. This also means that subsequent slashes
               are effectively ignored (set to 0%) *)
            let slashing_percentage =
              Percentage.sub_bounded
                new_total_slashing_percentage
                previous_total_slashing_percentage
            in
            let* frozen_deposits =
              let* initial_amount =
                get_initial_frozen_deposits_of_misbehaviour_cycle
                  ~current_cycle
                  ~misbehaviour_cycle
                  ctxt
                  delegate
              in
              let* current_amount =
                Delegate_storage.current_frozen_deposits ctxt delegate
              in
              return Deposits_repr.{initial_amount; current_amount}
            in
            let*? staked =
              compute_reward_and_burn
                slashing_percentage
                frozen_deposits
                global_limit_of_staking_over_baking
            in
            let* init_to_burn_to_reward =
              let giver_baker =
                `Frozen_deposits (Frozen_staker_repr.baker delegate)
              in
              let giver_stakers =
                `Frozen_deposits
                  (Frozen_staker_repr.shared_between_stakers ~delegate)
              in
              let {amount_to_burn; reward} = staked in
              let* to_burn =
                let+ {baker_part; stakers_part} =
                  Shared_stake.share
                    ~rounding:`Towards_baker
                    ctxt
                    delegate
                    amount_to_burn
                in
                [(giver_baker, baker_part); (giver_stakers, stakers_part)]
              in
              let* to_reward =
                let+ {baker_part; stakers_part} =
                  Shared_stake.share
                    ~rounding:`Towards_baker
                    ctxt
                    delegate
                    reward
                in
                [(giver_baker, baker_part); (giver_stakers, stakers_part)]
              in
              return (to_burn, to_reward)
            in
            let* to_burn, to_reward =
              let oldest_slashable_cycle =
                Cycle_repr.sub misbehaviour_cycle slashable_deposits_period
                |> Option.value ~default:Cycle_repr.root
              in
              let slashable_cycles =
                Cycle_repr.(oldest_slashable_cycle ---> misbehaviour_cycle)
              in
              List.fold_left_es
                (fun (to_burn, to_reward) cycle ->
                  let* frozen_deposits =
                    Unstaked_frozen_deposits_storage.get ctxt delegate cycle
                  in
                  let*? {amount_to_burn; reward} =
                    compute_reward_and_burn
                      slashing_percentage
                      frozen_deposits
                      global_limit_of_staking_over_baking
                  in
                  let giver =
                    `Unstaked_frozen_deposits
                      (Unstaked_frozen_staker_repr.Shared delegate, cycle)
                  in
                  return
                    ( (giver, amount_to_burn) :: to_burn,
                      (giver, reward) :: to_reward ))
                init_to_burn_to_reward
                slashable_cycles
            in
            let origin = Receipt_repr.Delayed_operation {operation_hash} in
            let* ctxt, punish_balance_updates =
              Token.transfer_n ctxt ~origin to_burn `Double_signing_punishments
            in
            let+ ctxt, reward_balance_updates =
              Token.transfer_n
                ctxt
                ~origin
                to_reward
                (`Contract (Contract_repr.Implicit rewarded))
            in
            ( ctxt,
              punish_balance_updates @ reward_balance_updates @ balance_updates
            ))
          (ctxt, balance_updates)
          denunciations
      in
      (ctxt, balance_updates))
    block_denunciations_map
    (ctxt, [])

let apply_denunciations ctxt =
  let open Lwt_result_syntax in
  let current_cycle = (Raw_context.current_level ctxt).cycle in
  let*! applicable_denunciations_map, remaining_denunciations =
    get_applicable_and_remaining_denunciations ctxt current_cycle
  in
  let* ctxt, balance_updates =
    apply_block_denunciations ctxt current_cycle applicable_denunciations_map
  in
  return (ctxt, balance_updates, remaining_denunciations)

let apply_and_clear_denunciations ctxt =
  let open Lwt_result_syntax in
  let* ctxt, balance_updates, remaining_denunciations =
    apply_denunciations ctxt
  in
  (* Updates the storage to only contain the remaining denunciations *)
  let*! ctxt = Pending_denunciations_storage.clear ctxt in
  let*! ctxt =
    List.fold_left_s
      (fun ctxt (delegate, current_cycle_denunciations) ->
        match current_cycle_denunciations with
        | [] -> Lwt.return ctxt
        | _ ->
            Pending_denunciations_storage.set_denunciations
              ctxt
              delegate
              current_cycle_denunciations)
      ctxt
      remaining_denunciations
  in
  return (ctxt, balance_updates)

module For_RPC = struct
  let get_pending_misbehaviour_map ctxt =
    Storage.Pending_denunciations.fold
      ctxt
      ~order:`Undefined
      ~init:MisMap.empty
      ~f:(fun delegate denunciations block_map ->
        let new_block_map =
          update_block_denunciations_map_with delegate denunciations block_map
        in
        Lwt.return new_block_map)

  let get_estimated_punished_amount ctxt delegate =
    let open Lwt_result_syntax in
    let current_cycle = (Raw_context.current_level ctxt).cycle in
    let* denunciations = Storage.Pending_denunciations.find ctxt delegate in
    match denunciations with
    | None | Some [] -> return Tez_repr.zero
    | Some denunciations ->
        let*! pending_misbehaviour_map = get_pending_misbehaviour_map ctxt in
        List.fold_left_es
          (fun estimated_punishing_amount denunciation ->
            let ({Misbehaviour_repr.level = raw_level; kind; _} as
                misbehaviour_key) =
              denunciation.Denunciations_repr.misbehaviour
            in
            match MisMap.find misbehaviour_key pending_misbehaviour_map with
            | None ->
                (* Should not happen as [pending_misbehaviour_map] has been created
                   using the bindings of [Storage.Pending_denunciations] and
                   [denunciation] belongs to [Storage.Pending_denunciations]. *)
                return estimated_punishing_amount
            | Some denunciations ->
                let level =
                  Level_repr.level_from_raw
                    ~cycle_eras:(Raw_context.cycle_eras ctxt)
                    raw_level
                in
                let denounced_pkhs =
                  List.map
                    fst
                    (Signature.Public_key_hash.Map.bindings denunciations)
                in
                let* ctxt, slashing_percentage =
                  Slash_percentage.get ctxt ~kind ~level denounced_pkhs
                in
                let misbehaviour_cycle = level.cycle in
                let* frozen_deposits =
                  let* initial_amount =
                    get_initial_frozen_deposits_of_misbehaviour_cycle
                      ~current_cycle
                      ~misbehaviour_cycle
                      ctxt
                      delegate
                  in
                  let* current_amount =
                    Delegate_storage.current_frozen_deposits ctxt delegate
                  in
                  return {Deposits_repr.initial_amount; current_amount}
                in
                let punishing_amount =
                  compute_punishing_amount slashing_percentage frozen_deposits
                in
                let new_estimated_punishing_amount =
                  Tez_repr.(punishing_amount +? estimated_punishing_amount)
                in
                Lwt.return new_estimated_punishing_amount)
          Tez_repr.zero
          denunciations

  let get_estimated_punished_share ctxt delegate =
    let open Lwt_result_syntax in
    let* estimated_punished_amount =
      get_estimated_punished_amount ctxt delegate
    in
    Shared_stake.share
      ~rounding:`Towards_baker
      ctxt
      delegate
      estimated_punished_amount

  let get_estimated_shared_pending_slashed_amount ctxt delegate =
    let open Lwt_result_syntax in
    let* {baker_part; stakers_part} =
      get_estimated_punished_share ctxt delegate
    in
    Lwt.return Tez_repr.(baker_part +? stakers_part)

  let get_delegate_estimated_own_pending_slashed_amount ctxt ~delegate =
    let open Lwt_result_syntax in
    let+ {baker_part; stakers_part = _} =
      get_estimated_punished_share ctxt delegate
    in
    baker_part

  let get_estimated_own_pending_slashed_amount ctxt contract =
    let open Lwt_result_syntax in
    let* delegate_opt = Contract_delegate_storage.find ctxt contract in
    match delegate_opt with
    | None -> return Tez_repr.zero
    | Some delegate ->
        if Contract_repr.(equal (Contract_repr.Implicit delegate) contract) then
          get_delegate_estimated_own_pending_slashed_amount ctxt ~delegate
        else
          let* {baker_part = _; stakers_part} =
            get_estimated_punished_share ctxt delegate
          in
          let* num =
            let+ staking_pseudotokens =
              Staking_pseudotokens_storage.For_RPC.staking_pseudotokens_balance
                ctxt
                ~delegator:contract
            in
            Staking_pseudotoken_repr.to_int64 staking_pseudotokens
          in
          let* den =
            let+ frozen_deposits_pseudotokens =
              Staking_pseudotokens_storage.For_RPC
              .get_frozen_deposits_pseudotokens
                ctxt
                ~delegate
            in
            Staking_pseudotoken_repr.to_int64 frozen_deposits_pseudotokens
          in
          Lwt.return (Tez_repr.mul_ratio ~rounding:`Up stakers_part ~num ~den)
end
package tezos-protocol-alpha

Source file delegate_slashed_deposits_storage.ml

Source file `delegate_slashed_deposits_storage.ml`
