substreams 0.7.6

Substreams SDK - A streaming data engine for The Graph - by StreamingFast
Documentation
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
//! Store Implementation for Substreams.
//!
//! This module is the heart of all your interactions with your Substreams store needs be it setting values via
//! Store or retrieving value via StoreGet and Delta.
//!
//! The DeltaExt trait when imported in your code will bring in must-use functions on Deltas iterator for filtering
//! deltas based on its key or operationt. The [key] module is also available for extracting segments of a key.
//!
//! In a lot of use cases, you will encode data into your keys for example `user:<address>` or `position:<pool>:<id>`.
//! The `DeltaExt` trait exists to pick up deltas that matches a specific key pattern as well as extracting segment of a key.
//!
//! The `DeltaExt` trait expects keys to be of the form `<segment>[:<segment>]*` (just like the [key] module) so the `:` is
//! the segment separator. The module is meant to be used like this for filtering specific deltas and extracting specific segments:
//!
//! ```rust
//! use substreams::key;
//! use substreams::store::{Delta, DeltaExt, Deltas, DeltaBigDecimal};
//!
//! fn db_out(store: Deltas<DeltaBigDecimal>) {
//!     for delta in store.into_iter().key_first_segment_eq("user") {
//!         let address = key::segment_at(delta.get_key(), 1);
//!
//!         // Do something for this delta where the key was in format `user:<address>`
//!     }
//! }
//! ```
//!
//! Or when filtering for multiple segments:
//!
//! ```rust
//! use substreams::key;
//! use substreams::store::{Delta, DeltaExt, Deltas, DeltaBigDecimal};
//!
//! fn db_out(store: Deltas<DeltaBigDecimal>) {
//!     for delta in store.into_iter().key_first_segment_in(["user", "contract"]) {
//!         // Do something for this delta where the key was in format `(user|contract):...`
//!     }
//! }
//! ```
//!
//! You can also filter per operations and merge all this together:
//!
//! ```rust
//! use substreams::key;
//! use substreams::pb::substreams::store_delta::Operation;
//! use substreams::store::{Delta, DeltaExt, Deltas, DeltaBigDecimal};
//!
//! fn db_out(store: Deltas<DeltaBigDecimal>) {
//!     for delta in store
//!         .iter()
//!         .operation_eq(Operation::Create)
//!         .key_first_segment_in(["user", "contract"])
//!         .key_last_segment_eq("token0")
//!    {
//!         // Do something for Create delta where the key was in format `(user|contract):...:token0`
//!     }
//! }
//! ```
use std::{convert::TryFrom, io::BufRead, str};

use crate::pb::sf::substreams::foundational_store::model::v2::{Key, Keys, QueriedEntries};
use crate::{key, operation, pb::substreams::store_delta::Operation};
use {
    crate::{
        pb::substreams::StoreDelta,
        scalar::{BigDecimal, BigInt},
        state, {pb, proto},
    },
    prost,
    std::i64,
    std::marker::PhantomData,
    std::str::FromStr,
};

/// `StoreSet` is a trait which is implemented on any type of typed StoreSet
pub trait StoreSet<V>: StoreNew + StoreDelete {
    /// Set a given key to a given value, if the key existed before, it will be replaced.
    fn set<K: AsRef<str>>(&self, ord: u64, key: K, value: &V);
    /// Set many keys to a given values, if the key existed before, it will be replaced.
    fn set_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: &V);
}

pub trait StoreDelete {
    /// Delete values in a store given prefixed string
    fn delete_prefix(&self, ord: i64, prefix: &String) {
        state::delete_prefix(ord, prefix);
    }
}

pub trait StoreNew {
    /// Create an instance of trait implementation
    fn new() -> Self;
}

/// `StoreSetRaw` is a struct representing a `store` with `updatePolicy` equal to `set` on a `valueType` equal to `bytes`
///     `StoreSetRaw` implements AsRef<[u8]> to give the client the flexibility
///     to either use the API with &Vec[...] or Vec[...].
pub struct StoreSetRaw {}
impl StoreNew for StoreSetRaw {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreSetRaw {}

impl<V: AsRef<[u8]>> StoreSet<V> for StoreSetRaw {
    /// Set a given key to a given value, if the key existed before, it will be replaced.
    fn set<K: AsRef<str>>(&self, ord: u64, key: K, value: &V) {
        state::set(ord as i64, key, value);
    }

    /// Set many keys to a given values, if the key existed before, it will be replaced.
    fn set_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: &V) {
        for key in keys {
            state::set(ord as i64, key, value);
        }
    }
}

/// `StoreSetString` is a struct representing a `store` with `updatePolicy` equal to `set` on a `valueType` equal to `string`
/// `StoreSetString` implements `AsRef<str>` to give the client the flexibility
/// to either use the API with &String or String.
pub struct StoreSetString {}
impl StoreNew for StoreSetString {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreSetString {}

impl<V: AsRef<str>> StoreSet<V> for StoreSetString {
    fn set<K: AsRef<str>>(&self, ord: u64, key: K, value: &V) {
        state::set(ord as i64, key, value.as_ref());
    }

    fn set_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: &V) {
        let value = value.as_ref();

        for key in keys {
            state::set(ord as i64, key, value);
        }
    }
}

/// `StoreSetInt64` is a struct representing a `store` with `updatePolicy` equal to `set` on a `valueType` equal to `int64`
pub struct StoreSetInt64 {}
impl StoreNew for StoreSetInt64 {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreSetInt64 {}

impl StoreSet<i64> for StoreSetInt64 {
    /// Set a given key to a given value, if the key existed before, it will be replaced.
    fn set<K: AsRef<str>>(&self, ord: u64, key: K, value: &i64) {
        state::set(ord as i64, key, value.to_string().as_bytes());
    }

    /// Set many keys to a given values, if the key existed before, it will be replaced.
    fn set_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: &i64) {
        let as_str = value.to_string();

        for key in keys {
            state::set(ord as i64, key, &as_str);
        }
    }
}

/// `StoreSetFloat64` is a struct representing a `store` with `updatePolicy` equal to `set` on a `valueType` equal to `float64`
pub struct StoreSetFloat64 {}
impl StoreNew for StoreSetFloat64 {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreSetFloat64 {}

impl StoreSet<f64> for StoreSetFloat64 {
    /// Set a given key to a given value, if the key existed before, it will be replaced.
    fn set<K: AsRef<str>>(&self, ord: u64, key: K, value: &f64) {
        state::set(ord as i64, key, value.to_string().as_bytes());
    }

    /// Set many keys to a given values, if the key existed before, it will be replaced.
    fn set_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: &f64) {
        let as_str = value.to_string();

        for key in keys {
            state::set(ord as i64, key, &as_str);
        }
    }
}

/// `StoreSetBigDecimal` is a struct representing a `store` with `updatePolicy` equal to `set` on a `valueType` equal to `bigdecimal`
pub struct StoreSetBigDecimal {}
impl StoreNew for StoreSetBigDecimal {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreSetBigDecimal {}

impl StoreSet<BigDecimal> for StoreSetBigDecimal {
    fn set<K: AsRef<str>>(&self, ord: u64, key: K, value: &BigDecimal) {
        state::set(ord as i64, key, value.to_string().as_bytes())
    }

    fn set_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: &BigDecimal) {
        let as_str = value.to_string();

        for key in keys {
            state::set(ord as i64, key, &as_str)
        }
    }
}

/// `StoreSetBigInt` is a struct representing a `store` with `updatePolicy` equal to `set` on a `valueType` equal to `bigint`
pub struct StoreSetBigInt {}
impl StoreNew for StoreSetBigInt {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreSetBigInt {}

impl StoreSet<BigInt> for StoreSetBigInt {
    fn set<K: AsRef<str>>(&self, ord: u64, key: K, value: &BigInt) {
        state::set(ord as i64, key, value.as_ref().to_string().as_bytes());
    }

    fn set_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: &BigInt) {
        let as_str = value.as_ref().to_string();

        for key in keys {
            state::set(ord as i64, key, &as_str);
        }
    }
}

/// `StoreSetProto` is a struct representing a `store` with `updatePolicy` equal to `set` and a `valueType` equal to `proto:{your_proto_type}`
#[allow(dead_code)]
pub struct StoreSetProto<V: Default + prost::Message> {
    casper: PhantomData<V>,
}

impl<V: Default + prost::Message> StoreDelete for StoreSetProto<V> {}

