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.extended_appointment.html
303 lines (181 loc) · 13.9 KB
/
teos.extended_appointment.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
<!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.extended_appointment — 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.gatekeeper" href="teos.gatekeeper.html" />
<link rel="prev" title="teos.cleaner" href="teos.cleaner.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"><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 current"><a class="current reference internal" href="#">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.extended_appointment</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/teos.extended_appointment.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.extended_appointment">
<span id="teos-extended-appointment"></span><h1>teos.extended_appointment<a class="headerlink" href="#module-teos.extended_appointment" title="Permalink to this headline">¶</a></h1>
<dl class="py class">
<dt id="teos.extended_appointment.ExtendedAppointment">
<em class="property">class </em><code class="sig-name descname">ExtendedAppointment</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">locator</span></em>, <em class="sig-param"><span class="n">encrypted_blob</span></em>, <em class="sig-param"><span class="n">to_self_delay</span></em>, <em class="sig-param"><span class="n">user_id</span></em>, <em class="sig-param"><span class="n">user_signature</span></em>, <em class="sig-param"><span class="n">start_block</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/extended_appointment.html#ExtendedAppointment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.extended_appointment.ExtendedAppointment" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="common.appointment.html#common.appointment.Appointment" title="common.appointment.Appointment"><code class="xref py py-class docutils literal notranslate"><span class="pre">common.appointment.Appointment</span></code></a></p>
<p>The <a class="reference internal" href="#teos.extended_appointment.ExtendedAppointment" title="teos.extended_appointment.ExtendedAppointment"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExtendedAppointment</span></code></a> contains extended information about an appointment between a user and the tower.</p>
<p>It extends the <a class="reference internal" href="common.appointment.html#common.appointment.Appointment" title="common.appointment.Appointment"><code class="xref py py-class docutils literal notranslate"><span class="pre">Appointment</span></code></a> with information relevant to the tower, such
as the <code class="docutils literal notranslate"><span class="pre">user_id</span></code>, <code class="docutils literal notranslate"><span class="pre">user_signature</span></code> and <code class="docutils literal notranslate"><span class="pre">start_block</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>locator</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – A 16-byte hex-encoded value used by the tower to detect channel breaches. It serves as a
trigger for the tower to decrypt and broadcast the penalty transaction.</p></li>
<li><p><strong>encrypted_blob</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – An encrypted blob of data containing a penalty transaction. The tower will decrypt
it and broadcast the penalty transaction upon seeing a breach on the blockchain.</p></li>
<li><p><strong>to_self_delay</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code>) – The <code class="docutils literal notranslate"><span class="pre">to_self_delay</span></code> encoded in the <code class="docutils literal notranslate"><span class="pre">csv</span></code> of the <code class="docutils literal notranslate"><span class="pre">to_remote</span></code> output of the
commitment transaction that this appointment is covering.</p></li>
<li><p><strong>user_id</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the public key that identifies the user (33-bytes hex str).</p></li>
<li><p><strong>user_signature</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the signature of the appointment by the user.</p></li>
<li><p><strong>start_block</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the block height at where the towers started watching for this appointment.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt id="teos.extended_appointment.ExtendedAppointment.from_dict">
<em class="property">classmethod </em><code class="sig-name descname">from_dict</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">appointment_data</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/extended_appointment.html#ExtendedAppointment.from_dict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.extended_appointment.ExtendedAppointment.from_dict" title="Permalink to this definition">¶</a></dt>
<dd><p>Builds an appointment from a dictionary.</p>
<p>This method is useful to load data from a database.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>appointment_data</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – a dictionary containing the following keys:
<code class="docutils literal notranslate"><span class="pre">{locator,</span> <span class="pre">to_self_delay,</span> <span class="pre">encrypted_blob,</span> <span class="pre">user_id}</span></code></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>An appointment initialized
using the provided data.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#teos.extended_appointment.ExtendedAppointment" title="teos.extended_appointment.ExtendedAppointment"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ExtendedAppointment</span></code></a></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p><strong>ValueError</strong> – If one of the mandatory keys is missing in <code class="docutils literal notranslate"><span class="pre">appointment_data</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.extended_appointment.ExtendedAppointment.get_summary">
<code class="sig-name descname">get_summary</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/extended_appointment.html#ExtendedAppointment.get_summary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.extended_appointment.ExtendedAppointment.get_summary" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the summary of an appointment, consisting on the <code class="docutils literal notranslate"><span class="pre">locator</span></code>, and the <code class="docutils literal notranslate"><span class="pre">user_id</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The appointment summary.</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">dict</span></code></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="teos.gatekeeper.html" class="btn btn-neutral float-right" title="teos.gatekeeper" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="teos.cleaner.html" class="btn btn-neutral float-left" title="teos.cleaner" 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>