hypersync-schema 0.4.0

schema utilities for hypersync
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

//! # HyperSync Schema
//!
//! Apache Arrow schemas for the HyperSync protocol.

use arrow::datatypes::{DataType, Field, Schema, SchemaRef};

fn hash_dt() -> DataType {
    DataType::Binary
}

fn addr_dt() -> DataType {
    DataType::Binary
}

fn quantity_dt() -> DataType {
    DataType::Binary
}

const NULLABLE: bool = true;

pub fn block_header() -> SchemaRef {
    Schema::new(vec![
        Field::new("number", DataType::UInt64, !NULLABLE),
        Field::new("hash", hash_dt(), !NULLABLE),
        Field::new("parent_hash", hash_dt(), !NULLABLE),
        Field::new("nonce", DataType::Binary, NULLABLE),
        Field::new("sha3_uncles", hash_dt(), !NULLABLE),
        Field::new("logs_bloom", DataType::Binary, !NULLABLE),
        Field::new("transactions_root", hash_dt(), !NULLABLE),
        Field::new("state_root", hash_dt(), !NULLABLE),
        Field::new("receipts_root", hash_dt(), !NULLABLE),
        Field::new("miner", addr_dt(), !NULLABLE),
        Field::new("difficulty", quantity_dt(), NULLABLE),
        Field::new("total_difficulty", quantity_dt(), NULLABLE),
        Field::new("extra_data", DataType::Binary, !NULLABLE),
        Field::new("size", quantity_dt(), !NULLABLE),
        Field::new("gas_limit", quantity_dt(), !NULLABLE),
        Field::new("gas_used", quantity_dt(), !NULLABLE),
        Field::new("timestamp", quantity_dt(), !NULLABLE),
        Field::new("uncles", DataType::Binary, NULLABLE),
        Field::new("base_fee_per_gas", quantity_dt(), NULLABLE),
        Field::new("blob_gas_used", quantity_dt(), NULLABLE),
        Field::new("excess_blob_gas", quantity_dt(), NULLABLE),
        Field::new("parent_beacon_block_root", hash_dt(), NULLABLE),
        Field::new("withdrawals_root", hash_dt(), NULLABLE),
        Field::new("withdrawals", DataType::Binary, NULLABLE),
        Field::new("l1_block_number", DataType::UInt64, NULLABLE),
        Field::new("send_count", quantity_dt(), NULLABLE),
        Field::new("send_root", hash_dt(), NULLABLE),
        Field::new("mix_hash", hash_dt(), NULLABLE),
    ])
    .into()
}

pub fn transaction() -> SchemaRef {
    Schema::new(vec![
        Field::new("block_hash", hash_dt(), !NULLABLE),
        Field::new("block_number", DataType::UInt64, !NULLABLE),
        Field::new("from", addr_dt(), NULLABLE),
        Field::new("gas", quantity_dt(), !NULLABLE),
        Field::new("gas_price", quantity_dt(), NULLABLE),
        Field::new("hash", hash_dt(), !NULLABLE),
        Field::new("input", DataType::Binary, !NULLABLE),
        Field::new("nonce", quantity_dt(), !NULLABLE),
        Field::new("to", addr_dt(), NULLABLE),
        Field::new("transaction_index", DataType::UInt64, !NULLABLE),
        Field::new("value", quantity_dt(), !NULLABLE),
        Field::new("v", quantity_dt(), NULLABLE),
        Field::new("r", quantity_dt(), NULLABLE),
        Field::new("s", quantity_dt(), NULLABLE),
        Field::new("max_priority_fee_per_gas", quantity_dt(), NULLABLE),
        Field::new("max_fee_per_gas", quantity_dt(), NULLABLE),
        Field::new("chain_id", quantity_dt(), NULLABLE),
        Field::new("cumulative_gas_used", quantity_dt(), !NULLABLE),
        Field::new("effective_gas_price", quantity_dt(), !NULLABLE),
        Field::new("gas_used", quantity_dt(), !NULLABLE),
        Field::new("contract_address", addr_dt(), NULLABLE),
        Field::new("logs_bloom", DataType::Binary, !NULLABLE),
        Field::new("type", DataType::UInt8, NULLABLE),
        Field::new("root", hash_dt(), NULLABLE),
        Field::new("status", DataType::UInt8, NULLABLE),
        Field::new("sighash", DataType::Binary, NULLABLE),
        Field::new("y_parity", quantity_dt(), NULLABLE),
        Field::new("access_list", DataType::Binary, NULLABLE),
        Field::new("authorization_list", DataType::Binary, NULLABLE),
        Field::new("l1_fee", quantity_dt(), NULLABLE),
        Field::new("l1_gas_price", quantity_dt(), NULLABLE),
        Field::new("l1_gas_used", quantity_dt(), NULLABLE),
        Field::new("l1_fee_scalar", quantity_dt(), NULLABLE),
        Field::new("gas_used_for_l1", quantity_dt(), NULLABLE),
        Field::new("max_fee_per_blob_gas", quantity_dt(), NULLABLE),
        Field::new("blob_versioned_hashes", DataType::Binary, NULLABLE),
        Field::new("deposit_nonce", quantity_dt(), NULLABLE),
        Field::new("blob_gas_price", quantity_dt(), NULLABLE),
        Field::new("deposit_receipt_version", quantity_dt(), NULLABLE),
        Field::new("blob_gas_used", quantity_dt(), NULLABLE),
        Field::new("l1_base_fee_scalar", quantity_dt(), NULLABLE),
        Field::new("l1_blob_base_fee", quantity_dt(), NULLABLE),
        Field::new("l1_blob_base_fee_scalar", quantity_dt(), NULLABLE),
        Field::new("l1_block_number", quantity_dt(), NULLABLE),
        Field::new("mint", quantity_dt(), NULLABLE),
        Field::new("source_hash", hash_dt(), NULLABLE),
    ])
    .into()
}

