update inheritance, add uml

[YouStillAlive]

closes #73

[github-actions[bot]]

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,706,706	5,883,512	5,742,176	36	16.03
joinParty(address,uint256)	144,007	5,731,439	2,088,217	26	5.83
leaveParty(address,uint256,uint256)	177,844	203,219	183,534	5	0.51
pause()	-	-	46,808	5	0.13
setBNBPartySwapRouter(address)	24,157	46,297	45,067	18	0.13
setNonfungiblePositionManager(address,address)	27,416	68,950	66,640	18	0.19
setSwapRouter(address)	-	-	46,342	16	0.13
unpause()	-	-	24,929	5	0.07
withdrawFee()	-	-	31,766	2	0.09
withdrawLPFee(address[])	-	-	173,662	1	0.48
withdrawPartyLPFee(address[])	-	-	173,798	2	0.49
NonfungiblePositionManager
approve(address,uint256)	46,052	46,395	46,303	4	0.13
SwapRouter
exactInput((bytes,address,uint256,uint256,uint256))	135,931	145,489	142,303	3	0.40
multicall(bytes[])	-	-	163,945	2	0.46

Deployments

	Min	Max	Avg	Block %	usd avg
BNBPartyFactory	3,709,716	3,709,728	3,709,727	2.9 %	10.36
MockContract	-	-	107,813	0.1 %	0.30
MockNonfungibleTokenPositionDescriptor	-	-	111,329	0.1 %	0.31
NonfungiblePositionManager	5,171,500	5,171,524	5,171,518	4 %	14.44
SqrtPriceCalculator	-	-	278,712	0.2 %	0.78
SwapRouter	2,201,066	2,201,090	2,201,085	1.7 %	6.15
UniswapV3Factory	5,437,097	5,437,109	5,437,108	4.2 %	15.18

Solidity and Network Config

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

[codecov-commenter]

:warning: Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Files with missing lines	Coverage Δ
contracts/BNBPartyFactory.sol	100.00% <ø> (ø)
contracts/BNBPartyView.sol	100.00% <ø> (ø)

[github-actions[bot]]

Slither report

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

• unused-return (6 results) (Medium)
• reentrancy-benign (1 results) (Low)
• reentrancy-events (4 results) (Low)
• naming-convention (8 results) (Informational)
• reentrancy-unlimited-gas (1 results) (Informational)

  unused-return

  Impact: Medium Confidence: Medium

• [ ] ID-0 BNBPartyFee._collectFee(address,INonfungiblePositionManager) ignores return value by manager.collect(INonfungiblePositionManager.CollectParams({tokenId:lpToTokenId[liquidityPool],recipient:msg.sender,amount0Max:type()(uint128).max,amount1Max:type()(uint128).max}))

https://github.com/bnb-party/BNBParty.Factory/blob/709a295b792caccc35cba032ec5b2eb60aa8367a/contracts/BNBPartyFee.sol#L149-L161

• [ ] ID-1 BNBPartyLiquidity._handleLiquidity(address) ignores return value by (sqrtPriceX96,None,None,None,None,None,None) = pool.slot0()

https://github.com/bnb-party/BNBParty.Factory/blob/709a295b792caccc35cba032ec5b2eb60aa8367a/contracts/BNBPartyLiquidity.sol#L14-L56

• [ ] ID-2 BNBPartyLiquidityHelper._decreaseAndCollect(uint256,uint128) ignores return value by BNBPositionManager.collect(INonfungiblePositionManager.CollectParams({tokenId:tokenId,recipient:address(this),amount0Max:uint128(amount0),amount1Max:uint128(amount1)}))

https://github.com/bnb-party/BNBParty.Factory/blob/709a295b792caccc35cba032ec5b2eb60aa8367a/contracts/BNBPartyLiquidityHelper.sol#L16-L40

• [ ] ID-3 BNBPartyCreation._createLP(INonfungiblePositionManager,address,address,uint256,uint256,uint160,uint24,IBNBPartyFactory.Ticks) ignores return value by (tokenId,None,None,None) = liquidityManager.mint(INonfungiblePositionManager.MintParams({token0:token0,token1:token1,fee:fee,tickLower:ticks.tickLower,tickUpper:ticks.tickUpper,amount0Desired:amount0,amount1Desired:amount1,amount0Min:0,amount1Min:0,recipient:address(this),deadline:block.timestamp}))

https://github.com/bnb-party/BNBParty.Factory/blob/709a295b792caccc35cba032ec5b2eb60aa8367a/contracts/BNBPartyCreation.sol#L43-L77

