-
Notifications
You must be signed in to change notification settings - Fork 3
/
mento.ts
459 lines (415 loc) · 13.5 KB
/
mento.ts
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
import {
Address,
TradingLimit,
TradingLimitsConfig,
TradingLimitsState,
} from './interfaces'
import {
BiPoolManager__factory,
Broker__factory,
IBreakerBox__factory,
IBroker,
IBroker__factory,
IExchangeProvider,
IExchangeProvider__factory,
} from '@mento-protocol/mento-core-ts'
import { BigNumber, BigNumberish, Signer, providers } from 'ethers'
import {
getBrokerAddressFromRegistry,
getSymbolFromTokenAddress,
increaseAllowance,
validateSigner,
validateSignerOrProvider,
} from './utils'
import { getLimits, getLimitsConfig, getLimitsState } from './limits'
import { strict as assert } from 'assert'
export interface Exchange {
providerAddr: Address
id: string
assets: Address[]
}
export interface Asset {
address: Address
symbol: string
}
export class Mento {
private readonly signerOrProvider: Signer | providers.Provider
private readonly broker: IBroker
private exchanges: Exchange[]
/**
* This constructor is private, use the static create or createWithParams methods
* to create a new Mento instance
* @param signerOrProvider an ethers provider or connected signer
* @param brokerAddress the address of the broker contract
* @param exchanges exchange data for the broker
*/
private constructor(
signerOrProvider: Signer | providers.Provider,
brokerAddress: Address,
exchanges?: Exchange[]
) {
this.signerOrProvider = signerOrProvider
this.broker = IBroker__factory.connect(brokerAddress, signerOrProvider)
this.exchanges = exchanges || []
}
/**
* Creates a new Mento object instance.
* When constructed with only a Provider only read-only operations are supported
* @param signerOrProvider an ethers signer or provider. A signer is required to execute swaps
* @returns a new Mento object instance
*/
static async create(signerOrProvider: Signer | providers.Provider) {
validateSignerOrProvider(signerOrProvider)
return new Mento(
signerOrProvider,
await getBrokerAddressFromRegistry(signerOrProvider)
)
}
/**
* Create a new Mento object instance given a broker address and optional exchanges data
* When constructed with a Provider, only read-only operations are supported
* @param signerOrProvider an ethers signer or provider. A signer is required to execute swaps
* @param brokerAddr the address of the broker contract
* @param exchanges the exchanges data for the broker
* @returns a new Mento object instance
*/
static createWithParams(
signerOrProvider: Signer | providers.Provider,
brokerAddr: Address,
exchanges?: Exchange[]
) {
validateSignerOrProvider(signerOrProvider)
return new Mento(signerOrProvider, brokerAddr, exchanges)
}
/**
* Returns a new Mento instance connected to the given signer
* @param signer an ethers signer
* @returns new Mento object instance
*/
connectSigner(signer: Signer) {
validateSigner(signer)
return new Mento(signer, this.broker.address, this.exchanges)
}
/**
* Returns a list of all the pairs that can be traded on Mento
* @returns The list of tradeable pairs in the form of [{address, symbol}]
*/
async getTradeablePairs(): Promise<[Asset, Asset][]> {
const exchanges = await this.getExchanges()
const pairs: [Asset, Asset][] = []
for (const exchange of exchanges) {
const asset0 = exchange.assets[0]
const asset1 = exchange.assets[1]
const symbols = await Promise.all([
getSymbolFromTokenAddress(asset0, this.signerOrProvider),
getSymbolFromTokenAddress(asset1, this.signerOrProvider),
])
pairs.push([
{ address: asset0, symbol: symbols[0] },
{ address: asset1, symbol: symbols[1] },
])
}
return pairs
}
/**
* Returns the amount of tokenIn to be sold to buy amountOut of tokenOut
* @param tokenIn the token to be sold
* @param tokenOut the token to be bought
* @param amountOut the amount of tokenOut to be bought
* @returns the amount of tokenIn to be sold
*/
async getAmountIn(
tokenIn: Address,
tokenOut: Address,
amountOut: BigNumberish
): Promise<BigNumber> {
const exchange = await this.getExchangeForTokens(tokenIn, tokenOut)
return this.broker.getAmountIn(
exchange.providerAddr,
exchange.id,
tokenIn,
tokenOut,
amountOut
)
}
/**
* Returns the amount of tokenOut to be bought by selling amountIn of tokenIn
* @param tokenIn the token to be sold
* @param tokenOut the token to be bought
* @param amountIn the amount of tokenIn to be sold
* @returns the amount of tokenOut to be bought
*/
async getAmountOut(
tokenIn: Address,
tokenOut: Address,
amountIn: BigNumberish
): Promise<BigNumber> {
const exchange = await this.getExchangeForTokens(tokenIn, tokenOut)
return this.broker.getAmountOut(
exchange.providerAddr,
exchange.id,
tokenIn,
tokenOut,
amountIn
)
}
/**
* Increases the broker's trading allowance for the given token
* @param token the token to increase the allowance for
* @param amount the amount to increase the allowance by
* @returns the populated TransactionRequest object
*/
async increaseTradingAllowance(
token: Address,
amount: BigNumberish
): Promise<providers.TransactionRequest> {
const spender = this.broker.address
const tx = await increaseAllowance(
token,
spender,
amount,
this.signerOrProvider
)
if (Signer.isSigner(this.signerOrProvider)) {
// The contract call doesn't populate all of the signer fields, so we need an extra call for the signer
return this.signerOrProvider.populateTransaction(tx)
} else {
return tx
}
}
/**
* Returns a token swap populated tx object with a fixed amount of tokenIn and a minimum amount of tokenOut
* Submitting the transaction to execute the swap is left to the consumer
* @param tokenIn the token to be sold
* @param tokenOut the token to be bought
* @param amountIn the amount of tokenIn to be sold
* @param amountOutMin the minimum amount of tokenOut to be bought
* @returns the populated TransactionRequest object
*/
async swapIn(
tokenIn: Address,
tokenOut: Address,
amountIn: BigNumberish,
amountOutMin: BigNumberish
): Promise<providers.TransactionRequest> {
const exchange = await this.getExchangeForTokens(tokenIn, tokenOut)
const tx = await this.broker.populateTransaction.swapIn(
exchange.providerAddr,
exchange.id,
tokenIn,
tokenOut,
amountIn,
amountOutMin
)
if (Signer.isSigner(this.signerOrProvider)) {
// The contract call doesn't populate all of the signer fields, so we need an extra call for the signer
return this.signerOrProvider.populateTransaction(tx)
} else {
return tx
}
}
/**
* Returns a token swap populated tx object with a maximum amount of tokenIn and a fixed amount of tokenOut
* Submitting the transaction to execute the swap is left to the consumer
* @param tokenIn the token to be sold
* @param tokenOut the token to be bought
* @param amountOut the amount of tokenOut to be bought
* @param amountInMax the maximum amount of tokenIn to be sold
* @returns the populated TransactionRequest object
*/
async swapOut(
tokenIn: Address,
tokenOut: Address,
amountOut: BigNumberish,
amountInMax: BigNumberish
): Promise<providers.TransactionRequest> {
const exchange = await this.getExchangeForTokens(tokenIn, tokenOut)
const tx = await this.broker.populateTransaction.swapOut(
exchange.providerAddr,
exchange.id,
tokenIn,
tokenOut,
amountOut,
amountInMax
)
if (Signer.isSigner(this.signerOrProvider)) {
// The contract call doesn't populate all of the signer fields, so we need an extra call for the signer
return this.signerOrProvider.populateTransaction(tx)
} else {
return tx
}
}
/**
* Returns the mento instance's broker contract
* @returns broker contract
*/
getBroker(): IBroker {
return this.broker
}
/**
* Returns the list of exchanges available in Mento (cached)
* @returns the list of exchanges
*/
async getExchanges(): Promise<Exchange[]> {
if (this.exchanges.length > 0) {
return this.exchanges
}
const exchangeProvidersAddresses = await this.broker.getExchangeProviders()
const exchanges: Exchange[] = (
await Promise.all(
exchangeProvidersAddresses.map((a) => this.getExchangesForProvider(a))
)
).flat()
this.exchanges = exchanges
return exchanges
}
/**
* Returns the list of exchanges for a given exchange provider address
* @returns list of exchanges
*/
async getExchangesForProvider(
exchangeProviderAddr: Address
): Promise<Exchange[]> {
const exchangeProvider: IExchangeProvider =
IExchangeProvider__factory.connect(
exchangeProviderAddr,
this.signerOrProvider
)
const exchangesInProvider = await exchangeProvider.getExchanges()
return exchangesInProvider.map((e) => {
assert(e.assets.length === 2, 'Exchange must have 2 assets')
return {
providerAddr: exchangeProviderAddr,
id: e.exchangeId,
assets: e.assets,
}
})
}
/**
* Returns the Mento exchange (if any) for a given pair of tokens
* @param token0 the address of the first token
* @param token1 the address of the second token
* @returns exchange
*/
async getExchangeForTokens(
token0: Address,
token1: Address
): Promise<Exchange> {
const exchanges = (await this.getExchanges()).filter(
(e) => e.assets.includes(token0) && e.assets.includes(token1)
)
if (exchanges.length === 0) {
throw Error(`No exchange found for ${token0} and ${token1}`)
}
assert(
exchanges.length === 1,
`More than one exchange found for ${token0} and ${token1}`
)
return exchanges[0]
}
/**
* Returns the Mento exchange for a given exchange id
* @param exchangeId the id of the exchange
* @returns the exchange with the given id
*/
async getExchangeById(exchangeId: string): Promise<Exchange> {
const exchanges = (await this.getExchanges()).filter(
(e) => e.id === exchangeId
)
if (exchanges.length === 0) {
throw Error(`No exchange found for id ${exchangeId}`)
}
assert(
exchanges.length === 1,
`More than one exchange found with id ${exchangeId}`
)
return exchanges[0]
}
/**
* Returns whether trading is enabled in the given mode for a given exchange id
* @param exchangeId the id of the exchange
* @param mode the trading mode
* @returns true if trading is enabled in the given mode, false otherwise
*/
async isTradingEnabled(exchangeId: string): Promise<boolean> {
const exchange = await this.getExchangeById(exchangeId)
const biPoolManager = BiPoolManager__factory.connect(
exchange.providerAddr,
this.signerOrProvider
)
const [breakerBoxAddr, exchangeConfig] = await Promise.all([
biPoolManager.breakerBox(),
biPoolManager.getPoolExchange(exchangeId),
])
const breakerBox = IBreakerBox__factory.connect(
breakerBoxAddr,
this.signerOrProvider
)
const currentMode = await breakerBox.getRateFeedTradingMode(
exchangeConfig.config.referenceRateFeedID
)
const BI_DIRECTIONAL_TRADING_MODE = 0
return currentMode == BI_DIRECTIONAL_TRADING_MODE
}
/**
* Return the trading limits for a given exchange id. Each limit is an object with the following fields:
* asset: the address of the asset with the limit
* maxIn: the maximum amount of the asset that can be sold
* maxOut: the maximum amount of the asset that can be bought
* until: the timestamp until which the limit is valid
* @param exchangeId the id of the exchange
* @returns the list of trading limits
*/
async getTradingLimits(exchangeId: string): Promise<TradingLimit[]> {
const exchange = await this.getExchangeById(exchangeId)
const broker = Broker__factory.connect(
this.broker.address,
this.signerOrProvider
)
const asset0Limits = await getLimits(broker, exchangeId, exchange.assets[0])
const asset1Limits = await getLimits(broker, exchangeId, exchange.assets[1])
return asset0Limits.concat(asset1Limits)
}
/**
* Returns the trading limits configurations for a given exchange id
* @param exchangeId the id of the exchange
* @returns the trading limits configuration
*/
async getTradingLimitConfig(
exchangeId: string
): Promise<TradingLimitsConfig[]> {
const exchange = await this.getExchangeById(exchangeId)
const broker = Broker__factory.connect(
this.broker.address,
this.signerOrProvider
)
const cfgs = []
for (const asset of exchange.assets) {
const limitCfg = await getLimitsConfig(broker, exchangeId, asset)
const isLimitConfigured = limitCfg.flags > 0
if (isLimitConfigured) {
cfgs.push(limitCfg)
}
}
return cfgs
}
/**
* Returns the trading limits state for a given exchange id
* @param exchangeId the id of the exchange
* @returns the trading limits state
*/
async getTradingLimitState(
exchangeId: string
): Promise<TradingLimitsState[]> {
const broker = Broker__factory.connect(
this.broker.address,
this.signerOrProvider
)
const configuredLimitCfgs = await this.getTradingLimitConfig(exchangeId)
return await Promise.all(
configuredLimitCfgs.map(
async (cfg) => await getLimitsState(broker, exchangeId, cfg.asset)
)
)
}
}