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.api.html
397 lines (269 loc) · 20.6 KB
/
teos.api.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
<!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.api — 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.appointments_dbm" href="teos.appointments_dbm.html" />
<link rel="prev" title="teos.cli.teos_cli" href="teos.cli.teos_cli.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 current"><a class="current reference internal" href="#">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"><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.api</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/teos.api.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.api">
<span id="teos-api"></span><h1>teos.api<a class="headerlink" href="#module-teos.api" title="Permalink to this headline">¶</a></h1>
<dl class="py class">
<dt id="teos.api.API">
<em class="property">class </em><code class="sig-name descname">API</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inspector</span></em>, <em class="sig-param"><span class="n">internal_api_endpoint</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/api.html#API"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.api.API" 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.api.API" title="teos.api.API"><code class="xref py py-class docutils literal notranslate"><span class="pre">API</span></code></a> is in charge of the interface between the user and the tower. It handles and serves user requests.
The API is connected with the <a class="reference internal" href="teos.internal_api.html#teos.internal_api.InternalAPI" title="teos.internal_api.InternalAPI"><code class="xref py py-class docutils literal notranslate"><span class="pre">InternalAPI</span></code></a> via gRPC.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>inspector</strong> (<a class="reference internal" href="teos.inspector.html#teos.inspector.Inspector" title="teos.inspector.Inspector"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Inspector</span></code></a>) – an <code class="xref py py-obj docutils literal notranslate"><span class="pre">Inspector</span></code> instance to check the correctness
of the received appointment data.</p></li>
<li><p><strong>internal_api_endpoint</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the endpoint where the internal api is served.</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt id="teos.api.API.logger">
<code class="sig-name descname">logger</code><a class="headerlink" href="#teos.api.API.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.api.API.app">
<code class="sig-name descname">app</code><a class="headerlink" href="#teos.api.API.app" title="Permalink to this definition">¶</a></dt>
<dd><p>The Flask app of the API server.</p>
</dd></dl>
<dl class="py method">
<dt id="teos.api.API.add_appointment">
<code class="sig-name descname">add_appointment</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/api.html#API.add_appointment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.api.API.add_appointment" title="Permalink to this definition">¶</a></dt>
<dd><p>Main endpoint of the Watchtower.</p>
<p>The client sends requests (appointments) to this endpoint to request a job to the Watchtower. Requests must be
json encoded and contain an <code class="docutils literal notranslate"><span class="pre">appointment</span></code> and <code class="docutils literal notranslate"><span class="pre">signature</span></code> fields.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A tuple containing the response (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) and response code (<code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code>). For accepted
appointments, the <code class="docutils literal notranslate"><span class="pre">rcode</span></code> is always 200 and the response contains the receipt signature (json). For
rejected appointments, the <code class="docutils literal notranslate"><span class="pre">rcode</span></code> contains an application error, and an error message. Error messages can
be found at <code class="docutils literal notranslate"><span class="pre">common.errors</span></code>.</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">tuple</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.api.API.get_appointment">
<code class="sig-name descname">get_appointment</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/api.html#API.get_appointment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.api.API.get_appointment" title="Permalink to this definition">¶</a></dt>
<dd><p>Gives information about a given appointment state in the Watchtower.</p>
<p>The information is requested by <code class="docutils literal notranslate"><span class="pre">locator</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><p>A json formatted dictionary containing information about the requested appointment.</p>
<p>Returns not found if the user does not have the requested appointment or the locator is invalid.</p>
<p>A <code class="docutils literal notranslate"><span class="pre">status</span></code> flag is added to the data provided by either the <a class="reference internal" href="teos.watcher.html#teos.watcher.Watcher" title="teos.watcher.Watcher"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Watcher</span></code></a> or the
<a class="reference internal" href="teos.responder.html#teos.responder.Responder" title="teos.responder.Responder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Responder</span></code></a> that signals the status of the appointment.</p>
<ul class="simple">
<li><p>Appointments hold by the <a class="reference internal" href="teos.watcher.html#teos.watcher.Watcher" title="teos.watcher.Watcher"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Watcher</span></code></a> are flagged as <code class="docutils literal notranslate"><span class="pre">being_watched</span></code>.</p></li>
<li><p>Appointments hold by the <a class="reference internal" href="teos.responder.html#teos.responder.Responder" title="teos.responder.Responder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Responder</span></code></a> are flagged as <code class="docutils literal notranslate"><span class="pre">dispute_triggered</span></code>.</p></li>
<li><p>Unknown appointments are flagged as <code class="docutils literal notranslate"><span class="pre">not_found</span></code>.</p></li>
</ul>
</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></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.api.API.register">
<code class="sig-name descname">register</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/api.html#API.register"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.api.API.register" title="Permalink to this definition">¶</a></dt>
<dd><p>Registers a user by creating a subscription.</p>
<p>Registration is pretty straightforward for now, since it does not require payments.
The amount of slots and expiry of the subscription cannot be requested by the user yet either. This is linked to
the previous point.
Users register by sending a public key to the proper endpoint. This is exploitable atm, but will be solved when
payments are introduced.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A tuple containing the response (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) and response code (<code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code>). For accepted
requests, the <code class="docutils literal notranslate"><span class="pre">rcode</span></code> is always 200 and the response contains a json with the public key and number of
slots in the subscription. For rejected requests, the <code class="docutils literal notranslate"><span class="pre">rcode</span></code> is a 404 and the value contains an
application error, and an error message. Error messages can be found at <code class="docutils literal notranslate"><span class="pre">common.errors</span></code>.</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">tuple</span></code></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt id="teos.api.get_remote_addr">
<code class="sig-name descname">get_remote_addr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/api.html#get_remote_addr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.api.get_remote_addr" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the remote client ip address. The <code class="docutils literal notranslate"><span class="pre">HTTP_X_REAL_IP</span></code> field is tried first in case the server is behind a
reverse proxy.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The IP address of the client.</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></p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="teos.api.get_request_data_json">
<code class="sig-name descname">get_request_data_json</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/api.html#get_request_data_json"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.api.get_request_data_json" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the content of a json <code class="docutils literal notranslate"><span class="pre">POST</span></code> request and makes sure it decodes to a dictionary.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>request</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Request</span></code>) – the request sent by the user.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The dictionary parsed from the json request.</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="common.exceptions.html#common.exceptions.InvalidParameter" title="common.exceptions.InvalidParameter"><strong>InvalidParameter</strong></a> – if the request is not json encoded or it does not decodes to a dictionary.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="teos.api.serve">
<code class="sig-name descname">serve</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">internal_api_endpoint</span></em>, <em class="sig-param"><span class="n">endpoint</span></em>, <em class="sig-param"><span class="n">min_to_self_delay</span></em>, <em class="sig-param"><span class="n">auto_run</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/api.html#serve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.api.serve" title="Permalink to this definition">¶</a></dt>
<dd><p>Starts the API.</p>
<p>This method can be handled either form an external WSGI (like gunicorn) or by the Flask development server.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>internal_api_endpoint</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – endpoint where the internal api is running (<code class="docutils literal notranslate"><span class="pre">host:port</span></code>).</p></li>
<li><p><strong>endpoint</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – endpoint where the http api will be running (<code class="docutils literal notranslate"><span class="pre">host:port</span></code>).</p></li>
<li><p><strong>min_to_self_delay</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the minimum to_self_delay accepted by the <code class="xref py py-obj docutils literal notranslate"><span class="pre">Inspector</span></code>.</p></li>
<li><p><strong>auto_run</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code>) – whether the server should be started by this process. False if run with an external
WSGI. True is run by Flask.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The application object needed by the WSGI server to run if <code class="docutils literal notranslate"><span class="pre">auto_run</span></code> is False, <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code> otherwise.</p>
</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="teos.appointments_dbm.html" class="btn btn-neutral float-right" title="teos.appointments_dbm" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="teos.cli.teos_cli.html" class="btn btn-neutral float-left" title="teos.cli.teos_cli" 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>