impl<V: Default + prost::Message> StoreNew for StoreSetProto<V> {
    fn new() -> Self {
        Self {
            // Adding a PhantomData<T> field to your type tells the compiler that
            // your type acts as though it stores a value of type T, even though
            // it doesn't really. This information is used when computing certain
            // safety properties. For a more in-depth explanation of how to use
            // PhantomData<T>
            casper: PhantomData,
        }
    }
}

impl<V: Default + prost::Message> StoreSet<V> for StoreSetProto<V> {
    fn set<K: AsRef<str>>(&self, ord: u64, key: K, value: &V) {
        let bytes = proto::encode(value)
            .unwrap_or_else(|_| panic!("Unable to encode store message's struct to Protobuf data"));

        state::set(ord as i64, key, &bytes)
    }

    fn set_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: &V) {
        let bytes = proto::encode(value)
            .unwrap_or_else(|_| panic!("Unable to encode store message's struct to Protobuf data"));

        for key in keys {
            state::set(ord as i64, key, &bytes)
        }
    }
}

/// `StoreSetIfNotExists` is a trait which is implemented on any type of typed StoreSetIfNotExists
pub trait StoreSetIfNotExists<V>: StoreDelete + StoreNew {
    /// Set a given key to a given value, if the key existed before, it will be ignored and not set.
    fn set_if_not_exists<K: AsRef<str>>(&self, ord: u64, key: K, value: &V);
    /// Set given keys to given values, if the key existed before, it will be ignored and not set.
    fn set_if_not_exists_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: &V);
}

/// `StoreSetIfNotExistsRaw` is a struct representing a `store` module with `updatePolicy` equal to `set_if_not_exists` and a `valueType` equal to `string`
///     `StoreSetIfNotExistsRaw` implements AsRef<[u8]> to give the client the flexibility
///     to either use the API with &Vec[...] or Vec[...].
pub struct StoreSetIfNotExistsRaw {}
impl StoreNew for StoreSetIfNotExistsRaw {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreSetIfNotExistsRaw {}

impl<V: AsRef<[u8]>> StoreSetIfNotExists<V> for StoreSetIfNotExistsRaw {
    fn set_if_not_exists<K: AsRef<str>>(&self, ord: u64, key: K, value: &V) {
        state::set_if_not_exists(ord as i64, key, value.as_ref());
    }

    fn set_if_not_exists_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: &V) {
        let value = value.as_ref();

        for key in keys {
            state::set_if_not_exists(ord as i64, key, value);
        }
    }
}

/// `StoreSetIfNotExistsString` is a struct representing a `store` module with `updatePolicy` equal to `set_if_not_exists` and a `valueType` equal to `string`
/// `StoreSetIfNotExistsString` implements `AsRef<str>` to give the client the flexibility
/// to either use the API with &String or String.
pub struct StoreSetIfNotExistsString {}
impl StoreNew for StoreSetIfNotExistsString {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreSetIfNotExistsString {}

impl<V: AsRef<str>> StoreSetIfNotExists<V> for StoreSetIfNotExistsString {
    fn set_if_not_exists<K: AsRef<str>>(&self, ord: u64, key: K, value: &V) {
        state::set_if_not_exists(ord as i64, key, value.as_ref().as_bytes());
    }

    fn set_if_not_exists_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: &V) {
        let value = value.as_ref();

        for key in keys {
            state::set_if_not_exists(ord as i64, key, value);
        }
    }
}

/// `StoreSetIfNotExistsBigDecimal` is a struct representing a `store` module with `updatePolicy` equal to `set_if_not_exists` and a `valueType` equal to `bigdecimal`
pub struct StoreSetIfNotExistsBigDecimal {}
impl StoreNew for StoreSetIfNotExistsBigDecimal {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreSetIfNotExistsBigDecimal {}

impl StoreSetIfNotExists<BigDecimal> for StoreSetIfNotExistsBigDecimal {
    fn set_if_not_exists<K: AsRef<str>>(&self, ord: u64, key: K, value: &BigDecimal) {
        state::set_if_not_exists(ord as i64, key, value.as_ref().to_string().as_bytes());
    }

    fn set_if_not_exists_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: &BigDecimal) {
        let as_str = value.to_string();

        for key in keys {
            state::set_if_not_exists(ord as i64, key, &as_str);
        }
    }
}

/// `StoreSetIfNotExistsBigInt` is a struct representing a `store` module with `updatePolicy` equal to `set_if_not_exists` and a `valueType` equal to `bigint`
pub struct StoreSetIfNotExistsBigInt {}
impl StoreNew for StoreSetIfNotExistsBigInt {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreSetIfNotExistsBigInt {}

impl StoreSetIfNotExists<BigInt> for StoreSetIfNotExistsBigInt {
    fn set_if_not_exists<K: AsRef<str>>(&self, ord: u64, key: K, value: &BigInt) {
        state::set_if_not_exists(ord as i64, key, value.to_string().as_bytes());
    }

    fn set_if_not_exists_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: &BigInt) {
        let as_str = value.to_string();

        for key in keys {
            state::set_if_not_exists(ord as i64, key, &as_str);
        }
    }
}

/// `StoreSetIfNotExistsInt64` is a struct representing a `store` module with `updatePolicy` equal to `set_if_not_exists` and a `valueType` equal to `int64`
pub struct StoreSetIfNotExistsInt64 {}
impl StoreNew for StoreSetIfNotExistsInt64 {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreSetIfNotExistsInt64 {}

impl StoreSetIfNotExists<i64> for StoreSetIfNotExistsInt64 {
    fn set_if_not_exists<K: AsRef<str>>(&self, ord: u64, key: K, value: &i64) {
        state::set_if_not_exists(ord as i64, key, value.to_string().as_bytes());
    }

    fn set_if_not_exists_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: &i64) {
        let as_str = value.to_string();

        for key in keys {
            state::set_if_not_exists(ord as i64, key, &as_str);
        }
    }
}

/// `StoreSetIfNotExistsFloat64` is a struct representing a `store` module with `updatePolicy` equal to `set_if_not_exists` and a `valueType` equal to `float64`
pub struct StoreSetIfNotExistsFloat64 {}
impl StoreNew for StoreSetIfNotExistsFloat64 {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreSetIfNotExistsFloat64 {}

impl StoreSetIfNotExists<f64> for StoreSetIfNotExistsFloat64 {
    fn set_if_not_exists<K: AsRef<str>>(&self, ord: u64, key: K, value: &f64) {
        state::set_if_not_exists(ord as i64, key, value.to_string().as_bytes());
    }

    fn set_if_not_exists_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: &f64) {
        let as_str = value.to_string();

        for key in keys {
            state::set_if_not_exists(ord as i64, key, &as_str);
        }
    }
}

/// `StoreSetIfNotExistsProto` is a struct representing a `store` module with `updatePolicy` equal to `set_if_not_exists` and a `valueType` equal to `proto:{your_proto_type}`
#[allow(dead_code)]
pub struct StoreSetIfNotExistsProto<T> {
    store: StoreSetIfNotExistsRaw,
    casper: PhantomData<T>,
}

impl<V: Default + prost::Message> StoreNew for StoreSetIfNotExistsProto<V> {
    fn new() -> Self {
        StoreSetIfNotExistsProto {
            store: StoreSetIfNotExistsRaw {},
            // Adding a PhantomData<T> field to your type tells the compiler that
            // your type acts as though it stores a value of type T, even though
            // it doesn't really. This information is used when computing certain
            // safety properties. For a more in-depth explanation of how to use
            // PhantomData<T>
            casper: PhantomData,
        }
    }
}

impl<V: Default + prost::Message> StoreDelete for StoreSetIfNotExistsProto<V> {}

impl<V: Default + prost::Message> StoreSetIfNotExists<V> for StoreSetIfNotExistsProto<V> {
    fn set_if_not_exists<K: AsRef<str>>(&self, ord: u64, key: K, value: &V) {
        let bytes = proto::encode(value)
            .unwrap_or_else(|_| panic!("Unable to encode store message's struct to Protobuf data"));

        self.store.set_if_not_exists(ord, key, &bytes)
    }

    fn set_if_not_exists_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: &V) {
        let bytes = proto::encode(value)
            .unwrap_or_else(|_| panic!("Unable to encode store message's struct to Protobuf data"));

        for key in keys {
            self.store.set_if_not_exists(ord, key, &bytes)
        }
    }
}

/// `StoreAdd` is a trait which is implemented on any type of types StoreAdd
pub trait StoreAdd<V>: StoreDelete + StoreNew {
    /// Add a given value to an already existing key
    fn add<K: AsRef<str>>(&self, ord: u64, key: K, value: V);
    /// Add multiple values to an already existing key
    fn add_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: V);
}

