rpc.rs 13.5 KB
Newer Older
Roman Zeyde's avatar
Roman Zeyde committed
1
use bitcoin::blockdata::block::BlockHeader;
2 3
use bitcoin::blockdata::transaction::Transaction;
use bitcoin::network::serialize::{deserialize, serialize};
4
use bitcoin::util::hash::Sha256dHash;
5 6 7
use crossbeam;
use crypto::digest::Digest;
use crypto::sha2::Sha256;
8
use hex;
9
use itertools;
Roman Zeyde's avatar
WiP  
Roman Zeyde committed
10
use serde_json::{from_str, Number, Value};
Roman Zeyde's avatar
Roman Zeyde committed
11
use std::collections::HashMap;
12
use std::io::{BufRead, BufReader, Write};
13
use std::net::{SocketAddr, TcpListener, TcpStream};
14
use std::sync::mpsc::{sync_channel, Receiver, SyncSender};
Roman Zeyde's avatar
WiP  
Roman Zeyde committed
15

Roman Zeyde's avatar
Roman Zeyde committed
16
use query::{Query, Status};
Roman Zeyde's avatar
Roman Zeyde committed
17
use types::FullHash;
Roman Zeyde's avatar
WiP  
Roman Zeyde committed
18 19 20

error_chain!{}

Roman Zeyde's avatar
Roman Zeyde committed
21
// TODO: Sha256dHash should be a generic hash-container (since script hash is single SHA256)
Roman Zeyde's avatar
Roman Zeyde committed
22 23
fn hash_from_value(val: Option<&Value>) -> Result<Sha256dHash> {
    let script_hash = val.chain_err(|| "missing hash")?;
Roman Zeyde's avatar
Roman Zeyde committed
24 25 26 27 28
    let script_hash = script_hash.as_str().chain_err(|| "non-string hash")?;
    let script_hash = Sha256dHash::from_hex(script_hash).chain_err(|| "non-hex hash")?;
    Ok(script_hash)
}

29 30
fn history_from_status(status: &Status) -> Vec<(i32, Sha256dHash)> {
    let mut txns_map = HashMap::<Sha256dHash, i32>::new();
Roman Zeyde's avatar
Roman Zeyde committed
31 32 33 34 35 36
    for f in &status.funding {
        txns_map.insert(f.txn_id, f.height);
    }
    for s in &status.spending {
        txns_map.insert(s.txn_id, s.height);
    }
37
    let mut txns: Vec<(i32, Sha256dHash)> =
Roman Zeyde's avatar
Roman Zeyde committed
38 39 40 41 42
        txns_map.into_iter().map(|item| (item.1, item.0)).collect();
    txns.sort();
    txns
}

43
fn hash_from_status(status: &Status) -> Value {
Roman Zeyde's avatar
Roman Zeyde committed
44 45
    let txns = history_from_status(status);
    if txns.is_empty() {
46
        return Value::Null;
Roman Zeyde's avatar
Roman Zeyde committed
47 48 49 50 51 52 53 54 55
    }

    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);
56
    Value::String(hex::encode(&hash))
Roman Zeyde's avatar
Roman Zeyde committed
57 58
}

59
fn jsonify_header(header: &BlockHeader, height: usize) -> Value {
Roman Zeyde's avatar
Roman Zeyde committed
60 61 62 63 64 65 66 67 68 69 70
    json!({
        "block_height": height,
        "version": header.version,
        "prev_block_hash": header.prev_blockhash.be_hex_string(),
        "merkle_root": header.merkle_root.be_hex_string(),
        "timestamp": header.time,
        "bits": header.bits,
        "nonce": header.nonce
    })
}

71 72
struct Handler<'a> {
    query: &'a Query<'a>,
73 74
    headers_subscribe: bool,
    status_hashes: HashMap<Sha256dHash, Value>, // ScriptHash -> StatusHash
75 76
}

