CORE Vault
Search…
English
CORE FORMULAS
User Guides
Bug Bounty Program
Code Overview
Flash Arbitrage
CORE’s high level arbitrage suite consists of three contracts:
- Arbitrage Executor
The Arbitrage Executor is the brain of our Flash Arbitrage, it calculates scenarios and executes the trades. This contract is closed source.
- Arbitrage Controller
The Arbitrage Controller is responsible for adding and storing all strategies. It calls the Arbitrage Executor and then splits the profits between the Caller and the CORE Buyer Contract. It vastly simplifies the interface to the Executor.
- Core Buyer Contract
This contract turns the arbitrage profits into CORE and transfers them directly to farmers.
No input is required to run these contracts, the loan is created by using Uniswaps Flash Swaps. This means only your gas cost is at stake. While the contract isn’t guaranteeing gas returns, you can always query the amount returned.
Overview of the Arbitrage Controller functions:
The creation of a new strategy emits an event which can be listened to and queried by.
1
event StrategyAdded(string indexed name, uint256 indexed id, address[] pairs, bool feeOff, address indexed originator);
2
3
struct Strategy {
4
string strategyName;
5
bool[] token0Out; // An array saying if token 0 should be out in this step
6
address[] pairs; // Array of pair addresses
7
uint256[] feeOnTransfers; //Array of fee on transfers 1% = 10
8
bool cBTCSupport; // Should the algorithm check for cBTC and wrap/unwrap it
9
// Note not checking saves gas
10
bool feeOff; // Allows for adding CORE strategies - where there is no fee on the executor
11
}
Copied!
The Arbitrage Controller is storing each strategy in a public array inside the smart contract. Each strategy has a name and an array of token0out — this is to support Uniswap so we know which way to conduct the trade in the Executor.
1
address[] pairs; // Array of pair addresses
Copied!
This shows the array of pairs that the trade will be in.
1
uint256[] feeOnTransfers; //Array of fee on transfers 1% = 10
Copied!
Strategies support Fee on Transfer tokens with fee on transfer array here. It allows people to input that this strategy has a fee on transfer, which signals the contract to calculate and execute the strategy correctly.
1
bool cBTCSupport; // Should the algorithm check for cBTC and wrap/unwrap it
2
// Note not checking saves gas
Copied!
cBTC support is determined by itself. You can not input it.
1
bool feeOff; // Allows for adding CORE strategies - where there is no fee on the executor
Copied!
This allows for a FoT Off strategy. Adding strategies involving CORE and feeOff is not permitted by anyone. To avoid atypical scenarios with feeOff.
Revenue split: The revenue split between the Caller and CORE Buyer Contract is dependant on the strategy utilizing feeOff or feeOn.
Strategies that are outside of CORE reward the Caller with the majority of the profits. The ease of use and profit split encourages usage of the service. It is easier to add strategies to this contract and share the profits than having to create your own complex suite of contracts. All strategies, including new creations, are open source and can be used by everyone.
Adding New Strategies
Users can add new strategies as long as they are valid. To create a valid strategy one must input an array of pairs (comma separated list) which has a logically flow from each other.
CORE pairs can not be added by the community. Only by CORE devs.
This closes the loop by itself, no need to input CORE/wETH again since the last pair will be treated as a return pair. The controller detects if cBTC is used and sets the support automatically. It makes sure the Executor picks the correct branch to execute and save gas in case support for cBTC is not on.
1
function addNewStrategy(bool borrowToken0, address[] memory pairs) public returns (uint256 strategyID) {
2
3
uint256[] memory feeOnTransfers = new uint256[](pairs.length);
4
strategyID = addNewStrategyWithFeeOnTransferTokens(borrowToken0, pairs, feeOnTransfers);
5
6
}
Copied!
addNewStrategy function is used for adding new strategies with no fee on transfers anywhere.
1
function addNewStrategyWithFeeOnTransferTokens(bool borrowToken0, address[] memory pairs, uint256[] memory feeOnTransfers) public returns (uint256 strategyID)
Copied!
addNewStrategyWithFeeOnTransferTokens supports fee on transfer input, to support fee on transfer tokens all over.
1
function numberOfStrategies() public view returns (uint256) {
2
return strategies.length;
Copied!
numberOfStrategies function returns the number of strategies (routes of arbitrage) inside the contract which everyone can easily scan in a loop.
1
function strategyProfitInReturnToken(uint256 strategyID) public view returns (uint256 profit) {
2
Strategy memory currentStrategy = strategies[strategyID];
3
return executor.getStrategyProfitInReturnToken(currentStrategy.pairs, currentStrategy.feeOnTransfers, currentStrategy.token0Out);
4
}
Copied!
Querying Profits from Strategies. The executor has a view function which returns the queried profit if the strategy was executed at that exact moment.
This function should be used to scan all outstanding strategies from the previous step and calling executions immediately.
Strategy Execution
There are two paths that strategy execution can take:
- 1.Skip calculating Optimal Input
- 2.Calculate Optimal Input at the time of execution
Number 1 is meant for miners, which know the optimal input without calculating it on chain.
1
function executeStrategy(uint256 strategyPID) public {
2
require(!depreciated, "This Contract is depreciated");
3
Strategy memory currentStrategy = strategies[strategyPID];
4
5
executor.executeStrategy(currentStrategy.pairs, currentStrategy.feeOnTransfers, currentStrategy.token0Out, currentStrategy.cBTCSupport);
6
7
8
// Eg. Token 0 was out so profit token is token 1
9
address profitToken = currentStrategy.token0Out[0] ?
10
IUniswapV2Pair(currentStrategy.pairs[0]).token1()
11
:
12
IUniswapV2Pair(currentStrategy.pairs[0]).token0();
13
14
15
uint256 profit = IERC20(profitToken).balanceOf(address(this));
16
17
// We split the profit based on the strategy
18
if(currentStrategy.feeOff) {
19
safeTransfer(profitToken, msg.sender, profit.mul(revenueSplitFeeOffStrategy).div(1000));
20
}
21
else {
22
safeTransfer(profitToken, msg.sender, profit.mul(revenueSplitFeeOnStrategy).div(1000));
23
}
24
25
safeTransfer(profitToken, distributor, IERC20(profitToken).balanceOf(address(this)));
26
27
}
Copied!
Self calculating execution just requires strategy PID. Strategies that do not automatically calculate amount input, meant for miners.
Adding Optimal Input:
1
function getOptimalInput(uint256 strategyPID) public view returns (uint256) {
2
Strategy memory currentStrategy = strategies[strategyPID];
3
return executor.getOptimalInput(currentStrategy.pairs, currentStrategy.feeOnTransfers, currentStrategy.token0Out);
4
}
Copied!
A view that returns the optimal input amount, which should be inputted in the execution function below:
1
function executeStrategy(uint256 inputAmount, uint256 strategyPID) public {
Copied!
Both execution strategy functions ensure you get promised profit and non-opaque split numbers.
The Flash Arbitrage executor does not hold any tokens, it only swaps them, picking the best path that will lower the gas used as much as possible as well as not writing any balances in its memory to save additional gas costs.
CORE Buyer Contract
This contract receives tokens, either from the Arbitrage Controller, or any other source in general and sells them for CORE.
If a CORE pair exists for the received token, it will sell it directly to CORE. In case of not having a token pair with CORE, the contract will sell the token for Ethereum and then buy CORE in the CORE/WETH pool immediately. All CORE will be distributed to farmers.
1
function buyAndGiveOutCOREForToken(address _token) public {
2
3
// We check if this token is CORE token if it is we just send it out
4
if(_token == address(CORE)) {
5
// return breaks out no need to else..else..
6
return sendCOREToVault();
7
}
8
uint256 balInputToken = IERC20(_token).balanceOf(address(this));
9
10
address pairWithCORE = uniswapFactory.getPair(_token, address(CORE));
11
// We check if there is a pair for CORE token with that token
12
if(pairWithCORE != address(0) && supportedPair[pairWithCORE]){ // we check supported pair so people don't make 1 liquidity pair iwth CORE
13
// It mens we have a pair with CORE
14
// So we should just swap with it
15
//Suport FoT tokens
16
17
uint256 amountOut = swapSupportingFeeOnTransfertokens(_token, pairWithCORE, balInputToken);
18
emit COREBought(amountOut);
19
return sendCOREToVault();
20
}
21
22
// This is the case we are not finding a pair with CORE so we try to find one with wETH
23
address pairWithWETH = uniswapFactory.getPair(_token, wETH);
24
if(pairWithWETH != address(0)) {
25
uint256 amountOut = swapSupportingFeeOnTransfertokens(_token, pairWithWETH, balInputToken);
26
27
amountOut = swapSupportingFeeOnTransfertokens(wETH, CORExWETHPair, amountOut);
28
emit COREBought(amountOut);
29
sendCOREToVault();
30
}
31
else {
32
revert("FA COREBuyer : Unsupported token");
33
}
34
35
36
37
38
}
Copied!
Anyone can call this function by inserting an address for the token. This will automatically conduct a swap and distribute the token to LP stakers.
Last modified 1yr ago