/// `StoreAddInt64` is a struct representing a `store` module with `updatePolicy` equal to `add` and a valueType of `int64`
pub struct StoreAddInt64 {}
impl StoreNew for StoreAddInt64 {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreAddInt64 {}

impl StoreAdd<i64> for StoreAddInt64 {
    fn add<K: AsRef<str>>(&self, ord: u64, key: K, value: i64) {
        state::add_int64(ord as i64, key, value);
    }

    fn add_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: i64) {
        for key in keys {
            state::add_int64(ord as i64, key, value);
        }
    }
}

/// `StoreAddFloat64` is a struct representing a `store` module with `updatePolicy` equal to `add` and a valueType of `float64`
pub struct StoreAddFloat64 {}
impl StoreNew for StoreAddFloat64 {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreAddFloat64 {}

impl StoreAdd<f64> for StoreAddFloat64 {
    fn add<K: AsRef<str>>(&self, ord: u64, key: K, value: f64) {
        state::add_float64(ord as i64, key, value);
    }

    fn add_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: f64) {
        for key in keys {
            state::add_float64(ord as i64, key, value);
        }
    }
}

/// `StoreAddBigDecimal` is a struct representing a `store` module with `updatePolicy` equal to `add` and a valueType of `bigdecimal`
/// `StoreAddBigDecimal` implements `AsRef<BigInt>` to give the client the flexibility
/// to either use the API with &BigDecimal or BigDecimal.
pub struct StoreAddBigDecimal {}
impl StoreNew for StoreAddBigDecimal {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreAddBigDecimal {}

impl<V: AsRef<BigDecimal>> StoreAdd<V> for StoreAddBigDecimal {
    fn add<K: AsRef<str>>(&self, ord: u64, key: K, value: V) {
        state::add_bigdecimal(ord as i64, key, value.as_ref());
    }

    fn add_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: V) {
        let value = value.as_ref();

        for key in keys {
            state::add_bigdecimal(ord as i64, key, value);
        }
    }
}

/// `StoreAddBigInt` is a struct representing a `store` module with `updatePolicy` equal to `add` and a valueType of `bigint`
/// `StoreAddBigInt` implements `AsRef<BigInt>` to give the client the flexibility
/// to either use the API with &BigInt or BigInt.
pub struct StoreAddBigInt {}
impl StoreNew for StoreAddBigInt {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreAddBigInt {}

impl<V: AsRef<BigInt>> StoreAdd<V> for StoreAddBigInt {
    fn add<K: AsRef<str>>(&self, ord: u64, key: K, value: V) {
        state::add_bigint(ord as i64, key, value.as_ref());
    }

    fn add_many<K: AsRef<str>>(&self, ord: u64, keys: &Vec<K>, value: V) {
        let value = value.as_ref();

        for key in keys {
            state::add_bigint(ord as i64, key, value);
        }
    }
}

/// `StoreMax` is a trait which is implemented on any type of typed StoreMax
pub trait StoreMax<V>: StoreNew + StoreDelete {
    /// max will set the provided key in the store only if the value received in
    /// parameter is bigger than the one already present in the store, with
    /// a default of the zero value when the key is absent.
    fn max<K: AsRef<str>>(&self, ord: u64, key: K, value: V);
}

/// `StoreMaxInt64` is a struct representing a `store` module with `updatePolicy` equal to `max` and a valueType of `int64`
pub struct StoreMaxInt64 {}
impl StoreNew for StoreMaxInt64 {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreMaxInt64 {}

impl StoreMax<i64> for StoreMaxInt64 {
    fn max<K: AsRef<str>>(&self, ord: u64, key: K, value: i64) {
        state::set_max_int64(ord as i64, key, value);
    }
}

/// `StoreMaxBigInt` is a struct representing a `store` module with `updatePolicy` equal to `max` and a valueType of `bigint`
/// `StoreMaxBigInt` implements `AsRef<BigInt>` to give the client the flexibility
/// to either use the API with &BigInt or BigInt.
pub struct StoreMaxBigInt {}
impl StoreNew for StoreMaxBigInt {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreMaxBigInt {}

impl<V: AsRef<BigInt>> StoreMax<V> for StoreMaxBigInt {
    fn max<K: AsRef<str>>(&self, ord: u64, key: K, value: V) {
        state::set_max_bigint(ord as i64, key, value.as_ref());
    }
}

/// `StoreMaxFloat64` is a struct representing a `store` module with `updatePolicy` equal to `max` and a valueType of `float64`
pub struct StoreMaxFloat64 {}
impl StoreNew for StoreMaxFloat64 {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreMaxFloat64 {}

impl StoreMax<f64> for StoreMaxFloat64 {
    fn max<K: AsRef<str>>(&self, ord: u64, key: K, value: f64) {
        state::set_max_float64(ord as i64, key, value);
    }
}

/// `StoreMaxBigDecimal` is a struct representing a `store` module with `updatePolicy` equal to `max` and a valueType of `bigdecimal`
/// `StoreMaxBigDecimal` implements `AsRef<BigDecimal>` to give the client the flexibility
/// to either use the API with &BigDecimal or BigDecimal.
pub struct StoreMaxBigDecimal {}
impl StoreNew for StoreMaxBigDecimal {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreMaxBigDecimal {}

impl<V: AsRef<BigDecimal>> StoreMax<V> for StoreMaxBigDecimal {
    fn max<K: AsRef<str>>(&self, ord: u64, key: K, value: V) {
        state::set_max_bigdecimal(ord as i64, key, value.as_ref());
    }
}

/// `StoreMin` is a trait which is implemented on any typed StoreMin
pub trait StoreMin<V>: StoreNew + StoreDelete {
    /// Will set the provided key in the store only if the value received in
    /// parameter is smaller than the one already present in the store, with
    /// a default of the zero value when the key is absent.
    fn min<K: AsRef<str>>(&self, ord: u64, key: K, value: V);
}

/// `StoreMinInt64` is a struct representing a `store` module with `updatePolicy` equal to `min` and a valueType of `int64`
pub struct StoreMinInt64 {}
impl StoreNew for StoreMinInt64 {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreMinInt64 {}

impl StoreMin<i64> for StoreMinInt64 {
    fn min<K: AsRef<str>>(&self, ord: u64, key: K, value: i64) {
        state::set_min_int64(ord as i64, key, value);
    }
}

/// `StoreMinBigInt` is a struct representing a `store` module with `updatePolicy` equal to `min` and a valueType of `bigint`
/// `StoreMinBigInt` implements `AsRef<BigInt>` to give the client the flexibility
/// to either use the API with &BigInt or BigInt.
pub struct StoreMinBigInt {}
impl StoreNew for StoreMinBigInt {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreMinBigInt {}

impl<V: AsRef<BigInt>> StoreMin<V> for StoreMinBigInt {
    fn min<K: AsRef<str>>(&self, ord: u64, key: K, value: V) {
        state::set_min_bigint(ord as i64, key, value.as_ref());
    }
}

/// `StoreMinFloat64` is a struct representing a `store` module with `updatePolicy` equal to `min` and a valueType of `float64`
pub struct StoreMinFloat64 {}
impl StoreNew for StoreMinFloat64 {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreMinFloat64 {}

impl StoreMin<f64> for StoreMinFloat64 {
    fn min<K: AsRef<str>>(&self, ord: u64, key: K, value: f64) {
        state::set_min_float64(ord as i64, key, value);
    }
}

/// `StoreMinBigDecimal` is a struct representing a `store` module with `updatePolicy` equal to `min` and a valueType of `bigdecimal`
/// `StoreMinBigDecimal` implements `AsRef<BigDecimal>` to give the client the flexibility to either use
/// the API with &BigDecimal or BigDecimal.
pub struct StoreMinBigDecimal {}
impl StoreNew for StoreMinBigDecimal {
    fn new() -> Self {
        Self {}
    }
}

impl StoreDelete for StoreMinBigDecimal {}

impl<V: AsRef<BigDecimal>> StoreMin<V> for StoreMinBigDecimal {
    fn min<K: AsRef<str>>(&self, ord: u64, key: K, value: V) {
        state::set_min_bigdecimal(ord as i64, key, value.as_ref());
    }
}

// -------------------- Appender -------------------- //
pub trait Appender<T> {
    fn new() -> Self;
    fn append<K: AsRef<str>>(&self, ord: u64, key: K, item: T);
    fn append_all<K: AsRef<str>>(&self, ord: u64, key: K, items: Vec<T>);
}

/// StoreAppend is a struct representing a `store` with
/// `updatePolicy` equal to `append`
pub struct StoreAppend<T> {
    casper: PhantomData<T>,
}

impl<T> Appender<T> for StoreAppend<T>
where
    T: Into<String>,
{
    fn new() -> Self {
        StoreAppend {
            casper: PhantomData,
        }
    }

    /// Concatenates a given value at the end of the key's current value
    fn append<K: AsRef<str>>(&self, ord: u64, key: K, item: T) {
        let item: String = item.into();
        state::append(ord as i64, &key, &format!("{};", &item).as_bytes());
    }

    fn append_all<K: AsRef<str>>(&self, ord: u64, key: K, items: Vec<T>) {
        for item in items {
            self.append(ord, &key, item);
        }
    }
}

// -------------------- StoreSetSum -------------------- //
pub trait StoreSetSum<T> {
    fn new() -> Self;
    fn set<K: AsRef<str>>(&self, ord: u64, key: K, value: T);
    fn sum<K: AsRef<str>>(&self, ord: u64, key: K, value: T);
}

pub struct StoreSetSumInt64 {}

impl StoreSetSum<i64> for StoreSetSumInt64 {
    fn new() -> Self {
        StoreSetSumInt64 {}
    }

