package tezos-protocol-020-PsParisC

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

Source file michelson_v1_primitives.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
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2018 Dynamic Ledger Solutions, Inc. <contact@tezos.com>     *)
(* Copyright (c) 2020 Metastate AG <hello@metastate.dev>                     *)
(* Copyright (c) 2022 DaiLambda, Inc. <contact@dailambda,jp>                 *)
(* Copyright (c) 2024 Marigold, <contact@marigold.dev>                       *)
(*                                                                           *)
(* 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.                                                 *)
(*                                                                           *)
(*****************************************************************************)

open Micheline

type error += Unknown_primitive_name of string

type error += Invalid_case of string

type error +=
  | Invalid_primitive_name of
      string Micheline.canonical * Micheline.canonical_location

type prim =
  | K_parameter
  | K_storage
  | K_code
  | K_view
  | D_False
  | D_Elt
  | D_Left
  | D_None
  | D_Pair
  | D_Right
  | D_Some
  | D_True
  | D_Unit
  | D_Ticket
  | D_Lambda_rec
  | I_PACK
  | I_UNPACK
  | I_BLAKE2B
  | I_SHA256
  | I_SHA512
  | I_ABS
  | I_ADD
  | I_AMOUNT
  | I_AND
  | I_BALANCE
  | I_CAR
  | I_CDR
  | I_CHAIN_ID
  | I_CHECK_SIGNATURE
  | I_COMPARE
  | I_CONCAT
  | I_CONS
  | I_CREATE_ACCOUNT
  | I_CREATE_CONTRACT
  | I_IMPLICIT_ACCOUNT
  | I_DIP
  | I_DROP
  | I_DUP
  | I_VIEW
  | I_EDIV
  | I_EMPTY_BIG_MAP
  | I_EMPTY_MAP
  | I_EMPTY_SET
  | I_EQ
  | I_EXEC
  | I_APPLY
  | I_FAILWITH
  | I_GE
  | I_GET
  | I_GET_AND_UPDATE
  | I_GT
  | I_HASH_KEY
  | I_IF
  | I_IF_CONS
  | I_IF_LEFT
  | I_IF_NONE
  | I_INT
  | I_LAMBDA
  | I_LAMBDA_REC
  | I_LE
  | I_LEFT
  | I_LEVEL
  | I_LOOP
  | I_LSL
  | I_LSR
  | I_LT
  | I_MAP
  | I_MEM
  | I_MUL
  | I_NEG
  | I_NEQ
  | I_NIL
  | I_NONE
  | I_NOT
  | I_NOW
  | I_MIN_BLOCK_TIME
  | I_OR
  | I_PAIR
  | I_UNPAIR
  | I_PUSH
  | I_RIGHT
  | I_SIZE
  | I_SOME
  | I_SOURCE
  | I_SENDER
  | I_SELF
  | I_SELF_ADDRESS
  | I_SLICE
  | I_STEPS_TO_QUOTA
  | I_SUB
  | I_SUB_MUTEZ
  | I_SWAP
  | I_TRANSFER_TOKENS
  | I_SET_DELEGATE
  | I_UNIT
  | I_UPDATE
  | I_XOR
  | I_ITER
  | I_LOOP_LEFT
  | I_ADDRESS
  | I_CONTRACT
  | I_ISNAT
  | I_CAST
  | I_RENAME
  | I_SAPLING_EMPTY_STATE
  | I_SAPLING_VERIFY_UPDATE
  | I_DIG
  | I_DUG
  | I_NEVER
  | I_VOTING_POWER
  | I_TOTAL_VOTING_POWER
  | I_KECCAK
  | I_SHA3
  | I_PAIRING_CHECK
  | I_TICKET
  | I_TICKET_DEPRECATED
  | I_READ_TICKET
  | I_SPLIT_TICKET
  | I_JOIN_TICKETS
  | I_OPEN_CHEST
  | I_EMIT
  | I_BYTES
  | I_NAT
  | T_bool
  | T_contract
  | T_int
  | T_key
  | T_key_hash
  | T_lambda
  | T_list
  | T_map
  | T_big_map
  | T_nat
  | T_option
  | T_or
  | T_pair
  | T_set
  | T_signature
  | T_string
  | T_bytes
  | T_mutez
  | T_timestamp
  | T_unit
  | T_operation
  | T_address
  | T_tx_rollup_l2_address
  | T_sapling_transaction
  | T_sapling_transaction_deprecated
  | T_sapling_state
  | T_chain_id
  | T_never
  | T_bls12_381_g1
  | T_bls12_381_g2
  | T_bls12_381_fr
  | T_ticket
  | T_chest_key
  | T_chest
  | H_constant

(* Auxiliary types for error documentation.
   All the prim constructor prefixes must match their namespace. *)