77
impl<'a> Handler<'a> {
78 79 80 81 82 83 84 85 86
    pub fn new(query: &'a Query) -> Handler<'a> {
        Handler {
            query: query,
            headers_subscribe: false,
            status_hashes: HashMap::new(),
        }
    }

    fn blockchain_headers_subscribe(&mut self) -> Result<Value> {
Roman Zeyde's avatar
Roman Zeyde committed
87 88 89
        let entry = self.query
            .get_best_header()
            .chain_err(|| "no headers found")?;
90 91
        self.headers_subscribe = true;
        Ok(jsonify_header(entry.header(), entry.height()))
92
    }
Roman Zeyde's avatar
WiP  
Roman Zeyde committed
93

94
    fn server_version(&self) -> Result<Value> {
95
        Ok(json!(["RustElectrum 0.1.0", "1.2"]))
96
    }
Roman Zeyde's avatar
WiP  
Roman Zeyde committed
97

98
    fn server_banner(&self) -> Result<Value> {
99
        Ok(json!("Welcome to RustElectrum Server!\n"))
100
    }
Roman Zeyde's avatar
WiP  
Roman Zeyde committed
101

102
    fn server_donation_address(&self) -> Result<Value> {
103
        Ok(Value::Null)
104
    }
Roman Zeyde's avatar
WiP  
Roman Zeyde committed
105

106 107 108
    fn server_peers_subscribe(&self) -> Result<Value> {
        Ok(json!([]))
    }
Roman Zeyde's avatar
WiP  
Roman Zeyde committed
109

110
    fn mempool_get_fee_histogram(&self) -> Result<Value> {
111
        Ok(json!(self.query.get_fee_histogram()))
112
    }
Roman Zeyde's avatar
WiP  
Roman Zeyde committed
113

114 115 116 117 118 119
    fn blockchain_block_get_chunk(&self, params: &[Value]) -> Result<Value> {
        const CHUNK_SIZE: usize = 2016;
        let index = params.get(0).chain_err(|| "missing index")?;
        let index = index.as_u64().chain_err(|| "non-number index")? as usize;
        let heights: Vec<usize> = (0..CHUNK_SIZE).map(|h| index * CHUNK_SIZE + h).collect();
        let headers = self.query.get_headers(&heights);
Roman Zeyde's avatar
Roman Zeyde committed
120 121 122
        let result = itertools::join(
            headers
                .into_iter()
123
                .map(|x| hex::encode(&serialize(&x).unwrap())),
Roman Zeyde's avatar
Roman Zeyde committed
124 125
            "",
        );
126 127 128
        Ok(json!(result))
    }

Roman Zeyde's avatar
Roman Zeyde committed
129 130 131 132
    fn blockchain_block_get_header(&self, params: &[Value]) -> Result<Value> {
        let height = params.get(0).chain_err(|| "missing height")?;
        let height = height.as_u64().chain_err(|| "non-number height")? as usize;
        let headers = self.query.get_headers(&vec![height]);
133
        Ok(json!(jsonify_header(&headers[0], height)))
Roman Zeyde's avatar
Roman Zeyde committed
134 135
    }

136
    fn blockchain_estimatefee(&self, _params: &[Value]) -> Result<Value> {
137
        Ok(json!(-1)) // see mempool_get_fee_histogram() instead.
138
    }
Roman Zeyde's avatar
WiP  
Roman Zeyde committed
139

Roman Zeyde's avatar
Roman Zeyde committed
140
    fn blockchain_relayfee(&self) -> Result<Value> {
141
        Ok(json!(0.0)) // allow sending transactions with any fee.
Roman Zeyde's avatar
Roman Zeyde committed
142 143
    }

144
    fn blockchain_scripthash_subscribe(&mut self, params: &[Value]) -> Result<Value> {
Roman Zeyde's avatar
Roman Zeyde committed
145
        let script_hash = hash_from_value(params.get(0)).chain_err(|| "bad script_hash")?;
Roman Zeyde's avatar
Roman Zeyde committed
146
        let status = self.query.status(&script_hash[..]);
147 148 149
        let result = hash_from_status(&status);
        self.status_hashes.insert(script_hash, result.clone());
        Ok(result)
150
    }
Roman Zeyde's avatar
WiP  
Roman Zeyde committed
151

152
    fn blockchain_scripthash_get_balance(&self, params: &[Value]) -> Result<Value> {
Roman Zeyde's avatar
Roman Zeyde committed
153
        let script_hash = hash_from_value(params.get(0)).chain_err(|| "bad script_hash")?;
Roman Zeyde's avatar
Roman Zeyde committed
154 155
        let status = self.query.status(&script_hash[..]);
        Ok(json!({ "confirmed": status.balance })) // TODO: "unconfirmed"
156
    }
Roman Zeyde's avatar
WiP  
Roman Zeyde committed
157

Roman Zeyde's avatar
Roman Zeyde committed
158
    fn blockchain_scripthash_get_history(&self, params: &[Value]) -> Result<Value> {
Roman Zeyde's avatar
Roman Zeyde committed
159
        let script_hash = hash_from_value(params.get(0)).chain_err(|| "bad script_hash")?;
Roman Zeyde's avatar
Roman Zeyde committed
160 161 162 163 164 165 166
        let status = self.query.status(&script_hash[..]);
        Ok(json!(Value::Array(
            history_from_status(&status)
                .into_iter()
                .map(|item| json!({"height": item.0, "tx_hash": item.1.be_hex_string()}))
                .collect()
        )))
167
    }
Roman Zeyde's avatar
WiP  
Roman Zeyde committed
168

169 170 171 172 173 174 175 176 177 178 179 180
    fn blockchain_transaction_broadcast(&self, params: &[Value]) -> Result<Value> {
        let tx = params.get(0).chain_err(|| "missing tx")?;
        let tx = tx.as_str().chain_err(|| "non-string tx")?;
        let tx = hex::decode(&tx).chain_err(|| "non-hex tx")?;
        let tx: Transaction = deserialize(&tx).chain_err(|| "failed to parse tx")?;
        let txid = self.query
            .daemon()
            .broadcast(&tx)
            .chain_err(|| "broadcast failed")?;
        Ok(json!(txid.be_hex_string()))
    }

181
    fn blockchain_transaction_get(&self, params: &[Value]) -> Result<Value> {
Roman Zeyde's avatar
Roman Zeyde committed
182
        // TODO: handle 'verbose' param
Roman Zeyde's avatar
Roman Zeyde committed
183
        let tx_hash = hash_from_value(params.get(0)).chain_err(|| "bad tx_hash")?;
184 185
        let tx = self.query.get_tx(&tx_hash);
        Ok(json!(hex::encode(&serialize(&tx).unwrap())))
Roman Zeyde's avatar
WiP  
Roman Zeyde committed
186 187
    }

Roman Zeyde's avatar
Roman Zeyde committed
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
    fn blockchain_transaction_get_merkle(&self, params: &[Value]) -> Result<Value> {
        let tx_hash = hash_from_value(params.get(0)).chain_err(|| "bad tx_hash")?;
        let height = params.get(1).chain_err(|| "missing height")?;
        let height = height.as_u64().chain_err(|| "non-number height")? as usize;
        let (merkle, pos) = self.query
            .get_merkle_proof(&tx_hash, height)
            .chain_err(|| "cannot create merkle proof")?;
        let merkle: Vec<String> = merkle
            .into_iter()
            .map(|txid| txid.be_hex_string())
            .collect();
        Ok(json!({
                "block_height": height,
                "merkle": merkle,
                "pos": pos}))
203
    }
Roman Zeyde's avatar
WiP  
Roman Zeyde committed
204

205
    fn handle_command(&mut self, method: &str, params: &[Value], id: &Number) -> Result<Value> {
206 207 208 209 210 211 212
        let result = match method {
            "blockchain.headers.subscribe" => self.blockchain_headers_subscribe(),
            "server.version" => self.server_version(),
            "server.banner" => self.server_banner(),
            "server.donation_address" => self.server_donation_address(),
            "server.peers.subscribe" => self.server_peers_subscribe(),
            "mempool.get_fee_histogram" => self.mempool_get_fee_histogram(),
213
            "blockchain.block.get_chunk" => self.blockchain_block_get_chunk(&params),
Roman Zeyde's avatar
Roman Zeyde committed
214
            "blockchain.block.get_header" => self.blockchain_block_get_header(&params),
215
            "blockchain.estimatefee" => self.blockchain_estimatefee(&params),
Roman Zeyde's avatar
Roman Zeyde committed
216
            "blockchain.relayfee" => self.blockchain_relayfee(),
217 218 219
            "blockchain.scripthash.subscribe" => self.blockchain_scripthash_subscribe(&params),
            "blockchain.scripthash.get_balance" => self.blockchain_scripthash_get_balance(&params),
            "blockchain.scripthash.get_history" => self.blockchain_scripthash_get_history(&params),
220
            "blockchain.transaction.broadcast" => self.blockchain_transaction_broadcast(&params),
221 222 223 224
            "blockchain.transaction.get" => self.blockchain_transaction_get(&params),
            "blockchain.transaction.get_merkle" => self.blockchain_transaction_get_merkle(&params),
            &_ => bail!("unknown method {} {:?}", method, params),
        }?;
Roman Zeyde's avatar
Roman Zeyde committed
225
        Ok(json!({"jsonrpc": "2.0", "id": id, "result": result}))
226 227
    }

Roman Zeyde's avatar
Roman Zeyde committed
228
    fn update_subscriptions(&mut self) -> Result<Vec<Value>> {
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
        let mut result = vec![];
        if self.headers_subscribe {
            let entry = self.query
                .get_best_header()
                .chain_err(|| "no headers found")?;
            let header = jsonify_header(entry.header(), entry.height());
            result.push(json!({
                "jsonrpc": "2.0",
                "method": "blockchain.headers.subscribe",
                "params": [header]}));
        }
        for (script_hash, status_hash) in self.status_hashes.iter_mut() {
            let status = self.query.status(&script_hash[..]);
            let new_status_hash = hash_from_status(&status);
            if new_status_hash == *status_hash {
                continue;
            }
            result.push(json!({
                "jsonrpc": "2.0",
                "method": "blockchain.scripthash.subscribe",
                "params": [script_hash.be_hex_string(), new_status_hash]}));
            *status_hash = new_status_hash;
        }
        Ok(result)
    }

Roman Zeyde's avatar
Roman Zeyde committed
255 256 257 258 259 260 261 262 263 264 265 266
    fn handle_replies(
        &mut self,
        stream: &mut TcpStream,
        addr: SocketAddr,
        chan: &Channel,
    ) -> Result<()> {
        let rx = chan.receiver();
        loop {
            let msg = rx.recv().chain_err(|| "channel closed")?;
            match msg {
                Message::Request(line) => {
                    let cmd: Value = from_str(&line).chain_err(|| "invalid JSON format")?;
267
                    debug!("[{}] -> {}", addr, cmd);
Roman Zeyde's avatar
Roman Zeyde committed
268 269 270 271 272 273 274 275
                    let reply = match (cmd.get("method"), cmd.get("params"), cmd.get("id")) {
                        (
                            Some(&Value::String(ref method)),
                            Some(&Value::Array(ref params)),
                            Some(&Value::Number(ref id)),
                        ) => self.handle_command(method, params, id)?,
                        _ => bail!("invalid command: {}", cmd),
                    };
276
                    debug!("[{}] <- {}", addr, reply);
Roman Zeyde's avatar
Roman Zeyde committed
277 278 279 280
                    let line = reply.to_string() + "\n";
                    stream
                        .write_all(line.as_bytes())
                        .chain_err(|| "failed to send response")?;
281
                }
Roman Zeyde's avatar
Roman Zeyde committed
282 283 284 285 286 287 288
                Message::Block(blockhash) => {
                    debug!("blockhash found: {}", blockhash);
                    for update in self.update_subscriptions()
                        .chain_err(|| "failed to get updates")?
                    {
                        debug!("update: {}", update);
                        let line = update.to_string() + "\n";
289 290
                        stream
                            .write_all(line.as_bytes())
Roman Zeyde's avatar
Roman Zeyde committed
291
                            .chain_err(|| "failed to send update")?;
292
                    }
Roman Zeyde's avatar
Roman Zeyde committed
293 294 295 296
                }
                Message::Done => {
                    debug!("done");
                    break;
297
                }
298
            }
Roman Zeyde's avatar
Roman Zeyde committed
299 300 301 302
        }
        Ok(())
    }

303
    fn handle_requests(mut reader: BufReader<TcpStream>, tx: SyncSender<Message>) {
Roman Zeyde's avatar
Roman Zeyde committed
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
        loop {
            let mut line = String::new();
            reader
                .read_line(&mut line)  // TODO: use .lines() iterator
                .expect("failed to read a request");
            if line.is_empty() {
                tx.send(Message::Done).expect("channel closed");
                break;
            } else {
                tx.send(Message::Request(line)).expect("channel closed");
            }
        }
    }

    pub fn run(mut self, mut stream: TcpStream, addr: SocketAddr, chan: &Channel) {
        let reader = BufReader::new(stream.try_clone().expect("failed to clone TcpStream"));
320
        // TODO: figure out graceful shutting down and error logging.
Roman Zeyde's avatar
Roman Zeyde committed
321 322
        crossbeam::scope(|scope| {
            let tx = chan.sender();
323 324
            scope.spawn(|| Handler::handle_requests(reader, tx));
            self.handle_replies(&mut stream, addr, chan).unwrap();
Roman Zeyde's avatar
Roman Zeyde committed
325
        });
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
    }
}

pub enum Message {
    Request(String),
    Block(Sha256dHash),
    Done,
}

pub struct Channel {
    tx: SyncSender<Message>,
    rx: Receiver<Message>,
}

impl Channel {
    pub fn new() -> Channel {
342
        let (tx, rx) = sync_channel(10);
343 344 345 346 347 348 349 350 351
        Channel { tx, rx }
    }

    pub fn sender(&self) -> SyncSender<Message> {
        self.tx.clone()
    }

    pub fn receiver(&self) -> &Receiver<Message> {
        &self.rx
Roman Zeyde's avatar
WiP  
Roman Zeyde committed
352 353 354
    }
}

Roman Zeyde's avatar
Roman Zeyde committed
355
pub fn serve(addr: &str, query: &Query, chan: Channel) {
356 357
    let listener = TcpListener::bind(addr).unwrap();
    info!("RPC server running on {}", addr);
Roman Zeyde's avatar
WiP  
Roman Zeyde committed
358 359 360
    loop {
        let (stream, addr) = listener.accept().unwrap();
        info!("[{}] connected peer", addr);
Roman Zeyde's avatar
Roman Zeyde committed
361 362 363 364
        Handler::new(query).run(stream, addr, &chan);
        info!("[{}] disconnected peer", addr);
    }
}