add custom errors

[YouStillAlive]

closes #21

[github-actions]

Methods

Symbol	Meaning
◯	Execution gas for this method does not include intrinsic gas overhead
△	Cost was non-zero but below the precision setting for the currency display (see options)

	Min	Max	Avg	Calls	usd avg
BNBPartyFactory
createParty(string,string)	5,645,887	5,827,221	5,772,476	6	3.32
joinParty(address,uint256)	130,440	251,966	191,203	2	0.11
leaveParty(address,uint256,uint256)	176,889	190,569	183,729	2	0.11
setNonfungiblePositionManager(address,address)	27,381	68,882	55,048	3	0.03
setSwapRouter(address)	24,097	46,237	38,857	3	0.02
NonfungiblePositionManager
approve(address,uint256)	46,052	46,371	46,285	4	0.03
SwapRouter
exactInput((bytes,address,uint256,uint256,uint256))	109,789	119,347	116,161	3	0.07
multicall(bytes[])	-	-	136,478	2	0.08

Deployments

	Min	Max	Avg	Block %	usd avg
BNBPartyFactory	-	-	2,545,757	2 %	1.46
MockNonfungibleTokenPositionDescriptor	-	-	111,537	0.1 %	0.06
NonfungiblePositionManager	-	-	5,171,524	4 %	2.97
SwapRouter	-	-	2,201,090	1.7 %	1.26
UniswapV3Factory	-	-	5,437,109	4.2 %	3.12

Solidity and Network Config

Settings	Value
Solidity: version	0.8.24
Solidity: optimized	true
Solidity: runs	200
Solidity: viaIR	false
Block Limit	130,000,000
L1 Gas Price	1 gwei
Token Price	574.30 usd/bnb
Network	BINANCE
Toolchain	hardhat

[github-actions]

Slither report

THIS CHECKLIST IS NOT COMPLETE. Use --show-ignored-findings to show all the results.
Summary

• incorrect-equality (1 results) (Medium)
• reentrancy-no-eth (1 results) (Medium)
• uninitialized-local (2 results) (Medium)
• unused-return (5 results) (Medium)
• shadowing-local (2 results) (Low)
• reentrancy-benign (2 results) (Low)
• assembly (1 results) (Informational)
• low-level-calls (6 results) (Informational)
• naming-convention (7 results) (Informational)
• unused-import (1 results) (Informational)

incorrect-equality

Impact: Medium
Confidence: High

• ID-0
  BNBPartyInternal._createFLP(address) uses a dangerous strict equality:
  • IERC20(tokenA).balanceOf(address(this)) == party.initialTokenAmount

BNBParty.Factory/contracts/BNBPartyInternal.sol

Lines 9 to 37 in fcc51ca

	function _createFLP(
	address _token
	) internal returns (address liquidityPool) {
	// tokenA < tokenB
	(address tokenA, address tokenB) = _token < address(WBNB)
	? (_token, address(WBNB))
	: (address(WBNB), _token);
	uint256 amount0;
	uint256 amount1;
	if (IERC20(tokenA).balanceOf(address(this)) == party.initialTokenAmount) {
	amount0 = party.initialTokenAmount;
	} else {
	amount1 = party.initialTokenAmount;
	}
	IERC20(_token).approve(
	address(BNBPositionManager),
	party.initialTokenAmount
	);
	liquidityPool = _createLP(
	BNBPositionManager,
	tokenA,
	tokenB,
	amount0,
	amount1,
	party.partyLpFee
	);
	isParty[liquidityPool] = true;
	}

reentrancy-no-eth

Impact: Medium
Confidence: Medium

• ID-1
  Reentrancy in BNBPartyInternal._handleLiquidity():
  External calls:
  • (amount0,amount1) = BNBPositionManager.decreaseLiquidity(INonfungiblePositionManager.DecreaseLiquidityParams({tokenId:lpToTokenId[msg.sender],liquidity:pool.liquidity(),amount0Min:0,amount1Min:0,deadline:block.timestamp}))
  • IERC20(token0).approve(address(positionManager),amount0)
  • IERC20(token1).approve(address(positionManager),amount1)
  • _createLP(positionManager,token0,token1,amount0,amount1,party.lpFee)
    • liquidityPool = liquidityManager.createAndInitializePoolIfNecessary(token0,token1,fee,party.sqrtPriceX96)
    • (lpToTokenId[liquidityPool],None,None,None) = liquidityManager.mint(INonfungiblePositionManager.MintParams({token0:token0,token1:token1,fee:fee,tickLower:party.tickLower,tickUpper:party.tickUpper,amount0Desired:amount0,amount1Desired:amount1,amount0Min:0,amount1Min:0,recipient:address(this),deadline:block.timestamp}))
      State variables written after the call(s):
  • _createLP(positionManager,token0,token1,amount0,amount1,party.lpFee)
    • (lpToTokenId[liquidityPool],None,None,None) = liquidityManager.mint(INonfungiblePositionManager.MintParams({token0:token0,token1:token1,fee:fee,tickLower:party.tickLower,tickUpper:party.tickUpper,amount0Desired:amount0,amount1Desired:amount1,amount0Min:0,amount1Min:0,recipient:address(this),deadline:block.timestamp}))
      BNBPartyState.lpToTokenId can be used in cross function reentrancies:
  • BNBPartyState.lpToTokenId