type namespace =
  | (* prefix "T" *) Type_namespace
  | (* prefix "D" *) Constant_namespace
  | (* prefix "I" *) Instr_namespace
  | (* prefix "K" *) Keyword_namespace
  | (* prefix "H" *) Constant_hash_namespace

let namespace = function
  | K_code | K_view | K_parameter | K_storage -> Keyword_namespace
  | D_Elt | D_False | D_Left | D_None | D_Pair | D_Right | D_Some | D_True
  | D_Unit | D_Lambda_rec | D_Ticket ->
      Constant_namespace
  | I_ABS | I_ADD | I_ADDRESS | I_AMOUNT | I_AND | I_APPLY | I_BALANCE
  | I_BLAKE2B | I_CAR | I_CAST | I_CDR | I_CHAIN_ID | I_CHECK_SIGNATURE
  | I_COMPARE | I_CONCAT | I_CONS | I_CONTRACT | I_CREATE_ACCOUNT
  | I_CREATE_CONTRACT | I_DIG | I_DIP | I_DROP | I_DUG | I_DUP | I_VIEW | I_EDIV
  | I_EMPTY_BIG_MAP | I_EMPTY_MAP | I_EMPTY_SET | I_EQ | I_EXEC | I_FAILWITH
  | I_GE | I_GET | I_GET_AND_UPDATE | I_GT | I_HASH_KEY | I_IF | I_IF_CONS
  | I_IF_LEFT | I_IF_NONE | I_IMPLICIT_ACCOUNT | I_INT | I_ISNAT | I_ITER
  | I_JOIN_TICKETS | I_KECCAK | I_LAMBDA | I_LAMBDA_REC | I_LE | I_LEFT
  | I_LEVEL | I_LOOP | I_LOOP_LEFT | I_LSL | I_LSR | I_LT | I_MAP | I_MEM
  | I_MUL | I_NEG | I_NEQ | I_NEVER | I_NIL | I_NONE | I_NOT | I_NOW
  | I_MIN_BLOCK_TIME | I_OR | I_PACK | I_PAIR | I_PAIRING_CHECK | I_PUSH
  | I_READ_TICKET | I_RENAME | I_RIGHT | I_SAPLING_EMPTY_STATE
  | I_SAPLING_VERIFY_UPDATE | I_SELF | I_SELF_ADDRESS | I_SENDER
  | I_SET_DELEGATE | I_SHA256 | I_SHA512 | I_SHA3 | I_SIZE | I_SLICE | I_SOME
  | I_SOURCE | I_SPLIT_TICKET | I_STEPS_TO_QUOTA | I_SUB | I_SUB_MUTEZ | I_SWAP
  | I_TICKET | I_TICKET_DEPRECATED | I_TOTAL_VOTING_POWER | I_TRANSFER_TOKENS
  | I_UNIT | I_UNPACK | I_UNPAIR | I_UPDATE | I_VOTING_POWER | I_XOR
  | I_OPEN_CHEST | I_EMIT | I_BYTES | I_NAT ->
      Instr_namespace
  | T_address | T_tx_rollup_l2_address | T_big_map | T_bool | T_bytes
  | T_chain_id | T_contract | T_int | T_key | T_key_hash | T_lambda | T_list
  | T_map | T_mutez | T_nat | T_never | T_operation | T_option | T_or | T_pair
  | T_sapling_state | T_sapling_transaction | T_sapling_transaction_deprecated
  | T_set | T_signature | T_string | T_timestamp | T_unit | T_bls12_381_fr
  | T_bls12_381_g1 | T_bls12_381_g2 | T_ticket | T_chest_key | T_chest ->
      Type_namespace
  | H_constant -> Constant_hash_namespace

let valid_case name =
  let is_lower = function '_' | 'a' .. 'z' -> true | _ -> false in
  let is_upper = function '_' | 'A' .. 'Z' -> true | _ -> false in
  let rec for_all a b f = Compare.Int.(a > b) || (f a && for_all (a + 1) b f) in
  let len = String.length name in
  Compare.Int.(len <> 0)
  && Compare.Char.(name.[0] <> '_')
  && ((is_upper name.[0] && for_all 1 (len - 1) (fun i -> is_upper name.[i]))
     || (is_upper name.[0] && for_all 1 (len - 1) (fun i -> is_lower name.[i]))
     || (is_lower name.[0] && for_all 1 (len - 1) (fun i -> is_lower name.[i]))
     )

