This repository has been archived by the owner on Sep 26, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathteos.block_processor.html
427 lines (297 loc) · 22.2 KB
/
teos.block_processor.html
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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>teos.block_processor — pyton-teos documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="teos.builder" href="teos.builder.html" />
<link rel="prev" title="teos.appointments_dbm" href="teos.appointments_dbm.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home" alt="Documentation Home"> pyton-teos
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="teos.html">teos package</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="teos.html#subpackages">Subpackages</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="teos.html#submodules">Submodules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="teos.api.html">teos.api</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.appointments_dbm.html">teos.appointments_dbm</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">teos.block_processor</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.builder.html">teos.builder</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.carrier.html">teos.carrier</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.chain_monitor.html">teos.chain_monitor</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.cleaner.html">teos.cleaner</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.extended_appointment.html">teos.extended_appointment</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.gatekeeper.html">teos.gatekeeper</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.inspector.html">teos.inspector</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.internal_api.html">teos.internal_api</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.lightning_server.html">teos.lightning_server</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.logger.html">teos.logger</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.responder.html">teos.responder</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.rpc.html">teos.rpc</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.teosd.html">teos.teosd</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.tools.html">teos.tools</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.users_dbm.html">teos.users_dbm</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.watcher.html">teos.watcher</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="common.html">common package</a></li>
<li class="toctree-l1"><a class="reference internal" href="contrib.html">contrib package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">pyton-teos</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li><a href="teos.html">teos package</a> »</li>
<li>teos.block_processor</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/teos.block_processor.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-teos.block_processor">
<span id="teos-block-processor"></span><h1>teos.block_processor<a class="headerlink" href="#module-teos.block_processor" title="Permalink to this headline">¶</a></h1>
<dl class="py class">
<dt id="teos.block_processor.BlockProcessor">
<em class="property">class </em><code class="sig-name descname">BlockProcessor</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">btc_connect_params</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/block_processor.html#BlockProcessor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.block_processor.BlockProcessor" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>The <a class="reference internal" href="#teos.block_processor.BlockProcessor" title="teos.block_processor.BlockProcessor"><code class="xref py py-class docutils literal notranslate"><span class="pre">BlockProcessor</span></code></a> contains methods related to the blockchain. Most of its methods require communication
with <code class="docutils literal notranslate"><span class="pre">bitcoind</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>btc_connect_params</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – a dictionary with the parameters to connect to bitcoind
(<code class="docutils literal notranslate"><span class="pre">rpc</span> <span class="pre">user,</span> <span class="pre">rpc</span> <span class="pre">password,</span> <span class="pre">host</span> <span class="pre">and</span> <span class="pre">port</span></code>).</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="teos.block_processor.BlockProcessor.logger">
<code class="sig-name descname">logger</code><a class="headerlink" href="#teos.block_processor.BlockProcessor.logger" title="Permalink to this definition">¶</a></dt>
<dd><p>the logger for this component.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Logger</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.block_processor.BlockProcessor.decode_raw_transaction">
<code class="sig-name descname">decode_raw_transaction</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">raw_tx</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/block_processor.html#BlockProcessor.decode_raw_transaction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.block_processor.BlockProcessor.decode_raw_transaction" title="Permalink to this definition">¶</a></dt>
<dd><p>Deserializes a given raw transaction (hex encoded) and builds a dictionary representing it with all the
associated metadata given by <code class="docutils literal notranslate"><span class="pre">bitcoind</span></code> (e.g. confirmation count).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>raw_tx</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the hex representation of the transaction.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The decoding of the given <code class="docutils literal notranslate"><span class="pre">raw_tx</span></code> if the transaction is well formatted.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p><a class="reference internal" href="#teos.block_processor.InvalidTransactionFormat" title="teos.block_processor.InvalidTransactionFormat"><strong>InvalidTransactionFormat</strong></a> – If the <cite>provided ``raw_tx`</cite> has invalid format.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.block_processor.BlockProcessor.find_last_common_ancestor">
<code class="sig-name descname">find_last_common_ancestor</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">last_known_block_hash</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/block_processor.html#BlockProcessor.find_last_common_ancestor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.block_processor.BlockProcessor.find_last_common_ancestor" title="Permalink to this definition">¶</a></dt>
<dd><p>Finds the last common ancestor between the current best chain tip and the last block known by us (older block).</p>
<p>This is useful to recover from a chain fork happening while offline (crash/shutdown).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>last_known_block_hash</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the hash of the last know block.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A tuple (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code>) where the first item contains the hash of the last common
ancestor and the second item contains the list of transactions from <code class="docutils literal notranslate"><span class="pre">last_known_block_hash</span></code> to
<code class="docutils literal notranslate"><span class="pre">last_common_ancestor</span></code>.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">tuple</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.block_processor.BlockProcessor.get_best_block_hash">
<code class="sig-name descname">get_best_block_hash</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/block_processor.html#BlockProcessor.get_best_block_hash"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.block_processor.BlockProcessor.get_best_block_hash" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the hash of the current best chain tip.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><p>The hash of the block if it can be found.</p>
<p>Returns <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code> otherwise (not even sure this can actually happen).</p>
</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code> or <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.block_processor.BlockProcessor.get_block">
<code class="sig-name descname">get_block</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">block_hash</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/block_processor.html#BlockProcessor.get_block"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.block_processor.BlockProcessor.get_block" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets a block given a block hash by querying <code class="docutils literal notranslate"><span class="pre">bitcoind</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>block_hash</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the block hash to be queried.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><p>A dictionary containing the requested block data if the block is found.</p>
<p>Returns <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code> otherwise.</p>
</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code> or <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.block_processor.BlockProcessor.get_block_count">
<code class="sig-name descname">get_block_count</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/block_processor.html#BlockProcessor.get_block_count"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.block_processor.BlockProcessor.get_block_count" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the block count of the best chain.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><p>The count of the best chain if it can be computed.</p>
<p>Returns <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code> otherwise (not even sure this can actually happen).</p>
</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code> or <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.block_processor.BlockProcessor.get_distance_to_tip">
<code class="sig-name descname">get_distance_to_tip</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">target_block_hash</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/block_processor.html#BlockProcessor.get_distance_to_tip"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.block_processor.BlockProcessor.get_distance_to_tip" title="Permalink to this definition">¶</a></dt>
<dd><p>Compute the distance between a given block hash and the best chain tip.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>target_block_hash</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the hash of the target block (the one to compute the distance form the tip).</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><p>The distance between the target and the best chain tip is the target block can be
found on the blockchain.</p>
<p>Returns <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code> otherwise.</p>
</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code> or <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.block_processor.BlockProcessor.get_missed_blocks">
<code class="sig-name descname">get_missed_blocks</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">last_know_block_hash</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/block_processor.html#BlockProcessor.get_missed_blocks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.block_processor.BlockProcessor.get_missed_blocks" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the blocks between the current best chain tip and a given block hash (<code class="docutils literal notranslate"><span class="pre">last_know_block_hash</span></code>).</p>
<p>This method is used to fetch all the missed information when recovering from a crash.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>last_know_block_hash</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the hash of the last known block.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A list of blocks between the last given block and the current best chain tip, starting from the
child of <code class="docutils literal notranslate"><span class="pre">last_know_block_hash</span></code>.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.block_processor.BlockProcessor.is_block_in_best_chain">
<code class="sig-name descname">is_block_in_best_chain</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">block_hash</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/block_processor.html#BlockProcessor.is_block_in_best_chain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.block_processor.BlockProcessor.is_block_in_best_chain" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks whether a given block is on the best chain or not. Blocks are identified by block_hash.</p>
<p>A block that is not in the best chain will either not exists (block = None) or have a confirmation count of
-1 (implying that the block was forked out or the chain never grew from that one).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>block_hash</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the hash of the block to be checked.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>True if the block is on the best chain, False otherwise.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p><strong>KeyError</strong> – If the block cannot be found in the blockchain.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py exception">
<dt id="teos.block_processor.InvalidTransactionFormat">
<em class="property">exception </em><code class="sig-name descname">InvalidTransactionFormat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">msg</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/block_processor.html#InvalidTransactionFormat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.block_processor.InvalidTransactionFormat" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="common.exceptions.html#common.exceptions.BasicException" title="common.exceptions.BasicException"><code class="xref py py-class docutils literal notranslate"><span class="pre">common.exceptions.BasicException</span></code></a></p>
<p>Raised when a transaction is not properly formatted.</p>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="teos.builder.html" class="btn btn-neutral float-right" title="teos.builder" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="teos.appointments_dbm.html" class="btn btn-neutral float-left" title="teos.appointments_dbm" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2019, Talaia Labs
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>