query.rs 11.4 KB
Newer Older
1
use bitcoin::blockdata::block::Block;
2
use bitcoin::blockdata::transaction::Transaction;
Roman Zeyde's avatar
Roman Zeyde committed
3
use bitcoin::network::serialize::deserialize;
4
use bitcoin::util::hash::Sha256dHash;
5 6 7
use crypto::digest::Digest;
use crypto::sha2::Sha256;
use std::collections::HashMap;
8
use std::sync::{Arc, RwLock};
9

10 11
use app::App;
use index::{compute_script_hash, TxInRow, TxOutRow, TxRow};
12
use mempool::Tracker;
13
use store::{ReadStore, Row};
14
use util::{FullHash, HashPrefix, HeaderEntry};
15

Roman Zeyde's avatar
Roman Zeyde committed
16
use errors::*;
Roman Zeyde's avatar
Roman Zeyde committed
17

18 19
struct FundingOutput {
    txn_id: Sha256dHash,
20
    height: u32,
21 22
    output_index: usize,
    value: u64,
Roman Zeyde's avatar
Roman Zeyde committed
23 24
}

25 26
struct SpendingInput {
    txn_id: Sha256dHash,
27
    height: u32,
28
    value: u64,
Roman Zeyde's avatar
Roman Zeyde committed
29 30 31
}

pub struct Status {
32 33 34 35 36
    confirmed: (Vec<FundingOutput>, Vec<SpendingInput>),
    mempool: (Vec<FundingOutput>, Vec<SpendingInput>),
}

fn calc_balance((funding, spending): &(Vec<FundingOutput>, Vec<SpendingInput>)) -> u64 {
Roman Zeyde's avatar
Roman Zeyde committed
37 38 39
    let funded_values = funding.iter().map(|output| output.value);
    let spent_values = spending.iter().map(|input| input.value);
    funded_values.sum::<u64>() - spent_values.sum::<u64>()
Roman Zeyde's avatar
Roman Zeyde committed
40 41
}

42
impl Status {
43 44 45 46 47 48 49 50 51 52 53 54 55 56
    fn funding(&self) -> impl Iterator<Item = &FundingOutput> {
        self.confirmed.0.iter().chain(self.mempool.0.iter())
    }

    fn spending(&self) -> impl Iterator<Item = &SpendingInput> {
        self.confirmed.1.iter().chain(self.mempool.1.iter())
    }

    pub fn confirmed_balance(&self) -> u64 {
        calc_balance(&self.confirmed)
    }

    pub fn mempool_balance(&self) -> u64 {
        calc_balance(&self.mempool)
57 58
    }

59 60
    pub fn history(&self) -> Vec<(i32, Sha256dHash)> {
        let mut txns_map = HashMap::<Sha256dHash, i32>::new();
61
        for f in self.funding() {
62
            txns_map.insert(f.txn_id, f.height as i32);
63
        }
64
        for s in self.spending() {
65
            txns_map.insert(s.txn_id, s.height as i32);
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
        }
        let mut txns: Vec<(i32, Sha256dHash)> =
            txns_map.into_iter().map(|item| (item.1, item.0)).collect();
        txns.sort();
        txns
    }

    pub fn hash(&self) -> Option<FullHash> {
        let txns = self.history();
        if txns.is_empty() {
            None
        } else {
            let mut hash = FullHash::default();
            let mut sha2 = Sha256::new();
            for (height, txn_id) in txns {
                let part = format!("{}:{}:", txn_id.be_hex_string(), height);
                sha2.input(part.as_bytes());
            }
            sha2.result(&mut hash);
            Some(hash)
        }
    }
}

Roman Zeyde's avatar
Roman Zeyde committed
90 91
struct TxnHeight {
    txn: Transaction,
92
    height: u32,
Roman Zeyde's avatar
Roman Zeyde committed
93 94
}