    fn set<K: AsRef<str>>(&self, ord: u64, key: K, value: i64) {
        let v = format!("set:{}", value.to_string());
        state::set_sum_int64(ord as i64, key, v);
    }

    fn sum<K: AsRef<str>>(&self, ord: u64, key: K, value: i64) {
        let v = format!("sum:{}", value.to_string());
        state::set_sum_int64(ord as i64, key, v);
    }
}

pub struct StoreSetSumFloat64 {}

impl StoreSetSum<f64> for StoreSetSumFloat64 {
    fn new() -> Self {
        StoreSetSumFloat64 {}
    }

    fn set<K: AsRef<str>>(&self, ord: u64, key: K, value: f64) {
        let v = format!("set:{}", value.to_string());
        state::set_sum_float64(ord as i64, key, v);
    }

    fn sum<K: AsRef<str>>(&self, ord: u64, key: K, value: f64) {
        let v = format!("sum:{}", value.to_string());
        state::set_sum_float64(ord as i64, key, v);
    }
}

pub struct StoreSetSumBigInt {}

impl StoreSetSum<BigInt> for StoreSetSumBigInt {
    fn new() -> Self {
        StoreSetSumBigInt {}
    }

    fn set<K: AsRef<str>>(&self, ord: u64, key: K, value: BigInt) {
        let v = format!("set:{}", value.to_string());
        state::set_sum_bigint(ord as i64, key, v);
    }

    fn sum<K: AsRef<str>>(&self, ord: u64, key: K, value: BigInt) {
        let v = format!("sum:{}", value.to_string());
        state::set_sum_bigint(ord as i64, key, v);
    }
}

pub struct StoreSetSumBigDecimal {}

impl StoreSetSum<BigDecimal> for StoreSetSumBigDecimal {
    fn new() -> Self {
        StoreSetSumBigDecimal {}
    }

    fn set<K: AsRef<str>>(&self, ord: u64, key: K, value: BigDecimal) {
        let v = format!("set:{}", value.to_string());
        state::set_sum_bigdecimal(ord as i64, key, v);
    }

    fn sum<K: AsRef<str>>(&self, ord: u64, key: K, value: BigDecimal) {
        let v = format!("sum:{}", value.to_string());
        state::set_sum_bigdecimal(ord as i64, key, v);
    }
}

// -------------------- StoreGet -------------------- //
/// StoreGet is a trait which is implemented on any type of typed StoreGet
pub trait StoreGet<T> {
    fn new(idx: u32) -> Self;
    fn get_at<K: AsRef<str>>(&self, ord: u64, key: K) -> Option<T>;
    fn get_last<K: AsRef<str>>(&self, key: K) -> Option<T>;
    fn get_first<K: AsRef<str>>(&self, key: K) -> Option<T>;
    fn has_at<K: AsRef<str>>(&self, ord: u64, key: K) -> bool;
    fn has_last<K: AsRef<str>>(&self, key: K) -> bool;
    fn has_first<K: AsRef<str>>(&self, key: K) -> bool;
}

/// RawStoreGet is a struct representing a read only store `store`
pub struct StoreGetRaw {
    idx: u32,
}

impl StoreGet<Vec<u8>> for StoreGetRaw {
    /// Return a StoreGet object with a store index set
    fn new(idx: u32) -> StoreGetRaw {
        StoreGetRaw { idx }
    }

    /// Allows you to read a single key from the store. The type
    /// of its value can be anything, and is usually declared in
    /// the output section of the manifest. The ordinal is used here
    /// to go query a key that might have changed mid-block by
    /// the store module that built it.
    fn get_at<K: AsRef<str>>(&self, ord: u64, key: K) -> Option<Vec<u8>> {
        state::get_at(self.idx, ord as i64, key)
    }

    /// Retrieves a key from the store, like `get_at`, but querying the state of
    /// the store as of the end of the block being processed, after all changes
    /// were applied within the current block. It does not need to rewind any changes
    /// as the store's state we work with is the state at the end of block already.
    fn get_last<K: AsRef<str>>(&self, key: K) -> Option<Vec<u8>> {
        state::get_last(self.idx, key)
    }

    /// Retrieves a key from the store, like `get_at`, but querying the state of
    /// the store as of the beginning of the block being processed, before any changes
    /// were applied within the current block. However, it needs to unwind any keys that
    /// would have changed in the block, so will be slightly less performant.
    fn get_first<K: AsRef<str>>(&self, key: K) -> Option<Vec<u8>> {
        state::get_first(self.idx, key)
    }

    /// Checks if a key exists in the store. The ordinal is used here
    /// to check if a key that might have changed mid-block by
    /// the store module that built it exists.
    fn has_at<K: AsRef<str>>(&self, ord: u64, key: K) -> bool {
        state::has_at(self.idx, ord as i64, key)
    }

    /// Checks if a key exists in the store, like `has_at`, but querying the state of
    /// the store as of the beginning of the block being processed, before any changes
    /// were applied within the current block. It does not need to rewind any changes
    /// in the middle of the block.
    fn has_last<K: AsRef<str>>(&self, key: K) -> bool {
        state::has_last(self.idx, key)
    }

    /// Checks if a key exists in the store, like `has_at`, but querying the state of
    /// the store as of the beginning of the block being processed, before any changes
    /// were applied within the current block. However, it needs to unwind any keys that
    /// would have changed mid-block, so will be slightly less performant.
    fn has_first<K: AsRef<str>>(&self, key: K) -> bool {
        state::has_first(self.idx, key)
    }
}

/// StoreGetString is as struct representing a read only store `store`
pub struct StoreGetString {
    idx: u32,
}

impl StoreGet<String> for StoreGetString {
    fn new(idx: u32) -> Self {
        StoreGetString { idx }
    }

    fn get_at<K: AsRef<str>>(&self, ord: u64, key: K) -> Option<String> {
        let key_ref = key.as_ref();

        state::get_at(self.idx, ord as i64, key_ref).map(|bytes| {
            String::from_utf8(bytes).unwrap_or_else(|_| {
                panic!("Invalid UTF-8 sequence in store value for key: {}", key_ref)
            })
        })
    }

    fn get_last<K: AsRef<str>>(&self, key: K) -> Option<String> {
        let key_ref = key.as_ref();

        state::get_last(self.idx, key_ref).map(|bytes| {
            String::from_utf8(bytes).unwrap_or_else(|_| {
                panic!("Invalid UTF-8 sequence in store value for key: {}", key_ref)
            })
        })
    }

    fn get_first<K: AsRef<str>>(&self, key: K) -> Option<String> {
        let key_ref = key.as_ref();

        state::get_first(self.idx, key_ref).map(|bytes| {
            String::from_utf8(bytes).unwrap_or_else(|_| {
                panic!("Invalid UTF-8 sequence in store value for key: {}", key_ref)
            })
        })
    }

    fn has_at<K: AsRef<str>>(&self, ord: u64, key: K) -> bool {
        state::has_at(self.idx, ord as i64, key)
    }

    fn has_last<K: AsRef<str>>(&self, key: K) -> bool {
        state::has_last(self.idx, key)
    }

    fn has_first<K: AsRef<str>>(&self, key: K) -> bool {
        state::has_first(self.idx, key)
    }
}

pub struct StoreGetInt64(StoreGetRaw);
impl StoreGet<i64> for StoreGetInt64 {
    fn new(idx: u32) -> Self {
        Self {
            0: StoreGetRaw { idx },
        }
    }

