| 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 |
26×
26×
26×
26×
26×
26×
2×
2×
1×
25×
2×
2×
2×
23×
149×
149×
149×
149×
149×
149×
147×
3×
146×
146×
144×
4×
16×
15×
15×
15×
15×
105×
105×
105×
90×
90×
90×
3×
3×
3×
102×
102×
87×
87×
87×
12×
12×
12×
12×
3×
1×
1×
1×
11×
11×
11×
1×
1×
11×
11×
11×
88×
11×
11×
10×
61×
61×
61×
4×
7×
7×
7×
56×
56×
7×
6×
38×
38×
38×
38×
2×
5×
35×
35×
34×
34×
159×
159×
2×
2×
16×
16×
2×
2×
1×
1×
2×
2×
2×
2×
2×
16×
16×
16×
16×
16×
4×
4×
2×
2×
4×
2×
2×
2×
4×
| // SPDX-License-Identifier: BlueOak-1.0.0
pragma solidity 0.8.17;
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "../interfaces/IAsset.sol";
import "../interfaces/IAssetRegistry.sol";
import "../interfaces/IFacadeAct.sol";
import "../interfaces/IRToken.sol";
import "../interfaces/IStRSR.sol";
import "../libraries/Fixed.sol";
import "../p1/BasketHandler.sol";
import "../p1/BackingManager.sol";
import "../p1/Furnace.sol";
import "../p1/RToken.sol";
import "../p1/RevenueTrader.sol";
import "../p1/StRSRVotes.sol";
/**
* @title Facade
* @notice A UX-friendly layer for non-governance protocol interactions
* @custom:static-call - Use ethers callStatic() in order to get result after update
*/
contract FacadeAct is IFacadeAct {
using FixLib for uint192;
struct Cache {
IAssetRegistry reg;
BackingManagerP1 bm;
BasketHandlerP1 bh;
RevenueTraderP1 rTokenTrader;
RevenueTraderP1 rsrTrader;
StRSRP1 stRSR;
RTokenP1 rToken;
IERC20 rsr;
}
/// Returns the next call a keeper of MEV searcher should make in order to progress the system
/// Returns zero bytes to indicate no action should be made
/// @dev This function begins reverting due to blocksize constraints at ~400 registered assets
/// @custom:static-call
function getActCalldata(RTokenP1 rToken) external returns (address, bytes memory) {
// solhint-disable no-empty-blocks
IMain main = rToken.main();
Cache memory cache = Cache({
reg: main.assetRegistry(),
bm: BackingManagerP1(address(main.backingManager())),
bh: BasketHandlerP1(address(main.basketHandler())),
rTokenTrader: RevenueTraderP1(address(main.rTokenTrader())),
rsrTrader: RevenueTraderP1(address(main.rsrTrader())),
stRSR: StRSRP1(address(main.stRSR())),
rsr: main.rsr(),
rToken: rToken
});
IERC20[] memory erc20s = cache.reg.erc20s();
// Refresh assets
cache.reg.refresh();
// tend to the basket and auctions
{
// first priority: keep the basket fresh
if (cache.bh.status() == CollateralStatus.DISABLED) {
cache.bh.refreshBasket();
if (cache.bh.status() != CollateralStatus.DISABLED) {
// cache.bh.refreshBasket();
return (
address(cache.bh),
abi.encodeWithSelector(cache.bh.refreshBasket.selector)
);
}
}
// see if backingManager settlement is required
Iif (cache.bm.tradesOpen() > 0) {
for (uint256 i = 0; i < erc20s.length; i++) {
ITrade trade = cache.bm.trades(erc20s[i]);
if (address(trade) != address(0) && trade.canSettle()) {
// try: cache.rTokenTrader.settleTrade(erc20s[i])
try cache.bm.settleTrade(erc20s[i]) {
// if succeeded
return (
address(cache.bm),
abi.encodeWithSelector(cache.bm.settleTrade.selector, erc20s[i])
);
} catch {}
}
}
} else if (
cache.bh.status() == CollateralStatus.SOUND && !cache.bh.fullyCollateralized()
) {
// try: backingManager.manageTokens([])
IERC20[] memory empty = new IERC20[](0);
try cache.bm.manageTokens(empty) {
return (
address(cache.bm),
abi.encodeWithSelector(cache.bm.manageTokens.selector, empty)
);
} catch {}
} else {
// status() != SOUND || basketHandler.fullyCollateralized
// check revenue traders
for (uint256 i = 0; i < erc20s.length; i++) {
// rTokenTrader: if there's a trade to settle
ITrade trade = cache.rTokenTrader.trades(erc20s[i]);
Iif (address(trade) != address(0) && trade.canSettle()) {
// try: cache.rTokenTrader.settleTrade(erc20s[i])
try cache.rTokenTrader.settleTrade(erc20s[i]) {
return (
address(cache.rTokenTrader),
abi.encodeWithSelector(
cache.rTokenTrader.settleTrade.selector,
erc20s[i]
)
);
} catch {}
}
// rsrTrader: if there's a trade to settle
trade = cache.rsrTrader.trades(erc20s[i]);
Iif (address(trade) != address(0) && trade.canSettle()) {
// try: cache.rTokenTrader.settleTrade(erc20s[i])
try cache.rsrTrader.settleTrade(erc20s[i]) {
return (
address(cache.rsrTrader),
abi.encodeWithSelector(
cache.rsrTrader.settleTrade.selector,
erc20s[i]
)
);
} catch {}
}
// rTokenTrader: check if we can start any trades
uint48 tradesOpen = cache.rTokenTrader.tradesOpen();
try cache.rTokenTrader.manageToken(erc20s[i]) {
if (cache.rTokenTrader.tradesOpen() - tradesOpen > 0) {
// A trade started; do cache.rTokenTrader.manageToken
return (
address(cache.rTokenTrader),
abi.encodeWithSelector(
cache.rTokenTrader.manageToken.selector,
erc20s[i]
)
);
}
} catch {}
// rsrTrader: check if we can start any trades
tradesOpen = cache.rsrTrader.tradesOpen();
try cache.rsrTrader.manageToken(erc20s[i]) {
if (cache.rsrTrader.tradesOpen() - tradesOpen > 0) {
// A trade started; do cache.rsrTrader.manageToken
return (
address(cache.rsrTrader),
abi.encodeWithSelector(
cache.rsrTrader.manageToken.selector,
erc20s[i]
)
);
}
} catch {}
}
// maybe revenue needs to be forwarded from backingManager
// only perform if basket is SOUND
if (cache.bh.status() == CollateralStatus.SOUND) {
IAsset rsrAsset = cache.reg.toAsset(cache.rsr);
uint192 initialStRSRBal = rsrAsset.bal(address(cache.stRSR)); // {RSR}
try cache.bm.manageTokens(erc20s) {
// if this unblocked an auction in either revenue trader,
// then prepare backingManager.manageTokens
for (uint256 i = 0; i < erc20s.length; i++) {
address[] memory twoERC20s = new address[](2);
// rTokenTrader
{
if (address(erc20s[i]) != address(rToken)) {
// rTokenTrader: check if we can start any trades
uint48 tradesOpen = cache.rTokenTrader.tradesOpen();
try cache.rTokenTrader.manageToken(erc20s[i]) {
if (cache.rTokenTrader.tradesOpen() - tradesOpen > 0) {
// always forward RToken + the ERC20
twoERC20s[0] = address(rToken);
twoERC20s[1] = address(erc20s[i]);
// backingManager.manageTokens([rToken, erc20s[i])
// forward revenue onward to the revenue traders
return (
address(cache.bm),
abi.encodeWithSelector(
cache.bm.manageTokens.selector,
twoERC20s
)
);
}
} catch {}
}
}
// rsrTrader
{
if (erc20s[i] != cache.rsr) {
// rsrTrader: check if we can start any trades
uint48 tradesOpen = cache.rsrTrader.tradesOpen();
try cache.rsrTrader.manageToken(erc20s[i]) {
Iif (cache.rsrTrader.tradesOpen() - tradesOpen > 0) {
// always forward RSR + the ERC20
twoERC20s[0] = address(cache.rsr);
twoERC20s[1] = address(erc20s[i]);
// backingManager.manageTokens(rsr, erc20s[i])
// forward revenue onward to the revenue traders
return (
address(cache.bm),
abi.encodeWithSelector(
cache.bm.manageTokens.selector,
twoERC20s
)
);
}
} catch {}
}
}
}
// forward RToken in isolation only, if it's large enough
{
IAsset rTokenAsset = cache.reg.toAsset(IERC20(address(rToken)));
(uint192 lotLow, ) = rTokenAsset.lotPrice();
if (
rTokenAsset.bal(address(cache.rTokenTrader)) >
minTradeSize(cache.rTokenTrader.minTradeVolume(), lotLow)
) {
try cache.rTokenTrader.manageToken(IERC20(address(rToken))) {
address[] memory oneERC20 = new address[](1);
oneERC20[0] = address(rToken);
return (
address(cache.bm),
abi.encodeWithSelector(
cache.bm.manageTokens.selector,
oneERC20
)
);
} catch {}
}
}
// forward RSR in isolation only, if it's large enough
// via handoutExcessAssets
{
(uint192 lotLow, ) = rsrAsset.lotPrice();
if (
rsrAsset.bal(address(cache.stRSR)) - initialStRSRBal >
minTradeSize(cache.rsrTrader.minTradeVolume(), lotLow)
) {
IERC20[] memory empty = new IERC20[](0);
return (
address(cache.bm),
abi.encodeWithSelector(cache.bm.manageTokens.selector, empty)
);
}
}
} catch {}
}
}
}
// check if there are reward tokens to claim
{
// save initial balances
uint256[] memory initialBals = new uint256[](erc20s.length);
for (uint256 i = 0; i < erc20s.length; ++i) {
initialBals[i] = erc20s[i].balanceOf(address(cache.bm));
}
uint192 minTradeVolume = cache.bm.minTradeVolume(); // {UoA}
// prefer restricting to backingManager.claimRewards when possible to save gas
try cache.bm.claimRewards() {
// See if any token bals grew sufficiently
for (uint256 i = 0; i < erc20s.length; ++i) {
(uint192 lotLow, ) = cache.reg.toAsset(erc20s[i]).lotPrice(); // {tok}
uint256 bal = erc20s[i].balanceOf(address(cache.bm));
if (bal - initialBals[i] > minTradeSize(minTradeVolume, lotLow)) {
// It's large enough to trade! Return bm.claimRewards as next step.
return (
address(cache.bm),
abi.encodeWithSelector(cache.bm.claimRewards.selector, rToken)
);
}
}
} catch {}
// save initial balances for both Revenue Traders
uint256[] memory initialBalsRTokenTrader = new uint256[](erc20s.length);
uint256[] memory initialBalsRSRTrader = new uint256[](erc20s.length);
for (uint256 i = 0; i < erc20s.length; ++i) {
initialBalsRTokenTrader[i] = erc20s[i].balanceOf(address(cache.rTokenTrader));
initialBalsRSRTrader[i] = erc20s[i].balanceOf(address(cache.rsrTrader));
}
// look at rewards from all sources
try this.claimRewards(rToken) {
// See if any token bals grew sufficiently
for (uint256 i = 0; i < erc20s.length; ++i) {
(uint192 lotLow, ) = cache.reg.toAsset(erc20s[i]).lotPrice(); // {tok}
// Get balances for revenue traders
uint256 balRTokenTrader = erc20s[i].balanceOf(address(cache.rTokenTrader));
uint256 balRSRTrader = erc20s[i].balanceOf(address(cache.rsrTrader));
// Check both traders
if (
(balRTokenTrader - initialBalsRTokenTrader[i]) >
minTradeSize(minTradeVolume, lotLow) ||
(balRSRTrader - initialBalsRSRTrader[i]) >
minTradeSize(minTradeVolume, lotLow)
) {
// It's large enough to trade! Return claimRewards as next step.
return (
address(this),
abi.encodeWithSelector(this.claimRewards.selector, rToken)
);
}
}
} catch {}
}
return (address(0), new bytes(0));
}
function claimRewards(RTokenP1 rToken) public {
IMain main = rToken.main();
main.backingManager().claimRewards();
main.rTokenTrader().claimRewards();
main.rsrTrader().claimRewards();
}
/// Calculates the minTradeSize for an asset based on the given minTradeVolume and price
/// @param minTradeVolume {UoA} The min trade volume, passed in for gas optimization
/// @return {tok} The min trade size for the asset in whole tokens
function minTradeSize(uint192 minTradeVolume, uint192 price) private pure returns (uint192) {
// {tok} = {UoA} / {UoA/tok}
uint192 size = price == 0 ? IFIX_MAX : minTradeVolume.div(price, ROUND);
return size > 0 ? size : 1;
}
/// To use this, call via callStatic.
/// If canStart is true, proceed to runRecollateralizationAuctions
/// @return canStart true iff a recollateralization auction can be started
/// @custom:static-call
function canRunRecollateralizationAuctions(IBackingManager bm)
external
returns (bool canStart)
{
IERC20[] memory erc20s = bm.main().assetRegistry().erc20s();
// Settle all backingManager auctions
for (uint256 i = 0; i < erc20s.length; ++i) {
ITrade trade = bm.trades(erc20s[i]);
Iif (address(trade) != address(0) && trade.canSettle()) {
bm.settleTrade(erc20s[i]);
}
}
uint256 tradesOpen = bm.tradesOpen();
if (tradesOpen != 0) return false;
// Try to launch auctions
bm.manageTokensSortedOrder(new IERC20[](0));
return bm.tradesOpen() > 0;
}
/// To use this, call via callStatic.
/// @return toStart The ERC20s that have auctions that can be started
/// @custom:static-call
function getRevenueAuctionERC20s(IRevenueTrader revenueTrader)
external
returns (IERC20[] memory toStart)
{
Registry memory reg = revenueTrader.main().assetRegistry().getRegistry();
// Forward ALL revenue
revenueTrader.main().backingManager().manageTokens(reg.erc20s);
// Calculate which erc20s can have auctions started
uint256 num;
IERC20[] memory unfiltered = new IERC20[](reg.erc20s.length); // will filter down later
for (uint256 i = 0; i < reg.erc20s.length; ++i) {
// Settle first if possible. Required so we can assess full available balance
ITrade trade = revenueTrader.trades(reg.erc20s[i]);
Iif (address(trade) != address(0) && trade.canSettle()) {
revenueTrader.settleTrade(reg.erc20s[i]);
}
uint256 tradesOpen = revenueTrader.tradesOpen();
try revenueTrader.manageToken(reg.erc20s[i]) {
if (revenueTrader.tradesOpen() - tradesOpen > 0) {
unfiltered[num] = reg.erc20s[i];
++num;
}
} catch {}
}
// Filter down
toStart = new IERC20[](num);
for (uint256 i = 0; i < num; ++i) {
toStart[i] = unfiltered[i];
}
}
/// To use this, first call:
/// - FacadeRead.auctionsSettleable(revenueTrader)
/// - getRevenueAuctionERC20s(revenueTrader)
/// If either arrays returned are non-empty, then can call this function.
/// Logic:
/// For each ERC20 in `toSettle`:
/// - Settle any open ERC20 trades
/// For each ERC20 in `toStart`:
/// - Transfer any revenue for that ERC20 from the backingManager to revenueTrader
/// - Call `revenueTrader.manageToken(ERC20)` to start an auction
function runRevenueAuctions(
IRevenueTrader revenueTrader,
IERC20[] memory toSettle,
IERC20[] memory toStart
) external {
// Settle auctions
for (uint256 i = 0; i < toSettle.length; ++i) {
revenueTrader.settleTrade(toSettle[i]);
}
// Transfer revenue backingManager -> revenueTrader
revenueTrader.main().backingManager().manageTokens(toStart);
// Start auctions
for (uint256 i = 0; i < toStart.length; ++i) {
revenueTrader.manageToken(toStart[i]);
}
}
}
|