Roman Zeyde's avatar
Roman Zeyde committed
95 96 97 98 99
fn merklize(left: Sha256dHash, right: Sha256dHash) -> Sha256dHash {
    let data = [&left[..], &right[..]].concat();
    Sha256dHash::from_data(&data)
}

100 101 102 103 104 105 106
// TODO: the functions below can be part of ReadStore.
fn txrow_by_txid(store: &ReadStore, txid: &Sha256dHash) -> Option<TxRow> {
    let key = TxRow::filter_full(&txid);
    let value = store.get(&key)?;
    Some(TxRow::from_row(&Row { key, value }))
}

107
fn txrows_by_prefix(store: &ReadStore, txid_prefix: &HashPrefix) -> Vec<TxRow> {
108
    store
109
        .scan(&TxRow::filter_prefix(&txid_prefix))
110 111 112 113
        .iter()
        .map(|row| TxRow::from_row(row))
        .collect()
}
114

115
fn txids_by_script_hash(store: &ReadStore, script_hash: &[u8]) -> Vec<HashPrefix> {
116 117 118 119 120 121
    store
        .scan(&TxOutRow::filter(script_hash))
        .iter()
        .map(|row| TxOutRow::from_row(row).txid_prefix)
        .collect()
}
122

123
fn txids_by_funding_output(
124
    store: &ReadStore,
125 126 127 128 129 130 131 132
    txn_id: &Sha256dHash,
    output_index: usize,
) -> Vec<HashPrefix> {
    store
        .scan(&TxInRow::filter(&txn_id, output_index))
        .iter()
        .map(|row| TxInRow::from_row(row).txid_prefix)
        .collect()
133 134
}

135 136
pub struct Query {
    app: Arc<App>,
137 138 139
    tracker: RwLock<Tracker>,
}