let string_of_prim = function
  | K_parameter -> "parameter"
  | K_storage -> "storage"
  | K_code -> "code"
  | K_view -> "view"
  | D_False -> "False"
  | D_Elt -> "Elt"
  | D_Left -> "Left"
  | D_None -> "None"
  | D_Pair -> "Pair"
  | D_Right -> "Right"
  | D_Some -> "Some"
  | D_True -> "True"
  | D_Unit -> "Unit"
  | D_Ticket -> "Ticket"
  | D_Lambda_rec -> "Lambda_rec"
  | I_PACK -> "PACK"
  | I_UNPACK -> "UNPACK"
  | I_BLAKE2B -> "BLAKE2B"
  | I_SHA256 -> "SHA256"
  | I_SHA512 -> "SHA512"
  | I_ABS -> "ABS"
  | I_ADD -> "ADD"
  | I_AMOUNT -> "AMOUNT"
  | I_AND -> "AND"
  | I_BALANCE -> "BALANCE"
  | I_CAR -> "CAR"
  | I_CDR -> "CDR"
  | I_CHAIN_ID -> "CHAIN_ID"
  | I_CHECK_SIGNATURE -> "CHECK_SIGNATURE"
  | I_COMPARE -> "COMPARE"
  | I_CONCAT -> "CONCAT"
  | I_CONS -> "CONS"
  | I_CREATE_ACCOUNT -> "CREATE_ACCOUNT"
  | I_CREATE_CONTRACT -> "CREATE_CONTRACT"
  | I_IMPLICIT_ACCOUNT -> "IMPLICIT_ACCOUNT"
  | I_DIP -> "DIP"
  | I_DROP -> "DROP"
  | I_DUP -> "DUP"
  | I_EDIV -> "EDIV"
  | I_EMPTY_BIG_MAP -> "EMPTY_BIG_MAP"
  | I_EMPTY_MAP -> "EMPTY_MAP"
  | I_EMPTY_SET -> "EMPTY_SET"
  | I_EQ -> "EQ"
  | I_EXEC -> "EXEC"
  | I_APPLY -> "APPLY"
  | I_FAILWITH -> "FAILWITH"
  | I_GE -> "GE"
  | I_GET -> "GET"
  | I_GET_AND_UPDATE -> "GET_AND_UPDATE"
  | I_GT -> "GT"
  | I_HASH_KEY -> "HASH_KEY"
  | I_IF -> "IF"
  | I_IF_CONS -> "IF_CONS"
  | I_IF_LEFT -> "IF_LEFT"
  | I_IF_NONE -> "IF_NONE"
  | I_INT -> "INT"
  | I_LAMBDA -> "LAMBDA"
  | I_LAMBDA_REC -> "LAMBDA_REC"
  | I_LE -> "LE"
  | I_LEFT -> "LEFT"
  | I_LEVEL -> "LEVEL"
  | I_LOOP -> "LOOP"
  | I_LSL -> "LSL"
  | I_LSR -> "LSR"
  | I_LT -> "LT"
  | I_MAP -> "MAP"
  | I_MEM -> "MEM"
  | I_MUL -> "MUL"
  | I_NEG -> "NEG"
  | I_NEQ -> "NEQ"
  | I_NIL -> "NIL"
  | I_NONE -> "NONE"
  | I_NOT -> "NOT"
  | I_NOW -> "NOW"
  | I_MIN_BLOCK_TIME -> "MIN_BLOCK_TIME"
  | I_OR -> "OR"
  | I_PAIR -> "PAIR"
  | I_PUSH -> "PUSH"
  | I_RIGHT -> "RIGHT"
  | I_SIZE -> "SIZE"
  | I_SOME -> "SOME"
  | I_SOURCE -> "SOURCE"
  | I_SENDER -> "SENDER"
  | I_SELF -> "SELF"
  | I_SELF_ADDRESS -> "SELF_ADDRESS"
  | I_SLICE -> "SLICE"
  | I_STEPS_TO_QUOTA -> "STEPS_TO_QUOTA"
  | I_SUB -> "SUB"
  | I_SUB_MUTEZ -> "SUB_MUTEZ"
  | I_SWAP -> "SWAP"
  | I_TRANSFER_TOKENS -> "TRANSFER_TOKENS"
  | I_SET_DELEGATE -> "SET_DELEGATE"
  | I_UNIT -> "UNIT"
  | I_UNPAIR -> "UNPAIR"
  | I_UPDATE -> "UPDATE"
  | I_XOR -> "XOR"
  | I_ITER -> "ITER"
  | I_LOOP_LEFT -> "LOOP_LEFT"
  | I_ADDRESS -> "ADDRESS"
  | I_CONTRACT -> "CONTRACT"
  | I_ISNAT -> "ISNAT"
  | I_CAST -> "CAST"
  | I_RENAME -> "RENAME"
  | I_SAPLING_EMPTY_STATE -> "SAPLING_EMPTY_STATE"
  | I_SAPLING_VERIFY_UPDATE -> "SAPLING_VERIFY_UPDATE"
  | I_DIG -> "DIG"
  | I_DUG -> "DUG"
  | I_NEVER -> "NEVER"
  | I_VOTING_POWER -> "VOTING_POWER"
  | I_TOTAL_VOTING_POWER -> "TOTAL_VOTING_POWER"
  | I_KECCAK -> "KECCAK"
  | I_SHA3 -> "SHA3"
  | I_PAIRING_CHECK -> "PAIRING_CHECK"
  | I_TICKET -> "TICKET"
  | I_TICKET_DEPRECATED -> "TICKET_DEPRECATED"
  | I_READ_TICKET -> "READ_TICKET"
  | I_SPLIT_TICKET -> "SPLIT_TICKET"
  | I_JOIN_TICKETS -> "JOIN_TICKETS"
  | I_OPEN_CHEST -> "OPEN_CHEST"
  | I_EMIT -> "EMIT"
  | I_VIEW -> "VIEW"
  | I_BYTES -> "BYTES"
  | I_NAT -> "NAT"
  | T_bool -> "bool"
  | T_contract -> "contract"
  | T_int -> "int"
  | T_key -> "key"
  | T_key_hash -> "key_hash"
  | T_lambda -> "lambda"
  | T_list -> "list"
  | T_map -> "map"
  | T_big_map -> "big_map"
  | T_nat -> "nat"
  | T_option -> "option"
  | T_or -> "or"
  | T_pair -> "pair"
  | T_set -> "set"
  | T_signature -> "signature"
  | T_string -> "string"
  | T_bytes -> "bytes"
  | T_mutez -> "mutez"
  | T_timestamp -> "timestamp"
  | T_unit -> "unit"
  | T_operation -> "operation"
  | T_address -> "address"
  | T_tx_rollup_l2_address -> "tx_rollup_l2_address"
  | T_sapling_state -> "sapling_state"
  | T_sapling_transaction -> "sapling_transaction"
  | T_sapling_transaction_deprecated -> "sapling_transaction_deprecated"
  | T_chain_id -> "chain_id"
  | T_never -> "never"
  | T_bls12_381_g1 -> "bls12_381_g1"
  | T_bls12_381_g2 -> "bls12_381_g2"
  | T_bls12_381_fr -> "bls12_381_fr"
  | T_ticket -> "ticket"
  | T_chest_key -> "chest_key"
  | T_chest -> "chest"
  | H_constant -> "constant"

