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
/
teos.carrier.html
344 lines (219 loc) · 16.4 KB
/
teos.carrier.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
<!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.carrier — 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.chain_monitor" href="teos.chain_monitor.html" />
<link rel="prev" title="teos.builder" href="teos.builder.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"><a class="reference internal" href="teos.block_processor.html">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 current"><a class="current reference internal" href="#">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.carrier</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/teos.carrier.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.carrier">
<span id="teos-carrier"></span><h1>teos.carrier<a class="headerlink" href="#module-teos.carrier" title="Permalink to this headline">¶</a></h1>
<dl class="py class">
<dt id="teos.carrier.Carrier">
<em class="property">class </em><code class="sig-name descname">Carrier</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/carrier.html#Carrier"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.carrier.Carrier" 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.carrier.Carrier" title="teos.carrier.Carrier"><code class="xref py py-class docutils literal notranslate"><span class="pre">Carrier</span></code></a> is in charge of interacting with <code class="docutils literal notranslate"><span class="pre">bitcoind</span></code> to send/get transactions. It uses <a class="reference internal" href="#teos.carrier.Receipt" title="teos.carrier.Receipt"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Receipt</span></code></a>
objects to report about the sending outcome.</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.carrier.Carrier.logger">
<code class="sig-name descname">logger</code><a class="headerlink" href="#teos.carrier.Carrier.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 attribute">
<dt id="teos.carrier.Carrier.issued_receipts">
<code class="sig-name descname">issued_receipts</code><a class="headerlink" href="#teos.carrier.Carrier.issued_receipts" title="Permalink to this definition">¶</a></dt>
<dd><p>A dictionary of issued receipts to prevent resending the same transaction over
and over. It should periodically be reset to prevent it from growing unbounded.</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">dict</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.carrier.Carrier.get_transaction">
<code class="sig-name descname">get_transaction</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">txid</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/carrier.html#Carrier.get_transaction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.carrier.Carrier.get_transaction" title="Permalink to this definition">¶</a></dt>
<dd><p>Queries transaction data to <code class="docutils literal notranslate"><span class="pre">bitcoind</span></code> given a transaction id.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>txid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – a 32-byte hex-formatted string representing the transaction id.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A dictionary with the transaction data if the transaction can be found on the
chain. <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code> 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">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.carrier.Carrier.send_transaction">
<code class="sig-name descname">send_transaction</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">rawtx</span></em>, <em class="sig-param"><span class="n">txid</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/carrier.html#Carrier.send_transaction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.carrier.Carrier.send_transaction" title="Permalink to this definition">¶</a></dt>
<dd><p>Tries to send a given raw transaction to the Bitcoin network using <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"><ul class="simple">
<li><p><strong>rawtx</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – a (potentially) signed raw transaction ready to be broadcast.</p></li>
<li><p><strong>txid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the transaction id corresponding to <code class="docutils literal notranslate"><span class="pre">rawtx</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A receipt reporting whether the transaction was successfully delivered or not and why.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#teos.carrier.Receipt" title="teos.carrier.Receipt"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Receipt</span></code></a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="teos.carrier.Receipt">
<em class="property">class </em><code class="sig-name descname">Receipt</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">delivered</span></em>, <em class="sig-param"><span class="n">confirmations</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">reason</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/carrier.html#Receipt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.carrier.Receipt" 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.carrier.Receipt" title="teos.carrier.Receipt"><code class="xref py py-class docutils literal notranslate"><span class="pre">Receipt</span></code></a> class represent the interaction between the <a class="reference internal" href="#teos.carrier.Carrier" title="teos.carrier.Carrier"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Carrier</span></code></a> and <code class="docutils literal notranslate"><span class="pre">bitcoind</span></code> when broadcasting
transactions. It is used to signal whether or not a transaction has been successfully broadcast and why.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>delivered</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code>) – whether or not the transaction has been successfully broadcast.</p></li>
<li><p><strong>confirmations</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code>) – the number of confirmations of the transaction to broadcast. In certain situations
the <a class="reference internal" href="#teos.carrier.Carrier" title="teos.carrier.Carrier"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Carrier</span></code></a> may fail to broadcast a transaction because it was already in the blockchain.
This attribute signals those situations.</p></li>
<li><p><strong>reason</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code>) – an error code describing why the transaction broadcast failed.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A receipt describing whether or not the transaction was delivered. Notice that transactions
that are already on chain are flagged as delivered with a <code class="docutils literal notranslate"><span class="pre">confirmations</span> <span class="pre">></span> <span class="pre">0</span></code> whereas new transactions are so
with <code class="docutils literal notranslate"><span class="pre">confirmations</span> <span class="pre">=</span> <span class="pre">0</span></code>.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#teos.carrier.Receipt" title="teos.carrier.Receipt"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Receipt</span></code></a></p>
</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="teos.chain_monitor.html" class="btn btn-neutral float-right" title="teos.chain_monitor" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="teos.builder.html" class="btn btn-neutral float-left" title="teos.builder" 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>