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
//! Electrum APIs
use std::convert::TryInto;
use bitcoin::consensus::encode::{deserialize, serialize};
use bitcoin::{BlockHeader, Script, Transaction, Txid};
use batch::Batch;
use types::*;
/// API calls exposed by an Electrum client
pub trait ElectrumApi {
/// Gets the block header for height `height`.
fn block_header(&self, height: usize) -> Result<BlockHeader, Error> {
Ok(deserialize(&self.block_header_raw(height)?)?)
}
/// Subscribes to notifications for new block headers, by sending a `blockchain.headers.subscribe` call.
fn block_headers_subscribe(&self) -> Result<HeaderNotification, Error> {
self.block_headers_subscribe_raw()?.try_into()
}
/// Tries to pop one queued notification for a new block header that we might have received.
/// Returns `None` if there are no items in the queue.
fn block_headers_pop(&self) -> Result<Option<HeaderNotification>, Error> {
self.block_headers_pop_raw()?
.map(|raw| raw.try_into())
.transpose()
}
/// Gets the transaction with `txid`. Returns an error if not found.
fn transaction_get(&self, txid: &Txid) -> Result<Transaction, Error> {
Ok(deserialize(&self.transaction_get_raw(txid)?)?)
}
/// Batch version of [`transaction_get`](#method.transaction_get).
///
/// Takes a list of `txids` and returns a list of transactions.
fn batch_transaction_get<'t, I>(&self, txids: I) -> Result<Vec<Transaction>, Error>
where
I: IntoIterator<Item = &'t Txid> + Clone,
{
self.batch_transaction_get_raw(txids)?
.iter()
.map(|s| Ok(deserialize(s)?))
.collect()
}
/// Batch version of [`block_header`](#method.block_header).
///
/// Takes a list of `heights` of blocks and returns a list of headers.
fn batch_block_header<I>(&self, heights: I) -> Result<Vec<BlockHeader>, Error>
where
I: IntoIterator<Item = u32> + Clone,
{
self.batch_block_header_raw(heights)?
.iter()
.map(|s| Ok(deserialize(s)?))
.collect()
}
/// Broadcasts a transaction to the network.
fn transaction_broadcast(&self, tx: &Transaction) -> Result<Txid, Error> {
let buffer: Vec<u8> = serialize(tx);
self.transaction_broadcast_raw(&buffer)
}
/// Execute a queue of calls stored in a [`Batch`](../batch/struct.Batch.html) struct. Returns
/// `Ok()` **only if** all of the calls are successful. The order of the JSON `Value`s returned
/// reflects the order in which the calls were made on the `Batch` struct.
fn batch_call(&self, batch: &Batch) -> Result<Vec<serde_json::Value>, Error>;
/// Subscribes to notifications for new block headers, by sending a `blockchain.headers.subscribe` call and
/// returns the current tip as raw bytes instead of deserializing them.
fn block_headers_subscribe_raw(&self) -> Result<RawHeaderNotification, Error>;
/// Tries to pop one queued notification for a new block header that we might have received.
/// Returns a the header in raw bytes if a notification is found in the queue, None otherwise.
fn block_headers_pop_raw(&self) -> Result<Option<RawHeaderNotification>, Error>;
/// Gets the raw bytes of block header for height `height`.
fn block_header_raw(&self, height: usize) -> Result<Vec<u8>, Error>;
/// Tries to fetch `count` block headers starting from `start_height`.
fn block_headers(&self, start_height: usize, count: usize) -> Result<GetHeadersRes, Error>;
/// Estimates the fee required in **Satoshis per kilobyte** to confirm a transaction in `number` blocks.
fn estimate_fee(&self, number: usize) -> Result<f64, Error>;
/// Returns the minimum accepted fee by the server's node in **Bitcoin, not Satoshi**.
fn relay_fee(&self) -> Result<f64, Error>;
/// Subscribes to notifications for activity on a specific *scriptPubKey*.
///
/// Returns a [`ScriptStatus`](../types/type.ScriptStatus.html) when successful that represents
/// the current status for the requested script.
///
/// Returns [`Error::AlreadySubscribed`](../types/enum.Error.html#variant.AlreadySubscribed) if
/// already subscribed to the script.
fn script_subscribe(&self, script: &Script) -> Result<Option<ScriptStatus>, Error>;
/// Subscribes to notifications for activity on a specific *scriptPubKey*.
///
/// Returns a `bool` with the server response when successful.
///
/// Returns [`Error::NotSubscribed`](../types/enum.Error.html#variant.NotSubscribed) if
/// not subscribed to the script.
fn script_unsubscribe(&self, script: &Script) -> Result<bool, Error>;
/// Tries to pop one queued notification for a the requested script. Returns `None` if there are no items in the queue.
fn script_pop(&self, script: &Script) -> Result<Option<ScriptStatus>, Error>;
/// Returns the balance for a *scriptPubKey*.
fn script_get_balance(&self, script: &Script) -> Result<GetBalanceRes, Error>;
/// Batch version of [`script_get_balance`](#method.script_get_balance).
///
/// Takes a list of scripts and returns a list of balance responses.
fn batch_script_get_balance<'s, I>(&self, scripts: I) -> Result<Vec<GetBalanceRes>, Error>
where
I: IntoIterator<Item = &'s Script> + Clone;
/// Returns the history for a *scriptPubKey*
fn script_get_history(&self, script: &Script) -> Result<Vec<GetHistoryRes>, Error>;
/// Batch version of [`script_get_history`](#method.script_get_history).
///
/// Takes a list of scripts and returns a list of history responses.
fn batch_script_get_history<'s, I>(&self, scripts: I) -> Result<Vec<Vec<GetHistoryRes>>, Error>
where
I: IntoIterator<Item = &'s Script> + Clone;
/// Returns the list of unspent outputs for a *scriptPubKey*
fn script_list_unspent(&self, script: &Script) -> Result<Vec<ListUnspentRes>, Error>;
/// Batch version of [`script_list_unspent`](#method.script_list_unspent).
///
/// Takes a list of scripts and returns a list of a list of utxos.
fn batch_script_list_unspent<'s, I>(
&self,
scripts: I,
) -> Result<Vec<Vec<ListUnspentRes>>, Error>
where
I: IntoIterator<Item = &'s Script> + Clone;
/// Gets the raw bytes of a transaction with `txid`. Returns an error if not found.
fn transaction_get_raw(&self, txid: &Txid) -> Result<Vec<u8>, Error>;
/// Batch version of [`transaction_get_raw`](#method.transaction_get_raw).
///
/// Takes a list of `txids` and returns a list of transactions raw bytes.
fn batch_transaction_get_raw<'t, I>(&self, txids: I) -> Result<Vec<Vec<u8>>, Error>
where
I: IntoIterator<Item = &'t Txid> + Clone;
/// Batch version of [`block_header_raw`](#method.block_header_raw).
///
/// Takes a list of `heights` of blocks and returns a list of block header raw bytes.
fn batch_block_header_raw<I>(&self, heights: I) -> Result<Vec<Vec<u8>>, Error>
where
I: IntoIterator<Item = u32> + Clone;
/// Batch version of [`estimate_fee`](#method.estimate_fee).
///
/// Takes a list of `numbers` of blocks and returns a list of fee required in
/// **Satoshis per kilobyte** to confirm a transaction in the given number of blocks.
fn batch_estimate_fee<I>(&self, numbers: I) -> Result<Vec<f64>, Error>
where
I: IntoIterator<Item = usize> + Clone;
/// Broadcasts the raw bytes of a transaction to the network.
fn transaction_broadcast_raw(&self, raw_tx: &[u8]) -> Result<Txid, Error>;
/// Returns the merkle path for the transaction `txid` confirmed in the block at `height`.
fn transaction_get_merkle(&self, txid: &Txid, height: usize) -> Result<GetMerkleRes, Error>;
/// Returns the capabilities of the server.
fn server_features(&self) -> Result<ServerFeaturesRes, Error>;
/// Pings the server. This method can also be used as a "dummy" call to trigger the processing
/// of incoming block header or script notifications.
fn ping(&self) -> Result<(), Error>;
#[cfg(feature = "debug-calls")]
/// Returns the number of network calls made since the creation of the client.
fn calls_made(&self) -> Result<usize, Error>;
}