let prim_of_string =
  let open Result_syntax in
  function
  | "parameter" -> return K_parameter
  | "storage" -> return K_storage
  | "code" -> return K_code
  | "view" -> return K_view
  | "False" -> return D_False
  | "Elt" -> return D_Elt
  | "Left" -> return D_Left
  | "None" -> return D_None
  | "Pair" -> return D_Pair
  | "Right" -> return D_Right
  | "Some" -> return D_Some
  | "True" -> return D_True
  | "Unit" -> return D_Unit
  | "Ticket" -> return D_Ticket
  | "Lambda_rec" -> return D_Lambda_rec
  | "PACK" -> return I_PACK
  | "UNPACK" -> return I_UNPACK
  | "BLAKE2B" -> return I_BLAKE2B
  | "SHA256" -> return I_SHA256
  | "SHA512" -> return I_SHA512
  | "ABS" -> return I_ABS
  | "ADD" -> return I_ADD
  | "AMOUNT" -> return I_AMOUNT
  | "AND" -> return I_AND
  | "BALANCE" -> return I_BALANCE
  | "CAR" -> return I_CAR
  | "CDR" -> return I_CDR
  | "CHAIN_ID" -> return I_CHAIN_ID
  | "CHECK_SIGNATURE" -> return I_CHECK_SIGNATURE
  | "COMPARE" -> return I_COMPARE
  | "CONCAT" -> return I_CONCAT
  | "CONS" -> return I_CONS
  | "CREATE_ACCOUNT" -> return I_CREATE_ACCOUNT
  | "CREATE_CONTRACT" -> return I_CREATE_CONTRACT
  | "IMPLICIT_ACCOUNT" -> return I_IMPLICIT_ACCOUNT
  | "DIP" -> return I_DIP
  | "DROP" -> return I_DROP
  | "DUP" -> return I_DUP
  | "VIEW" -> return I_VIEW
  | "EDIV" -> return I_EDIV
  | "EMPTY_BIG_MAP" -> return I_EMPTY_BIG_MAP
  | "EMPTY_MAP" -> return I_EMPTY_MAP
  | "EMPTY_SET" -> return I_EMPTY_SET
  | "EQ" -> return I_EQ
  | "EXEC" -> return I_EXEC
  | "APPLY" -> return I_APPLY
  | "FAILWITH" -> return I_FAILWITH
  | "GE" -> return I_GE
  | "GET" -> return I_GET
  | "GET_AND_UPDATE" -> return I_GET_AND_UPDATE
  | "GT" -> return I_GT
  | "HASH_KEY" -> return I_HASH_KEY
  | "IF" -> return I_IF
  | "IF_CONS" -> return I_IF_CONS
  | "IF_LEFT" -> return I_IF_LEFT
  | "IF_NONE" -> return I_IF_NONE
  | "INT" -> return I_INT
  | "KECCAK" -> return I_KECCAK
  | "LAMBDA" -> return I_LAMBDA
  | "LAMBDA_REC" -> return I_LAMBDA_REC
  | "LE" -> return I_LE
  | "LEFT" -> return I_LEFT
  | "LEVEL" -> return I_LEVEL
  | "LOOP" -> return I_LOOP
  | "LSL" -> return I_LSL
  | "LSR" -> return I_LSR
  | "LT" -> return I_LT
  | "MAP" -> return I_MAP
  | "MEM" -> return I_MEM
  | "MUL" -> return I_MUL
  | "NEG" -> return I_NEG
  | "NEQ" -> return I_NEQ
  | "NIL" -> return I_NIL
  | "NONE" -> return I_NONE
  | "NOT" -> return I_NOT
  | "NOW" -> return I_NOW
  | "MIN_BLOCK_TIME" -> return I_MIN_BLOCK_TIME
  | "OR" -> return I_OR
  | "PAIR" -> return I_PAIR
  | "UNPAIR" -> return I_UNPAIR
  | "PAIRING_CHECK" -> return I_PAIRING_CHECK
  | "PUSH" -> return I_PUSH
  | "RIGHT" -> return I_RIGHT
  | "SHA3" -> return I_SHA3
  | "SIZE" -> return I_SIZE
  | "SOME" -> return I_SOME
  | "SOURCE" -> return I_SOURCE
  | "SENDER" -> return I_SENDER
  | "SELF" -> return I_SELF
  | "SELF_ADDRESS" -> return I_SELF_ADDRESS
  | "SLICE" -> return I_SLICE
  | "STEPS_TO_QUOTA" -> return I_STEPS_TO_QUOTA
  | "SUB" -> return I_SUB
  | "SUB_MUTEZ" -> return I_SUB_MUTEZ
  | "SWAP" -> return I_SWAP
  | "TRANSFER_TOKENS" -> return I_TRANSFER_TOKENS
  | "SET_DELEGATE" -> return I_SET_DELEGATE
  | "UNIT" -> return I_UNIT
  | "UPDATE" -> return I_UPDATE
  | "XOR" -> return I_XOR
  | "ITER" -> return I_ITER
  | "LOOP_LEFT" -> return I_LOOP_LEFT
  | "ADDRESS" -> return I_ADDRESS
  | "CONTRACT" -> return I_CONTRACT
  | "ISNAT" -> return I_ISNAT
  | "CAST" -> return I_CAST
  | "RENAME" -> return I_RENAME
  | "SAPLING_EMPTY_STATE" -> return I_SAPLING_EMPTY_STATE
  | "SAPLING_VERIFY_UPDATE" -> return I_SAPLING_VERIFY_UPDATE
  | "DIG" -> return I_DIG
  | "DUG" -> return I_DUG
  | "NEVER" -> return I_NEVER
  | "VOTING_POWER" -> return I_VOTING_POWER
  | "TOTAL_VOTING_POWER" -> return I_TOTAL_VOTING_POWER
  | "TICKET" -> return I_TICKET
  | "TICKET_DEPRECATED" -> return I_TICKET_DEPRECATED
  | "READ_TICKET" -> return I_READ_TICKET
  | "SPLIT_TICKET" -> return I_SPLIT_TICKET
  | "JOIN_TICKETS" -> return I_JOIN_TICKETS
  | "OPEN_CHEST" -> return I_OPEN_CHEST
  | "EMIT" -> return I_EMIT
  | "BYTES" -> return I_BYTES
  | "NAT" -> return I_NAT
  | "bool" -> return T_bool
  | "contract" -> return T_contract
  | "int" -> return T_int
  | "key" -> return T_key
  | "key_hash" -> return T_key_hash
  | "lambda" -> return T_lambda
  | "list" -> return T_list
  | "map" -> return T_map
  | "big_map" -> return T_big_map
  | "nat" -> return T_nat
  | "option" -> return T_option
  | "or" -> return T_or
  | "pair" -> return T_pair
  | "set" -> return T_set
  | "signature" -> return T_signature
  | "string" -> return T_string
  | "bytes" -> return T_bytes
  | "mutez" -> return T_mutez
  | "timestamp" -> return T_timestamp
  | "unit" -> return T_unit
  | "operation" -> return T_operation
  | "address" -> return T_address
  | "tx_rollup_l2_address" -> return T_tx_rollup_l2_address
  | "sapling_state" -> return T_sapling_state
  | "sapling_transaction" -> return T_sapling_transaction
  | "sapling_transaction_deprecated" -> return T_sapling_transaction_deprecated
  | "chain_id" -> return T_chain_id
  | "never" -> return T_never
  | "bls12_381_g1" -> return T_bls12_381_g1
  | "bls12_381_g2" -> return T_bls12_381_g2
  | "bls12_381_fr" -> return T_bls12_381_fr
  | "ticket" -> return T_ticket
  | "chest_key" -> return T_chest_key
  | "chest" -> return T_chest
  | "constant" -> return H_constant
  | n ->
      if valid_case n then tzfail (Unknown_primitive_name n)
      else tzfail (Invalid_case n)