    fn get_at<K: AsRef<str>>(&self, ord: u64, key: K) -> Option<i64> {
        state::get_at(self.0.idx, ord as i64, key)
            .as_ref()
            .map(decode_bytes_to_i64)
    }

    fn get_last<K: AsRef<str>>(&self, key: K) -> Option<i64> {
        state::get_last(self.0.idx, key)
            .as_ref()
            .map(decode_bytes_to_i64)
    }

    fn get_first<K: AsRef<str>>(&self, key: K) -> Option<i64> {
        state::get_first(self.0.idx, key)
            .as_ref()
            .map(decode_bytes_to_i64)
    }

    fn has_at<K: AsRef<str>>(&self, ord: u64, key: K) -> bool {
        state::has_at(self.0.idx, ord as i64, key)
    }

    fn has_last<K: AsRef<str>>(&self, key: K) -> bool {
        state::has_last(self.0.idx, key)
    }

    fn has_first<K: AsRef<str>>(&self, key: K) -> bool {
        state::has_first(self.0.idx, key)
    }
}

pub struct StoreGetFloat64(StoreGetRaw);
impl StoreGet<f64> for StoreGetFloat64 {
    fn new(idx: u32) -> Self {
        Self {
            0: StoreGetRaw { idx },
        }
    }

    fn get_at<K: AsRef<str>>(&self, ord: u64, key: K) -> Option<f64> {
        state::get_at(self.0.idx, ord as i64, key)
            .as_ref()
            .map(decode_bytes_to_f64)
    }

    fn get_last<K: AsRef<str>>(&self, key: K) -> Option<f64> {
        state::get_last(self.0.idx, key)
            .as_ref()
            .map(decode_bytes_to_f64)
    }

    fn get_first<K: AsRef<str>>(&self, key: K) -> Option<f64> {
        state::get_first(self.0.idx, key)
            .as_ref()
            .map(decode_bytes_to_f64)
    }

    fn has_at<K: AsRef<str>>(&self, ord: u64, key: K) -> bool {
        state::has_at(self.0.idx, ord as i64, key)
    }

    fn has_last<K: AsRef<str>>(&self, key: K) -> bool {
        state::has_last(self.0.idx, key)
    }

    fn has_first<K: AsRef<str>>(&self, key: K) -> bool {
        state::has_first(self.0.idx, key)
    }
}

pub struct StoreGetBigDecimal(StoreGetRaw);
impl StoreGet<BigDecimal> for StoreGetBigDecimal {
    fn new(idx: u32) -> Self {
        Self {
            0: StoreGetRaw { idx },
        }
    }

    fn get_at<K: AsRef<str>>(&self, ord: u64, key: K) -> Option<BigDecimal> {
        state::get_at(self.0.idx, ord as i64, key).map(|bytes| BigDecimal::from_store_bytes(&bytes))
    }

    fn get_last<K: AsRef<str>>(&self, key: K) -> Option<BigDecimal> {
        state::get_last(self.0.idx, key).map(|bytes| BigDecimal::from_store_bytes(&bytes))
    }

    fn get_first<K: AsRef<str>>(&self, key: K) -> Option<BigDecimal> {
        state::get_first(self.0.idx, key).map(|bytes| BigDecimal::from_store_bytes(&bytes))
    }

    fn has_at<K: AsRef<str>>(&self, ord: u64, key: K) -> bool {
        state::has_at(self.0.idx, ord as i64, key)
    }

    fn has_last<K: AsRef<str>>(&self, key: K) -> bool {
        state::has_last(self.0.idx, key)
    }

    fn has_first<K: AsRef<str>>(&self, key: K) -> bool {
        state::has_first(self.0.idx, key)
    }
}

pub struct StoreGetBigInt(StoreGetRaw);
impl StoreGet<BigInt> for StoreGetBigInt {
    fn new(idx: u32) -> Self {
        Self {
            0: StoreGetRaw { idx },
        }
    }

    fn get_at<K: AsRef<str>>(&self, ord: u64, key: K) -> Option<BigInt> {
        state::get_at(self.0.idx, ord as i64, key).map(|bytes| BigInt::from_store_bytes(&bytes))
    }

    fn get_last<K: AsRef<str>>(&self, key: K) -> Option<BigInt> {
        state::get_last(self.0.idx, key).map(|bytes| BigInt::from_store_bytes(&bytes))
    }

    fn get_first<K: AsRef<str>>(&self, key: K) -> Option<BigInt> {
        state::get_first(self.0.idx, key).map(|bytes| BigInt::from_store_bytes(&bytes))
    }

    fn has_at<K: AsRef<str>>(&self, ord: u64, key: K) -> bool {
        state::has_at(self.0.idx, ord as i64, key)
    }

    fn has_last<K: AsRef<str>>(&self, key: K) -> bool {
        state::has_last(self.0.idx, key)
    }

    fn has_first<K: AsRef<str>>(&self, key: K) -> bool {
        state::has_first(self.0.idx, key)
    }
}

#[allow(dead_code)]
pub struct StoreGetArray<T> {
    store: StoreGetRaw,
    casper: PhantomData<T>,
}

impl<T: Into<String> + From<String>> StoreGet<Vec<T>> for StoreGetArray<T> {
    fn new(idx: u32) -> Self {
        Self {
            store: StoreGetRaw { idx },
            casper: PhantomData,
        }
    }

    fn get_at<K: AsRef<str>>(&self, ord: u64, key: K) -> Option<Vec<T>> {
        self.store.get_at(ord, key).and_then(split_array)
    }

    fn get_last<K: AsRef<str>>(&self, key: K) -> Option<Vec<T>> {
        self.store.get_last(key).and_then(split_array)
    }

    fn get_first<K: AsRef<str>>(&self, key: K) -> Option<Vec<T>> {
        self.store.get_first(key).and_then(split_array)
    }

    fn has_at<K: AsRef<str>>(&self, ord: u64, key: K) -> bool {
        self.store.has_at(ord, key)
    }

    fn has_last<K: AsRef<str>>(&self, key: K) -> bool {
        self.store.has_last(key)
    }

    fn has_first<K: AsRef<str>>(&self, key: K) -> bool {
        self.store.has_first(key)
    }
}

fn split_array<T: Into<String> + From<String>>(bytes: Vec<u8>) -> Option<Vec<T>> {
    let parts = std::io::Cursor::new(bytes).split(b';');
    let chunks: Vec<_> = parts
        .map(|x| x.expect("Cursor is infallible"))
        .filter(|x| x.len() > 0)
        .map(|part| {
            String::from_utf8(part)
                .unwrap_or_else(|_| panic!("Invalid UTF-8 sequence in store value"))
                .into()
        })
        .collect();

    match chunks.len() {
        0 => None,
        _ => Some(chunks),
    }
}

#[allow(dead_code)]
pub struct StoreGetProto<T> {
    store: StoreGetRaw,
    casper: PhantomData<T>,
}

impl<T: Default + prost::Message> StoreGetProto<T> {
    pub fn must_get_last<K: AsRef<str>>(&self, key: K) -> T {
        self.get_last(&key)
            .unwrap_or_else(|| panic!("cannot get_last value: key {} not found", key.as_ref()))
    }
}

impl<T> StoreGet<T> for StoreGetProto<T>
where
    T: Default + prost::Message,
{
    /// Return a StoreGet object with a store index set
    fn new(idx: u32) -> StoreGetProto<T> {
        StoreGetProto {
            store: StoreGetRaw { idx },
            casper: PhantomData,
        }
    }

    fn get_at<K: AsRef<str>>(&self, ord: u64, key: K) -> Option<T> {
        self.store
            .get_at(ord, key)
            .and_then(|bytes| proto::decode::<T>(&bytes).ok())
    }

    fn get_last<K: AsRef<str>>(&self, key: K) -> Option<T> {
        self.store
            .get_last(key)
            .and_then(|bytes| proto::decode::<T>(&bytes).ok())
    }

    fn get_first<K: AsRef<str>>(&self, key: K) -> Option<T> {
        self.store
            .get_first(key)
            .and_then(|bytes| proto::decode::<T>(&bytes).ok())
    }

    fn has_at<K: AsRef<str>>(&self, ord: u64, key: K) -> bool {
        self.store.has_at(ord, key)
    }

    fn has_last<K: AsRef<str>>(&self, key: K) -> bool {
        self.store.has_last(key)
    }

    fn has_first<K: AsRef<str>>(&self, key: K) -> bool {
        self.store.has_first(key)
    }
}

pub trait Delta: PartialEq {
    fn get_key(&self) -> &String;
    fn get_operation(&self) -> pb::substreams::store_delta::Operation;
}

pub trait DeltaExt: Iterator {
    /// Equivalent to `filter(|x| segment(x.get_key(), index) == value)`.
    fn key_segment_at_eq<S: AsRef<str>>(self, index: usize, value: S) -> key::SegmentAtEq<Self, S>
    where
        Self::Item: Delta,
        Self: Sized,
    {
        key::SegmentAtEq::new(value, Some(index), self)
    }

