-
Notifications
You must be signed in to change notification settings - Fork 0
/
manual_balancer.py
523 lines (357 loc) · 14.1 KB
/
manual_balancer.py
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
from balancerpy.vault import BalancerVault
# ----------------------------------------------------------------------------------------------- #
class FactoryData():
pass
# ----------------------------------------------------------------------------------------------- #
class BalancerExchangeData():
pass
# ----------------------------------------------------------------------------------------------- #
class BalancerExchange():
"""
How Balancer calls liquidity pools and uses the constant weighted product automated market maker
Parameters
---------------
self.factory_struct : FactoryData
Factory data
self.exchg_struct : BalancerExchangeData
Balancer exchange data
"""
def __init__(self, factory_struct: FactoryData, exchg_struct: BalancerExchangeData):
pass
def summary(self):
""" summary
Summarize current state of balancer liquidity pool
"""
pass
def join_pool(self, vault : BalancerVault, amt_shares_in: float, to: str):
""" join_pool
Initialize a Balancer pool, and add liquidity for all asset deposit
Parameters
---------------
tkn_grvaultoup : BalancerERC20Group
Group of ERC20 objects
amt_shares_in : float
Amount of pool shares in
to : str
User name/address
"""
pass
def join_swap_extern_amount_in(self, amt_tkn_in, tkn_in, to):
""" join_swap_extern_amount_in
Add liquidity via depositing token amount for single asset deposit
Parameters
---------------
amt_tkn_in : float
Amount of token coming in
tkn_in : ERC20
Input token
to : str
User name/address
"""
pass
def join_swap_pool_amount_out(self, amt_shares_in, tkn_in, to):
""" join_swap_pool_amount_out
Add liquidity via depositing shares amount for single asset deposit
Parameters
---------------
amt_shares_in : float
Amount of pool shares coming in
tkn_in : ERC20
Input token
to : str
User name/address
"""
pass
def exit_swap_extern_amount_out(self, amt_tkn_out, tkn_out, to):
""" exit_swap_extern_amount_out
Remove liquidity via withdrawing shares amount for a single asset
Parameters
---------------
amt_tkn_out : float
Amount of token requested for withdrawal
tkn_out : ERC20
Output token
to : str
User name/address
"""
pass
def exit_swap_pool_amount_in(self, amt_shares_out, tkn_out, to):
""" exit_swap_pool_amount_in
Remove liquidity via withdrawing shares amount for a single asset
Parameters
---------------
amt_shares_out : float
Amount of pool shares requested for withdrawal
tkn_out : ERC20
Output token
to : str
User name/address
"""
pass
def burn(self, shares, amt_tkn_out, tkn_out, _from):
""" burn
Burn liquidity from token based on number of pool shares and amount of token
Parameters
---------------
amt_tkn_out : float
Amount of token requested for burn
tkn_out : ERC20
Output token
_from : str
User name/address
"""
pass
def _burn(self, _from, shares_out):
""" burn
Burn liquidity from token based on number of pool shares
Parameters
---------------
shares_out : float
Amount of pool shares requested for burn
_from : str
User name/address
"""
pass
# remove liquidity: all asset withdrawal
def exit_pool(self, amt_shares_out, _from):
""" exit_pool
Remove liquidity via withdrawing shares amount for all assets within pool
Parameters
---------------
amt_shares_out : float
Amount of pool shares requested for exit
_from : str
User name/address
"""
pass
def swap_exact_amount_in(self, amt_tkn_in, tkn_in, tkn_out, to):
""" swap_exact_amount_in
Swap output token given input token
Parameters
---------------
amt_tkn_in : float
Amount of input token requested for swaping
tkn_in : ERC20
Input token
tkn_out : ERC20
Output token
to : str
User name/address
"""
pass
def swap_exact_amount_out(self, amt_tkn_out, tkn_out, tkn_in, to):
""" swap_exact_amount_out
Swap input token given output token
Parameters
---------------
amt_tkn_in : float
Amount of input token requested for swaping
tkn_in : ERC20
Input token
tkn_out : ERC20
Output token
to : str
User name/address
"""
pass
def swap(self, amt_swap, amt_fee, tkn_out, tkn_in, to):
""" swap
Swap output token given input token
Parameters
---------------
amt_out : float
Amount of input token requested for swaping
tkn_in : ERC20
Input token
tkn_out : ERC20
Output token
to : str
User name/address
"""
pass
def mint(self, new_shares, amt_tkn_in, tkn_in, to):
""" mint
Update reserve amount for specific token in the pool
Parameters
---------------
new_shares : float
Amount of new pool shares requested for minting
amt_tkn_in : float
Input token
tkn_in : ERC20
Output token
to : str
User name/address
"""
pass
def _mint(self, to, value):
""" _mint
Update reserve amount for specific token in the pool
Parameters
---------------
value : float
Amount of new pool shares requested for minting
to : str
User name/address
"""
pass
def _update(self, new_balance, tkn_nm):
""" _update
Update reserve amounts specified token
Parameters
---------------
new_balance : float
New reserve amount of token
tkn_nm : ERC20
Name of token being updated
"""
pass
def _tally_fees(self, tkn, fee):
""" _tally_fees
Tally fee from swap and record last collected fee
Parameters
---------------
tkn : ERC20
Token where fees are being collected for
fee : float
Fee being collected
"""
pass
def get_amount_out(self, amt_tkn_in, tkn_in, tkn_out):
""" get_amount_out
Given some amount of an asset, quotes an equivalent amount of the other asset
Parameters
---------------
amt_tkn_in : float
Amount of token requested for quote
tkn_in : ERC20
Input token
tkn_out : ERC20
Output token
"""
pass
def get_amount_in(self, amt_tkn_out, tkn_out, tkn_in):
""" get_amount_in
Given some amount of an asset, quotes an equivalent amount of the other asset
Parameters
---------------
amt_tkn_out : float
Amount of token requested for quote
tkn_out : ERC20
Input token
tkn_in : ERC20
Output token
"""
pass
def get_price(self, base_tkn, opp_tkn):
""" get_price
Get price of select token in the exchange pair
Parameters
---------------
base_tkn : float
Base token request for price quote
opp_tkn : ERC20
Denomination token of price quote
"""
pass
def get_reserve(self, token):
""" get_reserve
Get reserve amount of select token in the pool
Parameters
---------------
token : ERC20
ERC20 token
"""
pass
# ----------------------------------------------------------------------------------------------- #
class BalancerFactory():
"""
Create Balancer liquidity pools for given token sets
Parameters
---------------
self.name : str
Token name
self.address : str
Address name
"""
def __init__(self, name: str, address: str) -> None:
pass
def deploy(self, exchg_data : BalancerExchangeData):
""" deploy
Deploy a Balancer liquidity pool (LP) exchange
Parameters
-----------------
exchg_data : BalancerExchangeData
Exchange initialization data
Returns
-----------------
exchange : BalancerExchange
Newly created exchange that is also a LP token
"""
pass
def get_exchange(self, token):
""" get_exchange
Get exchange from given token
Parameters
-----------------
token : ERC20
receiving user address
Returns
-----------------
exchange : BalancerExchange
exchange from mapped token
"""
pass
def get_token(self, exchange):
""" get_token
Get token set from exchange
Parameters
-----------------
exchange : BalancerExchange
receiving user address
Returns
-----------------
token : ERC20
token from mapped exchange
"""
pass
# ----------------------------------------------------------------------------------------------- #
# ----------------------------------------------------------------------------------------------- #
class CWPQuote():
"""
Constant weighted product liquidity pool token quotes (ie, price, reserve and liquidity)
"""
def get_amount_from_shares(self, lp, tkn, amount_shares_in):
""" get_amount_from_shares
Get amount of token reserve, given an amount of input liquidity pool shares
Parameters
-----------------
lp : UniswapExchange
Uniswap LP
tkn: ERC20
Token asset from CWPT set
amount_shares_in: float
Amount of input shares
Returns
-----------------
amt_out: float
Amount of token reserve
"""
pass
def get_shares_from_amount(self, lp, tkn, amount_in):
""" get_shares_from_amount
Get amount of liquidity pool shares, given an amount of input token
Parameters
-----------------
lp : UniswapExchange
Uniswap LP
tkn: ERC20
Token asset from CWPT set
amount_in: float
Amount of input token
Returns
-----------------
lp_amt: float
Amount of liquidity pool shares
"""
pass