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
// Copyright 2020 The Exonum Team // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. //! Types used in the explorer API. //! //! The types are bundled together with the explorer (rather than the explorer service) //! in order to ease dependency management for client apps. use chrono::{DateTime, Utc}; use exonum::{ blockchain::{Block, CallProof}, crypto::Hash, helpers::Height, merkledb::BinaryValue, messages::{Precommit, Verified}, runtime::{AnyTx, CallInfo, ExecutionStatus, InstanceId}, }; use serde_derive::{Deserialize, Serialize}; use std::ops::Range; use crate::median_precommits_time; pub mod websocket; /// The maximum number of blocks to return per blocks request, in this way /// the parameter limits the maximum execution time for such requests. pub const MAX_BLOCKS_PER_REQUEST: usize = 1000; /// Information on blocks coupled with the corresponding range in the blockchain. #[derive(Debug, Serialize, Deserialize, PartialEq)] #[non_exhaustive] pub struct BlocksRange { /// Exclusive range of blocks. pub range: Range<Height>, /// Blocks in the range. pub blocks: Vec<BlockInfo>, } impl BlocksRange { /// Creates a new range of blocks. #[doc(hidden)] // not stabilized; used in the explorer service pub fn new(range: Range<Height>, blocks: Vec<BlockInfo>) -> Self { Self { range, blocks } } } /// Information about a transaction included in the block. #[derive(Debug, PartialEq, Serialize, Deserialize)] #[non_exhaustive] pub struct TxInfo { /// Transaction hash. pub tx_hash: Hash, /// Information to call. pub call_info: CallInfo, } /// Information about a block in the blockchain. #[derive(Debug, PartialEq, Serialize, Deserialize)] #[non_exhaustive] pub struct BlockInfo { /// Block header as recorded in the blockchain. #[serde(flatten)] pub block: Block, /// Precommits authorizing the block. #[serde(skip_serializing_if = "Option::is_none")] pub precommits: Option<Vec<Verified<Precommit>>>, /// Info of transactions in the block. #[serde(skip_serializing_if = "Option::is_none")] pub txs: Option<Vec<TxInfo>>, /// Median time from the block precommits. #[serde(skip_serializing_if = "Option::is_none")] pub time: Option<DateTime<Utc>>, } impl From<crate::BlockInfo<'_>> for BlockInfo { fn from(inner: crate::BlockInfo<'_>) -> Self { Self { block: inner.header().clone(), precommits: Some(inner.precommits().to_vec()), txs: Some( inner .transaction_hashes() .iter() .enumerate() .map(|(idx, &tx_hash)| TxInfo { tx_hash, call_info: inner .transaction(idx) .unwrap() .message() .payload() .call_info .clone(), }) .collect(), ), time: Some(median_precommits_time(&inner.precommits())), } } } impl BlockInfo { /// Creates a summary of the block. #[doc(hidden)] // not stabilized; intended for use in explorer service pub fn summary(block: crate::BlockInfo<'_>, query: &BlocksQuery) -> Self { BlockInfo { txs: None, time: if query.add_blocks_time { Some(median_precommits_time(&block.precommits())) } else { None }, precommits: if query.add_precommits { Some(block.precommits().to_vec()) } else { None }, block: block.into_header(), } } } /// Blocks in range parameters. #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Default)] #[non_exhaustive] pub struct BlocksQuery { /// The number of blocks to return. Should not be greater than `MAX_BLOCKS_PER_REQUEST`. pub count: usize, /// The maximum height of the returned blocks. /// /// The blocks are returned in reverse order, /// starting from the latest and at least up to the `latest - count + 1`. /// The default value is the height of the latest block in the blockchain. pub latest: Option<Height>, /// The minimum height of the returned blocks. The default value is `Height(0)` (the genesis /// block). /// /// Note that `earliest` has the least priority compared to `latest` and `count`; /// it can only truncate the list of otherwise returned blocks if some of them have a lesser /// height. pub earliest: Option<Height>, /// If true, then only non-empty blocks are returned. The default value is false. #[serde(default)] pub skip_empty_blocks: bool, /// If true, then the `time` field in each returned block will contain the median time from the /// block precommits. #[serde(default)] pub add_blocks_time: bool, /// If true, then the `precommits` field in each returned block will contain precommits for the /// block stored by the node. #[serde(default)] pub add_precommits: bool, } /// Block query parameters. #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] #[non_exhaustive] pub struct BlockQuery { /// The height of the desired block. pub height: Height, } impl BlockQuery { /// Creates a new block query with the given height. pub fn new(height: Height) -> Self { Self { height } } } /// Raw transaction in hex representation. #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] #[non_exhaustive] pub struct TransactionHex { /// The hex value of the transaction to be broadcasted. pub tx_body: String, } impl TransactionHex { /// Creates hex representation from the provided transaction. pub fn new(transaction: &Verified<AnyTx>) -> Self { Self { tx_body: hex::encode(transaction.to_bytes()), } } } /// Response to a request to broadcast a transaction over the blockchain network. #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] #[non_exhaustive] pub struct TransactionResponse { /// The hash digest of the transaction. pub tx_hash: Hash, } impl TransactionResponse { /// Creates a response based on provided transaction hash. pub fn new(tx_hash: Hash) -> Self { Self { tx_hash } } } /// Transaction query parameters. #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] #[non_exhaustive] pub struct TransactionQuery { /// The hash of the transaction to be searched. pub hash: Hash, } impl TransactionQuery { /// Creates a new transaction query with the given height. pub fn new(hash: Hash) -> Self { Self { hash } } } /// Query parameters to check the execution status of a transaction. #[derive(Debug, Serialize, Deserialize, Clone)] #[non_exhaustive] pub struct TransactionStatusQuery { /// The hash of the transaction to be searched. pub hash: Hash, /// Whether to return the status with a cryptographic proof of authenticity. #[serde(default)] pub with_proof: bool, } impl TransactionStatusQuery { /// Creates a new query. pub fn new(hash: Hash) -> Self { Self { hash, with_proof: false, } } /// Requests to return a call status with a cryptographic proof of authenticity. pub fn with_proof(mut self) -> Self { self.with_proof = true; self } } /// Query parameters to check the execution status of a `before_transactions` or /// `after_transactions` call. #[derive(Debug, Serialize, Deserialize, Clone)] #[non_exhaustive] pub struct CallStatusQuery { /// Height of a block. pub height: Height, /// Numerical service identifier. pub service_id: InstanceId, /// Whether to return the status with a cryptographic proof of authenticity. #[serde(default)] pub with_proof: bool, } impl CallStatusQuery { /// Creates a new query. pub fn new(height: Height, service_id: InstanceId) -> Self { Self { height, service_id, with_proof: false, } } /// Requests to return a call status with a cryptographic proof of authenticity. pub fn with_proof(mut self) -> Self { self.with_proof = true; self } } /// Call status response. /// /// This enum is serialized in JSON untagged. Hence, if the consumer knows the type of the response, /// she may parse it directly to `ExecutionStatus` or `CallProof`. #[derive(Debug, Serialize, Deserialize, Clone)] #[serde(untagged)] pub enum CallStatusResponse { /// Simple response. Simple(ExecutionStatus), /// Response with a cryptographic proof of authenticity. Proof(CallProof), }