Skip to content

Commit

Permalink
Apply linting to contracts and remove some innecessary dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
@sembrestels
sembrestels committed Nov 7, 2020
1 parent ecb1cb4 commit a1c1ce8
Show file tree
Hide file tree
Showing 11 changed files with 157 additions and 99 deletions.
8 changes: 4 additions & 4 deletions .travis.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ jobs:
script: npm run lint
name: 'All'
- stage: tests
script: npm run test:marketplace
name: 'Aragon Fundraising'
script: npm run test:controller
name: 'Marketplace Controller'
- script: npm run test:bancor-market-maker
name: 'Bancor Market Maker'
- script: npm run test:presale
name: 'Presale'
- stage: coverage
script: npm run coverage:marketplace
name: 'Aragon Fundraising'
script: npm run coverage:controller
name: 'Marketplace Controller'
- script: npm run coverage:bancor-market-maker
name: 'Bancor Market Maker'
- script: npm run coverage:presale
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This module provides market liquidity to the marketplacee by automatically match
| [`@1hive/apps-marketplace-bancor-formula`](/apps/bancor-formula) | | `BancorFormula` computation contract |
| [`@1hive/apps-marketplace-bancor-market-maker`](/apps/bancor-market-maker) | | Automated market-maker batching orders filled through the `BancorFormula` |
| [`@1hive/apps-marketplace-presale`](/apps/presale) | | Initial fundraising to hatch the bonding curve |
| [`@1hive/apps-marketplace`](/apps/marketplace-controller) | | `API` contract providing a single entry-point to interact consistently with all marketplace-related contracts |
| [`@1hive/apps-marketplace-controller`](/apps/marketplace-controller) | | `API` contract providing a single entry-point to interact consistently with all marketplace-related contracts |


## Contributing
Expand Down
84 changes: 60 additions & 24 deletions apps/bancor-formula/contracts/BancorFormula.sol
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
pragma solidity 0.4.24;
import "@1hive/apps-marketplace-shared-interfaces/contracts/IBancorFormula.sol";
import "@aragon/os/contracts/lib/math/SafeMath.sol";
import './utility/Utils.sol';
import "./utility/Utils.sol";


