Source file `zk_rollup_errors.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
(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2022 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 error +=
  | Deposit_as_external
  | Invalid_deposit_amount
  | Invalid_deposit_ticket
  | Wrong_deposit_parameters
  | Ticket_payload_size_limit_exceeded of {
      payload_size : Saturation_repr.may_saturate Saturation_repr.t;
      limit : int;
    }
  | Invalid_verification
  | Invalid_circuit
  | Inconsistent_state_update
  | Pending_bound

let () =
  register_error_kind
    `Temporary
    ~id:"operation.zk_rollup_deposit_as_external"
    ~title:"Zk_rollup: attempted a deposit through an external op"
    ~description:"Zk_rollup: attempted a deposit through an external op"
    ~pp:(fun ppf () ->
      Format.fprintf ppf "Zk_rollup: attempted a deposit through an external op")
    Data_encoding.empty
    (function Deposit_as_external -> Some () | _ -> None)
    (fun () -> Deposit_as_external) ;
  register_error_kind
    `Temporary
    ~id:"operation.zk_rollup_invalid_deposit_amount"
    ~title:"Zk_rollup: attempted a deposit with an invalid amount"
    ~description:"Zk_rollup: attempted a deposit with an invalid amount"
    ~pp:(fun ppf () ->
      Format.fprintf ppf "Zk_rollup: attempted a deposit with an invalid amount")
    Data_encoding.empty
    (function Invalid_deposit_amount -> Some () | _ -> None)
    (fun () -> Invalid_deposit_amount) ;
  register_error_kind
    `Temporary
    ~id:"operation.zk_rollup_invalid_deposit_ticket"
    ~title:"Zk_rollup: attempted a deposit with an invalid ticket"
    ~description:"Zk_rollup: attempted a deposit with an invalid ticket"
    ~pp:(fun ppf () ->
      Format.fprintf ppf "Zk_rollup: attempted a deposit with an invalid ticket")
    Data_encoding.empty
    (function Invalid_deposit_ticket -> Some () | _ -> None)
    (fun () -> Invalid_deposit_ticket) ;
  register_error_kind
    `Permanent
    ~id:"operation.zk_rollup_wrong_deposit_parameters"
    ~title:"Zk_rollup: attempted a deposit with invalid parameters"
    ~description:"Zk_rollup: attempted a deposit with invalid parameters"
    ~pp:(fun ppf () ->
      Format.fprintf
        ppf
        "Zk_rollup: attempted a deposit with an invalid parameters")
    Data_encoding.empty
    (function Wrong_deposit_parameters -> Some () | _ -> None)
    (fun () -> Wrong_deposit_parameters) ;
  register_error_kind
    `Permanent
    ~id:"zk_rollup_ticket_payload_size_limit_exceeded"
    ~title:"The payload of the deposited ticket exceeded the size limit"
    ~description:"The payload of the deposited ticket exceeded the size limit"
    Data_encoding.(
      obj2 (req "payload_size" Saturation_repr.n_encoding) (req "limit" int31))
    (function
      | Ticket_payload_size_limit_exceeded {payload_size; limit} ->
          Some (payload_size, limit)
      | _ -> None)
    (fun (payload_size, limit) ->
      Ticket_payload_size_limit_exceeded {payload_size; limit}) ;
  register_error_kind
    `Temporary
    ~id:"operation.zk_rollup_failed_verification"
    ~title:"Zk_rollup_update: failed verification"
    ~description:"Zk_rollup_update: failed verification"
    ~pp:(fun ppf () -> Format.fprintf ppf "The proof verification failed")
    Data_encoding.empty
    (function Invalid_verification -> Some () | _ -> None)
    (fun () -> Invalid_verification) ;
  register_error_kind
    `Permanent
    ~id:"operation.zk_rollup_invalid_circuit"
    ~title:"Zk_rollup_update: invalid circuit"
    ~description:"Zk_rollup_update: invalid circuit"
    ~pp:(fun ppf () ->
      Format.fprintf ppf "Invalid circuit in proof verification")
    Data_encoding.empty
    (function Invalid_circuit -> Some () | _ -> None)
    (fun () -> Invalid_circuit) ;
  register_error_kind
    `Permanent
    ~id:"operation.zk_rollup_inconsistent_state_update"
    ~title:"Zk_rollup_update: inconsistent state update"
    ~description:"Zk_rollup_update: new state is of incorrect size"
    ~pp:(fun ppf () ->
      Format.fprintf ppf "Zk_rollup_update: new state is of incorrect size")
    Data_encoding.empty
    (function Inconsistent_state_update -> Some () | _ -> None)
    (fun () -> Inconsistent_state_update) ;
  register_error_kind
    `Temporary
    ~id:"operation.zk_rollup_pending_bound"
    ~title:"Zk_rollup_update: update with fewer pending ops than allowed"
    ~description:"Zk_rollup_update: update with fewer pending ops than allowed"
    ~pp:(fun ppf () ->
      Format.fprintf
        ppf
        "Zk_rollup_update: update with fewer pending ops than allowed")
    Data_encoding.empty
    (function Pending_bound -> Some () | _ -> None)
    (fun () -> Pending_bound)