Source file plugin.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
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
open Protocol
open Alpha_context
(** The assumed number of blocks between operation-creation time and
the actual time when the operation is included in a block. *)
let default_operation_inclusion_latency = 3
type Environment.Error_monad.error += Cannot_parse_operation
type Environment.Error_monad.error += Cannot_serialize_log
type Environment.Error_monad.error += Cannot_retrieve_predecessor_level
let () =
Environment.Error_monad.register_error_kind
`Branch
~id:"operation.cannot_parse"
~title:"Cannot parse operation"
~description:"The operation is ill-formed or for another protocol version"
~pp:(fun ppf () -> Format.fprintf ppf "The operation cannot be parsed")
Data_encoding.unit
(function Cannot_parse_operation -> Some () | _ -> None)
(fun () -> Cannot_parse_operation) ;
Environment.Error_monad.register_error_kind
`Temporary
~id:"michelson_v1.cannot_serialize_log"
~title:"Not enough gas to serialize execution trace"
~description:
"Execution trace with stacks was to big to be serialized with the \
provided gas"
Data_encoding.empty
(function Cannot_serialize_log -> Some () | _ -> None)
(fun () -> Cannot_serialize_log) ;
Environment.Error_monad.register_error_kind
`Temporary
~id:"cannot_retrieve_predecessor_level"
~title:"Cannot retrieve predecessor level"
~description:"Cannot retrieve predecessor level."
Data_encoding.empty
(function Cannot_retrieve_predecessor_level -> Some () | _ -> None)
(fun () -> Cannot_retrieve_predecessor_level)
module View_helpers = struct
open Tezos_micheline
type Environment.Error_monad.error += Viewed_contract_has_no_script
type Environment.Error_monad.error += View_callback_origination_failed
type Environment.Error_monad.error +=
| Illformed_view_type of Entrypoint.t * Script.expr
type Environment.Error_monad.error +=
| View_never_returns of Entrypoint.t * Contract.t
type Environment.Error_monad.error +=
| View_unexpected_return of Entrypoint.t * Contract.t
type Environment.Error_monad.error += View_not_found of Contract.t * string
type Environment.Error_monad.error += Viewer_unexpected_storage
let () =
Environment.Error_monad.register_error_kind
`Permanent
~id:"viewedContractHasNoScript"
~title:"Viewed contract has no script"
~description:"A view was called on a contract with no script."
~pp:(fun ppf () ->
Format.fprintf ppf "A view was called on a contract with no script.")
Data_encoding.(unit)
(function Viewed_contract_has_no_script -> Some () | _ -> None)
(fun () -> Viewed_contract_has_no_script) ;
Environment.Error_monad.register_error_kind
`Permanent
~id:"viewCallbackOriginationFailed"
~title:"View callback origination failed"
~description:"View callback origination failed"
~pp:(fun ppf () ->
Format.fprintf ppf "Error during origination of view callback contract.")
Data_encoding.(unit)
(function View_callback_origination_failed -> Some () | _ -> None)
(fun () -> View_callback_origination_failed) ;
Environment.Error_monad.register_error_kind
`Permanent
~id:"illformedViewType"
~title:"An entrypoint type is incompatible with TZIP-4 view type."
~description:"An entrypoint type is incompatible with TZIP-4 view type."
~pp:(fun ppf (entrypoint, typ) ->
Format.fprintf
ppf
"The view %a has type %a, it is not compatible with a TZIP-4 view \
type."
Entrypoint.pp
entrypoint
Micheline_printer.print_expr
(Micheline_printer.printable
(fun x -> x)
(Michelson_v1_primitives.strings_of_prims typ)))
Data_encoding.(
obj2
(req "entrypoint" Entrypoint.simple_encoding)
(req "type" Script.expr_encoding))
(function Illformed_view_type (etp, exp) -> Some (etp, exp) | _ -> None)
(fun (etp, exp) -> Illformed_view_type (etp, exp)) ;
Environment.Error_monad.register_error_kind
`Permanent
~id:"viewNeverReturns"
~title:
"A view never returned a transaction to the given callback contract"
~description:
"A view never initiated a transaction to the given callback contract."
~pp:(fun ppf (entrypoint, callback) ->
Format.fprintf
ppf
"The view %a never initiated a transaction to the given callback \
contract %a."
Entrypoint.pp
entrypoint
Contract.pp
callback)
Data_encoding.(
obj2
(req "entrypoint" Entrypoint.simple_encoding)
(req "callback" Contract.encoding))
(function View_never_returns (e, c) -> Some (e, c) | _ -> None)
(fun (e, c) -> View_never_returns (e, c)) ;
Environment.Error_monad.register_error_kind
`Permanent
~id:"viewUnexpectedReturn"
~title:"A view returned an unexpected list of operations"
~description:
"A view initiated a list of operations while the TZIP-4 standard \
expects only a transaction to the given callback contract."
~pp:(fun ppf (entrypoint, callback) ->
Format.fprintf
ppf
"The view %a initiated a list of operations while the TZIP-4 \
standard expects only a transaction to the given callback contract \
%a."
Entrypoint.pp
entrypoint
Contract.pp
callback)
Data_encoding.(
obj2
(req "entrypoint" Entrypoint.simple_encoding)
(req "callback" Contract.encoding))
(function View_never_returns (e, c) -> Some (e, c) | _ -> None)
(fun (e, c) -> View_never_returns (e, c)) ;
Environment.Error_monad.register_error_kind
`Permanent
~id:"viewNotFound"
~title:"A view could not be found"
~description:"The contract does not have a view of the given name."
~pp:(fun ppf (contract, name) ->
Format.fprintf
ppf
"The contract %a does not have a view named `%s`."
Contract.pp
contract
name)
Data_encoding.(
obj2 (req "contract" Contract.encoding) (req "view" string))
(function View_not_found (k, n) -> Some (k, n) | _ -> None)
(fun (k, n) -> View_not_found (k, n)) ;
Environment.Error_monad.register_error_kind
`Permanent
~id:"viewerUnexpectedStorage"
~title:"A VIEW instruction returned an unexpected value"
~description:"A VIEW instruction returned an unexpected value."
~pp:(fun ppf () ->
Format.fprintf ppf "The simulated view returned an unexpected value.")
Data_encoding.unit
(function Viewer_unexpected_storage -> Some () | _ -> None)
(fun () -> Viewer_unexpected_storage)
let make_tzip4_viewer_script ty : Script.t =
let loc = 0 in
let ty = Micheline.root ty in
let code =
Micheline.strip_locations
@@ Micheline.Seq
( loc,
[
Micheline.Prim (loc, Script.K_parameter, [ty], []);
Micheline.Prim
( loc,
Script.K_storage,
[Micheline.Prim (loc, Script.T_unit, [], [])],
[] );
Micheline.Prim
( loc,
Script.K_code,
[Micheline.Prim (loc, Script.I_FAILWITH, [], [])],
[] );
] )
in
let storage =
Micheline.strip_locations (Micheline.Prim (loc, Script.D_Unit, [], []))
in
{code = Script.lazy_expr code; storage = Script.lazy_expr storage}
let make_view_parameter input callback =
let loc = 0 in
Micheline.strip_locations
(Micheline.Prim
( loc,
Script.D_Pair,
[
input;
Micheline.Bytes
( loc,
Data_encoding.Binary.to_bytes_exn Contract.encoding callback );
],
[] ))
let entrypoint ty =
match Micheline.root ty with
| Micheline.Prim
( _,
Script.T_pair,
[_; Micheline.Prim (_, Script.T_contract, [ty], _)],
_ ) ->
ok (Micheline.strip_locations ty)
| _ -> Environment.Error_monad.error (Illformed_view_type (entrypoint, ty))
let entrypoint operations callback =
let unexpected_return =
Environment.Error_monad.error
@@ View_unexpected_return (entrypoint, callback)
in
match operations with
| [
Script_typed_ir.Internal_operation
{
operation =
Transaction
{
transaction =
{destination; parameters; entrypoint = _; amount = _};
parameters = _;
parameters_ty = _;
location = _;
};
source = _;
nonce = _;
};
]
when Destination.equal destination (Contract callback) ->
ok parameters
| [] ->
Environment.Error_monad.error
(View_never_returns (entrypoint, callback))
| _ -> unexpected_return
let make_michelson_viewer_script address view input input_ty output_ty :
Script.t =
let loc = 0 in
let address = Micheline.String (loc, Contract.to_b58check address) in
let push ty value = Micheline.Prim (loc, Script.I_PUSH, [ty; value], []) in
let storage_decl = Micheline.Prim (loc, Script.T_option, [output_ty], []) in
let body =
Micheline.Seq
( loc,
[
Micheline.Prim (loc, Script.I_DROP, [], []);
push (Micheline.Prim (loc, Script.T_address, [], [])) address;
push input_ty (Micheline.root input);
Micheline.Prim
(loc, Script.I_VIEW, [Micheline.String (loc, view); output_ty], []);
Micheline.Prim
( loc,
Script.I_NIL,
[Micheline.Prim (loc, Script.T_operation, [], [])],
[] );
Micheline.Prim (loc, Script.I_PAIR, [], []);
] )
in
let code =
Micheline.strip_locations
@@ Micheline.Seq
( loc,
[
Micheline.Prim
( loc,
Script.K_parameter,
[Micheline.Prim (loc, Script.T_unit, [], [])],
[] );
Micheline.Prim (loc, Script.K_storage, [storage_decl], []);
Micheline.Prim (loc, Script.K_code, [body], []);
] )
in
let storage =
Micheline.strip_locations (Micheline.Prim (loc, Script.D_None, [], []))
in
{code = Script.lazy_expr code; storage = Script.lazy_expr storage}
let (storage : Script.expr) =
match Micheline.root storage with
| Micheline.Prim (_, Script.D_Some, [value], []) -> ok value
| _ -> Environment.Error_monad.error @@ Viewer_unexpected_storage
end
module RPC = struct
open Environment
open Alpha_context
open Environment.Error_monad
let parse_operation (op : Operation.raw) =
match
Data_encoding.Binary.of_bytes_opt
Operation.protocol_data_encoding
op.proto
with
| Some protocol_data -> ok {shell = op.shell; protocol_data}
| None -> error Cannot_parse_operation
let path = Tezos_rpc.Path.(open_root / "helpers")
module Registration = struct
let patched_services =
ref (RPC_directory.empty : Updater.rpc_context Tezos_rpc.Directory.t)
let register0_fullctxt ~chunked s f =
patched_services :=
RPC_directory.register ~chunked !patched_services s (fun ctxt q i ->
Services_registration.rpc_init ctxt `Head_level >>=? fun ctxt ->
f ctxt q i)
let register0 ~chunked s f =
register0_fullctxt ~chunked s (fun {context; _} -> f context)
let register0_fullctxt_successor_level ~chunked s f =
patched_services :=
RPC_directory.register ~chunked !patched_services s (fun ctxt q i ->
let mode =
if q#successor_level then `Successor_level else `Head_level
in
Services_registration.rpc_init ctxt mode >>=? fun ctxt -> f ctxt q i)
let register0_successor_level ~chunked s f =
register0_fullctxt_successor_level ~chunked s (fun {context; _} ->
f context)
let register0_noctxt ~chunked s f =
patched_services :=
RPC_directory.register ~chunked !patched_services s (fun _ q i -> f q i)
let opt_register0_fullctxt ~chunked s f =
patched_services :=
RPC_directory.opt_register ~chunked !patched_services s (fun ctxt q i ->
Services_registration.rpc_init ctxt `Head_level >>=? fun ctxt ->
f ctxt q i)
let opt_register0 ~chunked s f =
opt_register0_fullctxt ~chunked s (fun {context; _} -> f context)
let register1_fullctxt ~chunked s f =
patched_services :=
RPC_directory.register
~chunked
!patched_services
s
(fun (ctxt, arg) q i ->
Services_registration.rpc_init ctxt `Head_level >>=? fun ctxt ->
f ctxt arg q i)
let register1 ~chunked s f =
register1_fullctxt ~chunked s (fun {context; _} x -> f context x)
let register2_fullctxt ~chunked s f =
patched_services :=
RPC_directory.register
~chunked
!patched_services
s
(fun ((ctxt, arg1), arg2) q i ->
Services_registration.rpc_init ctxt `Head_level >>=? fun ctxt ->
f ctxt arg1 arg2 q i)
let register2 ~chunked s f =
register2_fullctxt ~chunked s (fun {context; _} a1 a2 q i ->
f context a1 a2 q i)
end
let unparsing_mode_encoding =
let open Script_ir_translator in
let open Data_encoding in
union
~tag_size:`Uint8
[
case
(Tag 0)
~title:"Readable"
(constant "Readable")
(function
| Readable -> Some () | Optimized | Optimized_legacy -> None)
(fun () -> Readable);
case
(Tag 1)
~title:"Optimized"
(constant "Optimized")
(function
| Optimized -> Some () | Readable | Optimized_legacy -> None)
(fun () -> Optimized);
case
(Tag 2)
~title:"Optimized_legacy"
(constant "Optimized_legacy")
(function
| Optimized_legacy -> Some () | Readable | Optimized -> None)
(fun () -> Optimized_legacy);
]
module Scripts = struct
module S = struct
open Data_encoding
let path = Tezos_rpc.Path.(path / "scripts")
let run_code_input_encoding =
merge_objs
(obj10
(req "script" Script.expr_encoding)
(req "storage" Script.expr_encoding)
(req "input" Script.expr_encoding)
(req "amount" Tez.encoding)
(opt "balance" Tez.encoding)
(req "chain_id" Chain_id.encoding)
(opt "source" Contract.encoding)
(opt "payer" Contract.encoding)
(opt "self" Contract.encoding)
(dft "entrypoint" Entrypoint.simple_encoding Entrypoint.default))
(obj4
(opt "unparsing_mode" unparsing_mode_encoding)
(opt "gas" Gas.Arith.z_integral_encoding)
(opt "now" Script_timestamp.encoding)
(opt "level" Script_int.n_encoding))
let run_code_output_encoding =
conv
(fun (storage, operations, lazy_storage_diff) ->
(storage, operations, lazy_storage_diff))
(fun (storage, operations, lazy_storage_diff) ->
(storage, operations, lazy_storage_diff))
(obj3
(req "storage" Script.expr_encoding)
(req "operations" (list Apply_results.internal_contents_encoding))
(opt "lazy_storage_diff" Lazy_storage.encoding))
let trace_code_input_encoding = run_code_input_encoding
let trace_encoding =
def "scripted.trace" @@ list
@@ obj3
(req "location" Script.location_encoding)
(req "gas" Gas.encoding)
(req "stack" (list Script.expr_encoding))
let trace_code_output_encoding =
conv
(fun (storage, operations, trace, lazy_storage_diff) ->
(storage, operations, trace, lazy_storage_diff))
(fun (storage, operations, trace, lazy_storage_diff) ->
(storage, operations, trace, lazy_storage_diff))
(obj4
(req "storage" Script.expr_encoding)
(req "operations" (list Apply_results.internal_contents_encoding))
(req "trace" trace_encoding)
(opt "lazy_storage_diff" Lazy_storage.encoding))
let run_tzip4_view_encoding =
let open Data_encoding in
obj10
(req "contract" Contract.encoding)
(req "entrypoint" Entrypoint.simple_encoding)
(req "input" Script.expr_encoding)
(req "chain_id" Chain_id.encoding)
(opt "source" Contract.encoding)
(opt "payer" Contract.encoding)
(opt "gas" Gas.Arith.z_integral_encoding)
(req "unparsing_mode" unparsing_mode_encoding)
(opt "now" Script_timestamp.encoding)
(opt "level" Script_int.n_encoding)
let run_script_view_encoding =
let open Data_encoding in
merge_objs
(obj10
(req "contract" Contract.encoding)
(req "view" string)
(req "input" Script.expr_encoding)
(dft "unlimited_gas" bool false)
(req "chain_id" Chain_id.encoding)
(opt "source" Contract.encoding)
(opt "payer" Contract.encoding)
(opt "gas" Gas.Arith.z_integral_encoding)
(req "unparsing_mode" unparsing_mode_encoding)
(opt "now" Script_timestamp.encoding))
(obj1 (opt "level" Script_int.n_encoding))
let run_code =
Tezos_rpc.Service.post_service
~description:"Run a piece of code in the current context"
~query:Tezos_rpc.Query.empty
~input:run_code_input_encoding
~output:run_code_output_encoding
Tezos_rpc.Path.(path / "run_code")
let trace_code =
Tezos_rpc.Service.post_service
~description:
"Run a piece of code in the current context, keeping a trace"
~query:Tezos_rpc.Query.empty
~input:trace_code_input_encoding
~output:trace_code_output_encoding
Tezos_rpc.Path.(path / "trace_code")
let run_tzip4_view =
Tezos_rpc.Service.post_service
~description:
"Simulate a call to a view following the TZIP-4 standard. See \
https://gitlab.com/tzip/tzip/-/blob/master/proposals/tzip-4/tzip-4.md#view-entrypoints."
~input:run_tzip4_view_encoding
~output:(obj1 (req "data" Script.expr_encoding))
~query:Tezos_rpc.Query.empty
Tezos_rpc.Path.(path / "run_view")
let run_script_view =
Tezos_rpc.Service.post_service
~description:"Simulate a call to a michelson view"
~input:run_script_view_encoding
~output:(obj1 (req "data" Script.expr_encoding))
~query:Tezos_rpc.Query.empty
Tezos_rpc.Path.(path / "run_script_view")
let typecheck_code =
Tezos_rpc.Service.post_service
~description:"Typecheck a piece of code in the current context"
~query:Tezos_rpc.Query.empty
~input:
(obj4
(req "program" Script.expr_encoding)
(opt "gas" Gas.Arith.z_integral_encoding)
(opt "legacy" bool)
(opt "show_types" bool))
~output:
(obj2
(req "type_map" Script_tc_errors_registration.type_map_enc)
(req "gas" Gas.encoding))
Tezos_rpc.Path.(path / "typecheck_code")
let script_size =
Tezos_rpc.Service.post_service
~description:"Compute the size of a script in the current context"
~query:Tezos_rpc.Query.empty
~input:
(obj4
(req "program" Script.expr_encoding)
(req "storage" Script.expr_encoding)
(opt "gas" Gas.Arith.z_integral_encoding)
(opt "legacy" bool))
~output:(obj1 (req "script_size" int31))
Tezos_rpc.Path.(path / "script_size")
let typecheck_data =
Tezos_rpc.Service.post_service
~description:
"Check that some data expression is well formed and of a given \
type in the current context"
~query:Tezos_rpc.Query.empty
~input:
(obj4
(req "data" Script.expr_encoding)
(req "type" Script.expr_encoding)
(opt "gas" Gas.Arith.z_integral_encoding)
(opt "legacy" bool))
~output:(obj1 (req "gas" Gas.encoding))
Tezos_rpc.Path.(path / "typecheck_data")
let pack_data =
Tezos_rpc.Service.post_service
~description:
"Computes the serialized version of some data expression using the \
same algorithm as script instruction PACK"
~input:
(obj3
(req "data" Script.expr_encoding)
(req "type" Script.expr_encoding)
(opt "gas" Gas.Arith.z_integral_encoding))
~output:(obj2 (req "packed" bytes) (req "gas" Gas.encoding))
~query:Tezos_rpc.Query.empty
Tezos_rpc.Path.(path / "pack_data")
let normalize_data =
Tezos_rpc.Service.post_service
~description:
"Normalizes some data expression using the requested unparsing mode"
~input:
(obj4
(req "data" Script.expr_encoding)
(req "type" Script.expr_encoding)
(req "unparsing_mode" unparsing_mode_encoding)
(opt "legacy" bool))
~output:(obj1 (req "normalized" Script.expr_encoding))
~query:Tezos_rpc.Query.empty
Tezos_rpc.Path.(path / "normalize_data")
let normalize_script =
Tezos_rpc.Service.post_service
~description:
"Normalizes a Michelson script using the requested unparsing mode"
~input:
(obj2
(req "script" Script.expr_encoding)
(req "unparsing_mode" unparsing_mode_encoding))
~output:(obj1 (req "normalized" Script.expr_encoding))
~query:Tezos_rpc.Query.empty
Tezos_rpc.Path.(path / "normalize_script")
let normalize_type =
Tezos_rpc.Service.post_service
~description:
"Normalizes some Michelson type by expanding `pair a b c` as `pair \
a (pair b c)"
~input:(obj1 (req "type" Script.expr_encoding))
~output:(obj1 (req "normalized" Script.expr_encoding))
~query:Tezos_rpc.Query.empty
Tezos_rpc.Path.(path / "normalize_type")
let run_operation =
Tezos_rpc.Service.post_service
~description:
"Run an operation with the context of the given block and without \
signature checks. Return the operation application result, \
including the consumed gas."
~query:Tezos_rpc.Query.empty
~input:
(obj2
(req "operation" Operation.encoding)
(req "chain_id" Chain_id.encoding))
~output:Apply_results.operation_data_and_metadata_encoding
Tezos_rpc.Path.(path / "run_operation")
let simulate_query =
let open Tezos_rpc.Query in
query (fun successor_level ->
object
method successor_level = successor_level
end)
|+ flag
~descr:
"If true, the simulation is done on the successor level of the \
current context."
"successor_level"
(fun t -> t#successor_level)
|> seal
let simulate_operation =
Tezos_rpc.Service.post_service
~description:
"Simulate running an operation at some future moment (based on the \
number of blocks given in the `latency` argument), and return the \
operation application result. The result is the same as \
run_operation except for the consumed gas, which depends on the \
contents of the cache at that future moment. This RPC estimates \
future gas consumption by trying to predict the state of the \
cache using some heuristics."
~query:simulate_query
~input:
(obj4
(opt "blocks_before_activation" int32)
(req "operation" Operation.encoding)
(req "chain_id" Chain_id.encoding)
(dft "latency" int16 default_operation_inclusion_latency))
~output:Apply_results.operation_data_and_metadata_encoding
Tezos_rpc.Path.(path / "simulate_operation")
let simulate_tx_rollup_operation =
Tezos_rpc.Service.post_service
~description:"Simulate a tx rollup operation"
~query:Tezos_rpc.Query.empty
~input:
(obj4
(opt "blocks_before_activation" int32)
(req "operation" Operation.encoding)
(req "chain_id" Chain_id.encoding)
(dft "latency" int16 default_operation_inclusion_latency))
~output:Apply_results.operation_data_and_metadata_encoding
Tezos_rpc.Path.(path / "simulate_tx_rollup_operation")
let entrypoint_type =
Tezos_rpc.Service.post_service
~description:"Return the type of the given entrypoint"
~query:Tezos_rpc.Query.empty
~input:
(obj2
(req "script" Script.expr_encoding)
(dft "entrypoint" Entrypoint.simple_encoding Entrypoint.default))
~output:(obj1 (req "entrypoint_type" Script.expr_encoding))
Tezos_rpc.Path.(path / "entrypoint")
let list_entrypoints =
Tezos_rpc.Service.post_service
~description:"Return the list of entrypoints of the given script"
~query:Tezos_rpc.Query.empty
~input:(obj1 (req "script" Script.expr_encoding))
~output:
(obj2
(dft
"unreachable"
(Data_encoding.list
(obj1
(req
"path"
(Data_encoding.list
Michelson_v1_primitives.prim_encoding))))
[])
(req "entrypoints" (assoc Script.expr_encoding)))
Tezos_rpc.Path.(path / "entrypoints")
end
module type UNPARSING_MODE = sig
val unparsing_mode : Script_ir_translator.unparsing_mode
end
module Traced_interpreter (Unparsing_mode : UNPARSING_MODE) = struct
type log_element =
| Log :
context
* Script.location
* ('a * 's)
* ('a, 's) Script_typed_ir.stack_ty
-> log_element
let unparse_stack ctxt (stack, stack_ty) =
let ctxt = Gas.set_unlimited ctxt in
let rec unparse_stack :
type a s.
(a, s) Script_typed_ir.stack_ty * (a * s) ->
Script.expr list tzresult Lwt.t = function
| Bot_t, (EmptyCell, EmptyCell) -> return_nil
| Item_t (ty, rest_ty), (v, rest) ->
Script_ir_translator.unparse_data
ctxt
Unparsing_mode.unparsing_mode
ty
v
>>=? fun (data, _ctxt) ->
unparse_stack (rest_ty, rest) >|=? fun rest ->
let data = Micheline.strip_locations data in
data :: rest
in
unparse_stack (stack_ty, stack)
let trace_logger () : Script_typed_ir.logger =
let log : log_element list ref = ref [] in
let log_interp _ ctxt loc sty stack =
log := Log (ctxt, loc, stack, sty) :: !log
in
let log_entry _ _ctxt _loc _sty _stack = () in
let log_exit _ ctxt loc sty stack =
log := Log (ctxt, loc, stack, sty) :: !log
in
let log_control _ = () in
let get_log () =
List.map_es
(fun (Log (ctxt, loc, stack, stack_ty)) ->
trace Cannot_serialize_log (unparse_stack ctxt (stack, stack_ty))
>>=? fun stack -> return (loc, Gas.level ctxt, stack))
!log
>>=? fun res -> return (Some (List.rev res))
in
{log_exit; log_entry; log_interp; get_log; log_control}
let execute ctxt step_constants ~script ~entrypoint ~parameter =
let open Script_interpreter in
let logger = trace_logger () in
execute
~logger
~cached_script:None
ctxt
Unparsing_mode.unparsing_mode
step_constants
~script
~entrypoint
~parameter
~internal:true
>>=? fun res ->
logger.get_log () >|=? fun trace ->
let trace = Option.value ~default:[] trace in
(res, trace)
end
let typecheck_data :
legacy:bool ->
context ->
Script.expr * Script.expr ->
context tzresult Lwt.t =
fun ~legacy ctxt (data, exp_ty) ->
record_trace
(Script_tc_errors.Ill_formed_type (None, exp_ty, 0))
(Script_ir_translator.parse_passable_ty
ctxt
~legacy
(Micheline.root exp_ty))
>>?= fun (Ex_ty exp_ty, ctxt) ->
trace_eval
(fun () ->
let exp_ty = Script_ir_translator.serialize_ty_for_error exp_ty in
Script_tc_errors.Ill_typed_data (None, data, exp_ty))
(let allow_forged =
true
in
Script_ir_translator.parse_data
ctxt
~legacy
~allow_forged
exp_ty
(Micheline.root data))
>|=? fun (_, ctxt) -> ctxt
module Unparse_types = struct
open Micheline
open Michelson_v1_primitives
open Script_typed_ir
let rec unparse_comparable_ty :
type a loc.
loc:loc -> a comparable_ty -> (loc, Script.prim) Micheline.node =
fun ~loc -> function
| Unit_t -> Prim (loc, T_unit, [], [])
| Never_t -> Prim (loc, T_never, [], [])
| Int_t -> Prim (loc, T_int, [], [])
| Nat_t -> Prim (loc, T_nat, [], [])
| Signature_t -> Prim (loc, T_signature, [], [])
| String_t -> Prim (loc, T_string, [], [])
| Bytes_t -> Prim (loc, T_bytes, [], [])
| Mutez_t -> Prim (loc, T_mutez, [], [])
| Bool_t -> Prim (loc, T_bool, [], [])
| Key_hash_t -> Prim (loc, T_key_hash, [], [])
| Key_t -> Prim (loc, T_key, [], [])
| Timestamp_t -> Prim (loc, T_timestamp, [], [])
| Address_t -> Prim (loc, T_address, [], [])
| Tx_rollup_l2_address_t -> Prim (loc, T_tx_rollup_l2_address, [], [])
| Chain_id_t -> Prim (loc, T_chain_id, [], [])
| Pair_t (l, r, _meta, YesYes) ->
let tl = unparse_comparable_ty ~loc l in
let tr = unparse_comparable_ty ~loc r in
Prim (loc, T_pair, [tl; tr], [])
| Union_t (l, r, _meta, YesYes) ->
let tl = unparse_comparable_ty ~loc l in
let tr = unparse_comparable_ty ~loc r in
Prim (loc, T_or, [tl; tr], [])
| Option_t (t, _meta, Yes) ->
Prim (loc, T_option, [unparse_comparable_ty ~loc t], [])
let unparse_memo_size ~loc memo_size =
let z = Alpha_context.Sapling.Memo_size.unparse_to_z memo_size in
Int (loc, z)
let rec unparse_ty :
type a ac loc.
loc:loc -> (a, ac) ty -> (loc, Script.prim) Micheline.node =
fun ~loc ty ->
let return (name, args, annot) = Prim (loc, name, args, annot) in
match ty with
| Unit_t -> return (T_unit, [], [])
| Int_t -> return (T_int, [], [])
| Nat_t -> return (T_nat, [], [])
| Signature_t -> return (T_signature, [], [])
| String_t -> return (T_string, [], [])
| Bytes_t -> return (T_bytes, [], [])
| Mutez_t -> return (T_mutez, [], [])
| Bool_t -> return (T_bool, [], [])
| Key_hash_t -> return (T_key_hash, [], [])
| Key_t -> return (T_key, [], [])
| Timestamp_t -> return (T_timestamp, [], [])
| Address_t -> return (T_address, [], [])
| Tx_rollup_l2_address_t -> return (T_tx_rollup_l2_address, [], [])
| Operation_t -> return (T_operation, [], [])
| Chain_id_t -> return (T_chain_id, [], [])
| Never_t -> return (T_never, [], [])
| Bls12_381_g1_t -> return (T_bls12_381_g1, [], [])
| Bls12_381_g2_t -> return (T_bls12_381_g2, [], [])
| Bls12_381_fr_t -> return (T_bls12_381_fr, [], [])
| Contract_t (ut, _meta) ->
let t = unparse_ty ~loc ut in
return (T_contract, [t], [])
| Pair_t (utl, utr, _meta, _) ->
let annot = [] in
let tl = unparse_ty ~loc utl in
let tr = unparse_ty ~loc utr in
return (T_pair, [tl; tr], annot)
| Union_t (utl, utr, _meta, _) ->
let annot = [] in
let tl = unparse_ty ~loc utl in
let tr = unparse_ty ~loc utr in
return (T_or, [tl; tr], annot)
| Lambda_t (uta, utr, _meta) ->
let ta = unparse_ty ~loc uta in
let tr = unparse_ty ~loc utr in
return (T_lambda, [ta; tr], [])
| Option_t (ut, _meta, _) ->
let annot = [] in
let ut = unparse_ty ~loc ut in
return (T_option, [ut], annot)
| List_t (ut, _meta) ->
let t = unparse_ty ~loc ut in
return (T_list, [t], [])
| Ticket_t (ut, _meta) ->
let t = unparse_comparable_ty ~loc ut in
return (T_ticket, [t], [])
| Set_t (ut, _meta) ->
let t = unparse_comparable_ty ~loc ut in
return (T_set, [t], [])
| Map_t (uta, utr, _meta) ->
let ta = unparse_comparable_ty ~loc uta in
let tr = unparse_ty ~loc utr in
return (T_map, [ta; tr], [])
| Big_map_t (uta, utr, _meta) ->
let ta = unparse_comparable_ty ~loc uta in
let tr = unparse_ty ~loc utr in
return (T_big_map, [ta; tr], [])
| Sapling_transaction_t memo_size ->
return
(T_sapling_transaction, [unparse_memo_size ~loc memo_size], [])
| Sapling_transaction_deprecated_t memo_size ->
return
( T_sapling_transaction_deprecated,
[unparse_memo_size ~loc memo_size],
[] )
| Sapling_state_t memo_size ->
return (T_sapling_state, [unparse_memo_size ~loc memo_size], [])
| Chest_t -> return (T_chest, [], [])
| Chest_key_t -> return (T_chest_key, [], [])
end
let run_operation_service ctxt ()
({shell; protocol_data = Operation_data protocol_data}, chain_id) =
let ret contents =
( Operation_data protocol_data,
Apply_results.Operation_metadata {contents} )
in
let operation : _ operation = {shell; protocol_data} in
let hash = Operation.hash {shell; protocol_data} in
let ctxt = Origination_nonce.init ctxt hash in
let payload_producer = Tezos_crypto.Signature.V0.Public_key_hash.zero in
match protocol_data.contents with
| Single (Manager_operation _) as op ->
Apply.precheck_manager_contents_list ctxt op ~mempool_mode:true
>>=? fun (ctxt, prechecked_contents_list) ->
Apply.apply_manager_contents_list
ctxt
Optimized
~payload_producer
chain_id
prechecked_contents_list
>|= fun (_ctxt, result) -> ok @@ ret result
| Cons (Manager_operation _, _) as op ->
Apply.precheck_manager_contents_list ctxt op ~mempool_mode:true
>>=? fun (ctxt, prechecked_contents_list) ->
Apply.apply_manager_contents_list
ctxt
Optimized
~payload_producer
chain_id
prechecked_contents_list
>|= fun (_ctxt, result) -> ok @@ ret result
| _ ->
let predecessor_level =
match
Alpha_context.Level.pred ctxt (Alpha_context.Level.current ctxt)
with
| Some level -> level
| None -> assert false
in
Alpha_context.Round.get ctxt >>=? fun predecessor_round ->
Apply.apply_contents_list
ctxt
chain_id
(Partial_construction
{
predecessor_level;
predecessor_round;
grand_parent_round = Round.zero;
})
Optimized
~payload_producer
operation
operation.protocol_data.contents
>|=? fun (_ctxt, result) -> ret result
let simulate_operation_service ctxt
(_simulate_query : < successor_level : bool >)
(blocks_before_activation, op, chain_id, time_in_blocks) =
Cache.Admin.future_cache_expectation
ctxt
~time_in_blocks
?blocks_before_activation
>>=? fun ctxt -> run_operation_service ctxt () (op, chain_id)
let default_from_context ctxt get = function
| None -> get ctxt
| Some x -> return x
type run_code_config = {
balance : Tez.t;
self : Contract.t;
payer : Contract.t;
source : Contract.t;
}
let default_balance = Tez.of_mutez_exn 4_000_000_000_000L
let register () =
let originate_dummy_contract ctxt script balance =
let ctxt = Origination_nonce.init ctxt Operation_hash.zero in
Lwt.return (Contract.fresh_contract_from_current_nonce ctxt)
>>=? fun (ctxt, dummy_contract) ->
Contract.raw_originate
ctxt
~prepaid_bootstrap_storage:false
dummy_contract
~script:(script, None)
>>=? fun ctxt ->
Token.transfer
~origin:Simulation
ctxt
`Minted
(`Contract dummy_contract)
balance
>>=? fun (ctxt, _) -> return (ctxt, dummy_contract)
in
let configure_contracts ctxt script balance ~src_opt ~pay_opt ~self_opt =
(match self_opt with
| None ->
let balance = Option.value ~default:default_balance balance in
originate_dummy_contract ctxt script balance
>>=? fun (ctxt, addr) -> return (ctxt, addr, balance)
| Some addr ->
default_from_context
ctxt
(fun c -> Contract.get_balance c addr)
balance
>>=? fun bal -> return (ctxt, addr, bal))
>>=? fun (ctxt, self, balance) ->
let source, payer =
match (src_opt, pay_opt) with
| None, None -> (self, self)
| Some c, None | None, Some c -> (c, c)
| Some src, Some pay -> (src, pay)
in
return (ctxt, {balance; self; source; payer})
in
let script_entrypoint_type ctxt expr entrypoint =
let ctxt = Gas.set_unlimited ctxt in
let legacy = false in
let open Script_ir_translator in
parse_toplevel ctxt ~legacy expr >>=? fun ({arg_type; _}, ctxt) ->
Lwt.return
( parse_parameter_ty_and_entrypoints ctxt ~legacy arg_type
>>? fun (Ex_parameter_ty_and_entrypoints {arg_type; entrypoints}, _)
->
Gas_monad.run ctxt
@@ Script_ir_translator.find_entrypoint
~error_details:Informative
arg_type
entrypoints
entrypoint
>>? fun (r, _ctxt) ->
r >|? fun (Ex_ty_cstr {original_type_expr; _}) ->
Micheline.strip_locations original_type_expr )
in
let script_view_type ctxt contract expr view =
let ctxt = Gas.set_unlimited ctxt in
let legacy = false in
let open Script_ir_translator in
parse_toplevel ctxt ~legacy expr >>=? fun ({views; _}, _) ->
Lwt.return
( Script_string.of_string view >>? fun view_name ->
match Script_map.get view_name views with
| None -> error (View_helpers.View_not_found (contract, view))
| Some Script_typed_ir.{input_ty; output_ty; _} ->
ok (input_ty, output_ty) )
in
Registration.register0
~chunked:true
S.run_code
(fun
ctxt
()
( ( code,
storage,
parameter,
amount,
balance,
chain_id,
src_opt,
pay_opt,
self_opt,
entrypoint ),
(unparsing_mode, gas, now, level) )
->
let unparsing_mode = Option.value ~default:Readable unparsing_mode in
let storage = Script.lazy_expr storage in
let code = Script.lazy_expr code in
configure_contracts
ctxt
{storage; code}
balance
~src_opt
~pay_opt
~self_opt
>>=? fun (ctxt, {self; source; payer; balance}) ->
let gas =
match gas with
| Some gas -> gas
| None -> Constants.hard_gas_limit_per_operation ctxt
in
let ctxt = Gas.set_limit ctxt gas in
let now =
match now with None -> Script_timestamp.now ctxt | Some t -> t
in
let level =
match level with
| None ->
(Level.current ctxt).level |> Raw_level.to_int32
|> Script_int.of_int32 |> Script_int.abs
| Some z -> z
in
let step_constants =
let open Script_interpreter in
{source; payer; self; amount; balance; chain_id; now; level}
in
Script_interpreter.execute
ctxt
unparsing_mode
step_constants
~cached_script:None
~script:{storage; code}
~entrypoint
~parameter
~internal:true
>|=? fun ( {
script = _;
code_size = _;
Script_interpreter.storage;
operations;
lazy_storage_diff;
ticket_diffs = _;
},
_ ) ->
( storage,
Apply_results.contents_of_packed_internal_operations operations,
lazy_storage_diff )) ;
Registration.register0
~chunked:true
S.trace_code
(fun
ctxt
()
( ( code,
storage,
parameter,
amount,
balance,
chain_id,
src_opt,
pay_opt,
self_opt,
entrypoint ),
(unparsing_mode, gas, now, level) )
->
let unparsing_mode = Option.value ~default:Readable unparsing_mode in
let storage = Script.lazy_expr storage in
let code = Script.lazy_expr code in
configure_contracts
ctxt
{storage; code}
balance
~src_opt
~pay_opt
~self_opt
>>=? fun (ctxt, {self; source; payer; balance}) ->
let gas =
match gas with
| Some gas -> gas
| None -> Constants.hard_gas_limit_per_operation ctxt
in
let ctxt = Gas.set_limit ctxt gas in
let now =
match now with None -> Script_timestamp.now ctxt | Some t -> t
in
let level =
match level with
| None ->
(Level.current ctxt).level |> Raw_level.to_int32
|> Script_int.of_int32 |> Script_int.abs
| Some z -> z
in
let step_constants =
let open Script_interpreter in
{source; payer; self; amount; balance; chain_id; now; level}
in
let module Unparsing_mode = struct
let unparsing_mode = unparsing_mode
end in
let module Interp = Traced_interpreter (Unparsing_mode) in
Interp.execute
ctxt
step_constants
~script:{storage; code}
~entrypoint
~parameter
>|=? fun ( ( {
script = _;
code_size = _;
Script_interpreter.storage;
operations;
lazy_storage_diff;
ticket_diffs = _;
},
_ctxt ),
trace ) ->
( storage,
Apply_results.contents_of_packed_internal_operations operations,
trace,
lazy_storage_diff )) ;
Registration.register0
~chunked:true
S.run_tzip4_view
(fun
ctxt
()
( contract,
entrypoint,
input,
chain_id,
source,
payer,
gas,
unparsing_mode,
now,
level )
->
Contract.get_script ctxt contract >>=? fun (ctxt, script_opt) ->
Option.fold
~some:ok
~none:(error View_helpers.Viewed_contract_has_no_script)
script_opt
>>?= fun script ->
Script_repr.(force_decode script.code) >>?= fun decoded_script ->
script_entrypoint_type ctxt decoded_script entrypoint
>>=? fun view_ty ->
View_helpers.extract_view_output_type entrypoint view_ty
>>?= fun ty ->
Contract.get_balance ctxt contract >>=? fun balance ->
Error_monad.trace View_helpers.View_callback_origination_failed
@@ originate_dummy_contract
ctxt
(View_helpers.make_tzip4_viewer_script ty)
Tez.zero
>>=? fun (ctxt, viewer_contract) ->
let source, payer =
match (source, payer) with
| Some source, Some payer -> (source, payer)
| Some source, None -> (source, source)
| None, Some payer -> (payer, payer)
| None, None -> (contract, contract)
in
let gas =
Option.value
~default:(Constants.hard_gas_limit_per_operation ctxt)
gas
in
let ctxt = Gas.set_limit ctxt gas in
let now =
match now with None -> Script_timestamp.now ctxt | Some t -> t
in
let level =
match level with
| None ->
(Level.current ctxt).level |> Raw_level.to_int32
|> Script_int.of_int32 |> Script_int.abs
| Some z -> z
in
let step_constants =
let open Script_interpreter in
{
source;
payer;
self = contract;
amount = Tez.zero;
balance;
chain_id;
now;
level;
}
in
let parameter =
View_helpers.make_view_parameter
(Micheline.root input)
viewer_contract
in
Script_interpreter.execute
ctxt
unparsing_mode
step_constants
~script
~cached_script:None
~entrypoint
~parameter
~internal:true
>>=? fun ( {
Script_interpreter.operations;
script = _;
code_size = _;
storage = _;
lazy_storage_diff = _;
ticket_diffs = _;
},
_ctxt ) ->
View_helpers.extract_parameter_from_operations
entrypoint
operations
viewer_contract
>>?= fun parameter -> Lwt.return (Script_repr.force_decode parameter)) ;
Registration.register0
~chunked:true
S.run_script_view
(fun
ctxt
()
( ( contract,
view,
input,
unlimited_gas,
chain_id,
source,
payer,
gas,
unparsing_mode,
now ),
level )
->
Contract.get_script ctxt contract >>=? fun (ctxt, script_opt) ->
Option.fold
~some:ok
~none:(Error_monad.error View_helpers.Viewed_contract_has_no_script)
script_opt
>>?= fun script ->
Script_repr.(force_decode script.code) >>?= fun decoded_script ->
script_view_type ctxt contract decoded_script view
>>=? fun (input_ty, output_ty) ->
Contract.get_balance ctxt contract >>=? fun balance ->
let source, payer =
match (source, payer) with
| Some source, Some payer -> (source, payer)
| Some source, None -> (source, source)
| None, Some payer -> (payer, payer)
| None, None -> (contract, contract)
in
let now =
match now with None -> Script_timestamp.now ctxt | Some t -> t
in
let max_gas = Gas.fp_of_milligas_int max_int in
let gas =
Option.value
~default:(Constants.hard_gas_limit_per_operation ctxt)
gas
in
let ctxt =
if unlimited_gas then Gas.set_limit ctxt max_gas
else Gas.set_limit ctxt gas
in
let level =
Option.value
level
~default:
((Level.current ctxt).level |> Raw_level.to_int32
|> Script_int.of_int32 |> Script_int.abs)
in
let step_constants =
{
Script_interpreter.source;
payer;
self = contract;
amount = Tez.zero;
balance;
chain_id;
now;
level;
}
in
let viewer_script =
View_helpers.make_michelson_viewer_script
contract
view
input
input_ty
output_ty
in
let parameter =
Micheline.(strip_locations (Prim (0, Script.D_Unit, [], [])))
in
Script_interpreter.execute
ctxt
unparsing_mode
step_constants
~script:viewer_script
~cached_script:None
~entrypoint:Entrypoint.default
~parameter
~internal:true
>>=? fun ( {
Script_interpreter.operations = _;
script = _;
code_size = _;
storage;
lazy_storage_diff = _;
ticket_diffs = _;
},
_ctxt ) ->
View_helpers.extract_value_from_storage storage >>?= fun value ->
return (Micheline.strip_locations value)) ;
Registration.register0
~chunked:false
S.typecheck_code
(fun ctxt () (expr, maybe_gas, legacy, show_types) ->
let legacy = Option.value ~default:false legacy in
let show_types = Option.value ~default:true show_types in
let ctxt =
match maybe_gas with
| None -> Gas.set_unlimited ctxt
| Some gas -> Gas.set_limit ctxt gas
in
Script_ir_translator.typecheck_code ~legacy ~show_types ctxt expr
>|=? fun (res, ctxt) -> (res, Gas.level ctxt)) ;
Registration.register0
~chunked:false
S.script_size
(fun ctxt () (expr, storage, maybe_gas, legacy) ->
let legacy = Option.value ~default:false legacy in
let ctxt =
match maybe_gas with
| None -> Gas.set_unlimited ctxt
| Some gas -> Gas.set_limit ctxt gas
in
let code = Script.lazy_expr expr in
Script_ir_translator.parse_code ~legacy ctxt ~code
>>=? fun ( Ex_code
(Code
{
code;
arg_type;
storage_type;
views;
entrypoints;
code_size;
}),
ctxt ) ->
Script_ir_translator.parse_data
~legacy
~allow_forged:true
ctxt
storage_type
(Micheline.root storage)
>>=? fun (storage, _) ->
let script =
Script_ir_translator.Ex_script
(Script
{
code;
arg_type;
storage_type;
views;
entrypoints;
code_size;
storage;
})
in
let size, cost = Script_ir_translator.script_size script in
Gas.consume ctxt cost >>?= fun _ctxt -> return @@ size) ;
Registration.register0
~chunked:false
S.typecheck_data
(fun ctxt () (data, ty, maybe_gas, legacy) ->
let legacy = Option.value ~default:false legacy in
let ctxt =
match maybe_gas with
| None -> Gas.set_unlimited ctxt
| Some gas -> Gas.set_limit ctxt gas
in
typecheck_data ~legacy ctxt (data, ty) >|=? fun ctxt -> Gas.level ctxt) ;
Registration.register0
~chunked:true
S.pack_data
(fun ctxt () (expr, typ, maybe_gas) ->
let open Script_ir_translator in
let ctxt =
match maybe_gas with
| None -> Gas.set_unlimited ctxt
| Some gas -> Gas.set_limit ctxt gas
in
parse_packable_ty ctxt ~legacy:true (Micheline.root typ)
>>?= fun (Ex_ty typ, ctxt) ->
parse_data
ctxt
~legacy:true
~allow_forged:true
typ
(Micheline.root expr)
>>=? fun (data, ctxt) ->
Script_ir_translator.pack_data ctxt typ data >|=? fun (bytes, ctxt) ->
(bytes, Gas.level ctxt)) ;
Registration.register0
~chunked:true
S.normalize_data
(fun ctxt () (expr, typ, unparsing_mode, legacy) ->
let open Script_ir_translator in
let legacy = Option.value ~default:false legacy in
let ctxt = Gas.set_unlimited ctxt in
Script_ir_translator.parse_any_ty ctxt ~legacy (Micheline.root typ)
>>?= fun (Ex_ty typ, ctxt) ->
parse_data ctxt ~legacy ~allow_forged:true typ (Micheline.root expr)
>>=? fun (data, ctxt) ->
Script_ir_translator.unparse_data ctxt unparsing_mode typ data
>|=? fun (normalized, _ctxt) -> Micheline.strip_locations normalized) ;
Registration.register0
~chunked:true
S.normalize_script
(fun ctxt () (script, unparsing_mode) ->
let ctxt = Gas.set_unlimited ctxt in
Script_ir_translator.unparse_code
ctxt
unparsing_mode
(Micheline.root script)
>|=? fun (normalized, _ctxt) -> Micheline.strip_locations normalized) ;
Registration.register0 ~chunked:true S.normalize_type (fun ctxt () typ ->
let open Script_ir_translator in
let ctxt = Gas.set_unlimited ctxt in
Script_ir_translator.parse_ty
ctxt
~legacy:true
~allow_lazy_storage:true
~allow_operation:true
~allow_contract:true
~allow_ticket:true
(Micheline.root typ)
>>?= fun (Ex_ty typ, _ctxt) ->
let normalized = Unparse_types.unparse_ty ~loc:() typ in
return @@ Micheline.strip_locations normalized) ;
Registration.register0 ~chunked:true S.run_operation run_operation_service ;
Registration.register0_successor_level
~chunked:true
S.simulate_operation
simulate_operation_service ;
Registration.register0
~chunked:true
S.entrypoint_type
(fun ctxt () (expr, entrypoint) ->
script_entrypoint_type ctxt expr entrypoint) ;
Registration.register0
~chunked:true
S.list_entrypoints
(fun ctxt () expr ->
let ctxt = Gas.set_unlimited ctxt in
let legacy = false in
let open Script_ir_translator in
parse_toplevel ~legacy ctxt expr >>=? fun ({arg_type; _}, ctxt) ->
Lwt.return
( parse_parameter_ty_and_entrypoints ctxt ~legacy arg_type
>|? fun (Ex_parameter_ty_and_entrypoints {arg_type; entrypoints}, _)
->
let unreachable_entrypoint, map =
Script_ir_translator.list_entrypoints_uncarbonated
arg_type
entrypoints
in
( unreachable_entrypoint,
Entrypoint.Map.fold
(fun entry (_ex_ty, original_type_expr) acc ->
( Entrypoint.to_string entry,
Micheline.strip_locations original_type_expr )
:: acc)
map
[] ) ))
let run_code ?unparsing_mode ?gas ?(entrypoint = Entrypoint.default)
?balance ~script ~storage ~input ~amount ~chain_id ~source ~payer ~self
~now ~level ctxt block =
RPC_context.make_call0
S.run_code
ctxt
block
()
( ( script,
storage,
input,
amount,
balance,
chain_id,
source,
payer,
self,
entrypoint ),
(unparsing_mode, gas, now, level) )
let trace_code ?unparsing_mode ?gas ?(entrypoint = Entrypoint.default)
?balance ~script ~storage ~input ~amount ~chain_id ~source ~payer ~self
~now ~level ctxt block =
RPC_context.make_call0
S.trace_code
ctxt
block
()
( ( script,
storage,
input,
amount,
balance,
chain_id,
source,
payer,
self,
entrypoint ),
(unparsing_mode, gas, now, level) )
let run_tzip4_view ?gas ~contract ~entrypoint ~input ~chain_id ~now ~level
?source ?payer ~unparsing_mode ctxt block =
RPC_context.make_call0
S.run_tzip4_view
ctxt
block
()
( contract,
entrypoint,
input,
chain_id,
source,
payer,
gas,
unparsing_mode,
now,
level )
(** [run_script_view] is an helper function to call the corresponding
RPC. [unlimited_gas] is set to [false] by default. *)
let run_script_view ?gas ~contract ~view ~input ?(unlimited_gas = false)
~chain_id ~now ~level ?source ?payer ~unparsing_mode ctxt block =
RPC_context.make_call0
S.run_script_view
ctxt
block
()
( ( contract,
view,
input,
unlimited_gas,
chain_id,
source,
payer,
gas,
unparsing_mode,
now ),
level )
let typecheck_code ?gas ?legacy ~script ?show_types ctxt block =
RPC_context.make_call0
S.typecheck_code
ctxt
block
()
(script, gas, legacy, show_types)
let script_size ?gas ?legacy ~script ~storage ctxt block =
RPC_context.make_call0
S.script_size
ctxt
block
()
(script, storage, gas, legacy)
let typecheck_data ?gas ?legacy ~data ~ty ctxt block =
RPC_context.make_call0
S.typecheck_data
ctxt
block
()
(data, ty, gas, legacy)
let pack_data ?gas ~data ~ty ctxt block =
RPC_context.make_call0 S.pack_data ctxt block () (data, ty, gas)
let normalize_data ?legacy ~data ~ty ~unparsing_mode ctxt block =
RPC_context.make_call0
S.normalize_data
ctxt
block
()
(data, ty, unparsing_mode, legacy)
let normalize_script ~script ~unparsing_mode ctxt block =
RPC_context.make_call0
S.normalize_script
ctxt
block
()
(script, unparsing_mode)
let normalize_type ~ty ctxt block =
RPC_context.make_call0 S.normalize_type ctxt block () ty
let run_operation ~op ~chain_id ctxt block =
RPC_context.make_call0 S.run_operation ctxt block () (op, chain_id)
let simulate_operation ~op ~chain_id ~latency ?(successor_level = false)
?blocks_before_activation ctxt block =
RPC_context.make_call0
S.simulate_operation
ctxt
block
(object
method successor_level = successor_level
end)
(blocks_before_activation, op, chain_id, latency)
let entrypoint_type ~script ~entrypoint ctxt block =
RPC_context.make_call0 S.entrypoint_type ctxt block () (script, entrypoint)
let list_entrypoints ctxt block ~script =
RPC_context.make_call0 S.list_entrypoints ctxt block () script
end
module Contract = struct
module S = struct
let path =
(RPC_path.(open_root / "context" / "contracts")
: RPC_context.t Tezos_rpc.Path.context)
let get_storage_normalized =
let open Data_encoding in
RPC_service.post_service
~description:
"Access the data of the contract and normalize it using the \
requested unparsing mode."
~input:(obj1 (req "unparsing_mode" unparsing_mode_encoding))
~query:RPC_query.empty
~output:(option Script.expr_encoding)
RPC_path.(path /: Contract.rpc_arg / "storage" / "normalized")
let get_script_normalized =
let open Data_encoding in
RPC_service.post_service
~description:
"Access the script of the contract and normalize it using the \
requested unparsing mode."
~input:
(obj2
(req "unparsing_mode" unparsing_mode_encoding)
(dft "normalize_types" bool false))
~query:RPC_query.empty
~output:(option Script.encoding)
RPC_path.(path /: Contract.rpc_arg / "script" / "normalized")
end
let register () =
Registration.register1
~chunked:true
S.get_storage_normalized
(fun ctxt contract () unparsing_mode ->
Contract.get_script ctxt contract >>=? fun (ctxt, script) ->
match script with
| None -> return_none
| Some script ->
let ctxt = Gas.set_unlimited ctxt in
let open Script_ir_translator in
parse_script
ctxt
~legacy:true
~allow_forged_in_storage:true
script
>>=? fun (Ex_script (Script {storage; storage_type; _}), ctxt) ->
unparse_data ctxt unparsing_mode storage_type storage
>|=? fun (storage, _ctxt) ->
Some (Micheline.strip_locations storage)) ;
Registration.register1
~chunked:true
S.get_script_normalized
(fun ctxt contract () (unparsing_mode, normalize_types) ->
Contract.get_script ctxt contract >>=? fun (ctxt, script) ->
match script with
| None -> return_none
| Some script ->
let ctxt = Gas.set_unlimited ctxt in
Script_ir_translator.parse_and_unparse_script_unaccounted
ctxt
~legacy:true
~allow_forged_in_storage:true
unparsing_mode
~normalize_types
script
>>=? fun (script, _ctxt) -> return_some script)
let get_storage_normalized ctxt block ~contract ~unparsing_mode =
RPC_context.make_call1
S.get_storage_normalized
ctxt
block
contract
()
unparsing_mode
let get_script_normalized ctxt block ~contract ~unparsing_mode
~normalize_types =
RPC_context.make_call1
S.get_script_normalized
ctxt
block
contract
()
(unparsing_mode, normalize_types)
end
module Big_map = struct
module S = struct
let path =
(RPC_path.(open_root / "context" / "big_maps")
: RPC_context.t RPC_path.context)
let big_map_get_normalized =
let open Data_encoding in
RPC_service.post_service
~description:
"Access the value associated with a key in a big map, normalize \
the output using the requested unparsing mode."
~query:RPC_query.empty
~input:(obj1 (req "unparsing_mode" unparsing_mode_encoding))
~output:Script.expr_encoding
RPC_path.(
path /: Big_map.Id.rpc_arg /: Script_expr_hash.rpc_arg
/ "normalized")
end
let register () =
Registration.register2
~chunked:true
S.big_map_get_normalized
(fun ctxt id key () unparsing_mode ->
let open Script_ir_translator in
let ctxt = Gas.set_unlimited ctxt in
Big_map.exists ctxt id >>=? fun (ctxt, types) ->
match types with
| None -> raise Not_found
| Some (_, value_type) -> (
parse_big_map_value_ty
ctxt
~legacy:true
(Micheline.root value_type)
>>?= fun (Ex_ty value_type, ctxt) ->
Big_map.get_opt ctxt id key >>=? fun (_ctxt, value) ->
match value with
| None -> raise Not_found
| Some value ->
parse_data
ctxt
~legacy:true
~allow_forged:true
value_type
(Micheline.root value)
>>=? fun (value, ctxt) ->
unparse_data ctxt unparsing_mode value_type value
>|=? fun (value, _ctxt) -> Micheline.strip_locations value))
let big_map_get_normalized ctxt block id key ~unparsing_mode =
RPC_context.make_call2
S.big_map_get_normalized
ctxt
block
id
key
()
unparsing_mode
end
module Sc_rollup = struct
open Data_encoding
module S = struct
let path : RPC_context.t RPC_path.context =
RPC_path.(open_root / "context" / "sc_rollup")
let kind =
RPC_service.get_service
~description:"Kind of smart-contract rollup"
~query:RPC_query.empty
~output:(obj1 (opt "kind" Sc_rollup.Kind.encoding))
RPC_path.(path /: Sc_rollup.Address.rpc_arg / "kind")
let inbox =
RPC_service.get_service
~description:"Inbox for a smart-contract rollup"
~query:RPC_query.empty
~output:Sc_rollup.Inbox.encoding
RPC_path.(path /: Sc_rollup.Address.rpc_arg / "inbox")
let initial_level =
RPC_service.get_service
~description:"Initial level for a smart-contract rollup"
~query:RPC_query.empty
~output:Raw_level_repr.encoding
RPC_path.(path /: Sc_rollup.Address.rpc_arg / "initial_level")
let root =
RPC_service.get_service
~description:"List of all originated smart contract rollups"
~query:RPC_query.empty
~output:(Data_encoding.list Sc_rollup.Address.encoding)
path
end
let kind ctxt block sc_rollup_address =
RPC_context.make_call1 S.kind ctxt block sc_rollup_address ()
let register_inbox () =
Registration.register1 ~chunked:true S.inbox (fun ctxt rollup () () ->
Stdlib.Format.eprintf
"@[Context level at RPC time at %a@]@."
Level.pp
(Level.current ctxt) ;
Sc_rollup.inbox ctxt rollup >>=? fun (inbox, _ctxt) -> return inbox)
let register_kind () =
Registration.register1 ~chunked:true S.kind @@ fun ctxt address () () ->
Alpha_context.Sc_rollup.kind ctxt address
let register_initial_level () =
Registration.register1 ~chunked:true S.initial_level
@@ fun ctxt address () () ->
Alpha_context.Sc_rollup.initial_level ctxt address
let register_root () =
Registration.register0 ~chunked:true S.root (fun context () () ->
Sc_rollup.list context)
let register () =
register_kind () ;
register_inbox () ;
register_initial_level () ;
register_root ()
let list ctxt block = RPC_context.make_call0 S.root ctxt block () ()
let initial_level ctxt block sc_rollup_address =
RPC_context.make_call1 S.initial_level ctxt block sc_rollup_address ()
end
module Tx_rollup = struct
open Data_encoding
module S = struct
let path : RPC_context.t RPC_path.context =
RPC_path.(open_root / "context" / "tx_rollup")
let has_bond =
RPC_service.get_service
~description:
"Returns true if the public key hash already deposited a bond for \
the given rollup"
~query:RPC_query.empty
~output:bool
RPC_path.(
path /: Tx_rollup.rpc_arg / "has_bond"
/: Signature.Public_key_hash.rpc_arg)
end
let register_has_bond () =
Registration.register2
~chunked:false
S.has_bond
(fun ctxt rollup operator () () ->
Tx_rollup_commitment.has_bond ctxt rollup operator
>>=? fun (_ctxt, has_bond) -> return has_bond)
let register () = register_has_bond ()
let has_bond ctxt block rollup operator =
RPC_context.make_call2 S.has_bond ctxt block rollup operator () ()
end
module Forge = struct
module S = struct
open Data_encoding
let path = Tezos_rpc.Path.(path / "forge")
let operations =
Tezos_rpc.Service.post_service
~description:"Forge an operation"
~query:Tezos_rpc.Query.empty
~input:Operation.unsigned_encoding
~output:bytes
Tezos_rpc.Path.(path / "operations")
let empty_proof_of_work_nonce =
Bytes.make Constants_repr.proof_of_work_nonce_size '\000'
let protocol_data =
Tezos_rpc.Service.post_service
~description:"Forge the protocol-specific part of a block header"
~query:Tezos_rpc.Query.empty
~input:
(obj5
(req "payload_hash" Block_payload_hash.encoding)
(req "payload_round" Round.encoding)
(opt "nonce_hash" Nonce_hash.encoding)
(dft
"proof_of_work_nonce"
(Fixed.bytes Alpha_context.Constants.proof_of_work_nonce_size)
empty_proof_of_work_nonce)
Liquidity_baking.(
dft
"liquidity_baking_toggle_vote"
liquidity_baking_toggle_vote_encoding
LB_pass))
~output:(obj1 (req "protocol_data" bytes))
Tezos_rpc.Path.(path / "protocol_data")
module Tx_rollup = struct
open Data_encoding
let path = Tezos_rpc.Path.(path / "tx_rollup")
module Inbox = struct
let path = Tezos_rpc.Path.(path / "inbox")
let message_hash =
Tezos_rpc.Service.post_service
~description:"Compute the hash of a message"
~query:Tezos_rpc.Query.empty
~input:(obj1 (req "message" Tx_rollup_message.encoding))
~output:(obj1 (req "hash" Tx_rollup_message_hash.encoding))
Tezos_rpc.Path.(path / "message_hash")
let merkle_tree_hash =
Tezos_rpc.Service.post_service
~description:"Compute the merkle tree hash of an inbox"
~query:Tezos_rpc.Query.empty
~input:
(obj1
(req "message_hashes" (list Tx_rollup_message_hash.encoding)))
~output:(obj1 (req "hash" Tx_rollup_inbox.Merkle.root_encoding))
Tezos_rpc.Path.(path / "merkle_tree_hash")
let merkle_tree_path =
Tezos_rpc.Service.post_service
~description:"Compute a path of an inbox message in a merkle tree"
~query:Tezos_rpc.Query.empty
~input:
(obj2
(req "message_hashes" (list Tx_rollup_message_hash.encoding))
(req "position" int16))
~output:(obj1 (req "path" Tx_rollup_inbox.Merkle.path_encoding))
Tezos_rpc.Path.(path / "merkle_tree_path")
end
module Commitment = struct
let path = Tezos_rpc.Path.(path / "commitment")
let merkle_tree_hash =
Tezos_rpc.Service.post_service
~description:"Compute the merkle tree hash of a commitment"
~query:Tezos_rpc.Query.empty
~input:
(obj1
(req
"message_result_hashes"
(list Tx_rollup_message_result_hash.encoding)))
~output:
(obj1 (req "hash" Tx_rollup_commitment.Merkle_hash.encoding))
Tezos_rpc.Path.(path / "merkle_tree_hash")
let merkle_tree_path =
Tezos_rpc.Service.post_service
~description:
"Compute a path of a message result hash in the commitment \
merkle tree"
~query:Tezos_rpc.Query.empty
~input:
(obj2
(req
"message_result_hashes"
(list Tx_rollup_message_result_hash.encoding))
(req "position" int16))
~output:
(obj1 (req "path" Tx_rollup_commitment.Merkle.path_encoding))
Tezos_rpc.Path.(path / "merkle_tree_path")
let message_result_hash =
Tezos_rpc.Service.post_service
~description:"Compute the message result hash"
~query:Tezos_rpc.Query.empty
~input:Tx_rollup_message_result.encoding
~output:(obj1 (req "hash" Tx_rollup_message_result_hash.encoding))
Tezos_rpc.Path.(path / "message_result_hash")
end
module Withdraw = struct
let path = Tezos_rpc.Path.(path / "withdraw")
let withdraw_list_hash =
Tezos_rpc.Service.post_service
~description:"Compute the hash of a withdraw list"
~query:Tezos_rpc.Query.empty
~input:
(obj1 (req "withdraw_list" (list Tx_rollup_withdraw.encoding)))
~output:(obj1 (req "hash" Tx_rollup_withdraw_list_hash.encoding))
Tezos_rpc.Path.(path / "withdraw_list_hash")
end
end
end
let register () =
Registration.register0_noctxt
~chunked:true
S.operations
(fun () (shell, proto) ->
return
(Data_encoding.Binary.to_bytes_exn
Operation.unsigned_encoding
(shell, proto))) ;
Registration.register0_noctxt
~chunked:true
S.protocol_data
(fun
()
( payload_hash,
payload_round,
seed_nonce_hash,
proof_of_work_nonce,
liquidity_baking_toggle_vote )
->
return
(Data_encoding.Binary.to_bytes_exn
Block_header.contents_encoding
{
payload_hash;
payload_round;
seed_nonce_hash;
proof_of_work_nonce;
liquidity_baking_toggle_vote;
})) ;
Registration.register0_noctxt
~chunked:true
S.Tx_rollup.Inbox.message_hash
(fun () message ->
return (Tx_rollup_message_hash.hash_uncarbonated message)) ;
Registration.register0_noctxt
~chunked:true
S.Tx_rollup.Inbox.merkle_tree_hash
(fun () message_hashes ->
return (Tx_rollup_inbox.Merkle.merklize_list message_hashes)) ;
Registration.register0_noctxt
~chunked:true
S.Tx_rollup.Inbox.merkle_tree_path
(fun () (message_hashes, position) ->
Lwt.return
(Tx_rollup_inbox.Merkle.compute_path message_hashes position)) ;
Registration.register0_noctxt
~chunked:true
S.Tx_rollup.Commitment.merkle_tree_hash
(fun () message_result_hashes ->
let open Tx_rollup_commitment.Merkle in
let tree = List.fold_left snoc nil message_result_hashes in
return (root tree)) ;
Registration.register0_noctxt
~chunked:true
S.Tx_rollup.Commitment.merkle_tree_path
(fun () (message_result_hashes, position) ->
let open Tx_rollup_commitment.Merkle in
let tree = List.fold_left snoc nil message_result_hashes in
Lwt.return (compute_path tree position)) ;
Registration.register0_noctxt
~chunked:true
S.Tx_rollup.Commitment.message_result_hash
(fun () message_result ->
return
(Tx_rollup_message_result_hash.hash_uncarbonated message_result)) ;
Registration.register0_noctxt
~chunked:true
S.Tx_rollup.Withdraw.withdraw_list_hash
(fun () withdrawals ->
return (Tx_rollup_withdraw_list_hash.hash_uncarbonated withdrawals))
module Manager = struct
let operations ctxt block ~branch ~source ?sourcePubKey ~counter ~fee
~gas_limit ~storage_limit operations =
Contract_services.manager_key ctxt block source >>= function
| Error _ as e -> Lwt.return e
| Ok revealed ->
let ops =
List.map
(fun (Manager operation) ->
Contents
(Manager_operation
{
source;
counter;
operation;
fee;
gas_limit;
storage_limit;
}))
operations
in
let ops =
match (sourcePubKey, revealed) with
| None, _ | _, Some _ -> ops
| Some pk, None ->
let operation = Reveal pk in
Contents
(Manager_operation
{
source;
counter;
operation;
fee;
gas_limit;
storage_limit;
})
:: ops
in
Environment.wrap_tzresult @@ Operation.of_list ops >>?= fun ops ->
RPC_context.make_call0 S.operations ctxt block () ({branch}, ops)
let reveal ctxt block ~branch ~source ~sourcePubKey ~counter ~fee () =
operations
ctxt
block
~branch
~source
~sourcePubKey
~counter
~fee
~gas_limit:Gas.Arith.zero
~storage_limit:Z.zero
[]
let transaction ctxt block ~branch ~source ?sourcePubKey ~counter ~amount
~destination ?(entrypoint = Entrypoint.default) ?parameters ~gas_limit
~storage_limit ~fee () =
let parameters =
Option.fold
~some:Script.lazy_expr
~none:Script.unit_parameter
parameters
in
operations
ctxt
block
~branch
~source
?sourcePubKey
~counter
~fee
~gas_limit
~storage_limit
[Manager (Transaction {amount; parameters; destination; entrypoint})]
let origination ctxt block ~branch ~source ?sourcePubKey ~counter ~balance
?delegatePubKey ~script ~gas_limit ~storage_limit ~fee () =
operations
ctxt
block
~branch
~source
?sourcePubKey
~counter
~fee
~gas_limit
~storage_limit
[
Manager
(Origination {delegate = delegatePubKey; script; credit = balance});
]
let delegation ctxt block ~branch ~source ?sourcePubKey ~counter ~fee
delegate =
operations
ctxt
block
~branch
~source
?sourcePubKey
~counter
~fee
~gas_limit:Gas.Arith.zero
~storage_limit:Z.zero
[Manager (Delegation delegate)]
end
let operation ctxt block ~branch operation =
RPC_context.make_call0
S.operations
ctxt
block
()
({branch}, Contents_list (Single operation))
let endorsement ctxt b ~branch ~consensus_content () =
operation ctxt b ~branch (Endorsement consensus_content)
let proposals ctxt b ~branch ~source ~period ~proposals () =
operation ctxt b ~branch (Proposals {source; period; proposals})
let ballot ctxt b ~branch ~source ~period ~proposal ~ballot () =
operation ctxt b ~branch (Ballot {source; period; proposal; ballot})
let failing_noop ctxt b ~branch ~message () =
operation ctxt b ~branch (Failing_noop message)
let seed_nonce_revelation ctxt block ~branch ~level ~nonce () =
operation ctxt block ~branch (Seed_nonce_revelation {level; nonce})
let double_baking_evidence ctxt block ~branch ~bh1 ~bh2 () =
operation ctxt block ~branch (Double_baking_evidence {bh1; bh2})
let double_endorsement_evidence ctxt block ~branch ~op1 ~op2 () =
operation ctxt block ~branch (Double_endorsement_evidence {op1; op2})
let double_preendorsement_evidence ctxt block ~branch ~op1 ~op2 () =
operation ctxt block ~branch (Double_preendorsement_evidence {op1; op2})
let empty_proof_of_work_nonce =
Bytes.make Constants_repr.proof_of_work_nonce_size '\000'
let protocol_data ctxt block ?(payload_hash = Block_payload_hash.zero)
?(payload_round = Round.zero) ?seed_nonce_hash
?(proof_of_work_nonce = empty_proof_of_work_nonce)
~liquidity_baking_toggle_vote () =
RPC_context.make_call0
S.protocol_data
ctxt
block
()
( payload_hash,
payload_round,
seed_nonce_hash,
proof_of_work_nonce,
liquidity_baking_toggle_vote )
end
module Parse = struct
module S = struct
open Data_encoding
let path = Tezos_rpc.Path.(path / "parse")
let operations =
Tezos_rpc.Service.post_service
~description:"Parse operations"
~query:Tezos_rpc.Query.empty
~input:
(obj2
(req "operations" (list (dynamic_size Operation.raw_encoding)))
(opt "check_signature" bool))
~output:(list (dynamic_size Operation.encoding))
Tezos_rpc.Path.(path / "operations")
let block =
Tezos_rpc.Service.post_service
~description:"Parse a block"
~query:Tezos_rpc.Query.empty
~input:Block_header.raw_encoding
~output:Block_header.protocol_data_encoding
Tezos_rpc.Path.(path / "block")
end
let parse_protocol_data protocol_data =
match
Data_encoding.Binary.of_bytes_opt
Block_header.protocol_data_encoding
protocol_data
with
| None -> Stdlib.failwith "Cant_parse_protocol_data"
| Some protocol_data -> protocol_data
let register () =
Registration.register0
~chunked:true
S.operations
(fun _ctxt () (operations, check) ->
List.map_es
(fun raw ->
parse_operation raw >>?= fun op ->
(match check with
| Some true -> return_unit
| Some false | None -> return_unit)
>|=? fun () -> op)
operations) ;
Registration.register0_noctxt ~chunked:false S.block (fun () raw_block ->
return @@ parse_protocol_data raw_block.protocol_data)
let operations ctxt block ?check operations =
RPC_context.make_call0 S.operations ctxt block () (operations, check)
let block ctxt block shell protocol_data =
RPC_context.make_call0
S.block
ctxt
block
()
({shell; protocol_data} : Block_header.raw)
end
let estimated_time round_durations ~current_level ~current_round
~current_timestamp ~level ~round =
if Level.(level <= current_level) then Result.return_none
else
Round.of_int round >>? fun round ->
Round.timestamp_of_round
round_durations
~round
~predecessor_timestamp:current_timestamp
~predecessor_round:current_round
>>? fun round_start_at_next_level ->
let step = Round.round_duration round_durations Round.zero in
let diff = Level.diff level current_level in
Period.mult (Int32.pred diff) step >>? fun delay ->
Timestamp.(round_start_at_next_level +? delay) >>? fun timestamp ->
Result.return_some timestamp
let requested_levels ~default_level ctxt cycles levels =
match (levels, cycles) with
| [], [] -> [default_level]
| levels, cycles ->
List.sort_uniq
Level.compare
(List.rev_append
(List.rev_map (Level.from_raw ctxt) levels)
(List.concat_map (Level.levels_in_cycle ctxt) cycles))
module Baking_rights = struct
type t = {
level : Raw_level.t;
delegate : Tezos_crypto.Signature.V0.Public_key_hash.t;
round : int;
timestamp : Timestamp.t option;
}
let encoding =
let open Data_encoding in
conv
(fun {level; delegate; round; timestamp} ->
(level, delegate, round, timestamp))
(fun (level, delegate, round, timestamp) ->
{level; delegate; round; timestamp})
(obj4
(req "level" Raw_level.encoding)
(req "delegate" Tezos_crypto.Signature.V0.Public_key_hash.encoding)
(req "round" uint16)
(opt "estimated_time" Timestamp.encoding))
let default_max_round = 64
module S = struct
open Data_encoding
let path = RPC_path.(open_root / "helpers" / "baking_rights")
type baking_rights_query = {
levels : Raw_level.t list;
cycle : Cycle.t option;
delegates : Tezos_crypto.Signature.V0.Public_key_hash.t list;
max_round : int option;
all : bool;
}
let baking_rights_query =
let open RPC_query in
query (fun levels cycle delegates max_round all ->
{levels; cycle; delegates; max_round; all})
|+ multi_field "level" Raw_level.rpc_arg (fun t -> t.levels)
|+ opt_field "cycle" Cycle.rpc_arg (fun t -> t.cycle)
|+ multi_field "delegate" Signature.Public_key_hash.rpc_arg (fun t ->
t.delegates)
|+ opt_field "max_round" RPC_arg.uint (fun t -> t.max_round)
|+ flag "all" (fun t -> t.all)
|> seal
let baking_rights =
RPC_service.get_service
~description:
(Format.sprintf
"Retrieves the list of delegates allowed to bake a block.\n\
By default, it gives the best baking opportunities (in terms \
of rounds) for bakers that have at least one opportunity below \
the %dth round for the next block.\n\
Parameters `level` and `cycle` can be used to specify the \
(valid) level(s) in the past or future at which the baking \
rights have to be returned.\n\
Parameter `delegate` can be used to restrict the results to \
the given delegates. If parameter `all` is set, all the baking \
opportunities for each baker at each level are returned, \
instead of just the first one.\n\
Returns the list of baking opportunities up to round %d. Also \
returns the minimal timestamps that correspond to these \
opportunities. The timestamps are omitted for levels in the \
past, and are only estimates for levels higher that the next \
block's, based on the hypothesis that all predecessor blocks \
were baked at the first round."
default_max_round
default_max_round)
~query:baking_rights_query
~output:(list encoding)
path
end
let baking_rights_at_level ctxt max_round level =
Baking.baking_rights ctxt level >>=? fun delegates ->
Round.get ctxt >>=? fun current_round ->
let current_level = Level.current ctxt in
let current_timestamp = Timestamp.current ctxt in
let round_durations = Alpha_context.Constants.round_durations ctxt in
let rec loop l acc round =
if Compare.Int.(round > max_round) then return (List.rev acc)
else
let (Misc.LCons (pk, next)) = l in
let delegate = Tezos_crypto.Signature.V0.Public_key.hash pk in
estimated_time
round_durations
~current_level
~current_round
~current_timestamp
~level
~round
>>?= fun timestamp ->
let acc = {level = level.level; delegate; round; timestamp} :: acc in
next () >>=? fun l -> loop l acc (round + 1)
in
loop delegates [] 0
let remove_duplicated_delegates rights =
List.rev @@ fst
@@ List.fold_left
(fun (acc, previous) r ->
if
Tezos_crypto.Signature.V0.Public_key_hash.Set.exists
(Tezos_crypto.Signature.V0.Public_key_hash.equal r.delegate)
previous
then (acc, previous)
else
( r :: acc,
Tezos_crypto.Signature.V0.Public_key_hash.Set.add
r.delegate
previous ))
([], Tezos_crypto.Signature.V0.Public_key_hash.Set.empty)
rights
let register () =
Registration.register0 ~chunked:true S.baking_rights (fun ctxt q () ->
let cycles =
match q.cycle with None -> [] | Some cycle -> [cycle]
in
let levels =
requested_levels
~default_level:(Level.succ ctxt (Level.current ctxt))
ctxt
cycles
q.levels
in
let max_round =
match q.max_round with
| None -> default_max_round
| Some max_round ->
Compare.Int.min
max_round
(Constants.consensus_committee_size ctxt)
in
List.map_es (baking_rights_at_level ctxt max_round) levels
>|=? fun rights ->
let rights =
if q.all then List.concat rights
else List.concat_map remove_duplicated_delegates rights
in
match q.delegates with
| [] -> rights
| _ :: _ as delegates ->
let is_requested p =
List.exists
(Tezos_crypto.Signature.V0.Public_key_hash.equal p.delegate)
delegates
in
List.filter is_requested rights)
let get ctxt ?(levels = []) ?cycle ?(delegates = []) ?(all = false)
?max_round block =
RPC_context.make_call0
S.baking_rights
ctxt
block
{levels; cycle; delegates; max_round; all}
()
end
module Endorsing_rights = struct
type delegate_rights = {
delegate : Tezos_crypto.Signature.V0.Public_key_hash.t;
first_slot : Slot.t;
endorsing_power : int;
}
type t = {
level : Raw_level.t;
delegates_rights : delegate_rights list;
estimated_time : Time.t option;
}
let delegate_rights_encoding =
let open Data_encoding in
conv
(fun {delegate; first_slot; endorsing_power} ->
(delegate, first_slot, endorsing_power))
(fun (delegate, first_slot, endorsing_power) ->
{delegate; first_slot; endorsing_power})
(obj3
(req "delegate" Tezos_crypto.Signature.V0.Public_key_hash.encoding)
(req "first_slot" Slot.encoding)
(req "endorsing_power" uint16))
let encoding =
let open Data_encoding in
conv
(fun {level; delegates_rights; estimated_time} ->
(level, delegates_rights, estimated_time))
(fun (level, delegates_rights, estimated_time) ->
{level; delegates_rights; estimated_time})
(obj3
(req "level" Raw_level.encoding)
(req "delegates" (list delegate_rights_encoding))
(opt "estimated_time" Timestamp.encoding))
module S = struct
open Data_encoding
let path = RPC_path.(path / "endorsing_rights")
type endorsing_rights_query = {
levels : Raw_level.t list;
cycle : Cycle.t option;
delegates : Tezos_crypto.Signature.V0.Public_key_hash.t list;
}
let endorsing_rights_query =
let open RPC_query in
query (fun levels cycle delegates -> {levels; cycle; delegates})
|+ multi_field "level" Raw_level.rpc_arg (fun t -> t.levels)
|+ opt_field "cycle" Cycle.rpc_arg (fun t -> t.cycle)
|+ multi_field "delegate" Signature.Public_key_hash.rpc_arg (fun t ->
t.delegates)
|> seal
let endorsing_rights =
RPC_service.get_service
~description:
"Retrieves the delegates allowed to endorse a block.\n\
By default, it gives the endorsing power for delegates that have \
at least one endorsing slot for the next block.\n\
Parameters `level` and `cycle` can be used to specify the (valid) \
level(s) in the past or future at which the endorsing rights have \
to be returned. Parameter `delegate` can be used to restrict the \
results to the given delegates.\n\
Returns the smallest endorsing slots and the endorsing power. \
Also returns the minimal timestamp that corresponds to endorsing \
at the given level. The timestamps are omitted for levels in the \
past, and are only estimates for levels higher that the next \
block's, based on the hypothesis that all predecessor blocks were \
baked at the first round."
~query:endorsing_rights_query
~output:(list encoding)
path
end
let endorsing_rights_at_level ctxt level =
Baking.endorsing_rights_by_first_slot ctxt level
>>=? fun (ctxt, rights) ->
Round.get ctxt >>=? fun current_round ->
let current_level = Level.current ctxt in
let current_timestamp = Timestamp.current ctxt in
let round_durations = Alpha_context.Constants.round_durations ctxt in
estimated_time
round_durations
~current_level
~current_round
~current_timestamp
~level
~round:0
>>?= fun estimated_time ->
let rights =
Slot.Map.fold
(fun first_slot (_pk, delegate, endorsing_power) acc ->
{delegate; first_slot; endorsing_power} :: acc)
rights
[]
in
return {level = level.level; delegates_rights = rights; estimated_time}
let register () =
Registration.register0 ~chunked:true S.endorsing_rights (fun ctxt q () ->
let cycles =
match q.cycle with None -> [] | Some cycle -> [cycle]
in
let levels =
requested_levels
~default_level:(Level.current ctxt)
ctxt
cycles
q.levels
in
List.map_es (endorsing_rights_at_level ctxt) levels
>|=? fun rights_per_level ->
match q.delegates with
| [] -> rights_per_level
| _ :: _ as delegates ->
List.filter_map
(fun rights_at_level ->
let is_requested p =
List.exists
(Tezos_crypto.Signature.V0.Public_key_hash.equal
p.delegate)
delegates
in
match
List.filter is_requested rights_at_level.delegates_rights
with
| [] -> None
| delegates_rights ->
Some {rights_at_level with delegates_rights})
rights_per_level)
let get ctxt ?(levels = []) ?cycle ?(delegates = []) block =
RPC_context.make_call0
S.endorsing_rights
ctxt
block
{levels; cycle; delegates}
()
end
module Validators = struct
type t = {
level : Raw_level.t;
delegate : Tezos_crypto.Signature.V0.Public_key_hash.t;
slots : Slot.t list;
}
let encoding =
let open Data_encoding in
conv
(fun {level; delegate; slots} -> (level, delegate, slots))
(fun (level, delegate, slots) -> {level; delegate; slots})
(obj3
(req "level" Raw_level.encoding)
(req "delegate" Tezos_crypto.Signature.V0.Public_key_hash.encoding)
(req "slots" (list Slot.encoding)))
module S = struct
open Data_encoding
let path = RPC_path.(path / "validators")
type validators_query = {
levels : Raw_level.t list;
delegates : Tezos_crypto.Signature.V0.Public_key_hash.t list;
}
let validators_query =
let open RPC_query in
query (fun levels delegates -> {levels; delegates})
|+ multi_field "level" Raw_level.rpc_arg (fun t -> t.levels)
|+ multi_field "delegate" Signature.Public_key_hash.rpc_arg (fun t ->
t.delegates)
|> seal
let validators =
RPC_service.get_service
~description:
"Retrieves the level, the endorsement slots and the public key \
hash of each delegate allowed to endorse a block.\n\
By default, it provides this information for the next level.\n\
Parameter `level` can be used to specify the (valid) level(s) in \
the past or future at which the endorsement rights have to be \
returned. Parameter `delegate` can be used to restrict the \
results to the given delegates.\n"
~query:validators_query
~output:(list encoding)
path
end
let endorsing_slots_at_level ctxt level =
Baking.endorsing_rights ctxt level >|=? fun (_, rights) ->
Signature.Public_key_hash.Map.fold
(fun delegate slots acc ->
{level = level.level; delegate; slots} :: acc)
(rights :> Slot.t list Signature.Public_key_hash.Map.t)
[]
let register () =
Registration.register0 ~chunked:true S.validators (fun ctxt q () ->
let levels =
requested_levels
~default_level:(Level.current ctxt)
ctxt
[]
q.levels
in
List.concat_map_es (endorsing_slots_at_level ctxt) levels
>|=? fun rights ->
match q.delegates with
| [] -> rights
| _ :: _ as delegates ->
let is_requested p =
List.exists
(Tezos_crypto.Signature.V0.Public_key_hash.equal p.delegate)
delegates
in
List.filter is_requested rights)
let get ctxt ?(levels = []) ?(delegates = []) block =
RPC_context.make_call0 S.validators ctxt block {levels; delegates} ()
end
module S = struct
open Data_encoding
type level_query = {offset : int32}
let level_query : level_query Tezos_rpc.Query.t =
let open Tezos_rpc.Query in
query (fun offset -> {offset})
|+ field "offset" Tezos_rpc.Arg.int32 0l (fun t -> t.offset)
|> seal
let current_level =
Tezos_rpc.Service.get_service
~description:
"Returns the level of the interrogated block, or the one of a block \
located `offset` blocks after it in the chain. For instance, the \
next block if `offset` is 1. The offset cannot be negative."
~query:level_query
~output:Level.encoding
Tezos_rpc.Path.(path / "current_level")
let levels_in_current_cycle =
Tezos_rpc.Service.get_service
~description:"Levels of a cycle"
~query:level_query
~output:
(obj2
(req "first" Raw_level.encoding)
(req "last" Raw_level.encoding))
Tezos_rpc.Path.(path / "levels_in_current_cycle")
let round =
Tezos_rpc.Service.get_service
~description:
"Returns the round of the interrogated block, or the one of a block \
located `offset` blocks after in the chain (or before when \
negative). For instance, the next block if `offset` is 1."
~query:Tezos_rpc.Query.empty
~output:Round.encoding
Tezos_rpc.Path.(path / "round")
end
type Environment.Error_monad.error += Negative_level_offset
let () =
Environment.Error_monad.register_error_kind
`Permanent
~id:"negative_level_offset"
~title:"The specified level offset is negative"
~description:"The specified level offset is negative"
~pp:(fun ppf () ->
Format.fprintf ppf "The specified level offset should be positive.")
Data_encoding.unit
(function Negative_level_offset -> Some () | _ -> None)
(fun () -> Negative_level_offset)
let register () =
Scripts.register () ;
Forge.register () ;
Parse.register () ;
Contract.register () ;
Big_map.register () ;
Baking_rights.register () ;
Endorsing_rights.register () ;
Validators.register () ;
Sc_rollup.register () ;
Tx_rollup.register () ;
Registration.register0 ~chunked:false S.current_level (fun ctxt q () ->
if q.offset < 0l then fail Negative_level_offset
else
Lwt.return
(Level.from_raw_with_offset
ctxt
~offset:q.offset
(Level.current ctxt).level)) ;
Registration.opt_register0
~chunked:true
S.levels_in_current_cycle
(fun ctxt q () ->
let rev_levels =
Level.levels_in_current_cycle ctxt ~offset:q.offset ()
in
match rev_levels with
| [] -> return_none
| [level] -> return (Some (level.level, level.level))
| last :: default_first :: rest ->
let first = List.last default_first rest in
return (Some (first.level, last.level))) ;
Registration.register0 ~chunked:false S.round (fun ctxt () () ->
Round.get ctxt)
let current_level ctxt ?(offset = 0l) block =
RPC_context.make_call0 S.current_level ctxt block {offset} ()
let levels_in_current_cycle ctxt ?(offset = 0l) block =
RPC_context.make_call0 S.levels_in_current_cycle ctxt block {offset} ()
let rpc_services =
register () ;
Tezos_rpc.Directory.merge rpc_services !Registration.patched_services
end