contract BancorFormula is IBancorFormula, Utils {
using SafeMath for uint256;


string public version = '0.3';
string public version = "0.3";

uint256 private constant ONE = 1;
uint32 private constant MAX_WEIGHT = 1000000;
Expand Down Expand Up @@ -38,6 +39,7 @@ contract BancorFormula is IBancorFormula, Utils {
*/
uint256[128] private maxExpArray;
constructor() public {
// solium-disable whitespace
// maxExpArray[ 0] = 0x6bffffffffffffffffffffffffffffffff;
// maxExpArray[ 1] = 0x67ffffffffffffffffffffffffffffffff;
// maxExpArray[ 2] = 0x637fffffffffffffffffffffffffffffff;
Expand Down Expand Up @@ -166,6 +168,7 @@ contract BancorFormula is IBancorFormula, Utils {
maxExpArray[125] = 0x009131271922eaa6064b73a22d0bd4f2bf;
maxExpArray[126] = 0x008b380f3558668c46c91c49a2f8e967b9;
maxExpArray[127] = 0x00857ddf0117efa215952912839f6473e6;
// solium-enable whitespace
}

/**
Expand All @@ -182,7 +185,14 @@ contract BancorFormula is IBancorFormula, Utils {
@return purchase return amount
*/
function calculatePurchaseReturn(uint256 _supply, uint256 _connectorBalance, uint32 _connectorWeight, uint256 _depositAmount) public view returns (uint256) {
function calculatePurchaseReturn(
uint256 _supply,
uint256 _connectorBalance,
uint32 _connectorWeight,
uint256 _depositAmount
)
public view returns (uint256)
{
// validate input
require(_supply > 0 && _connectorBalance > 0 && _connectorWeight > 0 && _connectorWeight <= MAX_WEIGHT);

Expand Down Expand Up @@ -216,7 +226,14 @@ contract BancorFormula is IBancorFormula, Utils {
@return sale return amount
*/
function calculateSaleReturn(uint256 _supply, uint256 _connectorBalance, uint32 _connectorWeight, uint256 _sellAmount) public view returns (uint256) {
function calculateSaleReturn(
uint256 _supply,
uint256 _connectorBalance,
uint32 _connectorWeight,
uint256 _sellAmount
)
public view returns (uint256)
{
// validate input
require(_supply > 0 && _connectorBalance > 0 && _connectorWeight > 0 && _connectorWeight <= MAX_WEIGHT && _sellAmount <= _supply);

Expand Down Expand Up @@ -256,13 +273,28 @@ contract BancorFormula is IBancorFormula, Utils {
@return second connector amount
*/
function calculateCrossConnectorReturn(uint256 _fromConnectorBalance, uint32 _fromConnectorWeight, uint256 _toConnectorBalance, uint32 _toConnectorWeight, uint256 _amount) public view returns (uint256) {
function calculateCrossConnectorReturn(
uint256 _fromConnectorBalance,
uint32 _fromConnectorWeight,
uint256 _toConnectorBalance,
uint32 _toConnectorWeight,
uint256 _amount
)
public view returns (uint256)
{
// validate input
require(_fromConnectorBalance > 0 && _fromConnectorWeight > 0 && _fromConnectorWeight <= MAX_WEIGHT && _toConnectorBalance > 0 && _toConnectorWeight > 0 && _toConnectorWeight <= MAX_WEIGHT);
require(
_fromConnectorBalance > 0 &&
_fromConnectorWeight > 0 &&
_fromConnectorWeight <= MAX_WEIGHT &&
_toConnectorBalance > 0 &&
_toConnectorWeight > 0 &&
_toConnectorWeight <= MAX_WEIGHT);

// special case for equal weights
if (_fromConnectorWeight == _toConnectorWeight)
if (_fromConnectorWeight == _toConnectorWeight) {
return _toConnectorBalance.mul(_amount) / _fromConnectorBalance.add(_amount);
}

uint256 result;
uint8 precision;
Expand Down Expand Up @@ -297,16 +329,14 @@ contract BancorFormula is IBancorFormula, Utils {
uint256 base = _baseN * FIXED_1 / _baseD;
if (base < OPT_LOG_MAX_VAL) {
baseLog = optimalLog(base);
}
else {
} else {
baseLog = generalLog(base);
}

uint256 baseLogTimesExp = baseLog * _expN / _expD;
if (baseLogTimesExp < OPT_EXP_MAX_VAL) {
return (optimalExp(baseLogTimesExp), MAX_PRECISION);
}
else {
} else {
uint8 precision = findPositionInMaxExpArray(baseLogTimesExp);
return (generalExp(baseLogTimesExp >> (MAX_PRECISION - precision), precision), precision);
}
Expand Down Expand Up @@ -352,8 +382,7 @@ contract BancorFormula is IBancorFormula, Utils {
_n >>= 1;
res += 1;
}
}
else {
} else {
// Exactly 8 iterations
for (uint8 s = 128; s > 0; s >>= 1) {
if (_n >= (ONE << s)) {
Expand All @@ -377,16 +406,19 @@ contract BancorFormula is IBancorFormula, Utils {

while (lo + 1 < hi) {
uint8 mid = (lo + hi) / 2;
if (maxExpArray[mid] >= _x)
if (maxExpArray[mid] >= _x) {
lo = mid;
else
} else {
hi = mid;
}
}

if (maxExpArray[hi] >= _x)
if (maxExpArray[hi] >= _x) {
return hi;
if (maxExpArray[lo] >= _x)
}
if (maxExpArray[lo] >= _x) {
return lo;
}

require(false);
return 0;
Expand Down Expand Up @@ -457,6 +489,7 @@ contract BancorFormula is IBancorFormula, Utils {
uint256 z;
uint256 w;

// solium-disable max-len
if (x >= 0xd3094c70f034de4b96ff7d5b6f99fcd8) {res += 0x40000000000000000000000000000000; x = x * FIXED_1 / 0xd3094c70f034de4b96ff7d5b6f99fcd8;} // add 1 / 2^1
if (x >= 0xa45af1e1f40c333b3de1db4dd55f29a7) {res += 0x20000000000000000000000000000000; x = x * FIXED_1 / 0xa45af1e1f40c333b3de1db4dd55f29a7;} // add 1 / 2^2
if (x >= 0x910b022db7ae67ce76b441c27035c6a1) {res += 0x10000000000000000000000000000000; x = x * FIXED_1 / 0x910b022db7ae67ce76b441c27035c6a1;} // add 1 / 2^3
Expand All @@ -476,6 +509,7 @@ contract BancorFormula is IBancorFormula, Utils {
res += z * (0x08ba2e8ba2e8ba2e8ba2e8ba2e8ba2e8b - y) / 0x600000000000000000000000000000000; z = z * w / FIXED_1; // add y^11 / 11 - y^12 / 12
res += z * (0x089d89d89d89d89d89d89d89d89d89d89 - y) / 0x700000000000000000000000000000000; z = z * w / FIXED_1; // add y^13 / 13 - y^14 / 14
res += z * (0x088888888888888888888888888888888 - y) / 0x800000000000000000000000000000000; // add y^15 / 15 - y^16 / 16
// solium-enable max-len

return res;
}
Expand Down Expand Up @@ -519,13 +553,15 @@ contract BancorFormula is IBancorFormula, Utils {
z = z * y / FIXED_1; res += z * 0x0000000000000001; // add y^20 * (20! / 20!)
res = res / 0x21c3677c82b40000 + y + FIXED_1; // divide by 20! and then add y^1 / 1! + y^0 / 0!

if ((x & 0x010000000000000000000000000000000) != 0) res = res * 0x1c3d6a24ed82218787d624d3e5eba95f9 / 0x18ebef9eac820ae8682b9793ac6d1e776; // multiply by e^2^(-3)
if ((x & 0x020000000000000000000000000000000) != 0) res = res * 0x18ebef9eac820ae8682b9793ac6d1e778 / 0x1368b2fc6f9609fe7aceb46aa619baed4; // multiply by e^2^(-2)
if ((x & 0x040000000000000000000000000000000) != 0) res = res * 0x1368b2fc6f9609fe7aceb46aa619baed5 / 0x0bc5ab1b16779be3575bd8f0520a9f21f; // multiply by e^2^(-1)
if ((x & 0x080000000000000000000000000000000) != 0) res = res * 0x0bc5ab1b16779be3575bd8f0520a9f21e / 0x0454aaa8efe072e7f6ddbab84b40a55c9; // multiply by e^2^(+0)
if ((x & 0x100000000000000000000000000000000) != 0) res = res * 0x0454aaa8efe072e7f6ddbab84b40a55c5 / 0x00960aadc109e7a3bf4578099615711ea; // multiply by e^2^(+1)
if ((x & 0x200000000000000000000000000000000) != 0) res = res * 0x00960aadc109e7a3bf4578099615711d7 / 0x0002bf84208204f5977f9a8cf01fdce3d; // multiply by e^2^(+2)
if ((x & 0x400000000000000000000000000000000) != 0) res = res * 0x0002bf84208204f5977f9a8cf01fdc307 / 0x0000003c6ab775dd0b95b4cbee7e65d11; // multiply by e^2^(+3)
// solium-disable max-len
if ((x & 0x010000000000000000000000000000000) != 0) {res = res * 0x1c3d6a24ed82218787d624d3e5eba95f9 / 0x18ebef9eac820ae8682b9793ac6d1e776;} // multiply by e^2^(-3)
if ((x & 0x020000000000000000000000000000000) != 0) {res = res * 0x18ebef9eac820ae8682b9793ac6d1e778 / 0x1368b2fc6f9609fe7aceb46aa619baed4;} // multiply by e^2^(-2)
if ((x & 0x040000000000000000000000000000000) != 0) {res = res * 0x1368b2fc6f9609fe7aceb46aa619baed5 / 0x0bc5ab1b16779be3575bd8f0520a9f21f;} // multiply by e^2^(-1)
if ((x & 0x080000000000000000000000000000000) != 0) {res = res * 0x0bc5ab1b16779be3575bd8f0520a9f21e / 0x0454aaa8efe072e7f6ddbab84b40a55c9;} // multiply by e^2^(+0)
if ((x & 0x100000000000000000000000000000000) != 0) {res = res * 0x0454aaa8efe072e7f6ddbab84b40a55c5 / 0x00960aadc109e7a3bf4578099615711ea;} // multiply by e^2^(+1)
if ((x & 0x200000000000000000000000000000000) != 0) {res = res * 0x00960aadc109e7a3bf4578099615711d7 / 0x0002bf84208204f5977f9a8cf01fdce3d;} // multiply by e^2^(+2)
if ((x & 0x400000000000000000000000000000000) != 0) {res = res * 0x0002bf84208204f5977f9a8cf01fdc307 / 0x0000003c6ab775dd0b95b4cbee7e65d11;} // multiply by e^2^(+3)
// solium-enable max-len

return res;
}
Expand Down
1 change: 1 addition & 0 deletions apps/bancor-formula/contracts/utility/SafeMath.sol
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
pragma solidity 0.4.24;


/*
Library for basic math operations with overflow/underflow protection
*/
Expand Down
6 changes: 4 additions & 2 deletions apps/bancor-formula/contracts/utility/Utils.sol
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
pragma solidity 0.4.24;


/*
Utilities & Common Modifiers
*/
contract Utils {
/**
constructor
*/
* constructor
*/
constructor() public {
// solium-disable-previous-line no-empty-blocks
}

// verifies that an amount is greater than zero
Expand Down
2 changes: 2 additions & 0 deletions apps/bancor-formula/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"license": "(GPL-3.0-or-later OR AGPL-3.0-or-later)",
"homepage": "https://github.com/AragonBlack/fundraising",
"scripts": {
"lint": "solium --dir ./contracts --config ../../.soliumrc.json --no-soliumignore",
"compile": "buidler compile --force",
"abi:extract": "buidler-extract --output abi/ --keys abi",
"publish": "buidler publish major"
Expand All @@ -28,6 +29,7 @@
"@nomiclabs/buidler-solhint": "^1.3.3",
"@nomiclabs/buidler-truffle5": "^1.3.4",
"@nomiclabs/buidler-web3": "^1.3.4",
"solium": "^1.2.3",
"buidler-extract": "^1.0.0",
"buidler-gas-reporter": "^0.1.3"
}
Expand Down
85 changes: 43 additions & 42 deletions apps/bancor-market-maker/contracts/BancorMarketMaker.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import "@aragon/apps-vault/contracts/Vault.sol";
import "@1hive/apps-marketplace-shared-interfaces/contracts/IBancorFormula.sol";
import "@1hive/apps-marketplace-shared-interfaces/contracts/IMarketplaceController.sol";


contract BancorMarketMaker is EtherTokenConstant, IsContract, AragonApp {
using SafeERC20 for ERC20;
using SafeMath for uint256;
Expand Down Expand Up @@ -285,45 +286,6 @@ contract BancorMarketMaker is EtherTokenConstant, IsContract, AragonApp {
_makeBuyOrder(buyerAddress, collateralTokenAddress, depositAmount, minReturnAmountAfterFee, true);
}

/**
* @dev Make a buy order
* @param _buyer The address of the buyer
* @param _collateral The address of the collateral token to be deposited
* @param _depositAmount The amount of collateral token to be deposited
* @param _minReturnAmountAfterFee The minimum amount of the returned bonded tokens
* @param _noPreApproval Whether or not funds should have already been transferred
*/
function _makeBuyOrder(address _buyer, address _collateral, uint256 _depositAmount, uint256 _minReturnAmountAfterFee, bool _noPreApproval)
internal nonReentrant
{
require(isOpen, ERROR_NOT_OPEN);
require(_collateralIsWhitelisted(_collateral), ERROR_COLLATERAL_NOT_WHITELISTED);
require(_collateralValueIsValid(_buyer, _collateral, _depositAmount, msg.value, _noPreApproval), ERROR_INVALID_COLLATERAL_VALUE);

// deduct fee
uint256 fee = _depositAmount.mul(buyFeePct).div(PCT_BASE);
uint256 depositAmountLessFee = _depositAmount.sub(fee);

// collect fee and collateral
if (fee > 0) {
_transfer(_buyer, beneficiary, _collateral, fee, _noPreApproval);
}
_transfer(_buyer, address(reserve), _collateral, depositAmountLessFee, _noPreApproval);

uint256 collateralSupply = token.totalSupply().add(collaterals[_collateral].virtualSupply);
uint256 collateralBalanceOfReserve = controller.balanceOf(address(reserve), _collateral).add(collaterals[_collateral].virtualBalance);
uint32 reserveRatio = collaterals[_collateral].reserveRatio;
uint256 returnAmount = formula.calculatePurchaseReturn(collateralSupply, collateralBalanceOfReserve, reserveRatio, depositAmountLessFee);

require(returnAmount >= _minReturnAmountAfterFee, ERROR_SLIPPAGE_EXCEEDS_LIMIT);

if (returnAmount > 0) {
tokenManager.mint(_buyer, returnAmount);
}

emit MakeBuyOrder(_buyer, _collateral, fee, depositAmountLessFee, returnAmount, buyFeePct);
}

/**
* @notice Make a sell order worth `@tokenAmount(self.token(): address, _sellAmount)` for atleast `@tokenAmount(_collateral, _minReturnAmountAfterFee)`
* @param _seller The address of the seller
Expand Down Expand Up @@ -405,9 +367,9 @@ contract BancorMarketMaker is EtherTokenConstant, IsContract, AragonApp {
return _msgValue == _value;
}

bool buyerAllowanceAvailable = !_noPreApproval
&& controller.balanceOf(_buyer, _collateral) >= _value
&& ERC20(_collateral).allowance(_buyer, address(this)) >= _value;
bool buyerAllowanceAvailable = !_noPreApproval &&
controller.balanceOf(_buyer, _collateral) >= _value &&
ERC20(_collateral).allowance(_buyer, address(this)) >= _value;

bool fundsAlreadyDeposited = _noPreApproval && controller.balanceOf(address(this), _collateral) >= _value;

Expand All @@ -424,6 +386,45 @@ contract BancorMarketMaker is EtherTokenConstant, IsContract, AragonApp {

/* initialization functions */

/**
* @dev Make a buy order
* @param _buyer The address of the buyer
* @param _collateral The address of the collateral token to be deposited
* @param _depositAmount The amount of collateral token to be deposited
* @param _minReturnAmountAfterFee The minimum amount of the returned bonded tokens
* @param _noPreApproval Whether or not funds should have already been transferred
*/
function _makeBuyOrder(address _buyer, address _collateral, uint256 _depositAmount, uint256 _minReturnAmountAfterFee, bool _noPreApproval)
internal nonReentrant
{
require(isOpen, ERROR_NOT_OPEN);
require(_collateralIsWhitelisted(_collateral), ERROR_COLLATERAL_NOT_WHITELISTED);
require(_collateralValueIsValid(_buyer, _collateral, _depositAmount, msg.value, _noPreApproval), ERROR_INVALID_COLLATERAL_VALUE);

// deduct fee
uint256 fee = _depositAmount.mul(buyFeePct).div(PCT_BASE);
uint256 depositAmountLessFee = _depositAmount.sub(fee);

// collect fee and collateral
if (fee > 0) {
_transfer(_buyer, beneficiary, _collateral, fee, _noPreApproval);
}
_transfer(_buyer, address(reserve), _collateral, depositAmountLessFee, _noPreApproval);

uint256 collateralSupply = token.totalSupply().add(collaterals[_collateral].virtualSupply);
uint256 collateralBalanceOfReserve = controller.balanceOf(address(reserve), _collateral).add(collaterals[_collateral].virtualBalance);
uint32 reserveRatio = collaterals[_collateral].reserveRatio;
uint256 returnAmount = formula.calculatePurchaseReturn(collateralSupply, collateralBalanceOfReserve, reserveRatio, depositAmountLessFee);

require(returnAmount >= _minReturnAmountAfterFee, ERROR_SLIPPAGE_EXCEEDS_LIMIT);

if (returnAmount > 0) {
tokenManager.mint(_buyer, returnAmount);
}

emit MakeBuyOrder(_buyer, _collateral, fee, depositAmountLessFee, returnAmount, buyFeePct);
}

/* state modifiying functions */

function _open() internal {
Expand Down
Loading

0 comments on commit a1c1ce8

Please sign in to comment.