140 141
impl Query {
    pub fn new(app: Arc<App>) -> Query {
142
        Query {
143
            app,
144
            tracker: RwLock::new(Tracker::new()),
145
        }
146 147
    }

148 149 150 151 152
    fn load_txns_by_prefix(
        &self,
        store: &ReadStore,
        prefixes: Vec<HashPrefix>,
    ) -> Result<Vec<TxnHeight>> {
Roman Zeyde's avatar
Roman Zeyde committed
153
        let mut txns = vec![];
154
        for txid_prefix in prefixes {
155
            for tx_row in txrows_by_prefix(store, &txid_prefix) {
156
                let txid: Sha256dHash = deserialize(&tx_row.key.txid).unwrap();
157
                let txn: Transaction = self.load_txn(&txid, Some(tx_row.height))?;
158 159
                txns.push(TxnHeight {
                    txn,
160
                    height: tx_row.height,
161
                })
162 163
            }
        }
164
        Ok(txns)
165 166
    }

167 168 169 170
    fn find_spending_input(
        &self,
        store: &ReadStore,
        funding: &FundingOutput,
171
    ) -> Result<Option<SpendingInput>> {
172
        let spending_txns: Vec<TxnHeight> = self.load_txns_by_prefix(
173
            store,
174
            txids_by_funding_output(store, &funding.txn_id, funding.output_index),
175
        )?;
Roman Zeyde's avatar
Roman Zeyde committed
176
        let mut spending_inputs = vec![];
Roman Zeyde's avatar
Roman Zeyde committed
177
        for t in &spending_txns {
178
            for input in t.txn.input.iter() {
Roman Zeyde's avatar
Roman Zeyde committed
179 180 181 182 183 184
                if input.prev_hash == funding.txn_id
                    && input.prev_index == funding.output_index as u32
                {
                    spending_inputs.push(SpendingInput {
                        txn_id: t.txn.txid(),
                        height: t.height,
185
                        value: funding.value,
Roman Zeyde's avatar
Roman Zeyde committed
186 187 188 189 190
                    })
                }
            }
        }
        assert!(spending_inputs.len() <= 1);
191
        Ok(if spending_inputs.len() == 1 {
Roman Zeyde's avatar
Roman Zeyde committed
192
            Some(spending_inputs.remove(0))
193 194
        } else {
            None
195
        })
196 197
    }

198
    fn find_funding_outputs(&self, t: &TxnHeight, script_hash: &[u8]) -> Vec<FundingOutput> {
Roman Zeyde's avatar
Roman Zeyde committed
199
        let mut result = vec![];
200
        let txn_id = t.txn.txid();
Roman Zeyde's avatar
Roman Zeyde committed
201
        for (index, output) in t.txn.output.iter().enumerate() {
202 203 204 205 206 207 208 209 210 211 212 213
            if compute_script_hash(&output.script_pubkey[..]) == script_hash {
                result.push(FundingOutput {
                    txn_id: txn_id,
                    height: t.height,
                    output_index: index,
                    value: output.value,
                })
            }
        }
        result
    }

214 215 216 217
    fn confirmed_status(
        &self,
        script_hash: &[u8],
    ) -> Result<(Vec<FundingOutput>, Vec<SpendingInput>)> {
218 219
        let mut funding = vec![];
        let mut spending = vec![];
220
        for t in self.load_txns_by_prefix(
221 222
            self.app.read_store(),
            txids_by_script_hash(self.app.read_store(), script_hash),
223
        )? {
224
            funding.extend(self.find_funding_outputs(&t, script_hash));
225
        }
226
        for funding_output in &funding {
227
            if let Some(spent) = self.find_spending_input(self.app.read_store(), &funding_output)? {
228
                spending.push(spent);
229 230
            }
        }
231
        Ok((funding, spending))
232 233
    }

234 235 236 237
    fn mempool_status(
        &self,
        script_hash: &[u8],
        confirmed_funding: &[FundingOutput],
238
    ) -> Result<(Vec<FundingOutput>, Vec<SpendingInput>)> {
239 240
        let mut funding = vec![];
        let mut spending = vec![];
241
        let tracker = self.tracker.read().unwrap();
242
        for t in self.load_txns_by_prefix(
243 244
            tracker.index(),
            txids_by_script_hash(tracker.index(), script_hash),
245
        )? {
246
            funding.extend(self.find_funding_outputs(&t, script_hash));
247
        }
248
        // // TODO: dedup outputs (somehow) both confirmed and in mempool (e.g. reorg?)
249
        for funding_output in funding.iter().chain(confirmed_funding.iter()) {
250
            if let Some(spent) = self.find_spending_input(tracker.index(), &funding_output)? {
251
                spending.push(spent);
Roman Zeyde's avatar
Roman Zeyde committed
252 253
            }
        }
254
        Ok((funding, spending))
255
    }
256

257
    pub fn status(&self, script_hash: &[u8]) -> Result<Status> {
258 259 260 261
        let confirmed = self.confirmed_status(script_hash)
            .chain_err(|| "failed to get confirmed status")?;
        let mempool = self.mempool_status(script_hash, &confirmed.0)
            .chain_err(|| "failed to get mempool status")?;
262
        Ok(Status { confirmed, mempool })
263 264
    }

265 266 267 268 269
    pub fn load_txn(
        &self,
        tx_hash: &Sha256dHash,
        block_height: Option<u32>,
    ) -> Result<Transaction> {
270
        if let Some(txn) = self.tracker.read().unwrap().get_txn(&tx_hash) {
271
            return Ok(txn); // found in mempool (as unconfirmed transaction)
272
        }
273 274 275 276 277 278 279 280
        let height = match block_height {
            Some(height) => height,
            None => {
                // Lookup in confirmed transactions' index
                txrow_by_txid(self.app.read_store(), &tx_hash)
                    .chain_err(|| format!("not indexed tx {}", tx_hash))?
                    .height
            }
281
        };
282 283 284 285 286 287
        let blockhash = *self.app
            .index()
            .get_header(height as usize)
            .chain_err(|| format!("missing header at height {}", height))?
            .hash();
        self.app.daemon().gettransaction(tx_hash, Some(blockhash))
288
    }
289

290 291 292 293 294 295
    pub fn get_headers(&self, heights: &[usize]) -> Vec<HeaderEntry> {
        let index = self.app.index();
        heights
            .iter()
            .filter_map(|height| index.get_header(*height))
            .collect()
296
    }
Roman Zeyde's avatar
Roman Zeyde committed
297

298
    pub fn get_best_header(&self) -> Result<HeaderEntry> {
299
        let last_header = self.app.index().best_header();
300
        Ok(last_header.chain_err(|| "no headers indexed")?.clone())
Roman Zeyde's avatar
Roman Zeyde committed
301
    }
Roman Zeyde's avatar
Roman Zeyde committed
302 303 304 305 306