    /// Equivalent to `filter(|x| first_segment(x.get_key(), index) == value)`.
    fn key_first_segment_eq<S: AsRef<str>>(self, value: S) -> key::SegmentAtEq<Self, S>
    where
        Self::Item: Delta,
        Self: Sized,
    {
        key::SegmentAtEq::new(value, Some(0), self)
    }

    /// Equivalent to `filter(|x| last_segment(x.get_key(), index) == value)`.
    fn key_last_segment_eq<S: AsRef<str>>(self, value: S) -> key::SegmentAtEq<Self, S>
    where
        Self::Item: Delta,
        Self: Sized,
    {
        key::SegmentAtEq::new(value, None, self)
    }

    /// Equivalent to `filter(|x| values.contains(first_segment(x.get_key(), index)))`.
    fn key_first_segment_in<S: AsRef<str>, V: AsRef<[S]>>(
        self,
        values: V,
    ) -> key::SegmentAtIn<Self, S, V>
    where
        Self::Item: Delta,
        Self: Sized,
    {
        key::SegmentAtIn::new(values, Some(0), self)
    }

    /// Equivalent to `filter(|x| values.contains(last_segment(x.get_key(), index)))`.
    fn key_last_segment_in<S: AsRef<str>, V: AsRef<[S]>>(
        self,
        values: V,
    ) -> key::SegmentAtIn<Self, S, V>
    where
        Self::Item: Delta,
        Self: Sized,
    {
        key::SegmentAtIn::new(values, None, self)
    }

    /// Equivalent to `filter(|x| x.get_operation() == operation)`.
    fn operation_eq(self, operation: Operation) -> operation::OperationIs<Self>
    where
        Self::Item: Delta,
        Self: Sized,
    {
        operation::OperationIs::new(operation, false, self)
    }

    /// Equivalent to `filter(|x| x.get_operation() != operation)`.
    fn operation_not_eq(self, operation: Operation) -> operation::OperationIs<Self>
    where
        Self::Item: Delta,
        Self: Sized,
    {
        operation::OperationIs::new(operation, true, self)
    }
}

impl<I: Iterator> DeltaExt for I {}

#[derive(Debug, Clone, PartialEq)]
pub struct Deltas<T: Delta> {
    pub deltas: Vec<T>,
}

impl<T: Delta + From<StoreDelta>> Deltas<T> {
    pub fn new(store_deltas: Vec<StoreDelta>) -> Self {
        Deltas {
            deltas: store_deltas.into_iter().map(Into::into).collect(),
        }
    }

    /// Shortcut for `self.deltas.iter()`.
    pub fn iter(&self) -> impl Iterator<Item = &T> {
        self.deltas.iter()
    }

