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
use std::collections::BTreeSet;
use arrayvec::ArrayVec;
use hypersync_format::{Address, FilterWrapper, FixedSizeData, Hash, LogArgument};
use serde::{Deserialize, Serialize};
pub type Sighash = FixedSizeData<4>;
pub mod hypersync_net_types_capnp {
include!(concat!(env!("OUT_DIR"), "/hypersync_net_types_capnp.rs"));
}
#[derive(Default, Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct BlockSelection {
/// Hash of a block, any blocks that have one of these hashes will be returned.
/// Empty means match all.
#[serde(default)]
pub hash: Vec<Hash>,
/// Miner address of a block, any blocks that have one of these miners will be returned.
/// Empty means match all.
#[serde(default)]
pub miner: Vec<Address>,
}
#[derive(Default, Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct LogSelection {
/// Address of the contract, any logs that has any of these addresses will be returned.
/// Empty means match all.
#[serde(default)]
pub address: Vec<Address>,
#[serde(default)]
pub address_filter: Option<FilterWrapper>,
/// Topics to match, each member of the top level array is another array, if the nth topic matches any
/// topic specified in nth element of topics, the log will be returned. Empty means match all.
#[serde(default)]
pub topics: ArrayVec<Vec<LogArgument>, 4>,
}
#[derive(Default, Serialize, Deserialize, Clone, Debug)]
pub struct TransactionSelection {
/// Address the transaction should originate from. If transaction.from matches any of these, the transaction
/// will be returned. Keep in mind that this has an and relationship with to filter, so each transaction should
/// match both of them. Empty means match all.
#[serde(default)]
pub from: Vec<Address>,
#[serde(default)]
pub from_filter: Option<FilterWrapper>,
/// Address the transaction should go to. If transaction.to matches any of these, the transaction will
/// be returned. Keep in mind that this has an and relationship with from filter, so each transaction should
/// match both of them. Empty means match all.
#[serde(default)]
pub to: Vec<Address>,
#[serde(default)]
pub to_filter: Option<FilterWrapper>,
/// If first 4 bytes of transaction input matches any of these, transaction will be returned. Empty means match all.
#[serde(default)]
pub sighash: Vec<Sighash>,
/// If transaction.status matches this value, the transaction will be returned.
pub status: Option<u8>,
/// If transaction.type matches any of these values, the transaction will be returned
#[serde(rename = "type")]
#[serde(default)]
pub kind: Vec<u8>,
/// If transaction.contract_address matches any of these values, the transaction will be returned.
#[serde(default)]
pub contract_address: Vec<Address>,
/// Bloom filter to filter by transaction.contract_address field. If the bloom filter contains the hash
/// of transaction.contract_address then the transaction will be returned. This field doesn't utilize the server side filtering
/// so it should be used alongside some non-probabilistic filters if possible.
#[serde(default)]
pub contract_address_filter: Option<FilterWrapper>,
/// If transaction.hash matches any of these values the transaction will be returned.
/// empty means match all.
#[serde(default)]
pub hash: Vec<Hash>,
}
#[derive(Default, Serialize, Deserialize, Clone, Debug)]
pub struct TraceSelection {
#[serde(default)]
pub from: Vec<Address>,
#[serde(default)]
pub from_filter: Option<FilterWrapper>,
#[serde(default)]
pub to: Vec<Address>,
#[serde(default)]
pub to_filter: Option<FilterWrapper>,
#[serde(default)]
pub address: Vec<Address>,
#[serde(default)]
pub address_filter: Option<FilterWrapper>,
#[serde(default)]
pub call_type: Vec<String>,
#[serde(default)]
pub reward_type: Vec<String>,
#[serde(default)]
#[serde(rename = "type")]
pub kind: Vec<String>,
#[serde(default)]
pub sighash: Vec<Sighash>,
}
#[derive(Default, Serialize, Deserialize, Clone, Debug)]
pub struct Query {
/// The block to start the query from
pub from_block: u64,
/// The block to end the query at. If not specified, the query will go until the
/// end of data. Exclusive, the returned range will be [from_block..to_block).
///
/// The query will return before it reaches this target block if it hits the time limit
/// configured on the server. The user should continue their query by putting the
/// next_block field in the response into from_block field of their next query. This implements
/// pagination.
pub to_block: Option<u64>,
/// List of log selections, these have an OR relationship between them, so the query will return logs
/// that match any of these selections.
#[serde(default)]
pub logs: Vec<LogSelection>,
/// List of transaction selections, the query will return transactions that match any of these selections
#[serde(default)]
pub transactions: Vec<TransactionSelection>,
/// List of trace selections, the query will return traces that match any of these selections
#[serde(default)]
pub traces: Vec<TraceSelection>,
/// List of block selections, the query will return blocks that match any of these selections
#[serde(default)]
pub blocks: Vec<BlockSelection>,
/// Weather to include all blocks regardless of if they are related to a returned transaction or log. Normally
/// the server will return only the blocks that are related to the transaction or logs in the response. But if this
/// is set to true, the server will return data for all blocks in the requested range [from_block, to_block).
#[serde(default)]
pub include_all_blocks: bool,
/// Field selection. The user can select which fields they are interested in, requesting less fields will improve
/// query execution time and reduce the payload size so the user should always use a minimal number of fields.
#[serde(default)]
pub field_selection: FieldSelection,
/// Maximum number of blocks that should be returned, the server might return more blocks than this number but
/// it won't overshoot by too much.
#[serde(default)]
pub max_num_blocks: Option<usize>,
/// Maximum number of transactions that should be returned, the server might return more transactions than this number but
/// it won't overshoot by too much.
#[serde(default)]
pub max_num_transactions: Option<usize>,
/// Maximum number of logs that should be returned, the server might return more logs than this number but
/// it won't overshoot by too much.
#[serde(default)]
pub max_num_logs: Option<usize>,
/// Maximum number of traces that should be returned, the server might return more traces than this number but
/// it won't overshoot by too much.
#[serde(default)]
pub max_num_traces: Option<usize>,
/// Selects join mode for the query,
/// Default: join in this order logs -> transactions -> traces -> blocks
/// JoinAll: join everything to everything. For example if logSelection matches log0, we get the
/// associated transaction of log0 and then we get associated logs of that transaction as well. Applites similarly
/// to blocks, traces.
/// JoinNothing: join nothing.
#[serde(default)]
pub join_mode: JoinMode,
}
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, Copy)]
pub enum JoinMode {
Default,
JoinAll,
JoinNothing,
}
impl Default for JoinMode {
fn default() -> Self {
Self::Default
}
}
#[derive(Default, Serialize, Deserialize, Clone, Debug)]
pub struct FieldSelection {
#[serde(default)]
pub block: BTreeSet<String>,
#[serde(default)]
pub transaction: BTreeSet<String>,
#[serde(default)]
pub log: BTreeSet<String>,
#[serde(default)]
pub trace: BTreeSet<String>,
}
#[derive(Clone, Copy, Deserialize, Serialize, Debug)]
pub struct ArchiveHeight {
pub height: Option<u64>,
}
#[derive(Clone, Copy, Deserialize, Serialize, Debug)]
pub struct ChainId {
pub chain_id: u64,
}
/// Guard for detecting rollbacks
#[derive(Debug, Clone, Serialize)]
pub struct RollbackGuard {
/// Block number of last block scanned in memory
pub block_number: u64,
/// Block timestamp of last block scanned in memory
pub timestamp: i64,
/// Block hash of last block scanned in memory
pub hash: Hash,
/// Block number of first block scanned in memory
pub first_block_number: u64,
/// Parent hash of first block scanned in memory
pub first_parent_hash: Hash,
}