-
Notifications
You must be signed in to change notification settings - Fork 382
Expand file tree
/
Copy pathgetting-started.html
More file actions
652 lines (490 loc) · 36.6 KB
/
getting-started.html
File metadata and controls
652 lines (490 loc) · 36.6 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
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
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
<!DOCTYPE html>
<html lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>Getting started — uniswap-python</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
</script>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=12da95d707ffb74b382d" rel="stylesheet" />
<link href="_static/styles/bootstrap.css?digest=12da95d707ffb74b382d" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=12da95d707ffb74b382d" rel="stylesheet" />
<link href="_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=12da95d707ffb74b382d" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" href="_static/styles/sphinx-book-theme.css?digest=14f4ca6b54d191a8c7657f6c759bf11a5fb86285" type="text/css" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=12da95d707ffb74b382d" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=12da95d707ffb74b382d" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/scripts/sphinx-book-theme.js?digest=5a5c038af52cf7bc1a1ec88eea08e6366ee68824"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'getting-started';</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="API Reference" href="api.html" />
<link rel="prev" title="Welcome to uniswap-python’s documentation!" href="index.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<a class="skip-link" href="#main-content">Skip to main content</a>
<input type="checkbox"
class="sidebar-toggle"
name="__primary"
id="__primary"/>
<label class="overlay overlay-primary" for="__primary"></label>
<input type="checkbox"
class="sidebar-toggle"
name="__secondary"
id="__secondary"/>
<label class="overlay overlay-secondary" for="__secondary"></label>
<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
id="search-input"
placeholder="Search..."
aria-label="Search..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>
<nav class="bd-header navbar navbar-expand-lg bd-navbar">
</nav>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<div class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<a class="navbar-brand logo" href="index.html">
<img src="_static/logo.png" class="logo__image only-light" alt="Logo image"/>
<script>document.write(`<img src="_static/logo.png" class="logo__image only-dark" alt="Logo image"/>`);</script>
</a></div>
<div class="sidebar-primary-item"><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cli.html">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></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
<div id="rtd-footer-container"></div>
</div>
<main id="main-content" class="bd-main">
<div class="sbt-scroll-pixel-helper"></div>
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item"><label class="sidebar-toggle primary-toggle btn btn-sm" for="__primary" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-bars"></span>
</label></div>
</div>
<div class="header-article-items__end">
<div class="header-article-item">
<div class="article-header-buttons">
<div class="dropdown dropdown-source-buttons">
<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Source repositories">
<i class="fab fa-github"></i>
</button>
<ul class="dropdown-menu">
<li><a href="https://github.com/shanefontaine/uniswap-python" target="_blank"
class="btn btn-sm btn-source-repository-button dropdown-item"
title="Source repository"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fab fa-github"></i>
</span>
<span class="btn__text-container">Repository</span>
</a>
</li>
<li><a href="https://github.com/shanefontaine/uniswap-python/edit/main/docs/getting-started.rst" target="_blank"
class="btn btn-sm btn-source-edit-button dropdown-item"
title="Suggest edit"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-pencil-alt"></i>
</span>
<span class="btn__text-container">Suggest edit</span>
</a>
</li>
</ul>
</div>
<div class="dropdown dropdown-download-buttons">
<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Download this page">
<i class="fas fa-download"></i>
</button>
<ul class="dropdown-menu">
<li><a href="_sources/getting-started.rst" target="_blank"
class="btn btn-sm btn-download-source-button dropdown-item"
title="Download source file"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-file"></i>
</span>
<span class="btn__text-container">.rst</span>
</a>
</li>
<li>
<button onclick="window.print()"
class="btn btn-sm btn-download-pdf-button dropdown-item"
title="Print to PDF"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-file-pdf"></i>
</span>
<span class="btn__text-container">.pdf</span>
</button>
</li>
</ul>
</div>
<button onclick="toggleFullScreen()"
class="btn btn-sm btn-fullscreen-button"
title="Fullscreen mode"
data-bs-placement="bottom" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-expand"></i>
</span>
</button>
<script>
document.write(`
<button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
<span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
<span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
</button>
`);
</script>
<script>
document.write(`
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
</button>
`);
</script>
<label class="sidebar-toggle secondary-toggle btn btn-sm" for="__secondary"title="Toggle secondary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-list"></span>
</label>
</div></div>
</div>
</div>
</div>
<div id="jb-print-docs-body" class="onlyprint">
<h1>Getting started</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
<div>
<h2> Contents </h2>
</div>
<nav aria-label="Page">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#installation">Installation</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#initializing-the-uniswap-class">Initializing the Uniswap class</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#environment-variables">Environment Variables</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#gas-pricing">Gas pricing</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#quoting-prices">Quoting prices</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#get-price-input"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_price_input()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#get-price-output"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_price_output()</span></code></a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#making-trades">Making trades</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#make-trade"><code class="xref py py-func docutils literal notranslate"><span class="pre">make_trade()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#make-trade-output"><code class="xref py py-func docutils literal notranslate"><span class="pre">make_trade_output()</span></code></a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#pool-methods-v1-only">Pool Methods (v1 only)</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#liquidity-methods-v1-only">Liquidity Methods (v1 only)</a></li>
</ul>
</nav>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article" role="main">
<section id="getting-started">
<h1>Getting started<a class="headerlink" href="#getting-started" title="Permalink to this heading">#</a></h1>
<p>This library attempts to present a clean interface to Uniswap, but in order to use it to its full potential, you must familiarize yourself with the official Uniswap documentation:</p>
<ul class="simple">
<li><p>V1: <a class="reference external" href="https://uniswap.org/docs/v1/">https://uniswap.org/docs/v1/</a></p></li>
<li><p>V2: <a class="reference external" href="https://uniswap.org/docs/v2/">https://uniswap.org/docs/v2/</a></p></li>
<li><p>V3: <a class="reference external" href="https://docs.uniswap.org/">https://docs.uniswap.org/</a></p></li>
</ul>
<nav class="contents local" id="table-of-contents">
<p class="topic-title">Table of contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#installation" id="id1">Installation</a></p></li>
<li><p><a class="reference internal" href="#initializing-the-uniswap-class" id="id2">Initializing the Uniswap class</a></p>
<ul>
<li><p><a class="reference internal" href="#environment-variables" id="id3">Environment Variables</a></p></li>
<li><p><a class="reference internal" href="#gas-pricing" id="id4">Gas pricing</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#quoting-prices" id="id5">Quoting prices</a></p>
<ul>
<li><p><a class="reference internal" href="#get-price-input" id="id6"><a class="reference internal" href="api.html#uniswap.Uniswap.get_price_input" title="uniswap.Uniswap.get_price_input"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_price_input()</span></code></a></a></p></li>
<li><p><a class="reference internal" href="#get-price-output" id="id7"><a class="reference internal" href="api.html#uniswap.Uniswap.get_price_output" title="uniswap.Uniswap.get_price_output"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_price_output()</span></code></a></a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#making-trades" id="id8">Making trades</a></p>
<ul>
<li><p><a class="reference internal" href="#make-trade" id="id9"><a class="reference internal" href="api.html#uniswap.Uniswap.make_trade" title="uniswap.Uniswap.make_trade"><code class="xref py py-func docutils literal notranslate"><span class="pre">make_trade()</span></code></a></a></p></li>
<li><p><a class="reference internal" href="#make-trade-output" id="id10"><a class="reference internal" href="api.html#uniswap.Uniswap.make_trade_output" title="uniswap.Uniswap.make_trade_output"><code class="xref py py-func docutils literal notranslate"><span class="pre">make_trade_output()</span></code></a></a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#pool-methods-v1-only" id="id11">Pool Methods (v1 only)</a></p></li>
<li><p><a class="reference internal" href="#liquidity-methods-v1-only" id="id12">Liquidity Methods (v1 only)</a></p></li>
</ul>
</nav>
<section id="installation">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Installation</a><a class="headerlink" href="#installation" title="Permalink to this heading">#</a></h2>
<p>You can install the latest release from PyPI, or install the latest commit directly from git:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Install the latest release from PyPI:</span>
pip<span class="w"> </span>install<span class="w"> </span>uniswap-python
<span class="c1"># or install from git:</span>
pip<span class="w"> </span>install<span class="w"> </span>git+git://github.com/uniswap-python/uniswap-python.git
<span class="c1"># or clone and install with poetry:</span>
git<span class="w"> </span>clone<span class="w"> </span>https://github.com/uniswap-python/uniswap-python.git
<span class="nb">cd</span><span class="w"> </span>uniswap-python
poetry<span class="w"> </span>install
</pre></div>
</div>
</section>
<section id="initializing-the-uniswap-class">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Initializing the Uniswap class</a><a class="headerlink" href="#initializing-the-uniswap-class" title="Permalink to this heading">#</a></h2>
<p>If you want to trade you need to provide your address and private key. If not, you can set them to <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
<p>In addition, the <a class="reference internal" href="api.html#uniswap.Uniswap" title="uniswap.Uniswap"><code class="xref py py-class docutils literal notranslate"><span class="pre">Uniswap</span></code></a> class takes several optional parameters, as documented in the <cite>API Reference</cite>.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">uniswap</span> <span class="kn">import</span> <span class="n">Uniswap</span>
<span class="n">address</span> <span class="o">=</span> <span class="s2">"YOUR ADDRESS"</span> <span class="c1"># or None if you're not going to make transactions</span>
<span class="n">private_key</span> <span class="o">=</span> <span class="s2">"YOUR PRIVATE KEY"</span> <span class="c1"># or None if you're not going to make transactions</span>
<span class="n">version</span> <span class="o">=</span> <span class="mi">2</span> <span class="c1"># specify which version of Uniswap to use</span>
<span class="n">provider</span> <span class="o">=</span> <span class="s2">"WEB3 PROVIDER URL"</span> <span class="c1"># can also be set through the environment variable `PROVIDER`</span>
<span class="n">uniswap</span> <span class="o">=</span> <span class="n">Uniswap</span><span class="p">(</span><span class="n">address</span><span class="o">=</span><span class="n">address</span><span class="p">,</span> <span class="n">private_key</span><span class="o">=</span><span class="n">private_key</span><span class="p">,</span> <span class="n">version</span><span class="o">=</span><span class="n">version</span><span class="p">,</span> <span class="n">provider</span><span class="o">=</span><span class="n">provider</span><span class="p">)</span>
<span class="c1"># Some token addresses we'll be using later in this guide</span>
<span class="n">eth</span> <span class="o">=</span> <span class="s2">"0x0000000000000000000000000000000000000000"</span>
<span class="n">bat</span> <span class="o">=</span> <span class="s2">"0x0D8775F648430679A709E98d2b0Cb6250d2887EF"</span>
<span class="n">dai</span> <span class="o">=</span> <span class="s2">"0x6B175474E89094C44Da98b954EedeAC495271d0F"</span>
</pre></div>
</div>
<section id="environment-variables">
<h3><a class="toc-backref" href="#id3" role="doc-backlink">Environment Variables</a><a class="headerlink" href="#environment-variables" title="Permalink to this heading">#</a></h3>
<p>The program expects an environment variables to be set in order to run the program. You can use an Infura node, since the transactions are being signed locally and broadcast as a raw transaction. The environment variable is:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>PROVIDER<span class="w"> </span><span class="c1"># HTTP Provider for web3</span>
</pre></div>
</div>
</section>
<section id="gas-pricing">
<h3><a class="toc-backref" href="#id4" role="doc-backlink">Gas pricing</a><a class="headerlink" href="#gas-pricing" title="Permalink to this heading">#</a></h3>
<p>To modify the gas pricing strategy you need to pass a custom <cite>Web3</cite> instance to the <a class="reference internal" href="api.html#uniswap.Uniswap" title="uniswap.Uniswap"><code class="xref py py-class docutils literal notranslate"><span class="pre">Uniswap</span></code></a> constructor. You can find details for how to configure Web3 gas strategies in their <a class="reference external" href="https://web3py.readthedocs.io/en/stable/gas_price.html">documentation</a>.</p>
</section>
</section>
<section id="quoting-prices">
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Quoting prices</a><a class="headerlink" href="#quoting-prices" title="Permalink to this heading">#</a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>These methods assume a certain route for the swap to take, which may not be the optimal route. See <a class="reference external" href="https://github.com/shanefontaine/uniswap-python/issues/93">issue #93</a> for details.</p>
</div>
<p>There are two functions to retrieve the price for a given pair, one for specifying how much you get given a certain amount of the input token, and another for specifying how much you need to pay to receive a certain amount of the output token.</p>
<section id="get-price-input">
<h3><a class="toc-backref" href="#id6" role="doc-backlink"><a class="reference internal" href="api.html#uniswap.Uniswap.get_price_input" title="uniswap.Uniswap.get_price_input"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_price_input()</span></code></a></a><a class="headerlink" href="#get-price-input" title="Permalink to this heading">#</a></h3>
<p>Returns the amount of output tokens you get for a given amount of input tokens.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Returns the amount of DAI you get for 1 ETH (10^18 wei)</span>
<span class="n">uniswap</span><span class="o">.</span><span class="n">get_price_input</span><span class="p">(</span><span class="n">eth</span><span class="p">,</span> <span class="n">dai</span><span class="p">,</span> <span class="mi">10</span><span class="o">**</span><span class="mi">18</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="get-price-output">
<h3><a class="toc-backref" href="#id7" role="doc-backlink"><a class="reference internal" href="api.html#uniswap.Uniswap.get_price_output" title="uniswap.Uniswap.get_price_output"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_price_output()</span></code></a></a><a class="headerlink" href="#get-price-output" title="Permalink to this heading">#</a></h3>
<p>Returns the amount of input token you need for the given amount of output tokens.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Returns the amount of ETH you need to pay (in wei) to get 1000 DAI</span>
<span class="n">uniswap</span><span class="o">.</span><span class="n">get_price_output</span><span class="p">(</span><span class="n">eth</span><span class="p">,</span> <span class="n">dai</span><span class="p">,</span> <span class="mi">1_000</span> <span class="o">*</span> <span class="mi">10</span><span class="o">**</span><span class="mi">18</span><span class="p">)</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>These methods return the price as an integer in the smallest unit of the token. You need to ensure that you know how many decimals the token you’re trying to trade uses to get prices in the common decimal format. See <a class="reference external" href="https://github.com/shanefontaine/uniswap-python/issues/12">issue #12</a> for details.</p>
<p>Decimals for common tokens:</p>
<ul class="simple">
<li><p>ETH, DAI, and BAT uses 18 decimals (as you can see in code below)</p></li>
<li><p>WBTC uses 8 decimals</p></li>
<li><p>USDC and USDT uses 6 decimals</p></li>
</ul>
<p>You can look up the number of decimals used by a particular token by looking up the contract on Etherscan.</p>
</div>
</section>
</section>
<section id="making-trades">
<h2><a class="toc-backref" href="#id8" role="doc-backlink">Making trades</a><a class="headerlink" href="#making-trades" title="Permalink to this heading">#</a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The same route assumptions and need for handling decimals apply here as those mentioned in the previous section.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Always check the expected price before executing a trade. It’s important that you’re using a pool with adequate liquidity, or else you may suffer significant losses! (see <a class="reference external" href="https://github.com/shanefontaine/uniswap-python/issues/198">issue #198</a> and <a class="reference external" href="https://github.com/shanefontaine/uniswap-python/issues/208">issue #208</a>)</p>
<p>Use the Uniswap version with the most liquidity for your route, and if using v3, make sure you set the <code class="docutils literal notranslate"><span class="pre">fee</span></code> parameter to use the best pool.</p>
</div>
<section id="make-trade">
<h3><a class="toc-backref" href="#id9" role="doc-backlink"><a class="reference internal" href="api.html#uniswap.Uniswap.make_trade" title="uniswap.Uniswap.make_trade"><code class="xref py py-func docutils literal notranslate"><span class="pre">make_trade()</span></code></a></a><a class="headerlink" href="#make-trade" title="Permalink to this heading">#</a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Make a trade by specifying the quantity of the input token you wish to sell</span>
<span class="n">uniswap</span><span class="o">.</span><span class="n">make_trade</span><span class="p">(</span><span class="n">eth</span><span class="p">,</span> <span class="n">bat</span><span class="p">,</span> <span class="mi">1</span><span class="o">*</span><span class="mi">10</span><span class="o">**</span><span class="mi">18</span><span class="p">)</span> <span class="c1"># sell 1 ETH for BAT</span>
<span class="n">uniswap</span><span class="o">.</span><span class="n">make_trade</span><span class="p">(</span><span class="n">bat</span><span class="p">,</span> <span class="n">eth</span><span class="p">,</span> <span class="mi">1</span><span class="o">*</span><span class="mi">10</span><span class="o">**</span><span class="mi">18</span><span class="p">)</span> <span class="c1"># sell 1 BAT for ETH</span>
<span class="n">uniswap</span><span class="o">.</span><span class="n">make_trade</span><span class="p">(</span><span class="n">bat</span><span class="p">,</span> <span class="n">dai</span><span class="p">,</span> <span class="mi">1</span><span class="o">*</span><span class="mi">10</span><span class="o">**</span><span class="mi">18</span><span class="p">)</span> <span class="c1"># sell 1 BAT for DAI</span>
<span class="n">uniswap</span><span class="o">.</span><span class="n">make_trade</span><span class="p">(</span><span class="n">eth</span><span class="p">,</span> <span class="n">bat</span><span class="p">,</span> <span class="mi">1</span><span class="o">*</span><span class="mi">10</span><span class="o">**</span><span class="mi">18</span><span class="p">,</span> <span class="s2">"0x123..."</span><span class="p">)</span> <span class="c1"># sell 1 ETH for BAT, and send the BAT to the provided address</span>
<span class="n">uniswap</span><span class="o">.</span><span class="n">make_trade</span><span class="p">(</span><span class="n">dai</span><span class="p">,</span> <span class="n">usdc</span><span class="p">,</span> <span class="mi">1</span><span class="o">*</span><span class="mi">10</span><span class="o">**</span><span class="mi">18</span><span class="p">,</span> <span class="n">fee</span><span class="o">=</span><span class="mi">500</span><span class="p">)</span> <span class="c1"># sell 1 DAI for USDC using the 0.05% fee pool (v3 only)</span>
</pre></div>
</div>
</section>
<section id="make-trade-output">
<h3><a class="toc-backref" href="#id10" role="doc-backlink"><a class="reference internal" href="api.html#uniswap.Uniswap.make_trade_output" title="uniswap.Uniswap.make_trade_output"><code class="xref py py-func docutils literal notranslate"><span class="pre">make_trade_output()</span></code></a></a><a class="headerlink" href="#make-trade-output" title="Permalink to this heading">#</a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Make a trade by specifying the quantity of the output token you wish to buy</span>
<span class="n">uniswap</span><span class="o">.</span><span class="n">make_trade_output</span><span class="p">(</span><span class="n">eth</span><span class="p">,</span> <span class="n">bat</span><span class="p">,</span> <span class="mi">1</span><span class="o">*</span><span class="mi">10</span><span class="o">**</span><span class="mi">18</span><span class="p">)</span> <span class="c1"># buy ETH for 1 BAT</span>
<span class="n">uniswap</span><span class="o">.</span><span class="n">make_trade_output</span><span class="p">(</span><span class="n">bat</span><span class="p">,</span> <span class="n">eth</span><span class="p">,</span> <span class="mi">1</span><span class="o">*</span><span class="mi">10</span><span class="o">**</span><span class="mi">18</span><span class="p">)</span> <span class="c1"># buy BAT for 1 ETH</span>
<span class="n">uniswap</span><span class="o">.</span><span class="n">make_trade_output</span><span class="p">(</span><span class="n">bat</span><span class="p">,</span> <span class="n">dai</span><span class="p">,</span> <span class="mi">1</span><span class="o">*</span><span class="mi">10</span><span class="o">**</span><span class="mi">18</span><span class="p">,</span> <span class="s2">"0x123..."</span><span class="p">)</span> <span class="c1"># buy BAT for 1 DAI, and send the BAT to the provided address</span>
<span class="n">uniswap</span><span class="o">.</span><span class="n">make_trade_output</span><span class="p">(</span><span class="n">dai</span><span class="p">,</span> <span class="n">usdc</span><span class="p">,</span> <span class="mi">1</span><span class="o">*</span><span class="mi">10</span><span class="o">**</span><span class="mi">8</span><span class="p">,</span> <span class="n">fee</span><span class="o">=</span><span class="mi">500</span><span class="p">)</span> <span class="c1"># buy USDC for 1 DAI using the 0.05% fee pool (v3 only)</span>
</pre></div>
</div>
</section>
</section>
<section id="pool-methods-v1-only">
<h2><a class="toc-backref" href="#id11" role="doc-backlink">Pool Methods (v1 only)</a><a class="headerlink" href="#pool-methods-v1-only" title="Permalink to this heading">#</a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Get the balance of ETH in an exchange contract.</span>
<span class="n">uniswap</span><span class="o">.</span><span class="n">get_ex_eth_balance</span><span class="p">(</span><span class="n">bat</span><span class="p">)</span>
<span class="c1"># Get the balance of a token in an exchange contract.</span>
<span class="n">uniswap</span><span class="o">.</span><span class="n">get_ex_token_balance</span><span class="p">(</span><span class="n">bat</span><span class="p">)</span>
<span class="c1"># Get the exchange rate of token/ETH</span>
<span class="n">uniswap</span><span class="o">.</span><span class="n">get_exchange_rate</span><span class="p">(</span><span class="n">bat</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="liquidity-methods-v1-only">
<h2><a class="toc-backref" href="#id12" role="doc-backlink">Liquidity Methods (v1 only)</a><a class="headerlink" href="#liquidity-methods-v1-only" title="Permalink to this heading">#</a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Add liquidity to the pool.</span>
<span class="n">uniswap</span><span class="o">.</span><span class="n">add_liquidity</span><span class="p">(</span><span class="n">bat</span><span class="p">,</span> <span class="mi">1</span><span class="o">*</span><span class="mi">10</span><span class="o">**</span><span class="mi">18</span><span class="p">)</span>
<span class="c1"># Remove liquidity from the pool.</span>
<span class="n">uniswap</span><span class="o">.</span><span class="n">remove_liquidity</span><span class="p">(</span><span class="n">bat</span><span class="p">,</span> <span class="mi">1</span><span class="o">*</span><span class="mi">10</span><span class="o">**</span><span class="mi">18</span><span class="p">)</span>
</pre></div>
</div>
</section>
</section>
</article>
<footer class="bd-footer-article">
<!-- Previous / next buttons -->
<div class="prev-next-area">
<a class="left-prev"
href="index.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Welcome to uniswap-python’s documentation!</p>
</div>
</a>
<a class="right-next"
href="api.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">API Reference</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> Contents
</div>
<nav class="bd-toc-nav page-toc">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#installation">Installation</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#initializing-the-uniswap-class">Initializing the Uniswap class</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#environment-variables">Environment Variables</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#gas-pricing">Gas pricing</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#quoting-prices">Quoting prices</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#get-price-input"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_price_input()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#get-price-output"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_price_output()</span></code></a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#making-trades">Making trades</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#make-trade"><code class="xref py py-func docutils literal notranslate"><span class="pre">make_trade()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#make-trade-output"><code class="xref py py-func docutils literal notranslate"><span class="pre">make_trade_output()</span></code></a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#pool-methods-v1-only">Pool Methods (v1 only)</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#liquidity-methods-v1-only">Liquidity Methods (v1 only)</a></li>
</ul>
</nav></div>
</div></div>
</div>
<footer class="bd-footer-content">
<div class="bd-footer-content__inner">
<div class="bd-footer-content__inner container">
<div class="footer-item">
<p class="component-author">
By Shane Fontaine, Erik Bjäreholt, and contributors
</p>
</div>
<div class="footer-item">
<p class="copyright">
© Copyright 2021, Shane Fontaine, Erik Bjäreholt, and contributors.
<br/>
</p>
</div>
<div class="footer-item">
</div>
<div class="footer-item">
</div>
</div></div>
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="_static/scripts/bootstrap.js?digest=12da95d707ffb74b382d"></script>
<script src="_static/scripts/pydata-sphinx-theme.js?digest=12da95d707ffb74b382d"></script>
<footer class="bd-footer">
</footer>
</body>
</html>