BNBParty.Factory/contracts/BNBPartyInternal.sol

Lines 79 to 99 in fcc51ca

	function _handleLiquidity() internal {
	// deacrease liquidity from old pool
	IUniswapV3Pool pool = IUniswapV3Pool(msg.sender);
	(uint256 amount0, uint256 amount1) = BNBPositionManager
	.decreaseLiquidity(
	INonfungiblePositionManager.DecreaseLiquidityParams({
	tokenId: lpToTokenId[msg.sender],
	liquidity: pool.liquidity(),
	amount0Min: 0,
	amount1Min: 0,
	deadline: block.timestamp
	})
	);
	address token0 = pool.token0();
	address token1 = pool.token1();
	// approve new LP
	IERC20(token0).approve(address(positionManager), amount0);
	IERC20(token1).approve(address(positionManager), amount1);
	// create new Liquidity Pool
	_createLP(positionManager, token0, token1, amount0, amount1, party.lpFee);
	}

uninitialized-local

Impact: Medium
Confidence: Medium

• ID-2
  BNBPartyInternal._createFLP(address).amount0 is a local variable never initialized

BNBParty.Factory/contracts/BNBPartyInternal.sol

Line 16 in fcc51ca

uint256 amount0;

• ID-3
  BNBPartyInternal._createFLP(address).amount1 is a local variable never initialized

BNBParty.Factory/contracts/BNBPartyInternal.sol

Line 17 in fcc51ca

uint256 amount1;

unused-return

Impact: Medium
Confidence: Medium

• ID-4
  BNBPartyInternal._executeSwap(address,address,address,uint256,uint256) ignores return value by swapRouter.exactInput{value: amountIn}(params)

BNBParty.Factory/contracts/BNBPartyInternal.sol

Lines 106 to 123 in fcc51ca

	function _executeSwap(
	address tokenIn,
	address tokenOut,
	address recipient,
	uint256 amountOutMinimum,
	uint256 amountIn
	) internal notZeroAddress(address(swapRouter)) {
	ISwapRouter.ExactInputParams memory params = ISwapRouter
	.ExactInputParams({
	path: abi.encodePacked(tokenIn, party.partyLpFee, tokenOut),
	recipient: recipient,
	deadline: block.timestamp,
	amountIn: amountIn,
	amountOutMinimum: amountOutMinimum
	});
	swapRouter.exactInput{value: amountIn }(params);
	}

• ID-5
  BNBPartyInternal._handleLiquidity() ignores return value by IERC20(token0).approve(address(positionManager),amount0)

BNBParty.Factory/contracts/BNBPartyInternal.sol

Lines 79 to 99 in fcc51ca

	function _handleLiquidity() internal {
	// deacrease liquidity from old pool
	IUniswapV3Pool pool = IUniswapV3Pool(msg.sender);
	(uint256 amount0, uint256 amount1) = BNBPositionManager
	.decreaseLiquidity(
	INonfungiblePositionManager.DecreaseLiquidityParams({
	tokenId: lpToTokenId[msg.sender],
	liquidity: pool.liquidity(),
	amount0Min: 0,
	amount1Min: 0,
	deadline: block.timestamp
	})
	);
	address token0 = pool.token0();
	address token1 = pool.token1();
	// approve new LP
	IERC20(token0).approve(address(positionManager), amount0);
	IERC20(token1).approve(address(positionManager), amount1);
	// create new Liquidity Pool
	_createLP(positionManager, token0, token1, amount0, amount1, party.lpFee);
	}

• ID-6
  BNBPartyInternal._handleLiquidity() ignores return value by IERC20(token1).approve(address(positionManager),amount1)

BNBParty.Factory/contracts/BNBPartyInternal.sol