pub fn log() -> SchemaRef {
    Schema::new(vec![
        Field::new("removed", DataType::Boolean, NULLABLE),
        Field::new("log_index", DataType::UInt64, !NULLABLE),
        Field::new("transaction_index", DataType::UInt64, !NULLABLE),
        Field::new("transaction_hash", hash_dt(), !NULLABLE),
        Field::new("block_hash", hash_dt(), !NULLABLE),
        Field::new("block_number", DataType::UInt64, !NULLABLE),
        Field::new("address", addr_dt(), !NULLABLE),
        Field::new("data", DataType::Binary, !NULLABLE),
        Field::new("topic0", DataType::Binary, NULLABLE),
        Field::new("topic1", DataType::Binary, NULLABLE),
        Field::new("topic2", DataType::Binary, NULLABLE),
        Field::new("topic3", DataType::Binary, NULLABLE),
    ])
    .into()
}

pub fn trace() -> SchemaRef {
    Schema::new(vec![
        Field::new("from", addr_dt(), NULLABLE),
        Field::new("to", addr_dt(), NULLABLE),
        Field::new("call_type", DataType::Utf8, NULLABLE),
        Field::new("gas", quantity_dt(), NULLABLE),
        Field::new("input", DataType::Binary, NULLABLE),
        Field::new("init", DataType::Binary, NULLABLE),
        Field::new("value", quantity_dt(), NULLABLE),
        Field::new("author", addr_dt(), NULLABLE),
        Field::new("reward_type", DataType::Utf8, NULLABLE),
        Field::new("block_hash", DataType::Binary, !NULLABLE),
        Field::new("block_number", DataType::UInt64, !NULLABLE),
        Field::new("address", addr_dt(), NULLABLE),
        Field::new("code", DataType::Binary, NULLABLE),
        Field::new("gas_used", quantity_dt(), NULLABLE),
        Field::new("output", DataType::Binary, NULLABLE),
        Field::new("subtraces", DataType::UInt64, NULLABLE),
        Field::new("trace_address", DataType::Binary, NULLABLE),
        Field::new("transaction_hash", DataType::Binary, NULLABLE),
        Field::new("transaction_position", DataType::UInt64, NULLABLE),
        Field::new("type", DataType::Utf8, NULLABLE),
        Field::new("error", DataType::Utf8, NULLABLE),
        Field::new("sighash", DataType::Binary, NULLABLE),
        Field::new("action_address", addr_dt(), NULLABLE),
        Field::new("balance", quantity_dt(), NULLABLE),
        Field::new("refund_address", addr_dt(), NULLABLE),
    ])
    .into()
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn smoke_test_schema_constructors() {
        block_header();
        transaction();
        log();
        trace();
    }
}