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 `sc_rollup_outbox_message_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
(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 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.                                                 *)
(*                                                                           *)
(*****************************************************************************)

type error +=
  | (* `Permanent *) Error_encode_outbox_message
  | (* `Permanent *) Error_decode_outbox_message

let () =
  let open Data_encoding in
  let msg =
    "Failed to encode a rollup management protocol outbox message value"
  in
  register_error_kind
    `Permanent
    ~id:"smart_rollup_outbox_message_repr.error_encoding_outbox_message"
    ~title:msg
    ~pp:(fun fmt () -> Format.fprintf fmt "%s" msg)
    ~description:msg
    unit
    (function Error_encode_outbox_message -> Some () | _ -> None)
    (fun () -> Error_encode_outbox_message) ;
  let msg =
    "Failed to decode a rollup management protocol outbox message value"
  in
  register_error_kind
    `Permanent
    ~id:"smart_rollup_outbox_message_repr.error_decoding_outbox_message"
    ~title:msg
    ~pp:(fun fmt () -> Format.fprintf fmt "%s" msg)
    ~description:msg
    unit
    (function Error_decode_outbox_message -> Some () | _ -> None)
    (fun () -> Error_decode_outbox_message)

type transaction = {
  unparsed_parameters : Script_repr.expr;  (** The payload. *)
  destination : Contract_hash.t;  (** The recipient contract. *)
  entrypoint : Entrypoint_repr.t;  (** Entrypoint of the destination. *)
}

let transaction_encoding =
  let open Data_encoding in
  conv
    (fun {unparsed_parameters; destination; entrypoint} ->
      (unparsed_parameters, destination, entrypoint))
    (fun (unparsed_parameters, destination, entrypoint) ->
      {unparsed_parameters; destination; entrypoint})
  @@ obj3
       (req "parameters" Script_repr.expr_encoding)
       (req "destination" Contract_repr.originated_encoding)
       Entrypoint_repr.(dft "entrypoint" simple_encoding default)

let pp_untyped_transaction fmt {destination; entrypoint; unparsed_parameters} =
  let json =
    Data_encoding.Json.construct Script_repr.expr_encoding unparsed_parameters
  in
  Format.fprintf
    fmt
    "@[<2>destination: %a@, entrypoint: %a@, unparsed_parameters: %a@]"
    Contract_hash.pp
    destination
    Entrypoint_repr.pp
    entrypoint
    Data_encoding.Json.pp
    json

type typed_transaction = {
  unparsed_parameters : Script_repr.expr;
  unparsed_ty : Script_repr.expr;
  destination : Contract_hash.t;
  entrypoint : Entrypoint_repr.t;
}

let typed_transaction_encoding =
  let open Data_encoding in
  conv
    (fun {unparsed_parameters; unparsed_ty; destination; entrypoint} ->
      (unparsed_parameters, unparsed_ty, destination, entrypoint))
    (fun (unparsed_parameters, unparsed_ty, destination, entrypoint) ->
      {unparsed_parameters; unparsed_ty; destination; entrypoint})
  @@ obj4
       (req "parameters" Script_repr.expr_encoding)
       (req "parameters_ty" Script_repr.expr_encoding)
       (req "destination" Contract_repr.originated_encoding)
       Entrypoint_repr.(dft "entrypoint" simple_encoding default)

let pp_typed_transaction fmt
    {destination; entrypoint; unparsed_parameters; unparsed_ty} =
  let json_param =
    Data_encoding.Json.construct Script_repr.expr_encoding unparsed_parameters
  in
  let json_ty =
    Data_encoding.Json.construct Script_repr.expr_encoding unparsed_ty
  in
  Format.fprintf
    fmt
    "@[<v2>destination: %a@,\
     entrypoint: %a@,\
     unparsed_ty: %a@,\
     unparsed_parameters: %a@]"
    Contract_hash.pp
    destination
    Entrypoint_repr.pp
    entrypoint
    Data_encoding.Json.pp
    json_ty
    Data_encoding.Json.pp
    json_param

type t =
  | Atomic_transaction_batch of {transactions : transaction list}
  | Atomic_transaction_batch_typed of {transactions : typed_transaction list}
  | Whitelist_update of Sc_rollup_whitelist_repr.t option

let encoding =
  let open Data_encoding in
  (* We use a union encoding in order to guarantee backwards compatibility
     when outbox messages are extended with more constructors.

     Each new constructor must be added with an increased tag number.
  *)
  check_size
    Constants_repr.sc_rollup_message_size_limit
    (union
       [
         case
           (Tag 0)
           ~title:"Atomic_transaction_batch"
           (obj2
              (req "transactions" (list transaction_encoding))
              (req "kind" (constant "untyped")))
           (function
             | Atomic_transaction_batch {transactions} -> Some (transactions, ())
             | _ -> None)
           (fun (transactions, ()) -> Atomic_transaction_batch {transactions});
         case
           (Tag 1)
           ~title:"Atomic_transaction_batch_typed"
           (obj2
              (req "transactions" (list typed_transaction_encoding))
              (req "kind" (constant "typed")))
           (function
             | Atomic_transaction_batch_typed {transactions} ->
                 Some (transactions, ())
             | _ -> None)
           (fun (transactions, ()) ->
             Atomic_transaction_batch_typed {transactions});
         case
           (Tag 2)
           ~title:"Whitelist_update"
           (obj2
              (opt "whitelist" Sc_rollup_whitelist_repr.encoding)
              (req "kind" (constant "whitelist_update")))
           (function
             | Whitelist_update whitelist_opt -> Some (whitelist_opt, ())
             | _ -> None)
           (fun (whitelist_opt, ()) -> Whitelist_update whitelist_opt);
       ])

let pp fmt = function
  | Atomic_transaction_batch {transactions} ->
      Format.pp_print_list
        ~pp_sep:Format.pp_print_space
        pp_untyped_transaction
        fmt
        transactions
  | Atomic_transaction_batch_typed {transactions} ->
      Format.pp_print_list
        ~pp_sep:Format.pp_print_space
        pp_typed_transaction
        fmt
        transactions
  | Whitelist_update whitelist_opt ->
      Format.pp_print_option Sc_rollup_whitelist_repr.pp fmt whitelist_opt

type serialized = string

let deserialize data =
  let open Result_syntax in
  match Data_encoding.Binary.of_string_opt encoding data with
  | Some x -> return x
  | None -> tzfail Error_decode_outbox_message

let serialize outbox_message =
  let open Result_syntax in
  match Data_encoding.Binary.to_string_opt encoding outbox_message with
  | Some str -> return str
  | None -> tzfail Error_encode_outbox_message

let unsafe_of_string s = s

let unsafe_to_string s = s
package tezos-protocol-alpha

Source file sc_rollup_outbox_message_repr.ml

Source file `sc_rollup_outbox_message_repr.ml`