• [ ] ID-4 BNBPartySwaps._executeSwap(ISwapRouter,ISwapRouter.ExactInputParams) ignores return value by ISwapRouter(router).exactInput{value: value}(params)

https://github.com/bnb-party/BNBParty.Factory/blob/709a295b792caccc35cba032ec5b2eb60aa8367a/contracts/BNBPartySwaps.sol#L47-L53

• [ ] ID-5 BNBPartyFee._getFeeGrowthInsideLastX128(IUniswapV3Pool,bytes32) ignores return value by (None,feeGrowthInside0LastX128,feeGrowthInside1LastX128,None,None) = pool.positions(key)

https://github.com/bnb-party/BNBParty.Factory/blob/709a295b792caccc35cba032ec5b2eb60aa8367a/contracts/BNBPartyFee.sol#L70-L82

reentrancy-benign

Impact: Low Confidence: Medium

• [ ] ID-6 Reentrancy in BNBPartyLiquidity._handleLiquidity(address): External calls:
  • (amount0,amount1) = _decreaseAndCollect(lpToTokenId[msg.sender],liquidity)
    • (amount0,amount1) = BNBPositionManager.decreaseLiquidity(INonfungiblePositionManager.DecreaseLiquidityParams({tokenId:tokenId,liquidity:liquidity,amount0Min:0,amount1Min:0,deadline:block.timestamp}))
    • BNBPositionManager.collect(INonfungiblePositionManager.CollectParams({tokenId:tokenId,recipient:address(this),amount0Max:uint128(amount0),amount1Max:uint128(amount1)})) State variables written after the call(s):
  • isTokenTargetReached[token1] = true
  • isTokenTargetReached[token0] = true

https://github.com/bnb-party/BNBParty.Factory/blob/709a295b792caccc35cba032ec5b2eb60aa8367a/contracts/BNBPartyLiquidity.sol#L14-L56

reentrancy-events

Impact: Low Confidence: Medium

• [ ] ID-7 Reentrancy in BNBPartySwaps._unwrapAndSendBNB(address,uint256): External calls:
  • WBNB.withdraw(unwrapAmount) External calls sending eth:
  • _transferBNB(recipient,party.bonusTargetReach + party.bonusPartyCreator)
    • address(recipient).transfer(amount) Event emitted after the call(s):
  • TransferOutBNB(recipient,amount)
    • _transferBNB(recipient,party.bonusTargetReach + party.bonusPartyCreator)

https://github.com/bnb-party/BNBParty.Factory/blob/709a295b792caccc35cba032ec5b2eb60aa8367a/contracts/BNBPartySwaps.sol#L13-L22

• [ ] ID-8 Reentrancy in BNBPartySwaps._unwrapAndSendBNB(address,uint256): External calls:
  • WBNB.withdraw(unwrapAmount) External calls sending eth:
  • _transferBNB(recipient,party.bonusTargetReach)
    • address(recipient).transfer(amount) Event emitted after the call(s):
  • TransferOutBNB(recipient,amount)
    • _transferBNB(recipient,party.bonusTargetReach)

https://github.com/bnb-party/BNBParty.Factory/blob/709a295b792caccc35cba032ec5b2eb60aa8367a/contracts/BNBPartySwaps.sol#L13-L22

• [ ] ID-9 Reentrancy in BNBPartySwaps._unwrapAndSendBNB(address,uint256): External calls:
  • WBNB.withdraw(unwrapAmount) External calls sending eth:
  • _transferBNB(recipient,party.bonusTargetReach)
    • address(recipient).transfer(amount)
  • _transferBNB(creator,party.bonusPartyCreator)
    • address(recipient).transfer(amount) Event emitted after the call(s):
  • TransferOutBNB(recipient,amount)
    • _transferBNB(creator,party.bonusPartyCreator)

https://github.com/bnb-party/BNBParty.Factory/blob/709a295b792caccc35cba032ec5b2eb60aa8367a/contracts/BNBPartySwaps.sol#L13-L22