Lines 79 to 99 in fcc51ca

	function _handleLiquidity() internal {
	// deacrease liquidity from old pool
	IUniswapV3Pool pool = IUniswapV3Pool(msg.sender);
	(uint256 amount0, uint256 amount1) = BNBPositionManager
	.decreaseLiquidity(
	INonfungiblePositionManager.DecreaseLiquidityParams({
	tokenId: lpToTokenId[msg.sender],
	liquidity: pool.liquidity(),
	amount0Min: 0,
	amount1Min: 0,
	deadline: block.timestamp
	})
	);
	address token0 = pool.token0();
	address token1 = pool.token1();
	// approve new LP
	IERC20(token0).approve(address(positionManager), amount0);
	IERC20(token1).approve(address(positionManager), amount1);
	// create new Liquidity Pool
	_createLP(positionManager, token0, token1, amount0, amount1, party.lpFee);
	}

• ID-7
  BNBPartyInternal._createFLP(address) ignores return value by IERC20(_token).approve(address(BNBPositionManager),party.initialTokenAmount)

BNBParty.Factory/contracts/BNBPartyInternal.sol

Lines 9 to 37 in fcc51ca

	function _createFLP(
	address _token
	) internal returns (address liquidityPool) {
	// tokenA < tokenB
	(address tokenA, address tokenB) = _token < address(WBNB)
	? (_token, address(WBNB))
	: (address(WBNB), _token);
	uint256 amount0;
	uint256 amount1;
	if (IERC20(tokenA).balanceOf(address(this)) == party.initialTokenAmount) {
	amount0 = party.initialTokenAmount;
	} else {
	amount1 = party.initialTokenAmount;
	}
	IERC20(_token).approve(
	address(BNBPositionManager),
	party.initialTokenAmount
	);
	liquidityPool = _createLP(
	BNBPositionManager,
	tokenA,
	tokenB,
	amount0,
	amount1,
	party.partyLpFee
	);
	isParty[liquidityPool] = true;
	}

• ID-8
  BNBPartyInternal._createLP(INonfungiblePositionManager,address,address,uint256,uint256,uint24) ignores return value by (lpToTokenId[liquidityPool],None,None,None) = liquidityManager.mint(INonfungiblePositionManager.MintParams({token0:token0,token1:token1,fee:fee,tickLower:party.tickLower,tickUpper:party.tickUpper,amount0Desired:amount0,amount1Desired:amount1,amount0Min:0,amount1Min:0,recipient:address(this),deadline:block.timestamp}))

BNBParty.Factory/contracts/BNBPartyInternal.sol

Lines 39 to 71 in fcc51ca

	function _createLP(
	INonfungiblePositionManager liquidityManager,
	address token0,
	address token1,
	uint256 amount0,
	uint256 amount1,
	uint24 fee
	) internal returns (address liquidityPool) {
	// Create LP
	liquidityPool = liquidityManager.createAndInitializePoolIfNecessary(
	token0,
	token1,
	fee,
	party.sqrtPriceX96
	);
	// Mint LP
	(lpToTokenId[liquidityPool], , , ) = liquidityManager.mint(
	INonfungiblePositionManager.MintParams({
	token0: token0,
	token1: token1,
	fee: fee,
	tickLower: party.tickLower,
	tickUpper: party.tickUpper,
	amount0Desired: amount0,
	amount1Desired: amount1,
	amount0Min: 0,
	amount1Min: 0,
	recipient: address(this),
	deadline: block.timestamp
	})
	);
	}

shadowing-local

Impact: Low
Confidence: High

• ID-9
  ERC20Token.constructor(string,string,uint256).name shadows:
  • ERC20.name() (function)
  • IERC20Metadata.name() (function)

BNBParty.Factory/contracts/token/ERC20Token.sol

Line 9 in fcc51ca

string memory name,

• ID-10
  ERC20Token.constructor(string,string,uint256).symbol shadows:
  • ERC20.symbol() (function)
  • IERC20Metadata.symbol() (function)

BNBParty.Factory/contracts/token/ERC20Token.sol

Line 10 in fcc51ca

string memory symbol,

reentrancy-benign

Impact: Low
Confidence: Medium

