Repository navigation
Expand file tree
/
Copy pathcli.html
More file actions
386 lines (309 loc) · 16.8 KB
/
Copy pathcli.html
File metadata and controls
386 lines (309 loc) · 16.8 KB
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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Command line interface — uniswap-python</title>
<link href="_static/css/theme.css" rel="stylesheet" />
<link href="_static/css/index.c5995385ac14fb8791e8eb36b4908be2.css" rel="stylesheet" />
<link rel="stylesheet"
href="_static/vendor/fontawesome/5.13.0/css/all.min.css">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/sphinx-book-theme.acff12b8f9c144ce68a297486a2fa670.css" type="text/css" />
<link rel="preload" as="script" href="_static/js/index.1c5a1a01449ed65a7b51.js">
<script 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/sphinx-book-theme.12a9622fbb08dcb3a2a40b2c02b83a57.js"></script>
<link rel="shortcut icon" href="_static/favicon.png"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Examples" href="examples.html" />
<link rel="prev" title="API Reference" href="api.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en" />
</head>
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
<div class="container-fluid" id="banner"></div>
<div class="container-xl">
<div class="row">
<div class="col-12 col-md-3 bd-sidebar site-navigation show" id="site-navigation">
<div class="navbar-brand-box">
<a class="navbar-brand text-wrap" href="index.html">
<img src="_static/logo.png" class="logo" alt="logo">
<h1 class="site-logo" id="site-title">uniswap-python</h1>
</a>
</div><form class="bd-search d-flex align-items-center" action="search.html" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
</form><nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
<div class="bd-toc-item active">
<p class="caption">
<span class="caption-text">
Contents:
</span>
</p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1">
<a class="reference internal" href="getting-started.html">
Getting started
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="api.html">
API Reference
</a>
</li>
<li class="toctree-l1 current active">
<a class="current reference internal" href="#">
Command line interface
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="examples.html">
Examples
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="supported-deployments.html">
Supported deployments
</a>
</li>
</ul>
</div>
</nav> <!-- To handle the deprecated key -->
<div class="navbar_extra_footer">
<p>
Back to <a href="https://github.com/shanefontaine/uniswap-python">GitHub</a>
</p>
</div>
</div>
<main class="col py-md-3 pl-md-4 bd-content overflow-auto" role="main">
<div class="topbar container-xl fixed-top">
<div class="topbar-contents row">
<div class="col-12 col-md-3 bd-topbar-whitespace site-navigation show"></div>
<div class="col pl-md-4 topbar-main">
<button id="navbar-toggler" class="navbar-toggler ml-0" type="button" data-toggle="collapse"
data-toggle="tooltip" data-placement="bottom" data-target=".site-navigation" aria-controls="navbar-menu"
aria-expanded="true" aria-label="Toggle navigation" aria-controls="site-navigation"
title="Toggle navigation" data-toggle="tooltip" data-placement="left">
<i class="fas fa-bars"></i>
<i class="fas fa-arrow-left"></i>
<i class="fas fa-arrow-up"></i>
</button>
<div class="dropdown-buttons-trigger">
<button id="dropdown-buttons-trigger" class="btn btn-secondary topbarbtn" aria-label="Download this page"><i
class="fas fa-download"></i></button>
<div class="dropdown-buttons">
<!-- ipynb file if we had a myst markdown file -->
<!-- Download raw file -->
<a class="dropdown-buttons" href="_sources/cli.rst.txt"><button type="button"
class="btn btn-secondary topbarbtn" title="Download source file" data-toggle="tooltip"
data-placement="left">.rst</button></a>
<!-- Download PDF via print -->
<button type="button" id="download-print" class="btn btn-secondary topbarbtn" title="Print to PDF"
onClick="window.print()" data-toggle="tooltip" data-placement="left">.pdf</button>
</div>
</div>
<!-- Source interaction buttons -->
<div class="dropdown-buttons-trigger">
<button id="dropdown-buttons-trigger" class="btn btn-secondary topbarbtn"
aria-label="Connect with source repository"><i class="fab fa-github"></i></button>
<div class="dropdown-buttons sourcebuttons">
<a class="repository-button"
href="https://github.com/shanefontaine/uniswap-python"><button type="button" class="btn btn-secondary topbarbtn"
data-toggle="tooltip" data-placement="left" title="Source repository"><i
class="fab fa-github"></i>repository</button></a>
<a class="edit-button" href="https://github.com/shanefontaine/uniswap-python/edit/master/docs/cli.rst"><button
type="button" class="btn btn-secondary topbarbtn" data-toggle="tooltip" data-placement="left"
title="Edit this page"><i class="fas fa-pencil-alt"></i>suggest edit</button></a>
</div>
</div>
<!-- Full screen (wrap in <a> to have style consistency -->
<a class="full-screen-button"><button type="button" class="btn btn-secondary topbarbtn" data-toggle="tooltip"
data-placement="bottom" onclick="toggleFullScreen()" aria-label="Fullscreen mode"
title="Fullscreen mode"><i
class="fas fa-expand"></i></button></a>
<!-- Launch buttons -->
</div>
<!-- Table of contents -->
<div class="d-none d-md-block col-md-2 bd-toc show">
<div class="tocsection onthispage pt-5 pb-3">
<i class="fas fa-list"></i> Contents
</div>
<nav id="bd-toc-nav">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#example-usage">
Example usage
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#usage">
Usage
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#unipy">
unipy
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
<a class="reference internal nav-link" href="#unipy-price">
price
</a>
</li>
<li class="toc-h4 nav-item toc-entry">
<a class="reference internal nav-link" href="#unipy-token">
token
</a>
</li>
<li class="toc-h4 nav-item toc-entry">
<a class="reference internal nav-link" href="#unipy-tokendb">
tokendb
</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div id="main-content" class="row">
<div class="col-12 col-md-9 pl-md-3 pr-md-0">
<div>
<div class="section" id="command-line-interface">
<h1>Command line interface<a class="headerlink" href="#command-line-interface" title="Permalink to this headline">¶</a></h1>
<p>uniswap-python provides a basic command line interface named <code class="docutils literal notranslate"><span class="pre">unipy</span></code>, to let you easier query the chain for things like the current price and token metadata.</p>
<div class="section" id="example-usage">
<h2>Example usage<a class="headerlink" href="#example-usage" title="Permalink to this headline">¶</a></h2>
<p><strong>Note:</strong> uniswap-python contains a small database of token contract addresses for convenience. You can always provide a contract address in place of a shorthand, and need to do so for all tokens not in the bundled database, or if you’re not on mainnet.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="c1"># Get price for 1 WETH quoted in DAI</span>
$ unipy price WETH DAI
<span class="m">3350</span>.883387688622
<span class="c1"># Get price for 1 WETH quoted in DAI, skip decimal normalization</span>
$ unipy price --raw WETH DAI
<span class="m">3350883387688622003541</span>
<span class="c1"># Get price for 1 WETH quoted in USDT</span>
$ unipy price WETH 0xdac17f958d2ee523a2206206994597c13d831ec7
<span class="m">3348</span>.128969
<span class="c1"># Get token metadata from its ERC20 contract</span>
$ unipy token 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2
<span class="o">{</span><span class="s1">'name'</span>: <span class="s1">'Wrapped Ether'</span>, <span class="s1">'symbol'</span>: <span class="s1">'WETH'</span>, <span class="s1">'decimals'</span>: <span class="m">18</span><span class="o">}</span>
<span class="c1"># List known/hardcoded tokens, with metadata</span>
$ unipy tokendb --metadata
<span class="o">{</span><span class="s1">'name'</span>: <span class="s1">'Wrapped Ether'</span>, <span class="s1">'symbol'</span>: <span class="s1">'WETH'</span>, <span class="s1">'decimals'</span>: <span class="m">18</span><span class="o">}</span>
<span class="o">{</span><span class="s1">'name'</span>: <span class="s1">'Dai Stablecoin'</span>, <span class="s1">'symbol'</span>: <span class="s1">'DAI'</span>, <span class="s1">'decimals'</span>: <span class="m">18</span><span class="o">}</span>
<span class="o">{</span><span class="s1">'name'</span>: <span class="s1">'Wrapped BTC'</span>, <span class="s1">'symbol'</span>: <span class="s1">'WBTC'</span>, <span class="s1">'decimals'</span>: <span class="m">8</span><span class="o">}</span>
...
</pre></div>
</div>
</div>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<div class="section" id="unipy">
<h3>unipy<a class="headerlink" href="#unipy" title="Permalink to this headline">¶</a></h3>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>unipy <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND <span class="o">[</span>ARGS<span class="o">]</span>...
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt id="cmdoption-unipy-v">
<span id="cmdoption-unipy-verbose"></span><code class="sig-name descname"><span class="pre">-v</span></code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname"><span class="pre">,</span> </code><code class="sig-name descname"><span class="pre">--verbose</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-unipy-v" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="std option">
<dt id="cmdoption-unipy-version">
<code class="sig-name descname"><span class="pre">--version</span></code><code class="sig-prename descclassname"> <span class="pre"><version></span></code><a class="headerlink" href="#cmdoption-unipy-version" title="Permalink to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Options</dt>
<dd class="field-odd"><p>1 | 2 | 3</p>
</dd>
</dl>
</dd></dl>
<div class="section" id="unipy-price">
<h4>price<a class="headerlink" href="#unipy-price" title="Permalink to this headline">¶</a></h4>
<p>Returns the price of <code class="docutils literal notranslate"><span class="pre">quantity</span></code> tokens of <code class="docutils literal notranslate"><span class="pre">token_in</span></code> quoted in <code class="docutils literal notranslate"><span class="pre">token_out</span></code>.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>unipy price <span class="o">[</span>OPTIONS<span class="o">]</span> TOKEN_IN TOKEN_OUT
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt id="cmdoption-unipy-price-raw">
<code class="sig-name descname"><span class="pre">--raw</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-unipy-price-raw" title="Permalink to this definition">¶</a></dt>
<dd><p>Don’t normalize the quoted price to the output token’s decimals</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-unipy-price-quantity">
<code class="sig-name descname"><span class="pre">--quantity</span></code><code class="sig-prename descclassname"> <span class="pre"><quantity></span></code><a class="headerlink" href="#cmdoption-unipy-price-quantity" title="Permalink to this definition">¶</a></dt>
<dd><p>Quantity of output tokens to get price of. Falls back to one full unit of the input token by default (10**18 for WETH, for example).</p>
</dd></dl>
<p class="rubric">Arguments</p>
<dl class="std option">
<dt id="cmdoption-unipy-price-arg-TOKEN_IN">
<span id="cmdoption-unipy-price-arg-token-in"></span><code class="sig-name descname"><span class="pre">TOKEN_IN</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-unipy-price-arg-TOKEN_IN" title="Permalink to this definition">¶</a></dt>
<dd><p>Required argument</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-unipy-price-arg-TOKEN_OUT">
<span id="cmdoption-unipy-price-arg-token-out"></span><code class="sig-name descname"><span class="pre">TOKEN_OUT</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-unipy-price-arg-TOKEN_OUT" title="Permalink to this definition">¶</a></dt>
<dd><p>Required argument</p>
</dd></dl>
</div>
<div class="section" id="unipy-token">
<h4>token<a class="headerlink" href="#unipy-token" title="Permalink to this headline">¶</a></h4>
<p>Show metadata for token</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>unipy token <span class="o">[</span>OPTIONS<span class="o">]</span> TOKEN
</pre></div>
</div>
<p class="rubric">Arguments</p>
<dl class="std option">
<dt id="cmdoption-unipy-token-arg-TOKEN">
<span id="cmdoption-unipy-token-arg-token"></span><code class="sig-name descname"><span class="pre">TOKEN</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-unipy-token-arg-TOKEN" title="Permalink to this definition">¶</a></dt>
<dd><p>Required argument</p>
</dd></dl>
</div>
<div class="section" id="unipy-tokendb">
<h4>tokendb<a class="headerlink" href="#unipy-tokendb" title="Permalink to this headline">¶</a></h4>
<p>List known token addresses</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>unipy tokendb <span class="o">[</span>OPTIONS<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt id="cmdoption-unipy-tokendb-metadata">
<code class="sig-name descname"><span class="pre">--metadata</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-unipy-tokendb-metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>Also get metadata for tokens</p>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class='prev-next-bottom'>
<a class='left-prev' id="prev-link" href="api.html" title="previous page">API Reference</a>
<a class='right-next' id="next-link" href="examples.html" title="next page">Examples</a>
</div>
</div>
</div>
<footer class="footer mt-5 mt-md-0">
<div class="container">
<p>
By Shane Fontaine, Erik Bjäreholt, and contributors<br/>
© Copyright 2021, Shane Fontaine, Erik Bjäreholt, and contributors.<br/>
</p>
</div>
</footer>
</main>
</div>
</div>
<script src="_static/js/index.1c5a1a01449ed65a7b51.js"></script>
</body>
</html>