    pub fn get_merkle_proof(
        &self,
        tx_hash: &Sha256dHash,
        height: usize,
307
    ) -> Result<(Vec<Sha256dHash>, usize)> {
308 309 310 311 312
        let header_entry = self.app
            .index()
            .get_header(height)
            .chain_err(|| format!("missing block #{}", height))?;
        let block: Block = self.app.daemon().getblock(&header_entry.hash())?;
Roman Zeyde's avatar
Roman Zeyde committed
313
        let mut txids: Vec<Sha256dHash> = block.txdata.iter().map(|tx| tx.txid()).collect();
314 315 316 317
        let pos = txids
            .iter()
            .position(|txid| txid == tx_hash)
            .chain_err(|| format!("missing txid {}", tx_hash))?;
Roman Zeyde's avatar
Roman Zeyde committed
318
        let mut merkle = vec![];
Roman Zeyde's avatar
Roman Zeyde committed
319 320 321 322 323 324 325 326 327 328 329 330 331 332
        let mut index = pos;
        while txids.len() > 1 {
            if txids.len() % 2 != 0 {
                let last = txids.last().unwrap().clone();
                txids.push(last);
            }
            index = if index % 2 == 0 { index + 1 } else { index - 1 };
            merkle.push(txids[index]);
            index = index / 2;
            txids = txids
                .chunks(2)
                .map(|pair| merklize(pair[0], pair[1]))
                .collect()
        }
333
        Ok((merkle, pos))
Roman Zeyde's avatar
Roman Zeyde committed
334
    }
335

336
    pub fn broadcast(&self, txn: &Transaction) -> Result<Sha256dHash> {
337
        self.app.daemon().broadcast(txn)
338 339
    }

Roman Zeyde's avatar
Roman Zeyde committed
340
    pub fn update_mempool(&self) -> Result<()> {
Roman Zeyde's avatar
Roman Zeyde committed
341
        self.tracker.write().unwrap().update(self.app.daemon())
342
    }
343

344
    /// Returns [vsize, fee_rate] pairs (measured in vbytes and satoshis).
345
    pub fn get_fee_histogram(&self) -> Vec<(f32, u32)> {
346 347 348
        self.tracker.read().unwrap().fee_histogram().clone()
    }

349 350 351 352 353 354 355 356 357 358 359 360 361
    // Fee rate [BTC/kB] to be confirmed in `blocks` from now.
    pub fn estimate_fee(&self, blocks: usize) -> f32 {
        let mut total_vsize = 0u32;
        let mut last_fee_rate = 0.0;
        let blocks_in_vbytes = (blocks * 1_000_000) as u32; // assume ~1MB blocks
        for (fee_rate, vsize) in self.tracker.read().unwrap().fee_histogram() {
            last_fee_rate = *fee_rate;
            total_vsize += vsize;
            if total_vsize >= blocks_in_vbytes {
                break; // under-estimate the fee rate a bit
            }
        }
        last_fee_rate * 1e-5 // [BTC/kB] = 10^5 [sat/B]
362
    }
363
}