• [ ] ID-10 Reentrancy in BNBPartyLiquidity._handleLiquidity(address): External calls:
  • (amount0,amount1) = _decreaseAndCollect(lpToTokenId[msg.sender],liquidity)
    • (amount0,amount1) = BNBPositionManager.decreaseLiquidity(INonfungiblePositionManager.DecreaseLiquidityParams({tokenId:tokenId,liquidity:liquidity,amount0Min:0,amount1Min:0,deadline:block.timestamp}))
    • BNBPositionManager.collect(INonfungiblePositionManager.CollectParams({tokenId:tokenId,recipient:address(this),amount0Max:uint128(amount0),amount1Max:uint128(amount1)}))
  • IERC20(token0).safeIncreaseAllowance(address(positionManager),amount0)
  • IERC20(token1).safeIncreaseAllowance(address(positionManager),amount1)
  • (liquidityPool,tokenId) = _createLP(positionManager,token0,token1,amount0,amount1,newSqrtPriceX96,party.lpFee,_getTicks(token0,party.lpTicks))
    • liquidityPool = liquidityManager.createAndInitializePoolIfNecessary(token0,token1,fee,sqrtPriceX96)
    • (tokenId,None,None,None) = liquidityManager.mint(INonfungiblePositionManager.MintParams({token0:token0,token1:token1,fee:fee,tickLower:ticks.tickLower,tickUpper:ticks.tickUpper,amount0Desired:amount0,amount1Desired:amount1,amount0Min:0,amount1Min:0,recipient:address(this),deadline:block.timestamp}))
  • _unwrapAndSendBNB(recipient,unwrapAmount)
    • WBNB.withdraw(unwrapAmount) External calls sending eth:
  • _unwrapAndSendBNB(recipient,unwrapAmount)
    • address(recipient).transfer(amount) Event emitted after the call(s):
  • TransferOutBNB(recipient,amount)
    • _unwrapAndSendBNB(recipient,unwrapAmount)

https://github.com/bnb-party/BNBParty.Factory/blob/709a295b792caccc35cba032ec5b2eb60aa8367a/contracts/BNBPartyLiquidity.sol#L14-L56

naming-convention

Impact: Informational Confidence: High

• [ ] ID-11 Variable BNBPartyState.WBNB is not in mixedCase

https://github.com/bnb-party/BNBParty.Factory/blob/709a295b792caccc35cba032ec5b2eb60aa8367a/contracts/BNBPartyState.sol#L26

• [ ] ID-12 Variable BNBPartyState.BNBPositionManager is not in mixedCase

https://github.com/bnb-party/BNBParty.Factory/blob/709a295b792caccc35cba032ec5b2eb60aa8367a/contracts/BNBPartyState.sol#L13

• [ ] ID-13 Parameter BNBPartyManageable.setSwapRouter(ISwapRouter)._swapRouter is not in mixedCase

https://github.com/bnb-party/BNBParty.Factory/blob/709a295b792caccc35cba032ec5b2eb60aa8367a/contracts/BNBPartyManageable.sol#L35

• [ ] ID-14 Parameter BNBPartyManageable.setNonfungiblePositionManager(INonfungiblePositionManager,INonfungiblePositionManager)._BNBPositionManager is not in mixedCase

https://github.com/bnb-party/BNBParty.Factory/blob/709a295b792caccc35cba032ec5b2eb60aa8367a/contracts/BNBPartyManageable.sol#L15

• [ ] ID-15 Function INonfungiblePositionManager.WETH9() is not in mixedCase

https://github.com/bnb-party/BNBParty.Factory/blob/709a295b792caccc35cba032ec5b2eb60aa8367a/contracts/interfaces/INonfungiblePositionManager.sol#L184

• [ ] ID-16 Parameter BNBPartyManageable.setNonfungiblePositionManager(INonfungiblePositionManager,INonfungiblePositionManager)._positionManager is not in mixedCase

https://github.com/bnb-party/BNBParty.Factory/blob/709a295b792caccc35cba032ec5b2eb60aa8367a/contracts/BNBPartyManageable.sol#L16

• [ ] ID-17 Parameter BNBPartyManageable.setBNBPartySwapRouter(ISwapRouter)._swapRouter is not in mixedCase

https://github.com/bnb-party/BNBParty.Factory/blob/709a295b792caccc35cba032ec5b2eb60aa8367a/contracts/BNBPartyManageable.sol#L29

• [ ] ID-18 Variable BNBPartyState.BNBSwapRouter is not in mixedCase

https://github.com/bnb-party/BNBParty.Factory/blob/709a295b792caccc35cba032ec5b2eb60aa8367a/contracts/BNBPartyState.sol#L15

reentrancy-unlimited-gas

Impact: Informational Confidence: Medium

• [ ] ID-19 Reentrancy in BNBPartySwaps._unwrapAndSendBNB(address,uint256): External calls:
  • _transferBNB(recipient,party.bonusTargetReach)
    • address(recipient).transfer(amount)
  • _transferBNB(creator,party.bonusPartyCreator)
    • address(recipient).transfer(amount) Event emitted after the call(s):
  • TransferOutBNB(recipient,amount)
    • _transferBNB(creator,party.bonusPartyCreator)

https://github.com/bnb-party/BNBParty.Factory/blob/709a295b792caccc35cba032ec5b2eb60aa8367a/contracts/BNBPartySwaps.sol#L13-L22