• ID-11
  Reentrancy in BNBPartyInternal._createFLP(address):
  External calls:
  • IERC20(_token).approve(address(BNBPositionManager),party.initialTokenAmount)
  • liquidityPool = _createLP(BNBPositionManager,tokenA,tokenB,amount0,amount1,party.partyLpFee)
    • liquidityPool = liquidityManager.createAndInitializePoolIfNecessary(token0,token1,fee,party.sqrtPriceX96)
    • (lpToTokenId[liquidityPool],None,None,None) = liquidityManager.mint(INonfungiblePositionManager.MintParams({token0:token0,token1:token1,fee:fee,tickLower:party.tickLower,tickUpper:party.tickUpper,amount0Desired:amount0,amount1Desired:amount1,amount0Min:0,amount1Min:0,recipient:address(this),deadline:block.timestamp}))
      State variables written after the call(s):
  • isParty[liquidityPool] = true
  • liquidityPool = _createLP(BNBPositionManager,tokenA,tokenB,amount0,amount1,party.partyLpFee)
    • (lpToTokenId[liquidityPool],None,None,None) = liquidityManager.mint(INonfungiblePositionManager.MintParams({token0:token0,token1:token1,fee:fee,tickLower:party.tickLower,tickUpper:party.tickUpper,amount0Desired:amount0,amount1Desired:amount1,amount0Min:0,amount1Min:0,recipient:address(this),deadline:block.timestamp}))

BNBParty.Factory/contracts/BNBPartyInternal.sol

Lines 9 to 37 in fcc51ca

	function _createFLP(
	address _token
	) internal returns (address liquidityPool) {
	// tokenA < tokenB
	(address tokenA, address tokenB) = _token < address(WBNB)
	? (_token, address(WBNB))
	: (address(WBNB), _token);
	uint256 amount0;
	uint256 amount1;
	if (IERC20(tokenA).balanceOf(address(this)) == party.initialTokenAmount) {
	amount0 = party.initialTokenAmount;
	} else {
	amount1 = party.initialTokenAmount;
	}
	IERC20(_token).approve(
	address(BNBPositionManager),
	party.initialTokenAmount
	);
	liquidityPool = _createLP(
	BNBPositionManager,
	tokenA,
	tokenB,
	amount0,
	amount1,
	party.partyLpFee
	);
	isParty[liquidityPool] = true;
	}

• ID-12
  Reentrancy in BNBPartyInternal._createLP(INonfungiblePositionManager,address,address,uint256,uint256,uint24):
  External calls:
  • liquidityPool = liquidityManager.createAndInitializePoolIfNecessary(token0,token1,fee,party.sqrtPriceX96)
  • (lpToTokenId[liquidityPool],None,None,None) = liquidityManager.mint(INonfungiblePositionManager.MintParams({token0:token0,token1:token1,fee:fee,tickLower:party.tickLower,tickUpper:party.tickUpper,amount0Desired:amount0,amount1Desired:amount1,amount0Min:0,amount1Min:0,recipient:address(this),deadline:block.timestamp}))
    State variables written after the call(s):
  • (lpToTokenId[liquidityPool],None,None,None) = liquidityManager.mint(INonfungiblePositionManager.MintParams({token0:token0,token1:token1,fee:fee,tickLower:party.tickLower,tickUpper:party.tickUpper,amount0Desired:amount0,amount1Desired:amount1,amount0Min:0,amount1Min:0,recipient:address(this),deadline:block.timestamp}))

BNBParty.Factory/contracts/BNBPartyInternal.sol

Lines 39 to 71 in fcc51ca

	function _createLP(
	INonfungiblePositionManager liquidityManager,
	address token0,
	address token1,
	uint256 amount0,
	uint256 amount1,
	uint24 fee
	) internal returns (address liquidityPool) {
	// Create LP
	liquidityPool = liquidityManager.createAndInitializePoolIfNecessary(
	token0,
	token1,
	fee,
	party.sqrtPriceX96
	);
	// Mint LP
	(lpToTokenId[liquidityPool], , , ) = liquidityManager.mint(
	INonfungiblePositionManager.MintParams({
	token0: token0,
	token1: token1,
	fee: fee,
	tickLower: party.tickLower,
	tickUpper: party.tickUpper,
	amount0Desired: amount0,
	amount1Desired: amount1,
	amount0Min: 0,
	amount1Min: 0,
	recipient: address(this),
	deadline: block.timestamp
	})
	);
	}

assembly

Impact: Informational
Confidence: High

• ID-13
  Address._revert(bytes) uses assembly
  • INLINE ASM

https://github.com/bnb-party/BNBParty.Factory/blob/fcc51caa87a7d24e4b9cf9f80bb1810264355172/node_modules/@openzeppelin/contracts/utils/Address.sol#L146-L158

low-level-calls

Impact: Informational
Confidence: High