let prims_of_strings expr =
  let open Result_syntax in
  let rec convert = function
    | (Int _ | String _ | Bytes _) as expr -> return expr
    | Prim (loc, prim, args, annot) ->
        let* prim =
          Error_monad.record_trace
            (Invalid_primitive_name (expr, loc))
            (prim_of_string prim)
        in
        let+ args = List.map_e convert args in
        Prim (loc, prim, args, annot)
    | Seq (loc, args) ->
        let+ args = List.map_e convert args in
        Seq (loc, args)
  in
  let+ expr = convert (root expr) in
  strip_locations expr

let strings_of_prims expr =
  let rec convert = function
    | (Int _ | String _ | Bytes _) as expr -> expr
    | Prim (loc, prim, args, annot) ->
        let prim = string_of_prim prim in
        let args = List.map convert args in
        Prim (loc, prim, args, annot)
    | Seq (loc, args) ->
        let args = List.map convert args in
        Seq (loc, args)
  in
  strip_locations (convert (root expr))

let prim_encoding =
  let open Data_encoding in
  def "michelson.v1.primitives"
  @@ string_enum
       (* Add the comment below every 10 lines *)
       [
         (* /!\ NEW INSTRUCTIONS MUST BE ADDED AT THE END OF THE STRING_ENUM, FOR BACKWARD COMPATIBILITY OF THE ENCODING. *)
         ("parameter", K_parameter);
         ("storage", K_storage);
         ("code", K_code);
         ("False", D_False);
         ("Elt", D_Elt);
         ("Left", D_Left);
         ("None", D_None);
         ("Pair", D_Pair);
         ("Right", D_Right);
         ("Some", D_Some);
         (* /!\ NEW INSTRUCTIONS MUST BE ADDED AT THE END OF THE STRING_ENUM, FOR BACKWARD COMPATIBILITY OF THE ENCODING. *)
         ("True", D_True);
         ("Unit", D_Unit);
         ("PACK", I_PACK);
         ("UNPACK", I_UNPACK);
         ("BLAKE2B", I_BLAKE2B);
         ("SHA256", I_SHA256);
         ("SHA512", I_SHA512);
         ("ABS", I_ABS);
         ("ADD", I_ADD);
         ("AMOUNT", I_AMOUNT);
         (* /!\ NEW INSTRUCTIONS MUST BE ADDED AT THE END OF THE STRING_ENUM, FOR BACKWARD COMPATIBILITY OF THE ENCODING. *)
         ("AND", I_AND);
         ("BALANCE", I_BALANCE);
         ("CAR", I_CAR);
         ("CDR", I_CDR);
         ("CHECK_SIGNATURE", I_CHECK_SIGNATURE);
         ("COMPARE", I_COMPARE);
         ("CONCAT", I_CONCAT);
         ("CONS", I_CONS);
         ("CREATE_ACCOUNT", I_CREATE_ACCOUNT);
         ("CREATE_CONTRACT", I_CREATE_CONTRACT);
         (* /!\ NEW INSTRUCTIONS MUST BE ADDED AT THE END OF THE STRING_ENUM, FOR BACKWARD COMPATIBILITY OF THE ENCODING. *)
         ("IMPLICIT_ACCOUNT", I_IMPLICIT_ACCOUNT);
         ("DIP", I_DIP);
         ("DROP", I_DROP);
         ("DUP", I_DUP);
         ("EDIV", I_EDIV);
         ("EMPTY_MAP", I_EMPTY_MAP);
         ("EMPTY_SET", I_EMPTY_SET);
         ("EQ", I_EQ);
         ("EXEC", I_EXEC);
         ("FAILWITH", I_FAILWITH);
         (* /!\ NEW INSTRUCTIONS MUST BE ADDED AT THE END OF THE STRING_ENUM, FOR BACKWARD COMPATIBILITY OF THE ENCODING. *)
         ("GE", I_GE);
         ("GET", I_GET);
         ("GT", I_GT);
         ("HASH_KEY", I_HASH_KEY);
         ("IF", I_IF);
         ("IF_CONS", I_IF_CONS);
         ("IF_LEFT", I_IF_LEFT);
         ("IF_NONE", I_IF_NONE);
         ("INT", I_INT);
         ("LAMBDA", I_LAMBDA);
         (* /!\ NEW INSTRUCTIONS MUST BE ADDED AT THE END OF THE STRING_ENUM, FOR BACKWARD COMPATIBILITY OF THE ENCODING. *)
         ("LE", I_LE);
         ("LEFT", I_LEFT);
         ("LOOP", I_LOOP);
         ("LSL", I_LSL);
         ("LSR", I_LSR);
         ("LT", I_LT);
         ("MAP", I_MAP);
         ("MEM", I_MEM);
         ("MUL", I_MUL);
         ("NEG", I_NEG);
         (* /!\ NEW INSTRUCTIONS MUST BE ADDED AT THE END OF THE STRING_ENUM, FOR BACKWARD COMPATIBILITY OF THE ENCODING. *)
         ("NEQ", I_NEQ);
         ("NIL", I_NIL);
         ("NONE", I_NONE);
         ("NOT", I_NOT);
         ("NOW", I_NOW);
         ("OR", I_OR);
         ("PAIR", I_PAIR);
         ("PUSH", I_PUSH);
         ("RIGHT", I_RIGHT);
         ("SIZE", I_SIZE);
         (* /!\ NEW INSTRUCTIONS MUST BE ADDED AT THE END OF THE STRING_ENUM, FOR BACKWARD COMPATIBILITY OF THE ENCODING. *)
         ("SOME", I_SOME);
         ("SOURCE", I_SOURCE);
         ("SENDER", I_SENDER);
         ("SELF", I_SELF);
         ("STEPS_TO_QUOTA", I_STEPS_TO_QUOTA);
         ("SUB", I_SUB);
         ("SWAP", I_SWAP);
         ("TRANSFER_TOKENS", I_TRANSFER_TOKENS);
         ("SET_DELEGATE", I_SET_DELEGATE);
         ("UNIT", I_UNIT);
         (* /!\ NEW INSTRUCTIONS MUST BE ADDED AT THE END OF THE STRING_ENUM, FOR BACKWARD COMPATIBILITY OF THE ENCODING. *)
         ("UPDATE", I_UPDATE);
         ("XOR", I_XOR);
         ("ITER", I_ITER);
         ("LOOP_LEFT", I_LOOP_LEFT);
         ("ADDRESS", I_ADDRESS);
         ("CONTRACT", I_CONTRACT);
         ("ISNAT", I_ISNAT);
         ("CAST", I_CAST);
         ("RENAME", I_RENAME);
         ("bool", T_bool);
         (* /!\ NEW INSTRUCTIONS MUST BE ADDED AT THE END OF THE STRING_ENUM, FOR BACKWARD COMPATIBILITY OF THE ENCODING. *)
         ("contract", T_contract);
         ("int", T_int);
         ("key", T_key);
         ("key_hash", T_key_hash);
         ("lambda", T_lambda);
         ("list", T_list);
         ("map", T_map);
         ("big_map", T_big_map);
         ("nat", T_nat);
         ("option", T_option);
         (* /!\ NEW INSTRUCTIONS MUST BE ADDED AT THE END OF THE STRING_ENUM, FOR BACKWARD COMPATIBILITY OF THE ENCODING. *)
         ("or", T_or);
         ("pair", T_pair);
         ("set", T_set);
         ("signature", T_signature);
         ("string", T_string);
         ("bytes", T_bytes);
         ("mutez", T_mutez);
         ("timestamp", T_timestamp);
         ("unit", T_unit);
         ("operation", T_operation);
         (* /!\ NEW INSTRUCTIONS MUST BE ADDED AT THE END OF THE STRING_ENUM, FOR BACKWARD COMPATIBILITY OF THE ENCODING. *)
         ("address", T_address);
         (* Alpha_002 addition *)
         ("SLICE", I_SLICE);
         (* Alpha_005 addition *)
         ("DIG", I_DIG);
         ("DUG", I_DUG);
         ("EMPTY_BIG_MAP", I_EMPTY_BIG_MAP);
         ("APPLY", I_APPLY);
         ("chain_id", T_chain_id);
         ("CHAIN_ID", I_CHAIN_ID);
         (* /!\ NEW INSTRUCTIONS MUST BE ADDED AT THE END OF THE STRING_ENUM, FOR BACKWARD COMPATIBILITY OF THE ENCODING. *)
         (* Alpha_008 addition *)
         ("LEVEL", I_LEVEL);
         ("SELF_ADDRESS", I_SELF_ADDRESS);
         ("never", T_never);
         ("NEVER", I_NEVER);
         ("UNPAIR", I_UNPAIR);
         ("VOTING_POWER", I_VOTING_POWER);
         ("TOTAL_VOTING_POWER", I_TOTAL_VOTING_POWER);
         ("KECCAK", I_KECCAK);
         ("SHA3", I_SHA3);
         (* /!\ NEW INSTRUCTIONS MUST BE ADDED AT THE END OF THE STRING_ENUM, FOR BACKWARD COMPATIBILITY OF THE ENCODING. *)
         (* Alpha_008 addition *)
         ("PAIRING_CHECK", I_PAIRING_CHECK);
         ("bls12_381_g1", T_bls12_381_g1);
         ("bls12_381_g2", T_bls12_381_g2);
         ("bls12_381_fr", T_bls12_381_fr);
         ("sapling_state", T_sapling_state);
         ("sapling_transaction_deprecated", T_sapling_transaction_deprecated);
         ("SAPLING_EMPTY_STATE", I_SAPLING_EMPTY_STATE);
         ("SAPLING_VERIFY_UPDATE", I_SAPLING_VERIFY_UPDATE);
         ("ticket", T_ticket);
         (* /!\ NEW INSTRUCTIONS MUST BE ADDED AT THE END OF THE STRING_ENUM, FOR BACKWARD COMPATIBILITY OF THE ENCODING. *)
         (* Alpha_008 addition *)
         ("TICKET_DEPRECATED", I_TICKET_DEPRECATED);
         ("READ_TICKET", I_READ_TICKET);
         ("SPLIT_TICKET", I_SPLIT_TICKET);
         ("JOIN_TICKETS", I_JOIN_TICKETS);
         ("GET_AND_UPDATE", I_GET_AND_UPDATE);
         (* Alpha_011 addition *)
         ("chest", T_chest);
         ("chest_key", T_chest_key);
         ("OPEN_CHEST", I_OPEN_CHEST);
         (* /!\ NEW INSTRUCTIONS MUST BE ADDED AT THE END OF THE STRING_ENUM, FOR BACKWARD COMPATIBILITY OF THE ENCODING. *)
         ("VIEW", I_VIEW);
         ("view", K_view);
         ("constant", H_constant);
         (* Alpha_012 addition *)
         ("SUB_MUTEZ", I_SUB_MUTEZ);
         (* Alpha_013 addition *)
         ("tx_rollup_l2_address", T_tx_rollup_l2_address);
         ("MIN_BLOCK_TIME", I_MIN_BLOCK_TIME);
         ("sapling_transaction", T_sapling_transaction);
         (* /!\ NEW INSTRUCTIONS MUST BE ADDED AT THE END OF THE STRING_ENUM, FOR BACKWARD COMPATIBILITY OF THE ENCODING. *)
         (* Alpha_014 addition *)
         ("EMIT", I_EMIT);
         (* Alpha_015 addition *)
         ("Lambda_rec", D_Lambda_rec);
         ("LAMBDA_REC", I_LAMBDA_REC);
         ("TICKET", I_TICKET);
         ("BYTES", I_BYTES);
         ("NAT", I_NAT);
         (* Alpha_019 addition *)
         ("Ticket", D_Ticket);
         (* New instructions must be added here, for backward compatibility of the encoding. *)
         (* Keep the comment above at the end of the list *)
       ]