    /// Shortcut for `self.deltas.into_iter()`.
    pub fn into_iter(self) -> impl Iterator<Item = T> {
        self.deltas.into_iter()
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct DeltaBigDecimal {
    pub operation: pb::substreams::store_delta::Operation,
    pub ordinal: u64,
    pub key: String,
    pub old_value: BigDecimal,
    pub new_value: BigDecimal,
}

impl From<StoreDelta> for DeltaBigDecimal {
    fn from(d: StoreDelta) -> Self {
        Self {
            operation: convert_i32_to_operation(d.operation),
            ordinal: d.ordinal,
            key: d.key,
            old_value: BigDecimal::from_store_bytes(&d.old_value),
            new_value: BigDecimal::from_store_bytes(&d.new_value),
        }
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct DeltaBigInt {
    pub operation: pb::substreams::store_delta::Operation,
    pub ordinal: u64,
    pub key: String,
    pub old_value: BigInt,
    pub new_value: BigInt,
}

impl From<StoreDelta> for DeltaBigInt {
    fn from(d: StoreDelta) -> Self {
        Self {
            operation: convert_i32_to_operation(d.operation),
            ordinal: d.ordinal,
            key: d.key,
            old_value: BigInt::from_store_bytes(&d.old_value),
            new_value: BigInt::from_store_bytes(&d.new_value),
        }
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct DeltaInt32 {
    pub operation: pb::substreams::store_delta::Operation,
    pub ordinal: u64,
    pub key: String,
    pub old_value: i32,
    pub new_value: i32,
}

impl From<StoreDelta> for DeltaInt32 {
    fn from(d: StoreDelta) -> Self {
        Self {
            operation: convert_i32_to_operation(d.operation),
            ordinal: d.ordinal,
            key: d.key,
            old_value: decode_bytes_to_i32(&d.old_value),
            new_value: decode_bytes_to_i32(&d.new_value),
        }
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct DeltaInt64 {
    pub operation: pb::substreams::store_delta::Operation,
    pub ordinal: u64,
    pub key: String,
    pub old_value: i64,
    pub new_value: i64,
}

impl From<StoreDelta> for DeltaInt64 {
    fn from(d: StoreDelta) -> Self {
        Self {
            operation: convert_i32_to_operation(d.operation),
            ordinal: d.ordinal,
            key: d.key,
            old_value: decode_bytes_to_i64(&d.old_value),
            new_value: decode_bytes_to_i64(&d.new_value),
        }
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct DeltaFloat64 {
    pub operation: pb::substreams::store_delta::Operation,
    pub ordinal: u64,
    pub key: String,
    pub old_value: f64,
    pub new_value: f64,
}

impl From<StoreDelta> for DeltaFloat64 {
    fn from(d: StoreDelta) -> Self {
        Self {
            operation: convert_i32_to_operation(d.operation),
            ordinal: d.ordinal,
            key: d.key,
            old_value: decode_bytes_to_f64(&d.old_value),
            new_value: decode_bytes_to_f64(&d.new_value),
        }
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct DeltaBool {
    pub operation: pb::substreams::store_delta::Operation,
    pub ordinal: u64,
    pub key: String,
    pub old_value: bool,
    pub new_value: bool,
}

impl From<StoreDelta> for DeltaBool {
    fn from(d: StoreDelta) -> Self {
        Self {
            operation: convert_i32_to_operation(d.operation),
            ordinal: d.ordinal,
            key: d.key,
            old_value: !d.old_value.contains(&0),
            new_value: !d.new_value.contains(&0),
        }
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct DeltaBytes {
    pub operation: pb::substreams::store_delta::Operation,
    pub ordinal: u64,
    pub key: String,
    pub old_value: Vec<u8>,
    pub new_value: Vec<u8>,
}

impl From<StoreDelta> for DeltaBytes {
    fn from(d: StoreDelta) -> Self {
        Self {
            operation: convert_i32_to_operation(d.operation),
            ordinal: d.ordinal,
            key: d.key,
            old_value: d.old_value,
            new_value: d.new_value,
        }
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct DeltaString {
    pub operation: pb::substreams::store_delta::Operation,
    pub ordinal: u64,
    pub key: String,
    pub old_value: String,
    pub new_value: String,
}

impl From<StoreDelta> for DeltaString {
    fn from(d: StoreDelta) -> Self {
        Self {
            operation: convert_i32_to_operation(d.operation),
            ordinal: d.ordinal,
            key: d.key,
            old_value: String::from_utf8(d.old_value).unwrap_or_else(|_| {
                panic!("Invalid UTF-8 sequence in Store DeltaString old value")
            }),
            new_value: String::from_utf8(d.new_value).unwrap_or_else(|_| {
                panic!("Invalid UTF-8 sequence in Store DeltaString new value")
            }),
        }
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct DeltaProto<T> {
    pub operation: pb::substreams::store_delta::Operation,
    pub ordinal: u64,
    pub key: String,
    pub old_value: T,
    pub new_value: T,
}

impl<T: Default + prost::Message + PartialEq> From<StoreDelta> for DeltaProto<T> {
    fn from(d: StoreDelta) -> Self {
        let nv: T = prost::Message::decode(d.new_value.as_ref())
            .unwrap_or_else(|_| panic!("Unable to decode Store DeltaProto for new value"));
        let ov: T = prost::Message::decode(d.old_value.as_ref())
            .unwrap_or_else(|_| panic!("Unable to decode Store DeltaProto for old value"));

        Self {
            operation: convert_i32_to_operation(d.operation),
            ordinal: d.ordinal,
            key: d.key,
            old_value: ov,
            new_value: nv,
        }
    }
}

impl<T: Default + prost::Message + PartialEq> Delta for DeltaProto<T> {
    fn get_key(&self) -> &String {
        &self.key
    }
    fn get_operation(&self) -> pb::substreams::store_delta::Operation {
        return self.operation;
    }
}

impl<T: Default + prost::Message + PartialEq> Delta for &DeltaProto<T> {
    fn get_key(&self) -> &String {
        &self.key
    }
    fn get_operation(&self) -> pb::substreams::store_delta::Operation {
        return self.operation;
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct DeltaArray<T> {
    pub operation: pb::substreams::store_delta::Operation,
    pub ordinal: u64,
    pub key: String,
    pub old_value: Vec<T>,
    pub new_value: Vec<T>,
}

impl<T: Into<String> + From<String> + PartialEq> From<StoreDelta> for DeltaArray<T> {
    fn from(d: StoreDelta) -> Self {
        let old = split_array::<T>(d.old_value).unwrap_or_default();
        let new = split_array::<T>(d.new_value).unwrap_or_default();

        Self {
            operation: convert_i32_to_operation(d.operation),
            ordinal: d.ordinal,
            key: d.key,
            old_value: old,
            new_value: new,
        }
    }
}

impl<T: Into<String> + From<String> + PartialEq> Delta for DeltaArray<T> {
    fn get_key(&self) -> &String {
        &self.key
    }
    fn get_operation(&self) -> pb::substreams::store_delta::Operation {
        return self.operation;
    }
}

impl<T: Into<String> + From<String> + PartialEq> Delta for &DeltaArray<T> {
    fn get_key(&self) -> &String {
        &self.key
    }
    fn get_operation(&self) -> pb::substreams::store_delta::Operation {
        return self.operation;
    }
}

macro_rules! impl_delta_ref {
    ($name:ty) => {
        impl Delta for $name {
            fn get_key(&self) -> &String {
                &self.key
            }
            fn get_operation(&self) -> pb::substreams::store_delta::Operation {
                self.operation
            }
        }
    };
}

macro_rules! impl_delta {
    ($name:ty) => {
        impl Delta for $name {
            fn get_key(&self) -> &String {
                &self.key
            }
            fn get_operation(&self) -> pb::substreams::store_delta::Operation {
                self.operation
            }
        }
        impl $name {
            pub fn get_key(&self) -> &String {
                &self.key
            }
            pub fn get_operation(&self) -> pb::substreams::store_delta::Operation {
                self.operation
            }
        }
    };
}

// Returns a `u64` whose high 32 bits are the pointer and low 32 bits are the length.
fn unpack_ptr_len(packed: u64) -> (*mut u8, u32) {
    let ptr32 = (packed >> 32) as u32;
    let len32 = packed as u32;
    let ptr = ptr32 as usize as *mut u8;
    (ptr, len32)
}

// Interface to query data from foundational stores within Substreams modules
pub struct FoundationalStore {
    store_index: u32,
}

impl FoundationalStore {
    pub fn new(store_index: u32) -> Self {
        Self { store_index }
    }

    pub fn get<K: AsRef<[u8]>>(&self, keys: &[K]) -> QueriedEntries {
        if keys.is_empty() {
            return QueriedEntries { entries: vec![] };
        }
        if cfg!(not(target_arch = "wasm32")) {
            panic!("foundational_store::get_all called outside wasm32 target");
        }

        let pb_keys = Keys {
            keys: keys
                .iter()
                .map(|k| Key {
                    bytes: k.as_ref().to_vec(),
                })
                .collect(),
        };

        let (ptr, len, _buf) = proto::encode_to_ptr(&pb_keys).unwrap();

        // Call host function to query multiple keys at once
        let packed = state::foundational_store_get(self.store_index, ptr as u32, len as u32);

        let (resp_ptr, resp_len) = unpack_ptr_len(packed);

        // Decode batch response from host memory
        let msg: QueriedEntries = proto::decode_ptr(resp_ptr, resp_len as usize).unwrap();

        msg
    }

    pub fn get_first<K: AsRef<[u8]>>(&self, keys: &[K]) -> QueriedEntries {
        if keys.is_empty() {
            return QueriedEntries { entries: vec![] };
        }
        if cfg!(not(target_arch = "wasm32")) {
            panic!("foundational_store::get_all called outside wasm32 target");
        }

        let pb_keys = Keys {
            keys: keys
                .iter()
                .map(|k| Key {
                    bytes: k.as_ref().to_vec(),
                })
                .collect(),
        };

        let (ptr, len, _buf) = proto::encode_to_ptr(&pb_keys).unwrap();

        // Call host function to query multiple keys at once
        let packed = state::foundational_store_get_first(self.store_index, ptr as u32, len as u32);

        let (resp_ptr, resp_len) = unpack_ptr_len(packed);

        // Decode batch response from host memory
        let msg: QueriedEntries = proto::decode_ptr(resp_ptr, resp_len as usize).unwrap();

        msg
    }
}

impl_delta!(DeltaBigDecimal);
impl_delta!(DeltaBigInt);
impl_delta!(DeltaInt32);
impl_delta!(DeltaInt64);
impl_delta!(DeltaFloat64);
impl_delta!(DeltaBool);
impl_delta!(DeltaBytes);
impl_delta!(DeltaString);

impl_delta_ref!(&DeltaBigDecimal);
impl_delta_ref!(&DeltaBigInt);
impl_delta_ref!(&DeltaInt32);
impl_delta_ref!(&DeltaInt64);
impl_delta_ref!(&DeltaFloat64);
impl_delta_ref!(&DeltaBool);
impl_delta_ref!(&DeltaBytes);
impl_delta_ref!(&DeltaString);

fn convert_i32_to_operation(operation: i32) -> pb::substreams::store_delta::Operation {
    Operation::try_from(operation).unwrap_or_else(|_| panic!("unhandled operation: {}", operation))
}

// We accept &Vec<u8> instead of &[u8] because use internally and makes it easier to chain
fn decode_bytes_to_i32(bytes: &Vec<u8>) -> i32 {
    if bytes.is_empty() {
        return 0;
    }

    // `FIXME: If we are ready to accept the fact that `bytes` is always valid UTF-8, we could even use
    //        the unsafe `from_utf8_unchecked` version, we would need first to measure the impact and
    //        better understand implication of an invalid UTF-8 &str with `from_str` call.
    let int_as_str =
        std::str::from_utf8(bytes).expect("received bytes expected to be valid UTF-8 string");

    i32::from_str(int_as_str).unwrap_or_else(|_| {
        panic!(
            "value {} is not a valid representation of an i32",
            int_as_str
        )
    })
}

// We accept &Vec<u8> instead of &[u8] because use internally and makes it easier to chain
fn decode_bytes_to_i64(bytes: &Vec<u8>) -> i64 {
    if bytes.is_empty() {
        return 0;
    }

    // FIXME: If we are ready to accept the fact that `bytes` is always valid UTF-8, we could even use
    //        the unsafe `from_utf8_unchecked` version, we would need first to measure the impact and
    //        better understand implication of an invalid UTF-8 &str with `from_str` call.
    let int_as_str =
        std::str::from_utf8(bytes).expect("received bytes expected to be valid UTF-8 string");

    i64::from_str(int_as_str).unwrap_or_else(|_| {
        panic!(
            "value {} is not a valid representation of an i64",
            int_as_str
        )
    })
}

// We accept &Vec<u8> instead of &[u8] because use internally and makes it easier to chain
fn decode_bytes_to_f64(bytes: &Vec<u8>) -> f64 {
    if bytes.is_empty() {
        return 0.0;
    }

    // FIXME: If we are ready to accept the fact that `bytes` is always valid UTF-8, we could even use
    //        the unsafe `from_utf8_unchecked` version, we would need first to measure the impact and
    //        better understand implication of an invalid UTF-8 &str with `from_str` call.
    let float64_as_str =
        std::str::from_utf8(bytes).expect("received bytes expected to be valid UTF-8 string");

    f64::from_str(float64_as_str).unwrap_or_else(|_| {
        panic!(
            "value {} is not a valid representation of an f64",
            float64_as_str
        )
    })
}

#[cfg(test)]
mod tests {
    use crate::pb::sf::substreams::foundational_store::model::v2::QueriedEntries;
    use crate::{
        pb::substreams::{store_delta::Operation, StoreDelta},
        store::{
            decode_bytes_to_f64, decode_bytes_to_i32, decode_bytes_to_i64, split_array,
            unpack_ptr_len, DeltaArray, Deltas, FoundationalStore,
        },
    };

    #[test]
    fn valid_int64_decode_bytes_to_i32() {
        let bytes: Vec<u8> = "1".as_bytes().to_vec();
        assert_eq!(1, decode_bytes_to_i32(&bytes))
    }

    #[test]
    fn valid_int64_max_value_decode_bytes_to_i32() {
        let bytes: Vec<u8> = i32::MAX.to_string().as_bytes().to_vec();
        assert_eq!(i32::MAX, decode_bytes_to_i32(&bytes))
    }

    #[test]
    #[should_panic]
    fn invalid_bytes_decode_bytes_to_i32() {
        let bytes: Vec<u8> = "invalid".as_bytes().to_vec();
        decode_bytes_to_i32(&bytes);
    }

    #[test]
    fn no_bytes_decode_bytes_to_i32() {
        let bytes: Vec<u8> = vec![];
        decode_bytes_to_i32(&bytes);
    }

    #[test]
    fn valid_int64_decode_bytes_to_i64() {
        let bytes: Vec<u8> = "1".as_bytes().to_vec();
        assert_eq!(1, decode_bytes_to_i64(&bytes))
    }

    #[test]
    fn valid_int64_max_value_decode_bytes_to_i64() {
        let bytes: Vec<u8> = i64::MAX.to_string().as_bytes().to_vec();
        assert_eq!(i64::MAX, decode_bytes_to_i64(&bytes))
    }

    #[test]
    #[should_panic]
    fn invalid_bytes_decode_bytes_to_i64() {
        let bytes: Vec<u8> = "invalid".as_bytes().to_vec();
        decode_bytes_to_i64(&bytes);
    }

    #[test]
    fn no_bytes_decode_bytes_to_i64() {
        let bytes: Vec<u8> = vec![];
        decode_bytes_to_i64(&bytes);
    }

    #[test]
    fn valid_f64_decode_bytes_to_f64() {
        let bytes: Vec<u8> = "1.00".as_bytes().to_vec();
        assert_eq!(1.00, decode_bytes_to_f64(&bytes))
    }

    #[test]
    fn valid_f64_max_value_decode_bytes_to_f64() {
        let bytes: Vec<u8> = f64::MAX.to_string().as_bytes().to_vec();
        assert_eq!(f64::MAX, decode_bytes_to_f64(&bytes))
    }

    #[test]
    #[should_panic]
    fn invalid_bytes_decode_bytes_to_f64() {
        let bytes: Vec<u8> = "invalid".as_bytes().to_vec();
        decode_bytes_to_f64(&bytes);
    }

    #[test]
    fn no_bytes_decode_bytes_to_f64() {
        let bytes: Vec<u8> = vec![];
        decode_bytes_to_f64(&bytes);
    }

    #[test]
    fn delta_array_strring() {
        let deltas = Deltas::<DeltaArray<String>>::new(vec![StoreDelta {
            operation: 1,
            ordinal: 0,
            key: "".to_string(),
            old_value: ";".as_bytes().to_vec(),
            new_value: "1.1;2.2;3.3;".as_bytes().to_vec(),
        }]);

        assert_eq!(
            Deltas::<DeltaArray<String>> {
                deltas: vec![DeltaArray::<String> {
                    operation: Operation::Create,
                    ordinal: 0,
                    key: "".to_string(),
                    old_value: vec![],
                    new_value: vec!["1.1".to_string(), "2.2".to_string(), "3.3".to_string(),]
                }]
            },
            deltas
        );
    }

    #[test]
    fn split_arrays_no_elements() {
        let value = "";
        let bytes = value.as_bytes();

        let expected_value = None;
        let actual_value = split_array::<String>(bytes.to_vec());

        assert_eq!(expected_value, actual_value)
    }

    #[test]
    fn split_arrays_one_string_element() {
        let value = "1;";
        let bytes = value.as_bytes();

        let expected_value = Some(vec!["1".to_string()]);
        let actual_value = split_array::<String>(bytes.to_vec());

        assert_eq!(expected_value, actual_value)
    }

    #[test]
    fn split_arrays_multiple_string_elements() {
        let value = "1;2;3;";
        let bytes = value.as_bytes();

        let expected_value = Some(vec!["1".to_string(), "2".to_string(), "3".to_string()]);
        let actual_value = split_array::<String>(bytes.to_vec());

        assert_eq!(expected_value, actual_value)
    }

    #[test]
    fn unpack_ptr_len_roundtrip() {
        // random pointer
        let ptr_orig = 0x1234_5678usize as *mut u8;
        let len_orig: usize = 0x9ABC_DEFusize;

        let packed: u64 = ((ptr_orig as u64) << 32) | (len_orig as u64 & 0xFFFF_FFFF);

        let (ptr_unpacked, len_unpacked) = unpack_ptr_len(packed);

        assert_eq!(ptr_unpacked, ptr_orig);
        assert_eq!(len_unpacked, len_orig as u32);
    }

    #[test]
    fn unpack_ptr_len_zero() {
        let packed = 0u64;
        let (ptr, len) = unpack_ptr_len(packed);
        assert!(ptr.is_null());
        assert_eq!(len, 0);
    }

    #[test]
    #[should_panic]
    fn get_non_wasm_returns_none() {
        let store = FoundationalStore::new(999);
        // now panics on non-wasm
        let _ = store.get(&[b"some_key"]);
    }

    #[test]
    #[should_panic]
    fn get_all_non_wasm_returns_none() {
        let store = FoundationalStore::new(0);
        let keys = &[b"test1", b"test2", b"test3"];
        // now panics on non-wasm
        let _ = store.get(keys);
    }

    #[test]
    fn get_all_empty_keys() {
        let store = FoundationalStore::new(42);
        let empty: &[&[u8]] = &[];
        let out = store.get(empty);
        // returns a real value before the wasm guard
        assert_eq!(out, QueriedEntries { entries: vec![] });
    }

    #[test]
    #[should_panic]
    fn test_with_vec_u8() {
        let store = FoundationalStore::new(123);
        let key = vec![0x01, 0x02, 0x03, 0x04];
        // now panics on non-wasm
        let _ = store.get(&[&key[..]]);
    }

    #[test]
    #[should_panic]
    fn test_with_string_bytes() {
        let store = FoundationalStore::new(456);
        let key = "test_key";
        // now panics on non-wasm
        let _ = store.get(&[key]);
    }

    #[test]
    #[should_panic]
    fn get_all_with_mixed_key_types() {
        let store = FoundationalStore::new(789);
        let vec_key = vec![0x01, 0x02];
        let keys = &[&b"string_key"[..], &vec_key[..], &b"byte_string"[..]];
        // now panics on non-wasm
        let _ = store.get(keys);
    }

    #[test]
    #[should_panic]
    fn get_all_single_key() {
        let store = FoundationalStore::new(100);
        let keys = &[b"single_key"];
        // now panics on non-wasm
        let _ = store.get(keys);
    }

    #[test]
    #[should_panic]
    fn get_all_multiple_string_keys() {
        let store = FoundationalStore::new(200);
        let keys = &["key1", "key2", "key3", "key4"];
        // now panics on non-wasm
        let _ = store.get(keys);
    }

    #[test]
    #[should_panic]
    fn get_all_with_different_block_numbers() {
        let store = FoundationalStore::new(300);
        let keys = &[b"test_key"];

        // any of these calls should panic on non-wasm; the first panic satisfies #[should_panic]
        let _ = store.get(keys);
    }

    #[test]
    #[should_panic]
    fn get_all_preserves_order() {
        let store = FoundationalStore::new(400);
        let keys = &[b"key_z", b"key_a", b"key_m"];
        // now panics on non-wasm
        let _ = store.get(keys);
    }

    #[test]
    #[should_panic]
    fn get_all_with_duplicate_keys() {
        let store = FoundationalStore::new(500);
        let keys = &[&b"duplicate"[..], &b"duplicate"[..], &b"unique"[..]];
        // now panics on non-wasm
        let _ = store.get(keys);
    }

    #[test]
    #[should_panic]
    fn get_all_with_empty_key() {
        let store = FoundationalStore::new(600);
        let keys = &[&b""[..], &b"non_empty"[..]];
        // now panics on non-wasm
        let _ = store.get(keys);
    }

    #[test]
    #[should_panic]
    fn get_all_large_number_of_keys() {
        let store = FoundationalStore::new(700);
        let keys: Vec<Vec<u8>> = (0..1000)
            .map(|i| format!("key_{}", i).into_bytes())
            .collect();
        let key_refs: Vec<&Vec<u8>> = keys.iter().collect();

        // now panics on non-wasm
        let _ = store.get(&key_refs);
    }
}