• ID-14
  Low level call in SafeERC20._callOptionalReturnBool(IERC20,bytes):
  • (success,returndata) = address(token).call(data)

https://github.com/bnb-party/BNBParty.Factory/blob/fcc51caa87a7d24e4b9cf9f80bb1810264355172/node_modules/@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol#L110-L117

• ID-15
  Low level call in Address.functionStaticCall(address,bytes):
  • (success,returndata) = target.staticcall(data)

https://github.com/bnb-party/BNBParty.Factory/blob/fcc51caa87a7d24e4b9cf9f80bb1810264355172/node_modules/@openzeppelin/contracts/utils/Address.sol#L95-L98

• ID-16
  Low level call in Address.functionDelegateCall(address,bytes):
  • (success,returndata) = target.delegatecall(data)

https://github.com/bnb-party/BNBParty.Factory/blob/fcc51caa87a7d24e4b9cf9f80bb1810264355172/node_modules/@openzeppelin/contracts/utils/Address.sol#L104-L107

• ID-17
  Low level call in Address.sendValue(address,uint256):
  • (success,None) = recipient.call{value: amount}()

https://github.com/bnb-party/BNBParty.Factory/blob/fcc51caa87a7d24e4b9cf9f80bb1810264355172/node_modules/@openzeppelin/contracts/utils/Address.sol#L41-L50

• ID-18
  Low level call in Address.functionCallWithValue(address,bytes,uint256):
  • (success,returndata) = target.call{value: value}(data)

https://github.com/bnb-party/BNBParty.Factory/blob/fcc51caa87a7d24e4b9cf9f80bb1810264355172/node_modules/@openzeppelin/contracts/utils/Address.sol#L83-L89

• ID-19
  Low level call in BNBPartyInternal._unwrapAndSendBNB(address):
  • (success,None) = recipient.call{value: party.bonusTargetReach}()

BNBParty.Factory/contracts/BNBPartyInternal.sol

Lines 73 to 77 in fcc51ca

	function _unwrapAndSendBNB(address recipient) internal {
	WBNB.withdraw(party.bonusTargetReach);
	(bool success, ) = recipient.call{value: party.bonusTargetReach}("");
	require(success, "Transfer failed.");
	}

naming-convention

Impact: Informational
Confidence: High

• ID-20
  Variable BNBPartyState.WBNB is not in mixedCase

BNBParty.Factory/contracts/BNBPartyState.sol

Line 20 in fcc51ca

IWBNB public immutable WBNB;

• ID-21
  Parameter BNBPartyState.setNonfungiblePositionManager(INonfungiblePositionManager,INonfungiblePositionManager)._BNBPositionManager is not in mixedCase

BNBParty.Factory/contracts/BNBPartyState.sol

Line 43 in fcc51ca

INonfungiblePositionManager _BNBPositionManager,

• ID-22
  Variable BNBPartyState.BNBPositionManager is not in mixedCase

BNBParty.Factory/contracts/BNBPartyState.sol

Line 12 in fcc51ca

INonfungiblePositionManager public BNBPositionManager; // BNB Party position manager

• ID-23
  Parameter BNBPartyState.setNonfungiblePositionManager(INonfungiblePositionManager,INonfungiblePositionManager)._positionManager is not in mixedCase

BNBParty.Factory/contracts/BNBPartyState.sol

Line 44 in fcc51ca

INonfungiblePositionManager _positionManager

• ID-24
  Parameter BNBPartyState.setSwapRouter(ISwapRouter)._swapRouter is not in mixedCase

BNBParty.Factory/contracts/BNBPartyState.sol

Line 53 in fcc51ca

function setSwapRouter(ISwapRouter _swapRouter) external onlyOwner {

• ID-25
  Function INonfungiblePositionManager.WETH9() is not in mixedCase

BNBParty.Factory/contracts/interfaces/INonfungiblePositionManager.sol

Line 184 in fcc51ca

function WETH9() external view returns (address);

• ID-26
  Function IERC20Permit.DOMAIN_SEPARATOR() is not in mixedCase

https://github.com/bnb-party/BNBParty.Factory/blob/fcc51caa87a7d24e4b9cf9f80bb1810264355172/node_modules/@openzeppelin/contracts/token/ERC20/extensions/IERC20Permit.sol#L89

unused-import

Impact: Informational
Confidence: High

• ID-27
  The following unused import(s) in contracts/BNBPartyInternal.sol should be removed:
  -import "./token/ERC20Token.sol"; (contracts/BNBPartyInternal.sol#4)