let () =
  register_error_kind
    `Permanent
    ~id:"michelson_v1.unknown_primitive_name"
    ~title:"Unknown primitive name"
    ~description:"In a script or data expression, a primitive was unknown."
    ~pp:(fun ppf n -> Format.fprintf ppf "Unknown primitive %s." n)
    Data_encoding.(obj1 (req "wrong_primitive_name" @@ string Plain))
    (function Unknown_primitive_name got -> Some got | _ -> None)
    (fun got -> Unknown_primitive_name got) ;
  register_error_kind
    `Permanent
    ~id:"michelson_v1.invalid_primitive_name_case"
    ~title:"Invalid primitive name case"
    ~description:
      "In a script or data expression, a primitive name is neither uppercase, \
       lowercase or capitalized."
    ~pp:(fun ppf n -> Format.fprintf ppf "Primitive %s has invalid case." n)
    Data_encoding.(obj1 (req "wrong_primitive_name" @@ string Plain))
    (function Invalid_case name -> Some name | _ -> None)
    (fun name -> Invalid_case name) ;
  register_error_kind
    `Permanent
    ~id:"michelson_v1.invalid_primitive_name"
    ~title:"Invalid primitive name"
    ~description:
      "In a script or data expression, a primitive name is unknown or has a \
       wrong case."
    ~pp:(fun ppf _ -> Format.fprintf ppf "Invalid primitive.")
    Data_encoding.(
      obj2
        (req
           "expression"
           (Micheline.canonical_encoding ~variant:"generic" @@ string Plain))
        (req "location" Micheline.canonical_location_encoding))
    (function
      | Invalid_primitive_name (expr, loc) -> Some (expr, loc) | _ -> None)
    (fun (expr, loc) -> Invalid_primitive_name (expr, loc))

let string_of_namespace = function
  | Type_namespace -> "T"
  | Constant_namespace -> "D"
  | Instr_namespace -> "I"
  | Keyword_namespace -> "K"
  | Constant_hash_namespace -> "H"
OCaml

Innovation. Community. Security.